Class: Azure::ARM::Network::LocalNetworkGateways

Inherits:
Object
  • Object
show all
Includes:
Models, MsRestAzure
Defined in:
lib/azure_mgmt_network/local_network_gateways.rb

Overview

LocalNetworkGateways

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ LocalNetworkGateways

Creates and initializes a new instance of the LocalNetworkGateways class.

Parameters:

  • client —

    service class for accessing basic functionality.



18
19
20
 
# File 'lib/azure_mgmt_network/local_network_gateways.rb', line 18

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns reference to the NetworkResourceProviderClient.

Returns:

  • reference to the NetworkResourceProviderClient



23
24
25
 
# File 'lib/azure_mgmt_network/local_network_gateways.rb', line 23

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, local_network_gateway_name, parameters, custom_headers = nil) ⇒ Concurrent::Promise

The Put LocalNetworkGateway operation creates/updates a local network gateway in the specified resource group through Network resource provider. gateway. Create or update Local Network Gateway operation through Network resource provider. applied to HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • local_network_gateway_name (String) —

    The name of the local network

  • parameters (LocalNetworkGateway) —

    Parameters supplied to the Begin

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

    hash of custom headers need to be

Returns:

  • (Concurrent::Promise) —

    Promise object which allows to get HTTP



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
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
171
172
173
174
175
176
177
178
 
# File 'lib/azure_mgmt_network/local_network_gateways.rb', line 78

def begin_create_or_update(resource_group_name, local_network_gateway_name, parameters, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'local_network_gateway_name is nil' if local_network_gateway_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  parameters.validate unless parameters.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  # Construct URL
  path = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways/{localNetworkGatewayName}"
  path['{resourceGroupName}'] = ERB::Util.url_encode(resource_group_name) if path.include?('{resourceGroupName}')
  path['{localNetworkGatewayName}'] = ERB::Util.url_encode(local_network_gateway_name) if path.include?('{localNetworkGatewayName}')
  path['{subscriptionId}'] = ERB::Util.url_encode(@client.subscription_id) if path.include?('{subscriptionId}')
  url = URI.join(@client.base_url, path)
  properties = {}
  properties['api-version'] = ERB::Util.url_encode(@client.api_version.to_s) unless @client.api_version.nil?
  unless url.query.nil?
    url.query.split('&').each do |url_item|
      url_items_parts = url_item.split('=')
      properties[url_items_parts[0]] = url_items_parts[1]
    end
  end
  properties.reject!{ |key, value| value.nil? }
  url.query = properties.map{ |key, value| "#{key}=#{value}" }.compact.join('&')
  fail URI::Error unless url.to_s =~ /\A#{URI::regexp}\z/
  corrected_url = url.to_s.gsub(/([^:])\/\//, '\1/')
  url = URI.parse(corrected_url)

  connection = Faraday.new(:url => url) do |faraday|
    faraday.use MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02
    faraday.use :cookie_jar
    faraday.adapter Faraday.default_adapter
  end
  request_headers = Hash.new

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

  unless custom_headers.nil?
    custom_headers.each do |key, value|
      request_headers[key] = value
    end
  end

  # Serialize Request
  request_headers['Content-Type'] = 'application/json'
  unless parameters.nil?
    parameters = LocalNetworkGateway.serialize_object(parameters)
  end
  request_content = JSON.generate(parameters, quirks_mode: true)

  # Send Request
  promise = Concurrent::Promise.new do
    connection.put do |request|
      request.headers = request_headers
      request.body = request_content
      @client.credentials.sign_request(request) unless @client.credentials.nil?
    end
  end

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

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(connection, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = JSON.load(response_content) unless response_content.to_s.empty?
        unless parsed_response.nil?
          parsed_response = LocalNetworkGateway.deserialize_object(parsed_response)
        end
        result.body = parsed_response
      rescue Exception => e
        fail MsRest::DeserializationError.new("Error occured in deserializing the response", e.message, e.backtrace, response_content)
      end
    end
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = JSON.load(response_content) unless response_content.to_s.empty?
        unless parsed_response.nil?
          parsed_response = LocalNetworkGateway.deserialize_object(parsed_response)
        end
        result.body = parsed_response
      rescue Exception => e
        fail MsRest::DeserializationError.new("Error occured in deserializing the response", e.message, e.backtrace, response_content)
      end
    end

    result
  end

  promise.execute
end

#begin_delete(resource_group_name, local_network_gateway_name, custom_headers = nil) ⇒ Concurrent::Promise

The Delete LocalNetworkGateway operation deletes the specifed local network Gateway through Network resource provider. gateway. applied to HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • local_network_gateway_name (String) —

    The name of the local network

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

    hash of custom headers need to be

Returns:

  • (Concurrent::Promise) —

    Promise object which allows to get HTTP



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
340
341
342
343
344
345
346
347
348
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
 
# File 'lib/azure_mgmt_network/local_network_gateways.rb', line 309

def begin_delete(resource_group_name, local_network_gateway_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'local_network_gateway_name is nil' if local_network_gateway_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  # Construct URL
  path = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways/{localNetworkGatewayName}/"
  path['{resourceGroupName}'] = ERB::Util.url_encode(resource_group_name) if path.include?('{resourceGroupName}')
  path['{localNetworkGatewayName}'] = ERB::Util.url_encode(local_network_gateway_name) if path.include?('{localNetworkGatewayName}')
  path['{subscriptionId}'] = ERB::Util.url_encode(@client.subscription_id) if path.include?('{subscriptionId}')
  url = URI.join(@client.base_url, path)
  properties = {}
  properties['api-version'] = ERB::Util.url_encode(@client.api_version.to_s) unless @client.api_version.nil?
  unless url.query.nil?
    url.query.split('&').each do |url_item|
      url_items_parts = url_item.split('=')
      properties[url_items_parts[0]] = url_items_parts[1]
    end
  end
  properties.reject!{ |key, value| value.nil? }
  url.query = properties.map{ |key, value| "#{key}=#{value}" }.compact.join('&')
  fail URI::Error unless url.to_s =~ /\A#{URI::regexp}\z/
  corrected_url = url.to_s.gsub(/([^:])\/\//, '\1/')
  url = URI.parse(corrected_url)

  connection = Faraday.new(:url => url) do |faraday|
    faraday.use MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02
    faraday.use :cookie_jar
    faraday.adapter Faraday.default_adapter
  end
  request_headers = Hash.new

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

  unless custom_headers.nil?
    custom_headers.each do |key, value|
      request_headers[key] = value
    end
  end

  # Send Request
  promise = Concurrent::Promise.new do
    connection.delete do |request|
      request.headers = request_headers
      @client.credentials.sign_request(request) unless @client.credentials.nil?
    end
  end

  promise = promise.then do |http_response|
    status_code = http_response.status
    response_content = http_response.body
    unless (status_code == 202 || status_code == 204 || status_code == 200)
      fail MsRestAzure::AzureOperationError.new(connection, http_response)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(connection, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?

    result
  end

  promise.execute
end

#create_or_update(resource_group_name, local_network_gateway_name, parameters, custom_headers = nil) ⇒ Concurrent::Promise

The Put LocalNetworkGateway operation creates/updates a local network gateway in the specified resource group through Network resource provider. gateway. Create or update Local Network Gateway operation through Network resource provider. uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. for the response.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • local_network_gateway_name (String) —

    The name of the local network

  • parameters (LocalNetworkGateway) —

    Parameters supplied to the Begin

  • @client.api_version (String) —

    Client Api Version.

  • @client.subscription_id (String) —

    Gets subscription credentials which

  • @client.accept_language (String) —

    Gets or sets the preferred language

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/azure_mgmt_network/local_network_gateways.rb', line 44

def create_or_update(resource_group_name, local_network_gateway_name, parameters, custom_headers = nil)
  # Send request
  promise = begin_create_or_update(resource_group_name, local_network_gateway_name, parameters, custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      unless parsed_response.nil?
        parsed_response = LocalNetworkGateway.deserialize_object(parsed_response)
      end
    end

    # Waiting for response.
    @client.get_put_operation_result(response, custom_headers, deserialize_method)
  end

  promise
end

#delete(resource_group_name, local_network_gateway_name, custom_headers = nil) ⇒ Concurrent::Promise

The Delete LocalNetworkGateway operation deletes the specifed local network Gateway through Network resource provider. gateway. response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • local_network_gateway_name (String) —

    The name of the local network

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/azure_mgmt_network/local_network_gateways.rb', line 281

def delete(resource_group_name, local_network_gateway_name, custom_headers = nil)
  # Send request
  promise = begin_delete(resource_group_name, local_network_gateway_name, custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

   # Waiting for response.
   @client.get_post_or_delete_operation_result(response, nil, deserialize_method)
  end

  promise
end

#get(resource_group_name, local_network_gateway_name, custom_headers = nil) ⇒ Concurrent::Promise

The Get LocalNetworkGateway operation retrieves information about the specified local network gateway through Network resource provider. gateway. applied to HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • local_network_gateway_name (String) —

    The name of the local network

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

    hash of custom headers need to be

Returns:

  • (Concurrent::Promise) —

    Promise object which allows to get HTTP



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
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
 
# File 'lib/azure_mgmt_network/local_network_gateways.rb', line 192

def get(resource_group_name, local_network_gateway_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'local_network_gateway_name is nil' if local_network_gateway_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  # Construct URL
  path = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways/{localNetworkGatewayName}"
  path['{resourceGroupName}'] = ERB::Util.url_encode(resource_group_name) if path.include?('{resourceGroupName}')
  path['{localNetworkGatewayName}'] = ERB::Util.url_encode(local_network_gateway_name) if path.include?('{localNetworkGatewayName}')
  path['{subscriptionId}'] = ERB::Util.url_encode(@client.subscription_id) if path.include?('{subscriptionId}')
  url = URI.join(@client.base_url, path)
  properties = {}
  properties['api-version'] = ERB::Util.url_encode(@client.api_version.to_s) unless @client.api_version.nil?
  unless url.query.nil?
    url.query.split('&').each do |url_item|
      url_items_parts = url_item.split('=')
      properties[url_items_parts[0]] = url_items_parts[1]
    end
  end
  properties.reject!{ |key, value| value.nil? }
  url.query = properties.map{ |key, value| "#{key}=#{value}" }.compact.join('&')
  fail URI::Error unless url.to_s =~ /\A#{URI::regexp}\z/
  corrected_url = url.to_s.gsub(/([^:])\/\//, '\1/')
  url = URI.parse(corrected_url)

  connection = Faraday.new(:url => url) do |faraday|
    faraday.use MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02
    faraday.use :cookie_jar
    faraday.adapter Faraday.default_adapter
  end
  request_headers = Hash.new

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

  unless custom_headers.nil?
    custom_headers.each do |key, value|
      request_headers[key] = value
    end
  end

  # Send Request
  promise = Concurrent::Promise.new do
    connection.get do |request|
      request.headers = request_headers
      @client.credentials.sign_request(request) unless @client.credentials.nil?
    end
  end

  promise = promise.then do |http_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(connection, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(connection, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = JSON.load(response_content) unless response_content.to_s.empty?
        unless parsed_response.nil?
          parsed_response = LocalNetworkGateway.deserialize_object(parsed_response)
        end
        result.body = parsed_response
      rescue Exception => e
        fail MsRest::DeserializationError.new("Error occured in deserializing the response", e.message, e.backtrace, response_content)
      end
    end

    result
  end

  promise.execute
end

#list(resource_group_name, custom_headers = nil) ⇒ Concurrent::Promise

The List LocalNetworkGateways opertion retrieves all the local network gateways stored. applied to HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

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

    hash of custom headers need to be

Returns:

  • (Concurrent::Promise) —

    Promise object which allows to get HTTP



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
426
427
428
429
430
431
432
433
434
435
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
 
# File 'lib/azure_mgmt_network/local_network_gateways.rb', line 386

def list(resource_group_name, custom_headers = 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?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  # Construct URL
  path = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways"
  path['{resourceGroupName}'] = ERB::Util.url_encode(resource_group_name) if path.include?('{resourceGroupName}')
  path['{subscriptionId}'] = ERB::Util.url_encode(@client.subscription_id) if path.include?('{subscriptionId}')
  url = URI.join(@client.base_url, path)
  properties = {}
  properties['api-version'] = ERB::Util.url_encode(@client.api_version.to_s) unless @client.api_version.nil?
  unless url.query.nil?
    url.query.split('&').each do |url_item|
      url_items_parts = url_item.split('=')
      properties[url_items_parts[0]] = url_items_parts[1]
    end
  end
  properties.reject!{ |key, value| value.nil? }
  url.query = properties.map{ |key, value| "#{key}=#{value}" }.compact.join('&')
  fail URI::Error unless url.to_s =~ /\A#{URI::regexp}\z/
  corrected_url = url.to_s.gsub(/([^:])\/\//, '\1/')
  url = URI.parse(corrected_url)

  connection = Faraday.new(:url => url) do |faraday|
    faraday.use MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02
    faraday.use :cookie_jar
    faraday.adapter Faraday.default_adapter
  end
  request_headers = Hash.new

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

  unless custom_headers.nil?
    custom_headers.each do |key, value|
      request_headers[key] = value
    end
  end

  # Send Request
  promise = Concurrent::Promise.new do
    connection.get do |request|
      request.headers = request_headers
      @client.credentials.sign_request(request) unless @client.credentials.nil?
    end
  end

  promise = promise.then do |http_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(connection, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(connection, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = JSON.load(response_content) unless response_content.to_s.empty?
        unless parsed_response.nil?
          parsed_response = LocalNetworkGatewayListResult.deserialize_object(parsed_response)
        end
        result.body = parsed_response
      rescue Exception => e
        fail MsRest::DeserializationError.new("Error occured in deserializing the response", e.message, e.backtrace, response_content)
      end
    end

    result
  end

  promise.execute
end

#list_next(next_page_link, custom_headers = nil) ⇒ Concurrent::Promise

The List LocalNetworkGateways opertion retrieves all the local network gateways stored. call to List operation. applied to HTTP request.

response.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful

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

    hash of custom headers need to be

Returns:

  • (Concurrent::Promise) —

    Promise object which allows to get HTTP



475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
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
 
# File 'lib/azure_mgmt_network/local_network_gateways.rb', line 475

def list_next(next_page_link, custom_headers = nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.nil?
  # Construct URL
  path = "{nextLink}"
  path['{nextLink}'] = next_page_link if path.include?('{nextLink}')
  url = URI.parse(path)
  properties = {}
  unless url.query.nil?
    url.query.split('&').each do |url_item|
      url_items_parts = url_item.split('=')
      properties[url_items_parts[0]] = url_items_parts[1]
    end
  end
  properties.reject!{ |key, value| value.nil? }
  url.query = properties.map{ |key, value| "#{key}=#{value}" }.compact.join('&')
  fail URI::Error unless url.to_s =~ /\A#{URI::regexp}\z/
  corrected_url = url.to_s.gsub(/([^:])\/\//, '\1/')
  url = URI.parse(corrected_url)

  connection = Faraday.new(:url => url) do |faraday|
    faraday.use MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02
    faraday.use :cookie_jar
    faraday.adapter Faraday.default_adapter
  end
  request_headers = Hash.new

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

  unless custom_headers.nil?
    custom_headers.each do |key, value|
      request_headers[key] = value
    end
  end

  # Send Request
  promise = Concurrent::Promise.new do
    connection.get do |request|
      request.headers = request_headers
      @client.credentials.sign_request(request) unless @client.credentials.nil?
    end
  end

  promise = promise.then do |http_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(connection, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(connection, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = JSON.load(response_content) unless response_content.to_s.empty?
        unless parsed_response.nil?
          parsed_response = LocalNetworkGatewayListResult.deserialize_object(parsed_response)
        end
        result.body = parsed_response
      rescue Exception => e
        fail MsRest::DeserializationError.new("Error occured in deserializing the response", e.message, e.backtrace, response_content)
      end
    end

    result
  end

  promise.execute
end