Class: Azure::Network::Mgmt::V2018_01_01::NetworkInterfaceIPConfigurations

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-01-01/generated/azure_mgmt_network/network_interface_ipconfigurations.rb

Overview

Network Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ NetworkInterfaceIPConfigurations

Creates and initializes a new instance of the NetworkInterfaceIPConfigurations class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def client
  @client
end

Instance Method Details

#get(resource_group_name, network_interface_name, ip_configuration_name, custom_headers: nil) ⇒ NetworkInterfaceIPConfiguration

Gets the specified network interface ip configuration.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_interface_name (String) —

    The name of the network interface.

  • ip_configuration_name (String) —

    The name of the ip configuration name.

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

    A hash of custom headers that

Returns:

  • (NetworkInterfaceIPConfiguration) —

    operation results.



129
130
131
132
 
# File 'lib/2018-01-01/generated/azure_mgmt_network/network_interface_ipconfigurations.rb', line 129

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

#get_async(resource_group_name, network_interface_name, ip_configuration_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets the specified network interface ip configuration.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_interface_name (String) —

    The name of the network interface.

  • ip_configuration_name (String) —

    The name of the ip configuration name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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

def get_async(resource_group_name, network_interface_name, ip_configuration_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'network_interface_name is nil' if network_interface_name.nil?
  fail ArgumentError, 'ip_configuration_name is nil' if ip_configuration_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 = {}
  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/networkInterfaces/{networkInterfaceName}/ipConfigurations/{ipConfigurationName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'networkInterfaceName' => network_interface_name,'ipConfigurationName' => ip_configuration_name,'subscriptionId' => @client.subscription_id},
      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::V2018_01_01::Models::NetworkInterfaceIPConfiguration.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, network_interface_name, ip_configuration_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the specified network interface ip configuration.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_interface_name (String) —

    The name of the network interface.

  • ip_configuration_name (String) —

    The name of the ip configuration name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



145
146
147
 
# File 'lib/2018-01-01/generated/azure_mgmt_network/network_interface_ipconfigurations.rb', line 145

def get_with_http_info(resource_group_name, network_interface_name, ip_configuration_name, custom_headers:nil)
  get_async(resource_group_name, network_interface_name, ip_configuration_name, custom_headers:custom_headers).value!
end

#list(resource_group_name, network_interface_name, custom_headers: nil) ⇒ Array<NetworkInterfaceIPConfiguration>

Get all ip configurations in a network interface

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_interface_name (String) —

    The name of the network interface.

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

    A hash of custom headers that

Returns:

  • (Array<NetworkInterfaceIPConfiguration>) —

    operation results.



34
35
36
37
 
# File 'lib/2018-01-01/generated/azure_mgmt_network/network_interface_ipconfigurations.rb', line 34

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

#list_as_lazy(resource_group_name, network_interface_name, custom_headers: nil) ⇒ NetworkInterfaceIPConfigurationListResult

Get all ip configurations in a network interface

will be added to the HTTP request.

to pages of the response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_interface_name (String) —

    The name of the network interface.

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

    A hash of custom headers that

Returns:

  • (NetworkInterfaceIPConfigurationListResult) —

    which provide lazy access



317
318
319
320
321
322
323
324
325
326
 
# File 'lib/2018-01-01/generated/azure_mgmt_network/network_interface_ipconfigurations.rb', line 317

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

Get all ip configurations in a network interface

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_interface_name (String) —

    The name of the network interface.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



63
64
65
66
67
68
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
 
# File 'lib/2018-01-01/generated/azure_mgmt_network/network_interface_ipconfigurations.rb', line 63

def list_async(resource_group_name, network_interface_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'network_interface_name is nil' if network_interface_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 = {}
  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/networkInterfaces/{networkInterfaceName}/ipConfigurations'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'networkInterfaceName' => network_interface_name,'subscriptionId' => @client.subscription_id},
      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::V2018_01_01::Models::NetworkInterfaceIPConfigurationListResult.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) ⇒ NetworkInterfaceIPConfigurationListResult

Get all ip configurations in a network interface

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:

  • (NetworkInterfaceIPConfigurationListResult) —

    operation results.



226
227
228
229
 
# File 'lib/2018-01-01/generated/azure_mgmt_network/network_interface_ipconfigurations.rb', line 226

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

Get all ip configurations in a network interface

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.



255
256
257
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
 
# File 'lib/2018-01-01/generated/azure_mgmt_network/network_interface_ipconfigurations.rb', line 255

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::V2018_01_01::Models::NetworkInterfaceIPConfigurationListResult.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

Get all ip configurations in a network interface

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.



241
242
243
 
# File 'lib/2018-01-01/generated/azure_mgmt_network/network_interface_ipconfigurations.rb', line 241

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

Get all ip configurations in a network interface

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • network_interface_name (String) —

    The name of the network interface.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



49
50
51
 
# File 'lib/2018-01-01/generated/azure_mgmt_network/network_interface_ipconfigurations.rb', line 49

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