Class: Azure::Network::Mgmt::V2020_07_01::VpnSites

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

Overview

VpnSites

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ VpnSites

Creates and initializes a new instance of the VpnSites class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ NetworkManagementClient (readonly)

Returns reference to the NetworkManagementClient.

Returns:



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

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, vpn_site_name, vpn_site_parameters, custom_headers: nil) ⇒ VpnSite

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

updated. VpnSite. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the VpnSite.

  • vpn_site_name (String) —

    The name of the VpnSite being created or

  • vpn_site_parameters (VpnSite) —

    Parameters supplied to create or update

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

    A hash of custom headers that

Returns:

  • (VpnSite) —

    operation results.



503
504
505
506
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_sites.rb', line 503

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

#begin_create_or_update_async(resource_group_name, vpn_site_name, vpn_site_parameters, custom_headers: nil) ⇒ Concurrent::Promise

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

updated. VpnSite. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the VpnSite.

  • vpn_site_name (String) —

    The name of the VpnSite being created or

  • vpn_site_parameters (VpnSite) —

    Parameters supplied to create or update

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_sites.rb', line 540

def begin_create_or_update_async(resource_group_name, vpn_site_name, vpn_site_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_site_name is nil' if vpn_site_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'vpn_site_parameters is nil' if vpn_site_parameters.nil?


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

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

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

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}'

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

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

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

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

updated. VpnSite. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the VpnSite.

  • vpn_site_name (String) —

    The name of the VpnSite being created or

  • vpn_site_parameters (VpnSite) —

    Parameters supplied to create or update

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



522
523
524
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_sites.rb', line 522

def begin_create_or_update_with_http_info(resource_group_name, vpn_site_name, vpn_site_parameters, custom_headers:nil)
  begin_create_or_update_async(resource_group_name, vpn_site_name, vpn_site_parameters, custom_headers:custom_headers).value!
end

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

Deletes a VpnSite.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the VpnSite.

  • vpn_site_name (String) —

    The name of the VpnSite being deleted.

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

    A hash of custom headers that



622
623
624
625
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_sites.rb', line 622

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

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

Deletes a VpnSite.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the VpnSite.

  • vpn_site_name (String) —

    The name of the VpnSite being deleted.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_sites.rb', line 651

def begin_delete_async(resource_group_name, vpn_site_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_site_name is nil' if vpn_site_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/vpnSites/{vpnSiteName}'

  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,'vpnSiteName' => vpn_site_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_site_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a VpnSite.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the VpnSite.

  • vpn_site_name (String) —

    The name of the VpnSite being deleted.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



637
638
639
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_sites.rb', line 637

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

#create_or_update(resource_group_name, vpn_site_name, vpn_site_parameters, custom_headers: nil) ⇒ VpnSite

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

updated. VpnSite. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the VpnSite.

  • vpn_site_name (String) —

    The name of the VpnSite being created or

  • vpn_site_parameters (VpnSite) —

    Parameters supplied to create or update

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

    A hash of custom headers that

Returns:

  • (VpnSite) —

    operation results.



132
133
134
135
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_sites.rb', line 132

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

#create_or_update_async(resource_group_name, vpn_site_name, vpn_site_parameters, custom_headers: nil) ⇒ Concurrent::Promise

updated. VpnSite. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The resource group name of the VpnSite.

  • vpn_site_name (String) —

    The name of the VpnSite being created or

  • vpn_site_parameters (VpnSite) —

    Parameters supplied to create or update

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_sites.rb', line 149

def create_or_update_async(resource_group_name, vpn_site_name, vpn_site_parameters, custom_headers:nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, vpn_site_name, vpn_site_parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Network::Mgmt::V2020_07_01::Models::VpnSite.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_site_name, custom_headers: nil) ⇒ Object

Deletes a VpnSite.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the VpnSite.

  • vpn_site_name (String) —

    The name of the VpnSite being deleted.

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

    A hash of custom headers that



283
284
285
286
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_sites.rb', line 283

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

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

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The resource group name of the VpnSite.

  • vpn_site_name (String) —

    The name of the VpnSite being deleted.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_sites.rb', line 297

def delete_async(resource_group_name, vpn_site_name, custom_headers:nil)
  # Send request
  promise = begin_delete_async(resource_group_name, vpn_site_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_site_name, custom_headers: nil) ⇒ VpnSite

Retrieves the details of a VPN site.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the VpnSite.

  • vpn_site_name (String) —

    The name of the VpnSite being retrieved.

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

    A hash of custom headers that

Returns:

  • (VpnSite) —

    operation results.



34
35
36
37
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_sites.rb', line 34

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

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

Retrieves the details of a VPN site.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the VpnSite.

  • vpn_site_name (String) —

    The name of the VpnSite being retrieved.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



63
64
65
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
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_sites.rb', line 63

def get_async(resource_group_name, vpn_site_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_site_name is nil' if vpn_site_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/vpnSites/{vpnSiteName}'

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

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

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

Retrieves the details of a VPN site.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the VpnSite.

  • vpn_site_name (String) —

    The name of the VpnSite being retrieved.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



49
50
51
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_sites.rb', line 49

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

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

Lists all the VpnSites 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<VpnSite>) —

    operation results.



411
412
413
414
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_sites.rb', line 411

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

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

  • (ListVpnSitesResult) —

    which provide lazy access to pages of the



906
907
908
909
910
911
912
913
914
915
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_sites.rb', line 906

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



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_sites.rb', line 436

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

  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_07_01::Models::ListVpnSitesResult.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<VpnSite>

Lists all the vpnSites in a resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the VpnSite.

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

    A hash of custom headers that

Returns:

  • (Array<VpnSite>) —

    operation results.



322
323
324
325
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_sites.rb', line 322

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

Lists all the vpnSites in a resource group.

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The resource group name of the VpnSite.

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

    A hash of custom headers that

Returns:

  • (ListVpnSitesResult) —

    which provide lazy access to pages of the



886
887
888
889
890
891
892
893
894
895
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_sites.rb', line 886

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

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the VpnSite.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_sites.rb', line 349

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

  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_07_01::Models::ListVpnSitesResult.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) ⇒ ListVpnSitesResult

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

  • (ListVpnSitesResult) —

    operation results.



706
707
708
709
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_sites.rb', line 706

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



735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_sites.rb', line 735

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_07_01::Models::ListVpnSitesResult.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 vpnSites 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.



721
722
723
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_sites.rb', line 721

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

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the VpnSite.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



336
337
338
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_sites.rb', line 336

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

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

  • (ListVpnSitesResult) —

    operation results.



796
797
798
799
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_sites.rb', line 796

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



825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_sites.rb', line 825

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_07_01::Models::ListVpnSitesResult.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 VpnSites 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.



811
812
813
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_sites.rb', line 811

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



424
425
426
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_sites.rb', line 424

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

#update_tags(resource_group_name, vpn_site_name, vpn_site_parameters, custom_headers: nil) ⇒ VpnSite

Updates VpnSite tags.

tags. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the VpnSite.

  • vpn_site_name (String) —

    The name of the VpnSite being updated.

  • vpn_site_parameters (TagsObject) —

    Parameters supplied to update VpnSite

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

    A hash of custom headers that

Returns:

  • (VpnSite) —

    operation results.



179
180
181
182
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_sites.rb', line 179

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

#update_tags_async(resource_group_name, vpn_site_name, vpn_site_parameters, custom_headers: nil) ⇒ Concurrent::Promise

Updates VpnSite tags.

tags. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the VpnSite.

  • vpn_site_name (String) —

    The name of the VpnSite being updated.

  • vpn_site_parameters (TagsObject) —

    Parameters supplied to update VpnSite

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_sites.rb', line 212

def update_tags_async(resource_group_name, vpn_site_name, vpn_site_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_site_name is nil' if vpn_site_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'vpn_site_parameters is nil' if vpn_site_parameters.nil?


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

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

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

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}'

  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,'vpnSiteName' => vpn_site_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_07_01::Models::VpnSite.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_site_name, vpn_site_parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Updates VpnSite tags.

tags. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the VpnSite.

  • vpn_site_name (String) —

    The name of the VpnSite being updated.

  • vpn_site_parameters (TagsObject) —

    Parameters supplied to update VpnSite

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



196
197
198
 
# File 'lib/2020-07-01/generated/azure_mgmt_network/vpn_sites.rb', line 196

def update_tags_with_http_info(resource_group_name, vpn_site_name, vpn_site_parameters, custom_headers:nil)
  update_tags_async(resource_group_name, vpn_site_name, vpn_site_parameters, custom_headers:custom_headers).value!
end