Class: Azure::Network::Mgmt::V2019_04_01::VpnSites

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-04-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/2019-04-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/2019-04-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.



441
442
443
444
 
# File 'lib/2019-04-01/generated/azure_mgmt_network/vpn_sites.rb', line 441

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.



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
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
 
# File 'lib/2019-04-01/generated/azure_mgmt_network/vpn_sites.rb', line 478

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::V2019_04_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 MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

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



460
461
462
 
# File 'lib/2019-04-01/generated/azure_mgmt_network/vpn_sites.rb', line 460

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



678
679
680
681
 
# File 'lib/2019-04-01/generated/azure_mgmt_network/vpn_sites.rb', line 678

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.



707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
 
# File 'lib/2019-04-01/generated/azure_mgmt_network/vpn_sites.rb', line 707

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 MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

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

    result
  end

  promise.execute
end

#begin_delete_with_http_info(resource_group_name, 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.



693
694
695
 
# File 'lib/2019-04-01/generated/azure_mgmt_network/vpn_sites.rb', line 693

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

#begin_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.



563
564
565
566
 
# File 'lib/2019-04-01/generated/azure_mgmt_network/vpn_sites.rb', line 563

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

#begin_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.



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
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
 
# File 'lib/2019-04-01/generated/azure_mgmt_network/vpn_sites.rb', line 596

def begin_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::V2019_04_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 || status_code == 201
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

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



580
581
582
 
# File 'lib/2019-04-01/generated/azure_mgmt_network/vpn_sites.rb', line 580

def begin_update_tags_with_http_info(resource_group_name, vpn_site_name, vpn_site_parameters, custom_headers:nil)
  begin_update_tags_async(resource_group_name, vpn_site_name, vpn_site_parameters, 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/2019-04-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/2019-04-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::V2019_04_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



221
222
223
224
 
# File 'lib/2019-04-01/generated/azure_mgmt_network/vpn_sites.rb', line 221

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



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/2019-04-01/generated/azure_mgmt_network/vpn_sites.rb', line 235

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/2019-04-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/2019-04-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 MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

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



349
350
351
352
 
# File 'lib/2019-04-01/generated/azure_mgmt_network/vpn_sites.rb', line 349

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



962
963
964
965
966
967
968
969
970
971
 
# File 'lib/2019-04-01/generated/azure_mgmt_network/vpn_sites.rb', line 962

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.



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

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 MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

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



260
261
262
263
 
# File 'lib/2019-04-01/generated/azure_mgmt_network/vpn_sites.rb', line 260

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



942
943
944
945
946
947
948
949
950
951
 
# File 'lib/2019-04-01/generated/azure_mgmt_network/vpn_sites.rb', line 942

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.



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/2019-04-01/generated/azure_mgmt_network/vpn_sites.rb', line 287

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 MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

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



762
763
764
765
 
# File 'lib/2019-04-01/generated/azure_mgmt_network/vpn_sites.rb', line 762

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.



791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
 
# File 'lib/2019-04-01/generated/azure_mgmt_network/vpn_sites.rb', line 791

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


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

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

  request_url = @base_url || @client.base_url

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

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

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



777
778
779
 
# File 'lib/2019-04-01/generated/azure_mgmt_network/vpn_sites.rb', line 777

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.



274
275
276
 
# File 'lib/2019-04-01/generated/azure_mgmt_network/vpn_sites.rb', line 274

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.



852
853
854
855
 
# File 'lib/2019-04-01/generated/azure_mgmt_network/vpn_sites.rb', line 852

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.



881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'lib/2019-04-01/generated/azure_mgmt_network/vpn_sites.rb', line 881

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


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

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

  request_url = @base_url || @client.base_url

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

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

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



867
868
869
 
# File 'lib/2019-04-01/generated/azure_mgmt_network/vpn_sites.rb', line 867

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.



362
363
364
 
# File 'lib/2019-04-01/generated/azure_mgmt_network/vpn_sites.rb', line 362

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/2019-04-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

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

  • (Concurrent::Promise) —

    promise which provides async access to http



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/2019-04-01/generated/azure_mgmt_network/vpn_sites.rb', line 195

def update_tags_async(resource_group_name, vpn_site_name, vpn_site_parameters, custom_headers:nil)
  # Send request
  promise = begin_update_tags_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::V2019_04_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