Class: Azure::Network::Mgmt::V2020_04_01::VpnServerConfigurations

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

Overview

VpnServerConfigurations

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ VpnServerConfigurations

Creates and initializes a new instance of the VpnServerConfigurations class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, vpn_server_configuration_name, vpn_server_configuration_parameters, custom_headers: nil) ⇒ VpnServerConfiguration

Creates a VpnServerConfiguration resource if it doesn't exist else updates the existing VpnServerConfiguration.

VpnServerConfiguration. VpnServerConfiguration being created or updated. Parameters supplied to create or update VpnServerConfiguration. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • vpn_server_configuration_name (String) —

    The name of the

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

    A hash of custom headers that

Returns:

  • (VpnServerConfiguration) —

    operation results.



525
526
527
528
 
# File 'lib/2020-04-01/generated/azure_mgmt_network/vpn_server_configurations.rb', line 525

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

#begin_create_or_update_async(resource_group_name, vpn_server_configuration_name, vpn_server_configuration_parameters, custom_headers: nil) ⇒ Concurrent::Promise

Creates a VpnServerConfiguration resource if it doesn't exist else updates the existing VpnServerConfiguration.

VpnServerConfiguration. VpnServerConfiguration being created or updated. Parameters supplied to create or update VpnServerConfiguration. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • vpn_server_configuration_name (String) —

    The name of the

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
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
 
# File 'lib/2020-04-01/generated/azure_mgmt_network/vpn_server_configurations.rb', line 564

def begin_create_or_update_async(resource_group_name, vpn_server_configuration_name, vpn_server_configuration_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, 'vpn_server_configuration_name is nil' if vpn_server_configuration_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'vpn_server_configuration_parameters is nil' if vpn_server_configuration_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_04_01::Models::VpnServerConfiguration.mapper()
  request_content = @client.serialize(request_mapper,  vpn_server_configuration_parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}'

  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,'vpnServerConfigurationName' => vpn_server_configuration_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_04_01::Models::VpnServerConfiguration.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_04_01::Models::VpnServerConfiguration.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, vpn_server_configuration_name, vpn_server_configuration_parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a VpnServerConfiguration resource if it doesn't exist else updates the existing VpnServerConfiguration.

VpnServerConfiguration. VpnServerConfiguration being created or updated. Parameters supplied to create or update VpnServerConfiguration. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • vpn_server_configuration_name (String) —

    The name of the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



545
546
547
 
# File 'lib/2020-04-01/generated/azure_mgmt_network/vpn_server_configurations.rb', line 545

def begin_create_or_update_with_http_info(resource_group_name, vpn_server_configuration_name, vpn_server_configuration_parameters, custom_headers:nil)
  begin_create_or_update_async(resource_group_name, vpn_server_configuration_name, vpn_server_configuration_parameters, custom_headers:custom_headers).value!
end

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

Deletes a VpnServerConfiguration.

VpnServerConfiguration. VpnServerConfiguration being deleted. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • vpn_server_configuration_name (String) —

    The name of the

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

    A hash of custom headers that



648
649
650
651
 
# File 'lib/2020-04-01/generated/azure_mgmt_network/vpn_server_configurations.rb', line 648

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

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

Deletes a VpnServerConfiguration.

VpnServerConfiguration. VpnServerConfiguration being deleted. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • vpn_server_configuration_name (String) —

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



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
 
# File 'lib/2020-04-01/generated/azure_mgmt_network/vpn_server_configurations.rb', line 681

def begin_delete_async(resource_group_name, vpn_server_configuration_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, 'vpn_server_configuration_name is nil' if vpn_server_configuration_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/vpnServerConfigurations/{vpnServerConfigurationName}'

  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,'vpnServerConfigurationName' => vpn_server_configuration_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, vpn_server_configuration_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a VpnServerConfiguration.

VpnServerConfiguration. VpnServerConfiguration being deleted. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • vpn_server_configuration_name (String) —

    The name of the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



665
666
667
 
# File 'lib/2020-04-01/generated/azure_mgmt_network/vpn_server_configurations.rb', line 665

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

#create_or_update(resource_group_name, vpn_server_configuration_name, vpn_server_configuration_parameters, custom_headers: nil) ⇒ VpnServerConfiguration

Creates a VpnServerConfiguration resource if it doesn't exist else updates the existing VpnServerConfiguration.

VpnServerConfiguration. VpnServerConfiguration being created or updated. Parameters supplied to create or update VpnServerConfiguration. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • vpn_server_configuration_name (String) —

    The name of the

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

    A hash of custom headers that

Returns:

  • (VpnServerConfiguration) —

    operation results.



139
140
141
142
 
# File 'lib/2020-04-01/generated/azure_mgmt_network/vpn_server_configurations.rb', line 139

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

#create_or_update_async(resource_group_name, vpn_server_configuration_name, vpn_server_configuration_parameters, custom_headers: nil) ⇒ Concurrent::Promise

VpnServerConfiguration. VpnServerConfiguration being created or updated. Parameters supplied to create or update VpnServerConfiguration. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • vpn_server_configuration_name (String) —

    The name of the

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



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

def create_or_update_async(resource_group_name, vpn_server_configuration_name, vpn_server_configuration_parameters, custom_headers:nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, vpn_server_configuration_name, vpn_server_configuration_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_04_01::Models::VpnServerConfiguration.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, vpn_server_configuration_name, custom_headers: nil) ⇒ Object

Deletes a VpnServerConfiguration.

VpnServerConfiguration. VpnServerConfiguration being deleted. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • vpn_server_configuration_name (String) —

    The name of the

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

    A hash of custom headers that



299
300
301
302
 
# File 'lib/2020-04-01/generated/azure_mgmt_network/vpn_server_configurations.rb', line 299

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

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

VpnServerConfiguration. VpnServerConfiguration being deleted. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • vpn_server_configuration_name (String) —

    The name of the

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/2020-04-01/generated/azure_mgmt_network/vpn_server_configurations.rb', line 315

def delete_async(resource_group_name, vpn_server_configuration_name, custom_headers:nil)
  # Send request
  promise = begin_delete_async(resource_group_name, vpn_server_configuration_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, vpn_server_configuration_name, custom_headers: nil) ⇒ VpnServerConfiguration

Retrieves the details of a VpnServerConfiguration.

VpnServerConfiguration. VpnServerConfiguration being retrieved. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • vpn_server_configuration_name (String) —

    The name of the

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

    A hash of custom headers that

Returns:

  • (VpnServerConfiguration) —

    operation results.



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

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

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

Retrieves the details of a VpnServerConfiguration.

VpnServerConfiguration. VpnServerConfiguration being retrieved. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • vpn_server_configuration_name (String) —

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



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
 
# File 'lib/2020-04-01/generated/azure_mgmt_network/vpn_server_configurations.rb', line 69

def get_async(resource_group_name, vpn_server_configuration_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, 'vpn_server_configuration_name is nil' if vpn_server_configuration_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/vpnServerConfigurations/{vpnServerConfigurationName}'

  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,'vpnServerConfigurationName' => vpn_server_configuration_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_04_01::Models::VpnServerConfiguration.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, vpn_server_configuration_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieves the details of a VpnServerConfiguration.

VpnServerConfiguration. VpnServerConfiguration being retrieved. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • vpn_server_configuration_name (String) —

    The name of the

  • 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-04-01/generated/azure_mgmt_network/vpn_server_configurations.rb', line 53

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

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

Lists all the VpnServerConfigurations 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<VpnServerConfiguration>) —

    operation results.



432
433
434
435
 
# File 'lib/2020-04-01/generated/azure_mgmt_network/vpn_server_configurations.rb', line 432

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

Lists all the VpnServerConfigurations in a subscription.

will be added to the HTTP request.

pages of the response.

Parameters:

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

    A hash of custom headers that

Returns:

  • (ListVpnServerConfigurationsResult) —

    which provide lazy access to



937
938
939
940
941
942
943
944
945
946
 
# File 'lib/2020-04-01/generated/azure_mgmt_network/vpn_server_configurations.rb', line 937

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



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

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

  request_url = @base_url || @client.base_url

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

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2020_04_01::Models::ListVpnServerConfigurationsResult.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<VpnServerConfiguration>

Lists all the vpnServerConfigurations in a resource group.

VpnServerConfiguration. 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<VpnServerConfiguration>) —

    operation results.



341
342
343
344
 
# File 'lib/2020-04-01/generated/azure_mgmt_network/vpn_server_configurations.rb', line 341

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

Lists all the vpnServerConfigurations in a resource group.

VpnServerConfiguration. will be added to the HTTP request.

pages of the 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:

  • (ListVpnServerConfigurationsResult) —

    which provide lazy access to



917
918
919
920
921
922
923
924
925
926
 
# File 'lib/2020-04-01/generated/azure_mgmt_network/vpn_server_configurations.rb', line 917

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

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



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/2020-04-01/generated/azure_mgmt_network/vpn_server_configurations.rb', line 370

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

  request_url = @base_url || @client.base_url

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

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2020_04_01::Models::ListVpnServerConfigurationsResult.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) ⇒ ListVpnServerConfigurationsResult

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

  • (ListVpnServerConfigurationsResult) —

    operation results.



736
737
738
739
 
# File 'lib/2020-04-01/generated/azure_mgmt_network/vpn_server_configurations.rb', line 736

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



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

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


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

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

  request_url = @base_url || @client.base_url

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

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2020_04_01::Models::ListVpnServerConfigurationsResult.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 vpnServerConfigurations 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.



751
752
753
 
# File 'lib/2020-04-01/generated/azure_mgmt_network/vpn_server_configurations.rb', line 751

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

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



356
357
358
 
# File 'lib/2020-04-01/generated/azure_mgmt_network/vpn_server_configurations.rb', line 356

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

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

  • (ListVpnServerConfigurationsResult) —

    operation results.



826
827
828
829
 
# File 'lib/2020-04-01/generated/azure_mgmt_network/vpn_server_configurations.rb', line 826

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



855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
 
# File 'lib/2020-04-01/generated/azure_mgmt_network/vpn_server_configurations.rb', line 855

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


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

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

  request_url = @base_url || @client.base_url

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

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2020_04_01::Models::ListVpnServerConfigurationsResult.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 VpnServerConfigurations 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.



841
842
843
 
# File 'lib/2020-04-01/generated/azure_mgmt_network/vpn_server_configurations.rb', line 841

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



445
446
447
 
# File 'lib/2020-04-01/generated/azure_mgmt_network/vpn_server_configurations.rb', line 445

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

#update_tags(resource_group_name, vpn_server_configuration_name, vpn_server_configuration_parameters, custom_headers: nil) ⇒ VpnServerConfiguration

Updates VpnServerConfiguration tags.

VpnServerConfiguration. VpnServerConfiguration being updated. to update VpnServerConfiguration tags. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • vpn_server_configuration_name (String) —

    The name of the

  • vpn_server_configuration_parameters (TagsObject) —

    Parameters supplied

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

    A hash of custom headers that

Returns:

  • (VpnServerConfiguration) —

    operation results.



189
190
191
192
 
# File 'lib/2020-04-01/generated/azure_mgmt_network/vpn_server_configurations.rb', line 189

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

#update_tags_async(resource_group_name, vpn_server_configuration_name, vpn_server_configuration_parameters, custom_headers: nil) ⇒ Concurrent::Promise

Updates VpnServerConfiguration tags.

VpnServerConfiguration. VpnServerConfiguration being updated. to update VpnServerConfiguration tags. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • vpn_server_configuration_name (String) —

    The name of the

  • vpn_server_configuration_parameters (TagsObject) —

    Parameters supplied

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/2020-04-01/generated/azure_mgmt_network/vpn_server_configurations.rb', line 226

def update_tags_async(resource_group_name, vpn_server_configuration_name, vpn_server_configuration_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, 'vpn_server_configuration_name is nil' if vpn_server_configuration_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'vpn_server_configuration_parameters is nil' if vpn_server_configuration_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_04_01::Models::TagsObject.mapper()
  request_content = @client.serialize(request_mapper,  vpn_server_configuration_parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}'

  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,'vpnServerConfigurationName' => vpn_server_configuration_name},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:patch, path_template, options)

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

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

    result
  end

  promise.execute
end

#update_tags_with_http_info(resource_group_name, vpn_server_configuration_name, vpn_server_configuration_parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Updates VpnServerConfiguration tags.

VpnServerConfiguration. VpnServerConfiguration being updated. to update VpnServerConfiguration tags. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • vpn_server_configuration_name (String) —

    The name of the

  • vpn_server_configuration_parameters (TagsObject) —

    Parameters supplied

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



208
209
210
 
# File 'lib/2020-04-01/generated/azure_mgmt_network/vpn_server_configurations.rb', line 208

def update_tags_with_http_info(resource_group_name, vpn_server_configuration_name, vpn_server_configuration_parameters, custom_headers:nil)
  update_tags_async(resource_group_name, vpn_server_configuration_name, vpn_server_configuration_parameters, custom_headers:custom_headers).value!
end