Class: Azure::ARM::Network::PublicIPAddresses

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

Overview

The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resrources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ PublicIPAddresses

Creates and initializes a new instance of the PublicIPAddresses class.

Parameters:

  • client

    service class for accessing basic functionality.



21
22
23
# File 'lib/generated/azure_mgmt_network/public_ipaddresses.rb', line 21

def initialize(client)
  @client = client
end

Instance Attribute Details

#clientNetworkManagementClient (readonly)

Returns reference to the NetworkManagementClient.

Returns:



26
27
28
# File 'lib/generated/azure_mgmt_network/public_ipaddresses.rb', line 26

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, public_ip_address_name, parameters, custom_headers = nil) ⇒ PublicIPAddress

The Put PublicIPAddress operation creates/updates a stable/dynamic PublicIP address

PublicIPAddress operation will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • public_ip_address_name (String)

    The name of the publicIpAddress.

  • parameters (PublicIPAddress)

    Parameters supplied to the create/update

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

    A hash of custom headers that

Returns:



309
310
311
312
# File 'lib/generated/azure_mgmt_network/public_ipaddresses.rb', line 309

def begin_create_or_update(resource_group_name, public_ip_address_name, parameters, custom_headers = nil)
  response = begin_create_or_update_async(resource_group_name, public_ip_address_name, parameters, custom_headers).value!
  response.body unless response.nil?
end

#begin_create_or_update_async(resource_group_name, public_ip_address_name, parameters, custom_headers = nil) ⇒ Concurrent::Promise

The Put PublicIPAddress operation creates/updates a stable/dynamic PublicIP address

PublicIPAddress operation to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • public_ip_address_name (String)

    The name of the publicIpAddress.

  • parameters (PublicIPAddress)

    Parameters supplied to the create/update

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
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
# File 'lib/generated/azure_mgmt_network/public_ipaddresses.rb', line 344

def begin_create_or_update_async(resource_group_name, public_ip_address_name, parameters, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'public_ip_address_name is nil' if public_ip_address_name.nil?
  fail ArgumentError, 'parameters is nil' if 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?


  request_headers = {}

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

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

  # Serialize Request
  request_mapper = PublicIPAddress.mapper()
  request_content = @client.serialize(request_mapper,  parameters, 'parameters')
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'publicIpAddressName' => public_ip_address_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :put, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, 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 = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = PublicIPAddress.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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 == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = PublicIPAddress.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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, public_ip_address_name, parameters, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

The Put PublicIPAddress operation creates/updates a stable/dynamic PublicIP address

PublicIPAddress operation will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • public_ip_address_name (String)

    The name of the publicIpAddress.

  • parameters (PublicIPAddress)

    Parameters supplied to the create/update

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



327
328
329
# File 'lib/generated/azure_mgmt_network/public_ipaddresses.rb', line 327

def begin_create_or_update_with_http_info(resource_group_name, public_ip_address_name, parameters, custom_headers = nil)
  begin_create_or_update_async(resource_group_name, public_ip_address_name, parameters, custom_headers).value!
end

#begin_delete(resource_group_name, public_ip_address_name, custom_headers = nil) ⇒ Object

The delete publicIpAddress operation deletes the specified publicIpAddress.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • public_ip_address_name (String)

    The name of the subnet.

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

    A hash of custom headers that



75
76
77
78
# File 'lib/generated/azure_mgmt_network/public_ipaddresses.rb', line 75

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

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

The delete publicIpAddress operation deletes the specified publicIpAddress.

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • public_ip_address_name (String)

    The name of the subnet.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
# File 'lib/generated/azure_mgmt_network/public_ipaddresses.rb', line 104

def begin_delete_async(resource_group_name, public_ip_address_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'public_ip_address_name is nil' if public_ip_address_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?


  request_headers = {}

  # 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/publicIPAddresses/{publicIpAddressName}'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'publicIpAddressName' => public_ip_address_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :delete, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

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

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

    result
  end

  promise.execute
end

#begin_delete_with_http_info(resource_group_name, public_ip_address_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

The delete publicIpAddress operation deletes the specified publicIpAddress.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • public_ip_address_name (String)

    The name of the subnet.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



90
91
92
# File 'lib/generated/azure_mgmt_network/public_ipaddresses.rb', line 90

def begin_delete_with_http_info(resource_group_name, public_ip_address_name, custom_headers = nil)
  begin_delete_async(resource_group_name, public_ip_address_name, custom_headers).value!
end

#create_or_update(resource_group_name, public_ip_address_name, parameters, custom_headers = nil) ⇒ PublicIPAddress

The Put PublicIPAddress operation creates/updates a stable/dynamic PublicIP address

PublicIPAddress operation will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • public_ip_address_name (String)

    The name of the publicIpAddress.

  • parameters (PublicIPAddress)

    Parameters supplied to the create/update

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

    A hash of custom headers that

Returns:



262
263
264
265
# File 'lib/generated/azure_mgmt_network/public_ipaddresses.rb', line 262

def create_or_update(resource_group_name, public_ip_address_name, parameters, custom_headers = nil)
  response = create_or_update_async(resource_group_name, public_ip_address_name, parameters, custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(resource_group_name, public_ip_address_name, parameters, custom_headers = nil) ⇒ Concurrent::Promise

PublicIPAddress operation will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • public_ip_address_name (String)

    The name of the publicIpAddress.

  • parameters (PublicIPAddress)

    Parameters supplied to the create/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



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
# File 'lib/generated/azure_mgmt_network/public_ipaddresses.rb', line 278

def create_or_update_async(resource_group_name, public_ip_address_name, parameters, custom_headers = nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, public_ip_address_name, parameters, custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = PublicIPAddress.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response, 'parsed_response')
    end

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

  promise
end

#delete(resource_group_name, public_ip_address_name, custom_headers = nil) ⇒ Object

The delete publicIpAddress operation deletes the specified publicIpAddress.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • public_ip_address_name (String)

    The name of the subnet.

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

    A hash of custom headers that



36
37
38
39
# File 'lib/generated/azure_mgmt_network/public_ipaddresses.rb', line 36

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

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

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • public_ip_address_name (String)

    The name of the subnet.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# File 'lib/generated/azure_mgmt_network/public_ipaddresses.rb', line 50

def delete_async(resource_group_name, public_ip_address_name, custom_headers = nil)
  # Send request
  promise = begin_delete_async(resource_group_name, public_ip_address_name, 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, public_ip_address_name, expand = nil, custom_headers = nil) ⇒ PublicIPAddress

The Get publicIpAddress operation retreives information about the specified pubicIpAddress

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • public_ip_address_name (String)

    The name of the subnet.

  • expand (String) (defaults to: nil)

    expand references resources.

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

    A hash of custom headers that

Returns:



161
162
163
164
# File 'lib/generated/azure_mgmt_network/public_ipaddresses.rb', line 161

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

#get_async(resource_group_name, public_ip_address_name, expand = nil, custom_headers = nil) ⇒ Concurrent::Promise

The Get publicIpAddress operation retreives information about the specified pubicIpAddress

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • public_ip_address_name (String)

    The name of the subnet.

  • expand (String) (defaults to: nil)

    expand references resources.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
# File 'lib/generated/azure_mgmt_network/public_ipaddresses.rb', line 194

def get_async(resource_group_name, public_ip_address_name, expand = nil, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'public_ip_address_name is nil' if public_ip_address_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?


  request_headers = {}

  # 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/publicIPAddresses/{publicIpAddressName}'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'publicIpAddressName' => public_ip_address_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version,'$expand' => expand},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, 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 = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = PublicIPAddress.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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, public_ip_address_name, expand = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

The Get publicIpAddress operation retreives information about the specified pubicIpAddress

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • public_ip_address_name (String)

    The name of the subnet.

  • expand (String) (defaults to: nil)

    expand references resources.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



178
179
180
# File 'lib/generated/azure_mgmt_network/public_ipaddresses.rb', line 178

def get_with_http_info(resource_group_name, public_ip_address_name, expand = nil, custom_headers = nil)
  get_async(resource_group_name, public_ip_address_name, expand, custom_headers).value!
end

#list(resource_group_name, custom_headers = nil) ⇒ Array<PublicIPAddress>

The List publicIpAddress operation retrieves all the publicIpAddresses in a resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

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

    A hash of custom headers that

Returns:



561
562
563
564
# File 'lib/generated/azure_mgmt_network/public_ipaddresses.rb', line 561

def list(resource_group_name, custom_headers = nil)
  first_page = list_as_lazy(resource_group_name, custom_headers)
  first_page.get_all_items
end

#list_all(custom_headers = nil) ⇒ Array<PublicIPAddress>

The List publicIpAddress operation retrieves all the publicIpAddresses 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:



449
450
451
452
# File 'lib/generated/azure_mgmt_network/public_ipaddresses.rb', line 449

def list_all(custom_headers = nil)
  first_page = list_all_as_lazy(custom_headers)
  first_page.get_all_items
end

#list_all_as_lazy(custom_headers = nil) ⇒ PublicIPAddressListResult

The List publicIpAddress operation retrieves all the publicIpAddresses in a subscription.

will be added to the HTTP request.

the response.

Parameters:

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

    A hash of custom headers that

Returns:



429
430
431
432
433
434
435
436
437
438
# File 'lib/generated/azure_mgmt_network/public_ipaddresses.rb', line 429

def list_all_as_lazy(custom_headers = nil)
  response = list_all_async(custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_link|
      list_all_next_async(next_link, custom_headers)
    end
    page
  end
end

#list_all_async(custom_headers = nil) ⇒ Concurrent::Promise

The List publicIpAddress operation retrieves all the publicIpAddresses 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.



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
# File 'lib/generated/azure_mgmt_network/public_ipaddresses.rb', line 476

def list_all_async(custom_headers = 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?


  request_headers = {}

  # 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/publicIPAddresses'
  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 || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, 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 = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = PublicIPAddressListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_all_next(next_page_link, custom_headers = nil) ⇒ PublicIPAddressListResult

The List publicIpAddress operation retrieves all the publicIpAddresses in a subscription.

call to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful

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

    A hash of custom headers that

Returns:



655
656
657
658
# File 'lib/generated/azure_mgmt_network/public_ipaddresses.rb', line 655

def list_all_next(next_page_link, custom_headers = nil)
  response = list_all_next_async(next_page_link, custom_headers).value!
  response.body unless response.nil?
end

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

The List publicIpAddress operation retrieves all the publicIpAddresses in a subscription.

call to List operation. to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
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
# File 'lib/generated/azure_mgmt_network/public_ipaddresses.rb', line 686

def list_all_next_async(next_page_link, custom_headers = nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.nil?


  request_headers = {}

  # 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}'
  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 || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, 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 = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = PublicIPAddressListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_all_next_with_http_info(next_page_link, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

The List publicIpAddress operation retrieves all the publicIpAddresses in a subscription.

call to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



671
672
673
# File 'lib/generated/azure_mgmt_network/public_ipaddresses.rb', line 671

def list_all_next_with_http_info(next_page_link, custom_headers = nil)
  list_all_next_async(next_page_link, custom_headers).value!
end

#list_all_with_http_info(custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

The List publicIpAddress operation retrieves all the publicIpAddresses 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.



463
464
465
# File 'lib/generated/azure_mgmt_network/public_ipaddresses.rb', line 463

def list_all_with_http_info(custom_headers = nil)
  list_all_async(custom_headers).value!
end

#list_as_lazy(resource_group_name, custom_headers = nil) ⇒ PublicIPAddressListResult

The List publicIpAddress operation retrieves all the publicIpAddresses in a resource group.

will be added to the HTTP request.

the response.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

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

    A hash of custom headers that

Returns:



540
541
542
543
544
545
546
547
548
549
# File 'lib/generated/azure_mgmt_network/public_ipaddresses.rb', line 540

def list_as_lazy(resource_group_name, custom_headers = nil)
  response = list_async(resource_group_name, custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_link|
      list_next_async(next_link, custom_headers)
    end
    page
  end
end

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

The List publicIpAddress operation retrieves all the publicIpAddresses in a resource group.

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



590
591
592
593
594
595
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
# File 'lib/generated/azure_mgmt_network/public_ipaddresses.rb', line 590

def list_async(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?


  request_headers = {}

  # 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/publicIPAddresses'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, 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 = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = PublicIPAddressListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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(next_page_link, custom_headers = nil) ⇒ PublicIPAddressListResult

The List publicIpAddress operation retrieves all the publicIpAddresses in a resource group.

call to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful

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

    A hash of custom headers that

Returns:



748
749
750
751
# File 'lib/generated/azure_mgmt_network/public_ipaddresses.rb', line 748

def list_next(next_page_link, custom_headers = nil)
  response = list_next_async(next_page_link, custom_headers).value!
  response.body unless response.nil?
end

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

The List publicIpAddress operation retrieves all the publicIpAddresses in a resource group.

call to List operation. to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



779
780
781
782
783
784
785
786
787
788
789
790
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
# File 'lib/generated/azure_mgmt_network/public_ipaddresses.rb', line 779

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


  request_headers = {}

  # 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}'
  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 || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, 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 = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = PublicIPAddressListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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

The List publicIpAddress operation retrieves all the publicIpAddresses in a resource group.

call to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



764
765
766
# File 'lib/generated/azure_mgmt_network/public_ipaddresses.rb', line 764

def list_next_with_http_info(next_page_link, custom_headers = nil)
  list_next_async(next_page_link, custom_headers).value!
end

#list_with_http_info(resource_group_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

The List publicIpAddress operation retrieves all the publicIpAddresses in a resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



576
577
578
# File 'lib/generated/azure_mgmt_network/public_ipaddresses.rb', line 576

def list_with_http_info(resource_group_name, custom_headers = nil)
  list_async(resource_group_name, custom_headers).value!
end