Class: Azure::Network::Mgmt::V2020_06_01::VirtualHubIpConfiguration

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

Overview

VirtualHubIpConfiguration

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ VirtualHubIpConfiguration

Creates and initializes a new instance of the VirtualHubIpConfiguration class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, virtual_hub_name, ip_config_name, parameters, custom_headers: nil) ⇒ HubIpConfiguration

Creates a VirtualHubIpConfiguration resource if it doesn't exist else updates the existing VirtualHubIpConfiguration.

VirtualHub. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • virtual_hub_name (String) —

    The name of the VirtualHub.

  • ip_config_name (String) —

    The name of the ipconfig.

  • parameters (HubIpConfiguration) —

    Hub Ip Configuration parameters.

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

    A hash of custom headers that

Returns:

  • (HubIpConfiguration) —

    operation results.



327
328
329
330
 
# File 'lib/2020-06-01/generated/azure_mgmt_network/virtual_hub_ip_configuration.rb', line 327

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

#begin_create_or_update_async(resource_group_name, virtual_hub_name, ip_config_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Creates a VirtualHubIpConfiguration resource if it doesn't exist else updates the existing VirtualHubIpConfiguration.

VirtualHub. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • virtual_hub_name (String) —

    The name of the VirtualHub.

  • ip_config_name (String) —

    The name of the ipconfig.

  • parameters (HubIpConfiguration) —

    Hub Ip Configuration parameters.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/2020-06-01/generated/azure_mgmt_network/virtual_hub_ip_configuration.rb', line 364

def begin_create_or_update_async(resource_group_name, virtual_hub_name, ip_config_name, 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, 'virtual_hub_name is nil' if virtual_hub_name.nil?
  fail ArgumentError, 'ip_config_name is nil' if ip_config_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'parameters is nil' if 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::V2020_06_01::Models::HubIpConfiguration.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/ipConfigurations/{ipConfigName}'

  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,'virtualHubName' => virtual_hub_name,'ipConfigName' => ip_config_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 MsRestAzure::AzureOperationError.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::V2020_06_01::Models::HubIpConfiguration.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::V2020_06_01::Models::HubIpConfiguration.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, virtual_hub_name, ip_config_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a VirtualHubIpConfiguration resource if it doesn't exist else updates the existing VirtualHubIpConfiguration.

VirtualHub. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • virtual_hub_name (String) —

    The name of the VirtualHub.

  • ip_config_name (String) —

    The name of the ipconfig.

  • parameters (HubIpConfiguration) —

    Hub Ip Configuration parameters.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



346
347
348
 
# File 'lib/2020-06-01/generated/azure_mgmt_network/virtual_hub_ip_configuration.rb', line 346

def begin_create_or_update_with_http_info(resource_group_name, virtual_hub_name, ip_config_name, parameters, custom_headers:nil)
  begin_create_or_update_async(resource_group_name, virtual_hub_name, ip_config_name, parameters, custom_headers:custom_headers).value!
end

#begin_delete(resource_group_name, virtual_hub_name, ip_config_name, custom_headers: nil) ⇒ Object

Deletes a VirtualHubIpConfiguration.

VirtualHubBgpConnection. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • virtual_hub_name (String) —

    The name of the VirtualHub.

  • ip_config_name (String) —

    The name of the ipconfig.

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

    A hash of custom headers that



449
450
451
452
 
# File 'lib/2020-06-01/generated/azure_mgmt_network/virtual_hub_ip_configuration.rb', line 449

def begin_delete(resource_group_name, virtual_hub_name, ip_config_name, custom_headers:nil)
  response = begin_delete_async(resource_group_name, virtual_hub_name, ip_config_name, custom_headers:custom_headers).value!
  nil
end

#begin_delete_async(resource_group_name, virtual_hub_name, ip_config_name, custom_headers: nil) ⇒ Concurrent::Promise

Deletes a VirtualHubIpConfiguration.

VirtualHubBgpConnection. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • virtual_hub_name (String) —

    The name of the VirtualHub.

  • ip_config_name (String) —

    The name of the ipconfig.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2020-06-01/generated/azure_mgmt_network/virtual_hub_ip_configuration.rb', line 482

def begin_delete_async(resource_group_name, virtual_hub_name, ip_config_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, 'virtual_hub_name is nil' if virtual_hub_name.nil?
  fail ArgumentError, 'ip_config_name is nil' if ip_config_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/virtualHubs/{virtualHubName}/ipConfigurations/{ipConfigName}'

  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,'virtualHubName' => virtual_hub_name,'ipConfigName' => ip_config_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 MsRestAzure::AzureOperationError.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, virtual_hub_name, ip_config_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a VirtualHubIpConfiguration.

VirtualHubBgpConnection. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • virtual_hub_name (String) —

    The name of the VirtualHub.

  • ip_config_name (String) —

    The name of the ipconfig.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



466
467
468
 
# File 'lib/2020-06-01/generated/azure_mgmt_network/virtual_hub_ip_configuration.rb', line 466

def begin_delete_with_http_info(resource_group_name, virtual_hub_name, ip_config_name, custom_headers:nil)
  begin_delete_async(resource_group_name, virtual_hub_name, ip_config_name, custom_headers:custom_headers).value!
end

#create_or_update(resource_group_name, virtual_hub_name, ip_config_name, parameters, custom_headers: nil) ⇒ HubIpConfiguration

Creates a VirtualHubIpConfiguration resource if it doesn't exist else updates the existing VirtualHubIpConfiguration.

VirtualHub. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • virtual_hub_name (String) —

    The name of the VirtualHub.

  • ip_config_name (String) —

    The name of the ipconfig.

  • parameters (HubIpConfiguration) —

    Hub Ip Configuration parameters.

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

    A hash of custom headers that

Returns:

  • (HubIpConfiguration) —

    operation results.



139
140
141
142
 
# File 'lib/2020-06-01/generated/azure_mgmt_network/virtual_hub_ip_configuration.rb', line 139

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

#create_or_update_async(resource_group_name, virtual_hub_name, ip_config_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

VirtualHub. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • virtual_hub_name (String) —

    The name of the VirtualHub.

  • ip_config_name (String) —

    The name of the ipconfig.

  • parameters (HubIpConfiguration) —

    Hub Ip Configuration parameters.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/2020-06-01/generated/azure_mgmt_network/virtual_hub_ip_configuration.rb', line 156

def create_or_update_async(resource_group_name, virtual_hub_name, ip_config_name, parameters, custom_headers:nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, virtual_hub_name, ip_config_name, parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Network::Mgmt::V2020_06_01::Models::HubIpConfiguration.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, virtual_hub_name, ip_config_name, custom_headers: nil) ⇒ Object

Deletes a VirtualHubIpConfiguration.

VirtualHubBgpConnection. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • virtual_hub_name (String) —

    The name of the VirtualHub.

  • ip_config_name (String) —

    The name of the ipconfig.

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

    A hash of custom headers that



184
185
186
187
 
# File 'lib/2020-06-01/generated/azure_mgmt_network/virtual_hub_ip_configuration.rb', line 184

def delete(resource_group_name, virtual_hub_name, ip_config_name, custom_headers:nil)
  response = delete_async(resource_group_name, virtual_hub_name, ip_config_name, custom_headers:custom_headers).value!
  nil
end

#delete_async(resource_group_name, virtual_hub_name, ip_config_name, custom_headers: nil) ⇒ Concurrent::Promise

VirtualHubBgpConnection. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • virtual_hub_name (String) —

    The name of the VirtualHub.

  • ip_config_name (String) —

    The name of the ipconfig.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/2020-06-01/generated/azure_mgmt_network/virtual_hub_ip_configuration.rb', line 200

def delete_async(resource_group_name, virtual_hub_name, ip_config_name, custom_headers:nil)
  # Send request
  promise = begin_delete_async(resource_group_name, virtual_hub_name, ip_config_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, virtual_hub_name, ip_config_name, custom_headers: nil) ⇒ HubIpConfiguration

Retrieves the details of a Virtual Hub Ip configuration.

VirtualHub. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • virtual_hub_name (String) —

    The name of the VirtualHub.

  • ip_config_name (String) —

    The name of the ipconfig.

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

    A hash of custom headers that

Returns:

  • (HubIpConfiguration) —

    operation results.



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

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

#get_async(resource_group_name, virtual_hub_name, ip_config_name, custom_headers: nil) ⇒ Concurrent::Promise

Retrieves the details of a Virtual Hub Ip configuration.

VirtualHub. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • virtual_hub_name (String) —

    The name of the VirtualHub.

  • ip_config_name (String) —

    The name of the ipconfig.

  • 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/2020-06-01/generated/azure_mgmt_network/virtual_hub_ip_configuration.rb', line 69

def get_async(resource_group_name, virtual_hub_name, ip_config_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, 'virtual_hub_name is nil' if virtual_hub_name.nil?
  fail ArgumentError, 'ip_config_name is nil' if ip_config_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/virtualHubs/{virtualHubName}/ipConfigurations/{ipConfigName}'

  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,'virtualHubName' => virtual_hub_name,'ipConfigName' => ip_config_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 MsRestAzure::AzureOperationError.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::V2020_06_01::Models::HubIpConfiguration.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, virtual_hub_name, ip_config_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieves the details of a Virtual Hub Ip configuration.

VirtualHub. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • virtual_hub_name (String) —

    The name of the VirtualHub.

  • ip_config_name (String) —

    The name of the ipconfig.

  • 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/2020-06-01/generated/azure_mgmt_network/virtual_hub_ip_configuration.rb', line 53

def get_with_http_info(resource_group_name, virtual_hub_name, ip_config_name, custom_headers:nil)
  get_async(resource_group_name, virtual_hub_name, ip_config_name, custom_headers:custom_headers).value!
end

#list(resource_group_name, virtual_hub_name, custom_headers: nil) ⇒ Array<HubIpConfiguration>

Retrieves the details of all VirtualHubIpConfigurations.

VirtualHub. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • virtual_hub_name (String) —

    The name of the VirtualHub.

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

    A hash of custom headers that

Returns:

  • (Array<HubIpConfiguration>) —

    operation results.



227
228
229
230
 
# File 'lib/2020-06-01/generated/azure_mgmt_network/virtual_hub_ip_configuration.rb', line 227

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

#list_as_lazy(resource_group_name, virtual_hub_name, custom_headers: nil) ⇒ ListVirtualHubIpConfigurationResults

Retrieves the details of all VirtualHubIpConfigurations.

VirtualHub. will be added to the HTTP request.

pages of the response.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • virtual_hub_name (String) —

    The name of the VirtualHub.

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

    A hash of custom headers that

Returns:

  • (ListVirtualHubIpConfigurationResults) —

    which provide lazy access to



630
631
632
633
634
635
636
637
638
639
 
# File 'lib/2020-06-01/generated/azure_mgmt_network/virtual_hub_ip_configuration.rb', line 630

def list_as_lazy(resource_group_name, virtual_hub_name, custom_headers:nil)
  response = list_async(resource_group_name, virtual_hub_name, 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(resource_group_name, virtual_hub_name, custom_headers: nil) ⇒ Concurrent::Promise

Retrieves the details of all VirtualHubIpConfigurations.

VirtualHub. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • virtual_hub_name (String) —

    The name of the VirtualHub.

  • 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
308
309
310
311
 
# File 'lib/2020-06-01/generated/azure_mgmt_network/virtual_hub_ip_configuration.rb', line 258

def list_async(resource_group_name, virtual_hub_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, 'virtual_hub_name is nil' if virtual_hub_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/virtualHubs/{virtualHubName}/ipConfigurations'

  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,'virtualHubName' => virtual_hub_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 MsRestAzure::AzureOperationError.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::V2020_06_01::Models::ListVirtualHubIpConfigurationResults.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(next_page_link, custom_headers: nil) ⇒ ListVirtualHubIpConfigurationResults

Retrieves the details of all VirtualHubIpConfigurations.

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:

  • (ListVirtualHubIpConfigurationResults) —

    operation results.



538
539
540
541
 
# File 'lib/2020-06-01/generated/azure_mgmt_network/virtual_hub_ip_configuration.rb', line 538

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

Retrieves the details of all VirtualHubIpConfigurations.

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.



567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
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
 
# File 'lib/2020-06-01/generated/azure_mgmt_network/virtual_hub_ip_configuration.rb', line 567

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 MsRestAzure::AzureOperationError.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::V2020_06_01::Models::ListVirtualHubIpConfigurationResults.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

Retrieves the details of all VirtualHubIpConfigurations.

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.



553
554
555
 
# File 'lib/2020-06-01/generated/azure_mgmt_network/virtual_hub_ip_configuration.rb', line 553

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(resource_group_name, virtual_hub_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieves the details of all VirtualHubIpConfigurations.

VirtualHub. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • virtual_hub_name (String) —

    The name of the VirtualHub.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



243
244
245
 
# File 'lib/2020-06-01/generated/azure_mgmt_network/virtual_hub_ip_configuration.rb', line 243

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