Class: Azure::Network::Mgmt::V2020_08_01::VpnGateways

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb

Overview

VpnGateways

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ VpnGateways

Creates and initializes a new instance of the VpnGateways class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ NetworkManagementClient (readonly)

Returns reference to the NetworkManagementClient.

Returns:



22
23
24
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 22

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, gateway_name, vpn_gateway_parameters, custom_headers: nil) ⇒ VpnGateway

Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway.

VpnGateway. Update a virtual wan vpn gateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • vpn_gateway_parameters (VpnGateway) —

    Parameters supplied to create or

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (VpnGateway) —

    operation results.



605
606
607
608
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 605

def begin_create_or_update(resource_group_name, gateway_name, vpn_gateway_parameters, custom_headers:nil)
  response = begin_create_or_update_async(resource_group_name, gateway_name, vpn_gateway_parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_create_or_update_async(resource_group_name, gateway_name, vpn_gateway_parameters, custom_headers: nil) ⇒ Concurrent::Promise

Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway.

VpnGateway. Update a virtual wan vpn gateway. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • vpn_gateway_parameters (VpnGateway) —

    Parameters supplied to create or

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 642

def begin_create_or_update_async(resource_group_name, gateway_name, vpn_gateway_parameters, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'gateway_name is nil' if gateway_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'vpn_gateway_parameters is nil' if vpn_gateway_parameters.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  # Serialize Request
  request_mapper = Azure::Network::Mgmt::V2020_08_01::Models::VpnGateway.mapper()
  request_content = @client.serialize(request_mapper,  vpn_gateway_parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'gatewayName' => gateway_name},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:put, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 201
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::VpnGateway.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::VpnGateway.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#begin_create_or_update_with_http_info(resource_group_name, gateway_name, vpn_gateway_parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway.

VpnGateway. Update a virtual wan vpn gateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • vpn_gateway_parameters (VpnGateway) —

    Parameters supplied to create or

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



624
625
626
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 624

def begin_create_or_update_with_http_info(resource_group_name, gateway_name, vpn_gateway_parameters, custom_headers:nil)
  begin_create_or_update_async(resource_group_name, gateway_name, vpn_gateway_parameters, custom_headers:custom_headers).value!
end

#begin_delete(resource_group_name, gateway_name, custom_headers: nil) ⇒ Object

Deletes a virtual wan vpn gateway.

VpnGateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that



836
837
838
839
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 836

def begin_delete(resource_group_name, gateway_name, custom_headers:nil)
  response = begin_delete_async(resource_group_name, gateway_name, custom_headers:custom_headers).value!
  nil
end

#begin_delete_async(resource_group_name, gateway_name, custom_headers: nil) ⇒ Concurrent::Promise

Deletes a virtual wan vpn gateway.

VpnGateway. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 867

def begin_delete_async(resource_group_name, gateway_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'gateway_name is nil' if gateway_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'gatewayName' => gateway_name},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 202 || status_code == 204
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

#begin_delete_with_http_info(resource_group_name, gateway_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a virtual wan vpn gateway.

VpnGateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



852
853
854
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 852

def begin_delete_with_http_info(resource_group_name, gateway_name, custom_headers:nil)
  begin_delete_async(resource_group_name, gateway_name, custom_headers:custom_headers).value!
end

#begin_reset(resource_group_name, gateway_name, custom_headers: nil) ⇒ VpnGateway

Resets the primary of the vpn gateway in the specified resource group.

VpnGateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (VpnGateway) —

    operation results.



923
924
925
926
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 923

def begin_reset(resource_group_name, gateway_name, custom_headers:nil)
  response = begin_reset_async(resource_group_name, gateway_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_reset_async(resource_group_name, gateway_name, custom_headers: nil) ⇒ Concurrent::Promise

Resets the primary of the vpn gateway in the specified resource group.

VpnGateway. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 954

def begin_reset_async(resource_group_name, gateway_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'gateway_name is nil' if gateway_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/reset'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'gatewayName' => gateway_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 202
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::VpnGateway.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#begin_reset_with_http_info(resource_group_name, gateway_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Resets the primary of the vpn gateway in the specified resource group.

VpnGateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



939
940
941
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 939

def begin_reset_with_http_info(resource_group_name, gateway_name, custom_headers:nil)
  begin_reset_async(resource_group_name, gateway_name, custom_headers:custom_headers).value!
end

#begin_start_packet_capture(resource_group_name, gateway_name, parameters: nil, custom_headers: nil) ⇒ String

Starts packet capture on vpn gateway in the specified resource group.

VpnGateway. capture parameters supplied to start packet capture on vpn gateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • parameters (VpnGatewayPacketCaptureStartParameters) (defaults to: nil) —

    Vpn gateway packet

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (String) —

    operation results.



1022
1023
1024
1025
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 1022

def begin_start_packet_capture(resource_group_name, gateway_name, parameters:nil, custom_headers:nil)
  response = begin_start_packet_capture_async(resource_group_name, gateway_name, parameters:parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_start_packet_capture_async(resource_group_name, gateway_name, parameters: nil, custom_headers: nil) ⇒ Concurrent::Promise

Starts packet capture on vpn gateway in the specified resource group.

VpnGateway. capture parameters supplied to start packet capture on vpn gateway. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • parameters (VpnGatewayPacketCaptureStartParameters) (defaults to: nil) —

    Vpn gateway packet

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 1057

def begin_start_packet_capture_async(resource_group_name, gateway_name, parameters:nil, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'gateway_name is nil' if gateway_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  # Serialize Request
  request_mapper = Azure::Network::Mgmt::V2020_08_01::Models::VpnGatewayPacketCaptureStartParameters.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/startpacketcapture'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'gatewayName' => gateway_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 202
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = {
          client_side_validation: true,
          required: false,
          serialized_name: 'parsed_response',
          type: {
            name: 'String'
          }
        }
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#begin_start_packet_capture_with_http_info(resource_group_name, gateway_name, parameters: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Starts packet capture on vpn gateway in the specified resource group.

VpnGateway. capture parameters supplied to start packet capture on vpn gateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • parameters (VpnGatewayPacketCaptureStartParameters) (defaults to: nil) —

    Vpn gateway packet

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1040
1041
1042
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 1040

def begin_start_packet_capture_with_http_info(resource_group_name, gateway_name, parameters:nil, custom_headers:nil)
  begin_start_packet_capture_async(resource_group_name, gateway_name, parameters:parameters, custom_headers:custom_headers).value!
end

#begin_stop_packet_capture(resource_group_name, gateway_name, parameters: nil, custom_headers: nil) ⇒ String

Stops packet capture on vpn gateway in the specified resource group.

VpnGateway. capture parameters supplied to stop packet capture on vpn gateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • parameters (VpnGatewayPacketCaptureStopParameters) (defaults to: nil) —

    Vpn gateway packet

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (String) —

    operation results.



1139
1140
1141
1142
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 1139

def begin_stop_packet_capture(resource_group_name, gateway_name, parameters:nil, custom_headers:nil)
  response = begin_stop_packet_capture_async(resource_group_name, gateway_name, parameters:parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_stop_packet_capture_async(resource_group_name, gateway_name, parameters: nil, custom_headers: nil) ⇒ Concurrent::Promise

Stops packet capture on vpn gateway in the specified resource group.

VpnGateway. capture parameters supplied to stop packet capture on vpn gateway. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • parameters (VpnGatewayPacketCaptureStopParameters) (defaults to: nil) —

    Vpn gateway packet

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 1174

def begin_stop_packet_capture_async(resource_group_name, gateway_name, parameters:nil, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'gateway_name is nil' if gateway_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  # Serialize Request
  request_mapper = Azure::Network::Mgmt::V2020_08_01::Models::VpnGatewayPacketCaptureStopParameters.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/stoppacketcapture'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'gatewayName' => gateway_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 202
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = {
          client_side_validation: true,
          required: false,
          serialized_name: 'parsed_response',
          type: {
            name: 'String'
          }
        }
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#begin_stop_packet_capture_with_http_info(resource_group_name, gateway_name, parameters: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Stops packet capture on vpn gateway in the specified resource group.

VpnGateway. capture parameters supplied to stop packet capture on vpn gateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • parameters (VpnGatewayPacketCaptureStopParameters) (defaults to: nil) —

    Vpn gateway packet

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1157
1158
1159
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 1157

def begin_stop_packet_capture_with_http_info(resource_group_name, gateway_name, parameters:nil, custom_headers:nil)
  begin_stop_packet_capture_async(resource_group_name, gateway_name, parameters:parameters, custom_headers:custom_headers).value!
end

#begin_update_tags(resource_group_name, gateway_name, vpn_gateway_parameters, custom_headers: nil) ⇒ VpnGateway

Updates virtual wan vpn gateway tags.

VpnGateway. virtual wan vpn gateway tags. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • vpn_gateway_parameters (TagsObject) —

    Parameters supplied to update a

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (VpnGateway) —

    operation results.



728
729
730
731
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 728

def begin_update_tags(resource_group_name, gateway_name, vpn_gateway_parameters, custom_headers:nil)
  response = begin_update_tags_async(resource_group_name, gateway_name, vpn_gateway_parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_update_tags_async(resource_group_name, gateway_name, vpn_gateway_parameters, custom_headers: nil) ⇒ Concurrent::Promise

Updates virtual wan vpn gateway tags.

VpnGateway. virtual wan vpn gateway tags. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • vpn_gateway_parameters (TagsObject) —

    Parameters supplied to update a

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 763

def begin_update_tags_async(resource_group_name, gateway_name, vpn_gateway_parameters, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'gateway_name is nil' if gateway_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'vpn_gateway_parameters is nil' if vpn_gateway_parameters.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  # Serialize Request
  request_mapper = Azure::Network::Mgmt::V2020_08_01::Models::TagsObject.mapper()
  request_content = @client.serialize(request_mapper,  vpn_gateway_parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'gatewayName' => gateway_name},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:patch, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 202 || status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::VpnGateway.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#begin_update_tags_with_http_info(resource_group_name, gateway_name, vpn_gateway_parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Updates virtual wan vpn gateway tags.

VpnGateway. virtual wan vpn gateway tags. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • vpn_gateway_parameters (TagsObject) —

    Parameters supplied to update a

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



746
747
748
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 746

def begin_update_tags_with_http_info(resource_group_name, gateway_name, vpn_gateway_parameters, custom_headers:nil)
  begin_update_tags_async(resource_group_name, gateway_name, vpn_gateway_parameters, custom_headers:custom_headers).value!
end

#create_or_update(resource_group_name, gateway_name, vpn_gateway_parameters, custom_headers: nil) ⇒ VpnGateway

Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway.

VpnGateway. Update a virtual wan vpn gateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • vpn_gateway_parameters (VpnGateway) —

    Parameters supplied to create or

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (VpnGateway) —

    operation results.



135
136
137
138
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 135

def create_or_update(resource_group_name, gateway_name, vpn_gateway_parameters, custom_headers:nil)
  response = create_or_update_async(resource_group_name, gateway_name, vpn_gateway_parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(resource_group_name, gateway_name, vpn_gateway_parameters, custom_headers: nil) ⇒ Concurrent::Promise

VpnGateway. Update a virtual wan vpn gateway. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • vpn_gateway_parameters (VpnGateway) —

    Parameters supplied to create or

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 152

def create_or_update_async(resource_group_name, gateway_name, vpn_gateway_parameters, custom_headers:nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, gateway_name, vpn_gateway_parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::VpnGateway.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#delete(resource_group_name, gateway_name, custom_headers: nil) ⇒ Object

Deletes a virtual wan vpn gateway.

VpnGateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that



227
228
229
230
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 227

def delete(resource_group_name, gateway_name, custom_headers:nil)
  response = delete_async(resource_group_name, gateway_name, custom_headers:custom_headers).value!
  nil
end

#delete_async(resource_group_name, gateway_name, custom_headers: nil) ⇒ Concurrent::Promise

VpnGateway. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 242

def delete_async(resource_group_name, gateway_name, custom_headers:nil)
  # Send request
  promise = begin_delete_async(resource_group_name, gateway_name, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#get(resource_group_name, gateway_name, custom_headers: nil) ⇒ VpnGateway

Retrieves the details of a virtual wan vpn gateway.

VpnGateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (VpnGateway) —

    operation results.



35
36
37
38
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 35

def get(resource_group_name, gateway_name, custom_headers:nil)
  response = get_async(resource_group_name, gateway_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(resource_group_name, gateway_name, custom_headers: nil) ⇒ Concurrent::Promise

Retrieves the details of a virtual wan vpn gateway.

VpnGateway. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 66

def get_async(resource_group_name, gateway_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'gateway_name is nil' if gateway_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'gatewayName' => gateway_name},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::VpnGateway.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#get_with_http_info(resource_group_name, gateway_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieves the details of a virtual wan vpn gateway.

VpnGateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



51
52
53
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 51

def get_with_http_info(resource_group_name, gateway_name, custom_headers:nil)
  get_async(resource_group_name, gateway_name, custom_headers:custom_headers).value!
end

#list(custom_headers: nil) ⇒ Array<VpnGateway>

Lists all the VpnGateways in a subscription.

will be added to the HTTP request.

Parameters:

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (Array<VpnGateway>) —

    operation results.



513
514
515
516
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 513

def list(custom_headers:nil)
  first_page = list_as_lazy(custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(custom_headers: nil) ⇒ ListVpnGatewaysResult

Lists all the VpnGateways in a subscription.

will be added to the HTTP request.

response.

Parameters:

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (ListVpnGatewaysResult) —

    which provide lazy access to pages of the



1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 1454

def list_as_lazy(custom_headers:nil)
  response = list_async(custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_async(custom_headers: nil) ⇒ Concurrent::Promise

Lists all the VpnGateways in a subscription.

to the HTTP request.

Parameters:

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 538

def list_async(custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnGateways'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::ListVpnGatewaysResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_by_resource_group(resource_group_name, custom_headers: nil) ⇒ Array<VpnGateway>

Lists all the VpnGateways in a resource group.

VpnGateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (Array<VpnGateway>) —

    operation results.



422
423
424
425
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 422

def list_by_resource_group(resource_group_name, custom_headers:nil)
  first_page = list_by_resource_group_as_lazy(resource_group_name, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_resource_group_as_lazy(resource_group_name, custom_headers: nil) ⇒ ListVpnGatewaysResult

Lists all the VpnGateways in a resource group.

VpnGateway. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (ListVpnGatewaysResult) —

    which provide lazy access to pages of the



1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 1434

def list_by_resource_group_as_lazy(resource_group_name, custom_headers:nil)
  response = list_by_resource_group_async(resource_group_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_resource_group_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_resource_group_async(resource_group_name, custom_headers: nil) ⇒ Concurrent::Promise

Lists all the VpnGateways in a resource group.

VpnGateway. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 451

def list_by_resource_group_async(resource_group_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::ListVpnGatewaysResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_by_resource_group_next(next_page_link, custom_headers: nil) ⇒ ListVpnGatewaysResult

Lists all the VpnGateways in a resource group.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (ListVpnGatewaysResult) —

    operation results.



1253
1254
1255
1256
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 1253

def list_by_resource_group_next(next_page_link, custom_headers:nil)
  response = list_by_resource_group_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_by_resource_group_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Lists all the VpnGateways in a resource group.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 1282

def list_by_resource_group_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = '{nextLink}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::ListVpnGatewaysResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_by_resource_group_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all the VpnGateways in a resource group.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1268
1269
1270
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 1268

def list_by_resource_group_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_resource_group_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_resource_group_with_http_info(resource_group_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all the VpnGateways in a resource group.

VpnGateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



437
438
439
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 437

def list_by_resource_group_with_http_info(resource_group_name, custom_headers:nil)
  list_by_resource_group_async(resource_group_name, custom_headers:custom_headers).value!
end

#list_next(next_page_link, custom_headers: nil) ⇒ ListVpnGatewaysResult

Lists all the VpnGateways in a subscription.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (ListVpnGatewaysResult) —

    operation results.



1343
1344
1345
1346
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 1343

def list_next(next_page_link, custom_headers:nil)
  response = list_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Lists all the VpnGateways in a subscription.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 1372

def list_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = '{nextLink}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::ListVpnGatewaysResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all the VpnGateways in a subscription.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1358
1359
1360
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 1358

def list_next_with_http_info(next_page_link, custom_headers:nil)
  list_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_with_http_info(custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all the VpnGateways in a subscription.

will be added to the HTTP request.

Parameters:

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



526
527
528
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 526

def list_with_http_info(custom_headers:nil)
  list_async(custom_headers:custom_headers).value!
end

#reset(resource_group_name, gateway_name, custom_headers: nil) ⇒ VpnGateway

Resets the primary of the vpn gateway in the specified resource group.

VpnGateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (VpnGateway) —

    operation results.



269
270
271
272
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 269

def reset(resource_group_name, gateway_name, custom_headers:nil)
  response = reset_async(resource_group_name, gateway_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#reset_async(resource_group_name, gateway_name, custom_headers: nil) ⇒ Concurrent::Promise

VpnGateway. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 284

def reset_async(resource_group_name, gateway_name, custom_headers:nil)
  # Send request
  promise = begin_reset_async(resource_group_name, gateway_name, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::VpnGateway.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method, FinalStateVia::LOCATION)
  end

  promise
end

#start_packet_capture(resource_group_name, gateway_name, parameters: nil, custom_headers: nil) ⇒ String

Starts packet capture on vpn gateway in the specified resource group.

VpnGateway. capture parameters supplied to start packet capture on vpn gateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • parameters (VpnGatewayPacketCaptureStartParameters) (defaults to: nil) —

    Vpn gateway packet

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (String) —

    operation results.



315
316
317
318
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 315

def start_packet_capture(resource_group_name, gateway_name, parameters:nil, custom_headers:nil)
  response = start_packet_capture_async(resource_group_name, gateway_name, parameters:parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#start_packet_capture_async(resource_group_name, gateway_name, parameters: nil, custom_headers: nil) ⇒ Concurrent::Promise

VpnGateway. capture parameters supplied to start packet capture on vpn gateway. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • parameters (VpnGatewayPacketCaptureStartParameters) (defaults to: nil) —

    Vpn gateway packet

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 332

def start_packet_capture_async(resource_group_name, gateway_name, parameters:nil, custom_headers:nil)
  # Send request
  promise = begin_start_packet_capture_async(resource_group_name, gateway_name, parameters:parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = {
        client_side_validation: true,
        required: false,
        serialized_name: 'parsed_response',
        type: {
          name: 'String'
        }
      }
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method, FinalStateVia::LOCATION)
  end

  promise
end

#stop_packet_capture(resource_group_name, gateway_name, parameters: nil, custom_headers: nil) ⇒ String

Stops packet capture on vpn gateway in the specified resource group.

VpnGateway. capture parameters supplied to stop packet capture on vpn gateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • parameters (VpnGatewayPacketCaptureStopParameters) (defaults to: nil) —

    Vpn gateway packet

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (String) —

    operation results.



370
371
372
373
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 370

def stop_packet_capture(resource_group_name, gateway_name, parameters:nil, custom_headers:nil)
  response = stop_packet_capture_async(resource_group_name, gateway_name, parameters:parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#stop_packet_capture_async(resource_group_name, gateway_name, parameters: nil, custom_headers: nil) ⇒ Concurrent::Promise

VpnGateway. capture parameters supplied to stop packet capture on vpn gateway. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • parameters (VpnGatewayPacketCaptureStopParameters) (defaults to: nil) —

    Vpn gateway packet

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 387

def stop_packet_capture_async(resource_group_name, gateway_name, parameters:nil, custom_headers:nil)
  # Send request
  promise = begin_stop_packet_capture_async(resource_group_name, gateway_name, parameters:parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = {
        client_side_validation: true,
        required: false,
        serialized_name: 'parsed_response',
        type: {
          name: 'String'
        }
      }
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method, FinalStateVia::LOCATION)
  end

  promise
end

#update_tags(resource_group_name, gateway_name, vpn_gateway_parameters, custom_headers: nil) ⇒ VpnGateway

Updates virtual wan vpn gateway tags.

VpnGateway. virtual wan vpn gateway tags. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • vpn_gateway_parameters (TagsObject) —

    Parameters supplied to update a

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (VpnGateway) —

    operation results.



183
184
185
186
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 183

def update_tags(resource_group_name, gateway_name, vpn_gateway_parameters, custom_headers:nil)
  response = update_tags_async(resource_group_name, gateway_name, vpn_gateway_parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#update_tags_async(resource_group_name, gateway_name, vpn_gateway_parameters, custom_headers: nil) ⇒ Concurrent::Promise

VpnGateway. virtual wan vpn gateway tags. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • vpn_gateway_parameters (TagsObject) —

    Parameters supplied to update a

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 200

def update_tags_async(resource_group_name, gateway_name, vpn_gateway_parameters, custom_headers:nil)
  # Send request
  promise = begin_update_tags_async(resource_group_name, gateway_name, vpn_gateway_parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::VpnGateway.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end