Class: Azure::Network::Mgmt::V2019_11_01::P2sVpnGateways

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb

Overview

P2sVpnGateways

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ P2sVpnGateways

Creates and initializes a new instance of the P2sVpnGateways class.

Parameters:

  • client

    service class for accessing basic functionality.


17
18
19
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#clientNetworkManagementClient (readonly)

Returns reference to the NetworkManagementClient.

Returns:


22
23
24
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 22

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, gateway_name, p2svpn_gateway_parameters, custom_headers: nil) ⇒ P2SVpnGateway

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

P2SVpnGateway. create or Update a virtual wan p2s 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.

  • p2svpn_gateway_parameters (P2SVpnGateway)

    Parameters supplied to

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

    A hash of custom headers that

Returns:

  • (P2SVpnGateway)

    operation results.


694
695
696
697
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 694

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

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

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

P2SVpnGateway. create or Update a virtual wan p2s 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.

  • p2svpn_gateway_parameters (P2SVpnGateway)

    Parameters supplied to

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.


731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
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
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 731

def begin_create_or_update_async(resource_group_name, gateway_name, p2svpn_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, 'p2svpn_gateway_parameters is nil' if p2svpn_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::V2019_11_01::Models::P2SVpnGateway.mapper()
  request_content = @client.serialize(request_mapper,  p2svpn_gateway_parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{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::V2019_11_01::Models::P2SVpnGateway.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::V2019_11_01::Models::P2SVpnGateway.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, p2svpn_gateway_parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

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

P2SVpnGateway. create or Update a virtual wan p2s 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.

  • p2svpn_gateway_parameters (P2SVpnGateway)

    Parameters supplied to

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.


713
714
715
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 713

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

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

Deletes a virtual wan p2s vpn gateway.

P2SVpnGateway. 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


814
815
816
817
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 814

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 p2s vpn gateway.

P2SVpnGateway. 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.


845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 845

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/p2svpnGateways/{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 p2s vpn gateway.

P2SVpnGateway. 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.


830
831
832
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 830

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_disconnect_p2s_vpn_connections(resource_group_name, p2s_vpn_gateway_name, request, custom_headers: nil) ⇒ Object

Disconnect P2S vpn connections of the virtual wan P2SVpnGateway in the specified resource group.

disconnect p2s vpn connections. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • p2s_vpn_gateway_name (String)

    The name of the P2S Vpn Gateway.

  • request (P2SVpnConnectionRequest)

    The parameters are supplied to

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

    A hash of custom headers that


1221
1222
1223
1224
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 1221

def begin_disconnect_p2s_vpn_connections(resource_group_name, p2s_vpn_gateway_name, request, custom_headers:nil)
  response = begin_disconnect_p2s_vpn_connections_async(resource_group_name, p2s_vpn_gateway_name, request, custom_headers:custom_headers).value!
  nil
end

#begin_disconnect_p2s_vpn_connections_async(resource_group_name, p2s_vpn_gateway_name, request, custom_headers: nil) ⇒ Concurrent::Promise

Disconnect P2S vpn connections of the virtual wan P2SVpnGateway in the specified resource group.

disconnect p2s vpn connections. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • p2s_vpn_gateway_name (String)

    The name of the P2S Vpn Gateway.

  • request (P2SVpnConnectionRequest)

    The parameters are supplied to

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.


1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
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
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 1256

def begin_disconnect_p2s_vpn_connections_async(resource_group_name, p2s_vpn_gateway_name, request, 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, 'p2s_vpn_gateway_name is nil' if p2s_vpn_gateway_name.nil?
  fail ArgumentError, 'request is nil' if request.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?

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

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{p2sVpnGatewayName}/disconnectP2sVpnConnections'

  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,'p2sVpnGatewayName' => p2s_vpn_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(: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?

    result
  end

  promise.execute
end

#begin_disconnect_p2s_vpn_connections_with_http_info(resource_group_name, p2s_vpn_gateway_name, request, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Disconnect P2S vpn connections of the virtual wan P2SVpnGateway in the specified resource group.

disconnect p2s vpn connections. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • p2s_vpn_gateway_name (String)

    The name of the P2S Vpn Gateway.

  • request (P2SVpnConnectionRequest)

    The parameters are supplied to

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.


1239
1240
1241
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 1239

def begin_disconnect_p2s_vpn_connections_with_http_info(resource_group_name, p2s_vpn_gateway_name, request, custom_headers:nil)
  begin_disconnect_p2s_vpn_connections_async(resource_group_name, p2s_vpn_gateway_name, request, custom_headers:custom_headers).value!
end

#begin_generate_vpn_profile(resource_group_name, gateway_name, parameters, custom_headers: nil) ⇒ VpnProfileResponse

Generates VPN profile for P2S client of the P2SVpnGateway in the specified resource group.

generate P2SVpnGateway VPN client package operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • gateway_name (String)

    The name of the P2SVpnGateway.

  • parameters (P2SVpnProfileParameters)

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (VpnProfileResponse)

    operation results.


903
904
905
906
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 903

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

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

Generates VPN profile for P2S client of the P2SVpnGateway in the specified resource group.

generate P2SVpnGateway VPN client package operation. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • gateway_name (String)

    The name of the P2SVpnGateway.

  • parameters (P2SVpnProfileParameters)

    Parameters supplied to the

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.


938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
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
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 938

def begin_generate_vpn_profile_async(resource_group_name, gateway_name, parameters, 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, 'parameters is nil' if parameters.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::V2019_11_01::Models::P2SVpnProfileParameters.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/p2svpnGateways/{gatewayName}/generatevpnprofile'

  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 = Azure::Network::Mgmt::V2019_11_01::Models::VpnProfileResponse.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_generate_vpn_profile_with_http_info(resource_group_name, gateway_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Generates VPN profile for P2S client of the P2SVpnGateway in the specified resource group.

generate P2SVpnGateway VPN client package operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • gateway_name (String)

    The name of the P2SVpnGateway.

  • parameters (P2SVpnProfileParameters)

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.


921
922
923
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 921

def begin_generate_vpn_profile_with_http_info(resource_group_name, gateway_name, parameters, custom_headers:nil)
  begin_generate_vpn_profile_async(resource_group_name, gateway_name, parameters, custom_headers:custom_headers).value!
end

#begin_get_p2s_vpn_connection_health(resource_group_name, gateway_name, custom_headers: nil) ⇒ P2SVpnGateway

Gets the connection health of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • gateway_name (String)

    The name of the P2SVpnGateway.

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

    A hash of custom headers that

Returns:

  • (P2SVpnGateway)

    operation results.


1012
1013
1014
1015
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 1012

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

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

Gets the connection health of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • gateway_name (String)

    The name of the P2SVpnGateway.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.


1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
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
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 1043

def begin_get_p2s_vpn_connection_health_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/p2svpnGateways/{gatewayName}/getP2sVpnConnectionHealth'

  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::V2019_11_01::Models::P2SVpnGateway.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_get_p2s_vpn_connection_health_detailed(resource_group_name, gateway_name, request, custom_headers: nil) ⇒ P2SVpnConnectionHealth

Gets the sas url to get the connection health detail of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.

get p2s vpn connections detailed health. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • gateway_name (String)

    The name of the P2SVpnGateway.

  • request (P2SVpnConnectionHealthRequest)

    Request parameters supplied to

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

    A hash of custom headers that

Returns:

  • (P2SVpnConnectionHealth)

    operation results.


1111
1112
1113
1114
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 1111

def begin_get_p2s_vpn_connection_health_detailed(resource_group_name, gateway_name, request, custom_headers:nil)
  response = begin_get_p2s_vpn_connection_health_detailed_async(resource_group_name, gateway_name, request, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

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

Gets the sas url to get the connection health detail of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.

get p2s vpn connections detailed health. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • gateway_name (String)

    The name of the P2SVpnGateway.

  • request (P2SVpnConnectionHealthRequest)

    Request parameters supplied to

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.


1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
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
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 1146

def begin_get_p2s_vpn_connection_health_detailed_async(resource_group_name, gateway_name, request, 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, 'request is nil' if request.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?

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

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

  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(: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::V2019_11_01::Models::P2SVpnConnectionHealth.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_get_p2s_vpn_connection_health_detailed_with_http_info(resource_group_name, gateway_name, request, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the sas url to get the connection health detail of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.

get p2s vpn connections detailed health. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • gateway_name (String)

    The name of the P2SVpnGateway.

  • request (P2SVpnConnectionHealthRequest)

    Request parameters supplied to

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.


1129
1130
1131
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 1129

def begin_get_p2s_vpn_connection_health_detailed_with_http_info(resource_group_name, gateway_name, request, custom_headers:nil)
  begin_get_p2s_vpn_connection_health_detailed_async(resource_group_name, gateway_name, request, custom_headers:custom_headers).value!
end

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

Gets the connection health of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • gateway_name (String)

    The name of the P2SVpnGateway.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.


1028
1029
1030
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 1028

def begin_get_p2s_vpn_connection_health_with_http_info(resource_group_name, gateway_name, custom_headers:nil)
  begin_get_p2s_vpn_connection_health_async(resource_group_name, gateway_name, custom_headers:custom_headers).value!
end

#create_or_update(resource_group_name, gateway_name, p2svpn_gateway_parameters, custom_headers: nil) ⇒ P2SVpnGateway

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

P2SVpnGateway. create or Update a virtual wan p2s 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.

  • p2svpn_gateway_parameters (P2SVpnGateway)

    Parameters supplied to

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

    A hash of custom headers that

Returns:

  • (P2SVpnGateway)

    operation results.


135
136
137
138
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 135

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

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

P2SVpnGateway. create or Update a virtual wan p2s 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.

  • p2svpn_gateway_parameters (P2SVpnGateway)

    Parameters supplied to

  • 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/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 152

def create_or_update_async(resource_group_name, gateway_name, p2svpn_gateway_parameters, custom_headers:nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, gateway_name, p2svpn_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::V2019_11_01::Models::P2SVpnGateway.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 p2s vpn gateway.

P2SVpnGateway. 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


290
291
292
293
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 290

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

P2SVpnGateway. 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


305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 305

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

#disconnect_p2s_vpn_connections(resource_group_name, p2s_vpn_gateway_name, request, custom_headers: nil) ⇒ Object

Disconnect P2S vpn connections of the virtual wan P2SVpnGateway in the specified resource group.

disconnect p2s vpn connections. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • p2s_vpn_gateway_name (String)

    The name of the P2S Vpn Gateway.

  • request (P2SVpnConnectionRequest)

    The parameters are supplied to

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

    A hash of custom headers that


648
649
650
651
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 648

def disconnect_p2s_vpn_connections(resource_group_name, p2s_vpn_gateway_name, request, custom_headers:nil)
  response = disconnect_p2s_vpn_connections_async(resource_group_name, p2s_vpn_gateway_name, request, custom_headers:custom_headers).value!
  nil
end

#disconnect_p2s_vpn_connections_async(resource_group_name, p2s_vpn_gateway_name, request, custom_headers: nil) ⇒ Concurrent::Promise

disconnect p2s vpn connections. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • p2s_vpn_gateway_name (String)

    The name of the P2S Vpn Gateway.

  • request (P2SVpnConnectionRequest)

    The parameters are supplied to

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http


664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 664

def disconnect_p2s_vpn_connections_async(resource_group_name, p2s_vpn_gateway_name, request, custom_headers:nil)
  # Send request
  promise = begin_disconnect_p2s_vpn_connections_async(resource_group_name, p2s_vpn_gateway_name, request, 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, FinalStateVia::LOCATION)
  end

  promise
end

#generate_vpn_profile(resource_group_name, gateway_name, parameters, custom_headers: nil) ⇒ VpnProfileResponse

Generates VPN profile for P2S client of the P2SVpnGateway in the specified resource group.

generate P2SVpnGateway VPN client package operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • gateway_name (String)

    The name of the P2SVpnGateway.

  • parameters (P2SVpnProfileParameters)

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (VpnProfileResponse)

    operation results.


513
514
515
516
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 513

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

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

generate P2SVpnGateway VPN client package operation. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • gateway_name (String)

    The name of the P2SVpnGateway.

  • parameters (P2SVpnProfileParameters)

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http


529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 529

def generate_vpn_profile_async(resource_group_name, gateway_name, parameters, custom_headers:nil)
  # Send request
  promise = begin_generate_vpn_profile_async(resource_group_name, gateway_name, parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Network::Mgmt::V2019_11_01::Models::VpnProfileResponse.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

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

Retrieves the details of a virtual wan p2s vpn gateway.

P2SVpnGateway. 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:

  • (P2SVpnGateway)

    operation results.


35
36
37
38
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_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 p2s vpn gateway.

P2SVpnGateway. 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/2019-11-01/generated/azure_mgmt_network/p2s_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/p2svpnGateways/{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::V2019_11_01::Models::P2SVpnGateway.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_p2s_vpn_connection_health(resource_group_name, gateway_name, custom_headers: nil) ⇒ P2SVpnGateway

Gets the connection health of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • gateway_name (String)

    The name of the P2SVpnGateway.

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

    A hash of custom headers that

Returns:

  • (P2SVpnGateway)

    operation results.


558
559
560
561
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 558

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

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

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • gateway_name (String)

    The name of the P2SVpnGateway.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 572

def get_p2s_vpn_connection_health_async(resource_group_name, gateway_name, custom_headers:nil)
  # Send request
  promise = begin_get_p2s_vpn_connection_health_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::V2019_11_01::Models::P2SVpnGateway.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

#get_p2s_vpn_connection_health_detailed(resource_group_name, gateway_name, request, custom_headers: nil) ⇒ P2SVpnConnectionHealth

Gets the sas url to get the connection health detail of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.

get p2s vpn connections detailed health. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • gateway_name (String)

    The name of the P2SVpnGateway.

  • request (P2SVpnConnectionHealthRequest)

    Request parameters supplied to

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

    A hash of custom headers that

Returns:

  • (P2SVpnConnectionHealth)

    operation results.


603
604
605
606
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 603

def get_p2s_vpn_connection_health_detailed(resource_group_name, gateway_name, request, custom_headers:nil)
  response = get_p2s_vpn_connection_health_detailed_async(resource_group_name, gateway_name, request, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

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

get p2s vpn connections detailed health. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • gateway_name (String)

    The name of the P2SVpnGateway.

  • request (P2SVpnConnectionHealthRequest)

    Request parameters supplied to

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http


619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 619

def get_p2s_vpn_connection_health_detailed_async(resource_group_name, gateway_name, request, custom_headers:nil)
  # Send request
  promise = begin_get_p2s_vpn_connection_health_detailed_async(resource_group_name, gateway_name, request, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Network::Mgmt::V2019_11_01::Models::P2SVpnConnectionHealth.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

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

Retrieves the details of a virtual wan p2s vpn gateway.

P2SVpnGateway. 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/2019-11-01/generated/azure_mgmt_network/p2s_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<P2SVpnGateway>

Lists all the P2SVpnGateways 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<P2SVpnGateway>)

    operation results.


422
423
424
425
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 422

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) ⇒ ListP2SVpnGatewaysResult

Lists all the P2SVpnGateways 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:

  • (ListP2SVpnGatewaysResult)

    which provide lazy access to pages of the


1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 1520

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 P2SVpnGateways 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.


447
448
449
450
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
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 447

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/p2svpnGateways'

  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::V2019_11_01::Models::ListP2SVpnGatewaysResult.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<P2SVpnGateway>

Lists all the P2SVpnGateways in a resource group.

P2SVpnGateway. 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<P2SVpnGateway>)

    operation results.


331
332
333
334
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 331

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) ⇒ ListP2SVpnGatewaysResult

Lists all the P2SVpnGateways in a resource group.

P2SVpnGateway. 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:

  • (ListP2SVpnGatewaysResult)

    which provide lazy access to pages of the


1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 1500

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 P2SVpnGateways in a resource group.

P2SVpnGateway. 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.


360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 360

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/p2svpnGateways'

  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::V2019_11_01::Models::ListP2SVpnGatewaysResult.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) ⇒ ListP2SVpnGatewaysResult

Lists all the P2SVpnGateways 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:

  • (ListP2SVpnGatewaysResult)

    operation results.


1319
1320
1321
1322
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 1319

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 P2SVpnGateways 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.


1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
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
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 1348

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::V2019_11_01::Models::ListP2SVpnGatewaysResult.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 P2SVpnGateways 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.


1334
1335
1336
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 1334

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 P2SVpnGateways in a resource group.

P2SVpnGateway. 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.


346
347
348
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 346

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) ⇒ ListP2SVpnGatewaysResult

Lists all the P2SVpnGateways 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:

  • (ListP2SVpnGatewaysResult)

    operation results.


1409
1410
1411
1412
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 1409

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 P2SVpnGateways 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.


1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 1438

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::V2019_11_01::Models::ListP2SVpnGatewaysResult.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 P2SVpnGateways 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.


1424
1425
1426
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 1424

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 P2SVpnGateways 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.


435
436
437
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 435

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

#update_tags(resource_group_name, gateway_name, p2svpn_gateway_parameters, custom_headers: nil) ⇒ P2SVpnGateway

Updates virtual wan p2s vpn gateway tags.

P2SVpnGateway. virtual wan p2s 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.

  • p2svpn_gateway_parameters (TagsObject)

    Parameters supplied to update a

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

    A hash of custom headers that

Returns:

  • (P2SVpnGateway)

    operation results.


183
184
185
186
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 183

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

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

Updates virtual wan p2s vpn gateway tags.

P2SVpnGateway. virtual wan p2s 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.

  • p2svpn_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.


218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 218

def update_tags_async(resource_group_name, gateway_name, p2svpn_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, 'p2svpn_gateway_parameters is nil' if p2svpn_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::V2019_11_01::Models::TagsObject.mapper()
  request_content = @client.serialize(request_mapper,  p2svpn_gateway_parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{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 == 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::V2019_11_01::Models::P2SVpnGateway.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

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

Updates virtual wan p2s vpn gateway tags.

P2SVpnGateway. virtual wan p2s 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.

  • p2svpn_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.


201
202
203
# File 'lib/2019-11-01/generated/azure_mgmt_network/p2s_vpn_gateways.rb', line 201

def update_tags_with_http_info(resource_group_name, gateway_name, p2svpn_gateway_parameters, custom_headers:nil)
  update_tags_async(resource_group_name, gateway_name, p2svpn_gateway_parameters, custom_headers:custom_headers).value!
end