Class: Azure::Network::Mgmt::V2018_08_01::VpnGateways

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

Overview

VpnGateways

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ VpnGateways

Creates and initializes a new instance of the VpnGateways class.

Parameters:

  • client

    service class for accessing basic functionality.


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

def client
  @client
end

Instance Method Details

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

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

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

Parameters:

  • resource_group_name (String)

    The resource group name of the

  • gateway_name (String)

    The name of the gateway.

  • vpn_gateway_parameters (VpnGateway)

    Parameters supplied to create or

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

    A hash of custom headers that

Returns:

  • (VpnGateway)

    operation results.


451
452
453
454
# File 'lib/2018-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 451

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

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

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

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

Parameters:

  • resource_group_name (String)

    The resource group name of the

  • gateway_name (String)

    The name of the gateway.

  • vpn_gateway_parameters (VpnGateway)

    Parameters supplied to create or

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.


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
556
557
558
559
# File 'lib/2018-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 488

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


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

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

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

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

  request_url = @base_url || @client.base_url

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

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 201
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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::V2018_08_01::Models::VpnGateway.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2018_08_01::Models::VpnGateway.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

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

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

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

Parameters:

  • resource_group_name (String)

    The resource group name of the

  • gateway_name (String)

    The name of the gateway.

  • vpn_gateway_parameters (VpnGateway)

    Parameters supplied to create or

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.


470
471
472
# File 'lib/2018-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 470

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

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

Deletes a virtual wan vpn gateway.

VpnGateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The resource group name of the

  • gateway_name (String)

    The name of the gateway.

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

    A hash of custom headers that


692
693
694
695
# File 'lib/2018-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 692

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

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

Deletes a virtual wan vpn gateway.

VpnGateway. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The resource group name of the

  • gateway_name (String)

    The name of the gateway.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.


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/2018-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 723

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


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

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

  request_url = @base_url || @client.base_url

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

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

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

    result
  end

  promise.execute
end

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

Deletes a virtual wan vpn gateway.

VpnGateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The resource group name of the

  • gateway_name (String)

    The name of the gateway.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.


708
709
710
# File 'lib/2018-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 708

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_update_tags(resource_group_name, gateway_name, vpn_gateway_parameters, custom_headers: nil) ⇒ VpnGateway

Updates virtual wan vpn gateway tags.

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

Parameters:

  • resource_group_name (String)

    The resource group name of the

  • gateway_name (String)

    The name of the gateway.

  • vpn_gateway_parameters (TagsObject)

    Parameters supplied to update a

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

    A hash of custom headers that

Returns:

  • (VpnGateway)

    operation results.


574
575
576
577
# File 'lib/2018-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 574

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

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

Updates virtual wan vpn gateway tags.

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

Parameters:

  • resource_group_name (String)

    The resource group name of the

  • gateway_name (String)

    The name of the gateway.

  • vpn_gateway_parameters (TagsObject)

    Parameters supplied to update a

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.


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
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
# File 'lib/2018-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 609

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


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

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

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

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

  request_url = @base_url || @client.base_url

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

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 201
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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::V2018_08_01::Models::VpnGateway.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2018_08_01::Models::VpnGateway.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

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

Updates virtual wan vpn gateway tags.

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

Parameters:

  • resource_group_name (String)

    The resource group name of the

  • gateway_name (String)

    The name of the gateway.

  • vpn_gateway_parameters (TagsObject)

    Parameters supplied to update a

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.


592
593
594
# File 'lib/2018-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 592

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

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

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

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

Parameters:

  • resource_group_name (String)

    The resource group name of the

  • gateway_name (String)

    The name of the gateway.

  • vpn_gateway_parameters (VpnGateway)

    Parameters supplied to create or

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

    A hash of custom headers that

Returns:

  • (VpnGateway)

    operation results.


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

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

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

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

response.

Parameters:

  • resource_group_name (String)

    The resource group name of the

  • gateway_name (String)

    The name of the gateway.

  • vpn_gateway_parameters (VpnGateway)

    Parameters supplied to create or

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http


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

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

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

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

  promise
end

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

Deletes a virtual wan vpn gateway.

VpnGateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The resource group name of the

  • gateway_name (String)

    The name of the gateway.

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

    A hash of custom headers that


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

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

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

VpnGateway. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The resource group name of the

  • gateway_name (String)

    The name of the gateway.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http


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

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

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

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

  promise
end

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

Retrieves the details of a virtual wan vpn gateway.

VpnGateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The resource group name of the

  • gateway_name (String)

    The name of the gateway.

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

    A hash of custom headers that

Returns:

  • (VpnGateway)

    operation results.


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

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

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

Retrieves the details of a virtual wan vpn gateway.

VpnGateway. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The resource group name of the

  • gateway_name (String)

    The name of the gateway.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.


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

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


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

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

  request_url = @base_url || @client.base_url

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

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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::V2018_08_01::Models::VpnGateway.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

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

Retrieves the details of a virtual wan vpn gateway.

VpnGateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The resource group name of the

  • gateway_name (String)

    The name of the gateway.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.


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

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

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

Lists all the VpnGateways in a subscription.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (Array<VpnGateway>)

    operation results.


359
360
361
362
# File 'lib/2018-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 359

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

#list_as_lazy(custom_headers: nil) ⇒ ListVpnGatewaysResult

Lists all the VpnGateways in a subscription.

will be added to the HTTP request.

response.

Parameters:

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

    A hash of custom headers that

Returns:

  • (ListVpnGatewaysResult)

    which provide lazy access to pages of the


979
980
981
982
983
984
985
986
987
988
# File 'lib/2018-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 979

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

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

Lists all the VpnGateways in a subscription.

to the HTTP request.

Parameters:

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.


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
428
429
430
431
432
433
434
435
# File 'lib/2018-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 384

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


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

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

  request_url = @base_url || @client.base_url

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

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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::V2018_08_01::Models::ListVpnGatewaysResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

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

Lists all the VpnGateways in a resource group.

VpnGateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The resource group name of the

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

    A hash of custom headers that

Returns:

  • (Array<VpnGateway>)

    operation results.


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

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

#list_by_resource_group_as_lazy(resource_group_name, custom_headers: nil) ⇒ ListVpnGatewaysResult

Lists all the VpnGateways in a resource group.

VpnGateway. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The resource group name of the

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

    A hash of custom headers that

Returns:

  • (ListVpnGatewaysResult)

    which provide lazy access to pages of the


959
960
961
962
963
964
965
966
967
968
# File 'lib/2018-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 959

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

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

Lists all the VpnGateways in a resource group.

VpnGateway. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The resource group name of the

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.


297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
# File 'lib/2018-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 297

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


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

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

  request_url = @base_url || @client.base_url

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

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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::V2018_08_01::Models::ListVpnGatewaysResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_by_resource_group_next(next_page_link, custom_headers: nil) ⇒ ListVpnGatewaysResult

Lists all the VpnGateways in a resource group.

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

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (ListVpnGatewaysResult)

    operation results.


778
779
780
781
# File 'lib/2018-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 778

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

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

Lists all the VpnGateways in a resource group.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.


807
808
809
810
811
812
813
814
815
816
817
818
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
# File 'lib/2018-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 807

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 MsRest::HttpOperationError.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::V2018_08_01::Models::ListVpnGatewaysResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

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

Lists all the VpnGateways in a resource group.

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

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.


793
794
795
# File 'lib/2018-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 793

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

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

Lists all the VpnGateways in a resource group.

VpnGateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The resource group name of the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.


283
284
285
# File 'lib/2018-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 283

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

#list_next(next_page_link, custom_headers: nil) ⇒ ListVpnGatewaysResult

Lists all the VpnGateways in a subscription.

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

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (ListVpnGatewaysResult)

    operation results.


868
869
870
871
# File 'lib/2018-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 868

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

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

Lists all the VpnGateways in a subscription.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.


897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
# File 'lib/2018-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 897

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 MsRest::HttpOperationError.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::V2018_08_01::Models::ListVpnGatewaysResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

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

Lists all the VpnGateways in a subscription.

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

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.


883
884
885
# File 'lib/2018-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 883

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

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

Lists all the VpnGateways in a subscription.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.


372
373
374
# File 'lib/2018-08-01/generated/azure_mgmt_network/vpn_gateways.rb', line 372

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

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

Updates virtual wan vpn gateway tags.

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

Parameters:

  • resource_group_name (String)

    The resource group name of the

  • gateway_name (String)

    The name of the gateway.

  • vpn_gateway_parameters (TagsObject)

    Parameters supplied to update a

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

    A hash of custom headers that

Returns:

  • (VpnGateway)

    operation results.


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

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

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

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

response.

Parameters:

  • resource_group_name (String)

    The resource group name of the

  • gateway_name (String)

    The name of the gateway.

  • vpn_gateway_parameters (TagsObject)

    Parameters supplied to update a

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http


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

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

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

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

  promise
end