Class: Azure::Network::Mgmt::V2019_06_01::VpnSitesConfiguration

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-06-01/generated/azure_mgmt_network/vpn_sites_configuration.rb

Overview

VpnSitesConfiguration

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ VpnSitesConfiguration

Creates and initializes a new instance of the VpnSitesConfiguration class.

Parameters:

  • client

    service class for accessing basic functionality.


17
18
19
# File 'lib/2019-06-01/generated/azure_mgmt_network/vpn_sites_configuration.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#clientNetworkManagementClient (readonly)

Returns reference to the NetworkManagementClient.

Returns:


22
23
24
# File 'lib/2019-06-01/generated/azure_mgmt_network/vpn_sites_configuration.rb', line 22

def client
  @client
end

Instance Method Details

#begin_download(resource_group_name, virtual_wanname, request, custom_headers: nil) ⇒ Object

Gives the sas-url to download the configurations for vpn-sites in a resource group.

configuration of all vpn-sites is needed. download vpn-sites configuration. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The resource group name.

  • virtual_wanname (String)

    The name of the VirtualWAN for which

  • request (GetVpnSitesConfigurationRequest)

    Parameters supplied to

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

    A hash of custom headers that


82
83
84
85
# File 'lib/2019-06-01/generated/azure_mgmt_network/vpn_sites_configuration.rb', line 82

def begin_download(resource_group_name, virtual_wanname, request, custom_headers:nil)
  response = begin_download_async(resource_group_name, virtual_wanname, request, custom_headers:custom_headers).value!
  nil
end

#begin_download_async(resource_group_name, virtual_wanname, request, custom_headers: nil) ⇒ Concurrent::Promise

Gives the sas-url to download the configurations for vpn-sites in a resource group.

configuration of all vpn-sites is needed. download vpn-sites configuration. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The resource group name.

  • virtual_wanname (String)

    The name of the VirtualWAN for which

  • request (GetVpnSitesConfigurationRequest)

    Parameters supplied to

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.


119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
# File 'lib/2019-06-01/generated/azure_mgmt_network/vpn_sites_configuration.rb', line 119

def begin_download_async(resource_group_name, virtual_wanname, request, 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, 'virtual_wanname is nil' if virtual_wanname.nil?
  fail ArgumentError, 'request is nil' if request.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?

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

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/vpnConfiguration'

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

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 202
      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_download_with_http_info(resource_group_name, virtual_wanname, request, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gives the sas-url to download the configurations for vpn-sites in a resource group.

configuration of all vpn-sites is needed. download vpn-sites configuration. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The resource group name.

  • virtual_wanname (String)

    The name of the VirtualWAN for which

  • request (GetVpnSitesConfigurationRequest)

    Parameters supplied to

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.


101
102
103
# File 'lib/2019-06-01/generated/azure_mgmt_network/vpn_sites_configuration.rb', line 101

def begin_download_with_http_info(resource_group_name, virtual_wanname, request, custom_headers:nil)
  begin_download_async(resource_group_name, virtual_wanname, request, custom_headers:custom_headers).value!
end

#download(resource_group_name, virtual_wanname, request, custom_headers: nil) ⇒ Object

Gives the sas-url to download the configurations for vpn-sites in a resource group.

configuration of all vpn-sites is needed. download vpn-sites configuration. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The resource group name.

  • virtual_wanname (String)

    The name of the VirtualWAN for which

  • request (GetVpnSitesConfigurationRequest)

    Parameters supplied to

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

    A hash of custom headers that


36
37
38
39
# File 'lib/2019-06-01/generated/azure_mgmt_network/vpn_sites_configuration.rb', line 36

def download(resource_group_name, virtual_wanname, request, custom_headers:nil)
  response = download_async(resource_group_name, virtual_wanname, request, custom_headers:custom_headers).value!
  nil
end

#download_async(resource_group_name, virtual_wanname, request, custom_headers: nil) ⇒ Concurrent::Promise

configuration of all vpn-sites is needed. download vpn-sites configuration. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The resource group name.

  • virtual_wanname (String)

    The name of the VirtualWAN for which

  • request (GetVpnSitesConfigurationRequest)

    Parameters supplied to

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http


53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# File 'lib/2019-06-01/generated/azure_mgmt_network/vpn_sites_configuration.rb', line 53

def download_async(resource_group_name, virtual_wanname, request, custom_headers:nil)
  # Send request
  promise = begin_download_async(resource_group_name, virtual_wanname, request, 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, FinalStateVia::LOCATION)
  end

  promise
end