Class: Azure::Network::Mgmt::V2019_07_01::VpnSiteLinks

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

Overview

VpnSiteLinks

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ VpnSiteLinks

Creates and initializes a new instance of the VpnSiteLinks class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def client
  @client
end

Instance Method Details

#get(resource_group_name, vpn_site_name, vpn_site_link_name, custom_headers: nil) ⇒ VpnSiteLink

Retrieves the details of a VPN site link.

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

  • vpn_site_link_name (String) —

    The name of the VpnSiteLink being

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

    A hash of custom headers that

Returns:

  • (VpnSiteLink) —

    operation results.



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

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

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

Retrieves the details of a VPN site link.

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

  • vpn_site_link_name (String) —

    The name of the VpnSiteLink being

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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

def get_async(resource_group_name, vpn_site_name, vpn_site_link_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, 'vpn_site_link_name is nil' if vpn_site_link_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}/vpnSiteLinks/{vpnSiteLinkName}'

  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,'vpnSiteLinkName' => vpn_site_link_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_07_01::Models::VpnSiteLink.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, vpn_site_link_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieves the details of a VPN site link.

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

  • vpn_site_link_name (String) —

    The name of the VpnSiteLink being

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



53
54
55
 
# File 'lib/2019-07-01/generated/azure_mgmt_network/vpn_site_links.rb', line 53

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

#list_by_vpn_site(resource_group_name, vpn_site_name, custom_headers: nil) ⇒ Array<VpnSiteLink>

Lists all the vpnSiteLinks in a resource group for 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.

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

    A hash of custom headers that

Returns:

  • (Array<VpnSiteLink>) —

    operation results.



135
136
137
138
 
# File 'lib/2019-07-01/generated/azure_mgmt_network/vpn_site_links.rb', line 135

def list_by_vpn_site(resource_group_name, vpn_site_name, custom_headers:nil)
  first_page = list_by_vpn_site_as_lazy(resource_group_name, vpn_site_name, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_vpn_site_as_lazy(resource_group_name, vpn_site_name, custom_headers: nil) ⇒ ListVpnSiteLinksResult

Lists all the vpnSiteLinks in a resource group for a vpn site.

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.

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

    A hash of custom headers that

Returns:

  • (ListVpnSiteLinksResult) —

    which provide lazy access to pages of the



320
321
322
323
324
325
326
327
328
329
 
# File 'lib/2019-07-01/generated/azure_mgmt_network/vpn_site_links.rb', line 320

def list_by_vpn_site_as_lazy(resource_group_name, vpn_site_name, custom_headers:nil)
  response = list_by_vpn_site_async(resource_group_name, vpn_site_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_vpn_site_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

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

Lists all the vpnSiteLinks in a resource group for 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.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/2019-07-01/generated/azure_mgmt_network/vpn_site_links.rb', line 164

def list_by_vpn_site_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}/vpnSiteLinks'

  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_07_01::Models::ListVpnSiteLinksResult.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_vpn_site_next(next_page_link, custom_headers: nil) ⇒ ListVpnSiteLinksResult

Lists all the vpnSiteLinks in a resource group for a vpn site.

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:

  • (ListVpnSiteLinksResult) —

    operation results.



229
230
231
232
 
# File 'lib/2019-07-01/generated/azure_mgmt_network/vpn_site_links.rb', line 229

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

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

Lists all the vpnSiteLinks in a resource group for a vpn site.

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.



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/2019-07-01/generated/azure_mgmt_network/vpn_site_links.rb', line 258

def list_by_vpn_site_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_07_01::Models::ListVpnSiteLinksResult.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_vpn_site_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all the vpnSiteLinks in a resource group for a vpn site.

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.



244
245
246
 
# File 'lib/2019-07-01/generated/azure_mgmt_network/vpn_site_links.rb', line 244

def list_by_vpn_site_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_vpn_site_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_vpn_site_with_http_info(resource_group_name, vpn_site_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all the vpnSiteLinks in a resource group for 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.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



150
151
152
 
# File 'lib/2019-07-01/generated/azure_mgmt_network/vpn_site_links.rb', line 150

def list_by_vpn_site_with_http_info(resource_group_name, vpn_site_name, custom_headers:nil)
  list_by_vpn_site_async(resource_group_name, vpn_site_name, custom_headers:custom_headers).value!
end