Class: Azure::Network::Mgmt::V2020_07_01::VpnConnections

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

Overview

VpnConnections

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ VpnConnections

Creates and initializes a new instance of the VpnConnections class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_connections.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-07-01/generated/azure_mgmt_network/vpn_connections.rb', line 22

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, gateway_name, connection_name, vpn_connection_parameters, custom_headers: nil) ⇒ VpnConnection

Creates a vpn connection to a scalable vpn gateway if it doesn't exist else updates the existing connection.

VpnGateway. create or Update a VPN Connection. 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.

  • connection_name (String) —

    The name of the connection.

  • vpn_connection_parameters (VpnConnection) —

    Parameters supplied to

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

    A hash of custom headers that

Returns:

  • (VpnConnection) —

    operation results.



444
445
446
447
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_connections.rb', line 444

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

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

Creates a vpn connection to a scalable vpn gateway if it doesn't exist else updates the existing connection.

VpnGateway. create or Update a VPN Connection. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • connection_name (String) —

    The name of the connection.

  • vpn_connection_parameters (VpnConnection) —

    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.



483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_connections.rb', line 483

def begin_create_or_update_async(resource_group_name, gateway_name, connection_name, vpn_connection_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, 'connection_name is nil' if connection_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'vpn_connection_parameters is nil' if vpn_connection_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_07_01::Models::VpnConnection.mapper()
  request_content = @client.serialize(request_mapper,  vpn_connection_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}/vpnConnections/{connectionName}'

  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,'connectionName' => connection_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_07_01::Models::VpnConnection.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_07_01::Models::VpnConnection.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, connection_name, vpn_connection_parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a vpn connection to a scalable vpn gateway if it doesn't exist else updates the existing connection.

VpnGateway. create or Update a VPN Connection. 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.

  • connection_name (String) —

    The name of the connection.

  • vpn_connection_parameters (VpnConnection) —

    Parameters supplied to

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



464
465
466
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_connections.rb', line 464

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

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

Deletes a vpn connection.

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.

  • connection_name (String) —

    The name of the connection.

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

    A hash of custom headers that



568
569
570
571
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_connections.rb', line 568

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

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

Deletes a vpn connection.

VpnGateway. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • connection_name (String) —

    The name of the connection.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_connections.rb', line 601

def begin_delete_async(resource_group_name, gateway_name, connection_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, 'connection_name is nil' if connection_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}/vpnConnections/{connectionName}'

  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,'connectionName' => connection_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, connection_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a vpn connection.

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.

  • connection_name (String) —

    The name of the connection.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



585
586
587
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_connections.rb', line 585

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

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

Starts packet capture on Vpn connection in the specified resource group.

packet capture parameters supplied to start packet capture on gateway connection. 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 gateway.

  • vpn_connection_name (String) —

    The name of the vpn connection.

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

    Vpn Connection

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

    A hash of custom headers that

Returns:

  • (String) —

    operation results.



661
662
663
664
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_connections.rb', line 661

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

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

Starts packet capture on Vpn connection in the specified resource group.

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • gateway_name (String) —

    The name of the gateway.

  • vpn_connection_name (String) —

    The name of the vpn connection.

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

    Vpn Connection

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
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
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_connections.rb', line 698

def begin_start_packet_capture_async(resource_group_name, gateway_name, vpn_connection_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, 'vpn_connection_name is nil' if vpn_connection_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_07_01::Models::VpnConnectionPacketCaptureStartParameters.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}/vpnConnections/{vpnConnectionName}/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,'vpnConnectionName' => vpn_connection_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 == 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 = {
          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, vpn_connection_name, parameters: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Starts packet capture on Vpn connection in the specified resource group.

packet capture parameters supplied to start packet capture on gateway connection. 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 gateway.

  • vpn_connection_name (String) —

    The name of the vpn connection.

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

    Vpn Connection

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



680
681
682
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_connections.rb', line 680

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

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

Stops packet capture on Vpn connection in the specified resource group.

packet capture parameters supplied to stop packet capture on gateway connection. 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 gateway.

  • vpn_connection_name (String) —

    The name of the vpn connection.

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

    Vpn Connection

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

    A hash of custom headers that

Returns:

  • (String) —

    operation results.



782
783
784
785
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_connections.rb', line 782

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

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

Stops packet capture on Vpn connection in the specified resource group.

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • gateway_name (String) —

    The name of the gateway.

  • vpn_connection_name (String) —

    The name of the vpn connection.

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

    Vpn Connection

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
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
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_connections.rb', line 819

def begin_stop_packet_capture_async(resource_group_name, gateway_name, vpn_connection_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, 'vpn_connection_name is nil' if vpn_connection_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_07_01::Models::VpnConnectionPacketCaptureStopParameters.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}/vpnConnections/{vpnConnectionName}/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,'vpnConnectionName' => vpn_connection_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 == 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 = {
          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, vpn_connection_name, parameters: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Stops packet capture on Vpn connection in the specified resource group.

packet capture parameters supplied to stop packet capture on gateway connection. 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 gateway.

  • vpn_connection_name (String) —

    The name of the vpn connection.

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

    Vpn Connection

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



801
802
803
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_connections.rb', line 801

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

#create_or_update(resource_group_name, gateway_name, connection_name, vpn_connection_parameters, custom_headers: nil) ⇒ VpnConnection

Creates a vpn connection to a scalable vpn gateway if it doesn't exist else updates the existing connection.

VpnGateway. create or Update a VPN Connection. 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.

  • connection_name (String) —

    The name of the connection.

  • vpn_connection_parameters (VpnConnection) —

    Parameters supplied to

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

    A hash of custom headers that

Returns:

  • (VpnConnection) —

    operation results.



140
141
142
143
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_connections.rb', line 140

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

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

VpnGateway. create or Update a VPN Connection. 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.

  • connection_name (String) —

    The name of the connection.

  • vpn_connection_parameters (VpnConnection) —

    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



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_connections.rb', line 158

def create_or_update_async(resource_group_name, gateway_name, connection_name, vpn_connection_parameters, custom_headers:nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, gateway_name, connection_name, vpn_connection_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_07_01::Models::VpnConnection.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, connection_name, custom_headers: nil) ⇒ Object

Deletes a vpn connection.

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.

  • connection_name (String) —

    The name of the connection.

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

    A hash of custom headers that



186
187
188
189
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_connections.rb', line 186

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

#delete_async(resource_group_name, gateway_name, connection_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.

  • connection_name (String) —

    The name of the connection.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



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

def delete_async(resource_group_name, gateway_name, connection_name, custom_headers:nil)
  # Send request
  promise = begin_delete_async(resource_group_name, gateway_name, connection_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, connection_name, custom_headers: nil) ⇒ VpnConnection

Retrieves the details of a vpn connection.

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.

  • connection_name (String) —

    The name of the vpn connection.

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

    A hash of custom headers that

Returns:

  • (VpnConnection) —

    operation results.



36
37
38
39
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_connections.rb', line 36

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

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

Retrieves the details of a vpn connection.

VpnGateway. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • gateway_name (String) —

    The name of the gateway.

  • connection_name (String) —

    The name of the vpn connection.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
120
121
122
123
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_connections.rb', line 69

def get_async(resource_group_name, gateway_name, connection_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, 'connection_name is nil' if connection_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}/vpnConnections/{connectionName}'

  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,'connectionName' => connection_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_07_01::Models::VpnConnection.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, connection_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieves the details of a vpn connection.

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.

  • connection_name (String) —

    The name of the vpn connection.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



53
54
55
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_connections.rb', line 53

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

#list_by_vpn_gateway(resource_group_name, gateway_name, custom_headers: nil) ⇒ Array<VpnConnection>

Retrieves all vpn connections for a particular 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:

  • (Array<VpnConnection>) —

    operation results.



343
344
345
346
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_connections.rb', line 343

def list_by_vpn_gateway(resource_group_name, gateway_name, custom_headers:nil)
  first_page = list_by_vpn_gateway_as_lazy(resource_group_name, gateway_name, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_vpn_gateway_as_lazy(resource_group_name, gateway_name, custom_headers: nil) ⇒ ListVpnConnectionsResult

Retrieves all vpn connections for a particular virtual wan vpn gateway.

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:

  • (ListVpnConnectionsResult) —

    which provide lazy access to pages of the



991
992
993
994
995
996
997
998
999
1000
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_connections.rb', line 991

def list_by_vpn_gateway_as_lazy(resource_group_name, gateway_name, custom_headers:nil)
  response = list_by_vpn_gateway_async(resource_group_name, gateway_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_vpn_gateway_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

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

Retrieves all vpn connections for a particular 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.



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
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_connections.rb', line 374

def list_by_vpn_gateway_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}/vpnConnections'

  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_07_01::Models::ListVpnConnectionsResult.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_vpn_gateway_next(next_page_link, custom_headers: nil) ⇒ ListVpnConnectionsResult

Retrieves all vpn connections for a particular virtual wan vpn gateway.

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:

  • (ListVpnConnectionsResult) —

    operation results.



899
900
901
902
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_connections.rb', line 899

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

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

Retrieves all vpn connections for a particular virtual wan vpn gateway.

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.



928
929
930
931
932
933
934
935
936
937
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
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_connections.rb', line 928

def list_by_vpn_gateway_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_07_01::Models::ListVpnConnectionsResult.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_vpn_gateway_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieves all vpn connections for a particular virtual wan vpn gateway.

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.



914
915
916
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_connections.rb', line 914

def list_by_vpn_gateway_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_vpn_gateway_next_async(next_page_link, custom_headers:custom_headers).value!
end

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

Retrieves all vpn connections for a particular 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.



359
360
361
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_connections.rb', line 359

def list_by_vpn_gateway_with_http_info(resource_group_name, gateway_name, custom_headers:nil)
  list_by_vpn_gateway_async(resource_group_name, gateway_name, custom_headers:custom_headers).value!
end

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

Starts packet capture on Vpn connection in the specified resource group.

packet capture parameters supplied to start packet capture on gateway connection. 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 gateway.

  • vpn_connection_name (String) —

    The name of the vpn connection.

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

    Vpn Connection

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

    A hash of custom headers that

Returns:

  • (String) —

    operation results.



232
233
234
235
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_connections.rb', line 232

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

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

packet capture parameters supplied to start packet capture on gateway connection. 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 gateway.

  • vpn_connection_name (String) —

    The name of the vpn connection.

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

    Vpn Connection

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_connections.rb', line 250

def start_packet_capture_async(resource_group_name, gateway_name, vpn_connection_name, parameters:nil, custom_headers:nil)
  # Send request
  promise = begin_start_packet_capture_async(resource_group_name, gateway_name, vpn_connection_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, vpn_connection_name, parameters: nil, custom_headers: nil) ⇒ String

Stops packet capture on Vpn connection in the specified resource group.

packet capture parameters supplied to stop packet capture on gateway connection. 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 gateway.

  • vpn_connection_name (String) —

    The name of the vpn connection.

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

    Vpn Connection

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

    A hash of custom headers that

Returns:

  • (String) —

    operation results.



289
290
291
292
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_connections.rb', line 289

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

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

packet capture parameters supplied to stop packet capture on gateway connection. 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 gateway.

  • vpn_connection_name (String) —

    The name of the vpn connection.

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

    Vpn Connection

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_connections.rb', line 307

def stop_packet_capture_async(resource_group_name, gateway_name, vpn_connection_name, parameters:nil, custom_headers:nil)
  # Send request
  promise = begin_stop_packet_capture_async(resource_group_name, gateway_name, vpn_connection_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