Class: Azure::Network::Mgmt::V2018_04_01::LoadBalancerFrontendIPConfigurations

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

Overview

LoadBalancerFrontendIPConfigurations

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ LoadBalancerFrontendIPConfigurations

Creates and initializes a new instance of the LoadBalancerFrontendIPConfigurations class.

Parameters:

  • client

    service class for accessing basic functionality.



17
18
19
# File 'lib/2018-04-01/generated/azure_mgmt_network/load_balancer_frontend_ipconfigurations.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#clientNetworkManagementClient (readonly)

Returns reference to the NetworkManagementClient.

Returns:



22
23
24
# File 'lib/2018-04-01/generated/azure_mgmt_network/load_balancer_frontend_ipconfigurations.rb', line 22

def client
  @client
end

Instance Method Details

#get(resource_group_name, load_balancer_name, frontend_ipconfiguration_name, custom_headers: nil) ⇒ FrontendIPConfiguration

Gets load balancer frontend IP configuration.

configuration. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • load_balancer_name (String)

    The name of the load balancer.

  • frontend_ipconfiguration_name (String)

    The name of the frontend IP

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

    A hash of custom headers that

Returns:

  • (FrontendIPConfiguration)

    operation results.



130
131
132
133
# File 'lib/2018-04-01/generated/azure_mgmt_network/load_balancer_frontend_ipconfigurations.rb', line 130

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

#get_async(resource_group_name, load_balancer_name, frontend_ipconfiguration_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets load balancer frontend IP configuration.

configuration. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • load_balancer_name (String)

    The name of the load balancer.

  • frontend_ipconfiguration_name (String)

    The name of the frontend IP

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
215
216
217
# File 'lib/2018-04-01/generated/azure_mgmt_network/load_balancer_frontend_ipconfigurations.rb', line 163

def get_async(resource_group_name, load_balancer_name, frontend_ipconfiguration_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'load_balancer_name is nil' if load_balancer_name.nil?
  fail ArgumentError, 'frontend_ipconfiguration_name is nil' if frontend_ipconfiguration_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/loadBalancers/{loadBalancerName}/frontendIPConfigurations/{frontendIPConfigurationName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'loadBalancerName' => load_balancer_name,'frontendIPConfigurationName' => frontend_ipconfiguration_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_04_01::Models::FrontendIPConfiguration.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, load_balancer_name, frontend_ipconfiguration_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets load balancer frontend IP configuration.

configuration. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • load_balancer_name (String)

    The name of the load balancer.

  • frontend_ipconfiguration_name (String)

    The name of the frontend IP

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



147
148
149
# File 'lib/2018-04-01/generated/azure_mgmt_network/load_balancer_frontend_ipconfigurations.rb', line 147

def get_with_http_info(resource_group_name, load_balancer_name, frontend_ipconfiguration_name, custom_headers:nil)
  get_async(resource_group_name, load_balancer_name, frontend_ipconfiguration_name, custom_headers:custom_headers).value!
end

#list(resource_group_name, load_balancer_name, custom_headers: nil) ⇒ Array<FrontendIPConfiguration>

Gets all the load balancer frontend IP configurations.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • load_balancer_name (String)

    The name of the load balancer.

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

    A hash of custom headers that

Returns:

  • (Array<FrontendIPConfiguration>)

    operation results.



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

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

#list_as_lazy(resource_group_name, load_balancer_name, custom_headers: nil) ⇒ LoadBalancerFrontendIPConfigurationListResult

Gets all the load balancer frontend IP configurations.

will be added to the HTTP request.

access to pages of the response.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • load_balancer_name (String)

    The name of the load balancer.

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

    A hash of custom headers that

Returns:

  • (LoadBalancerFrontendIPConfigurationListResult)

    which provide lazy



320
321
322
323
324
325
326
327
328
329
# File 'lib/2018-04-01/generated/azure_mgmt_network/load_balancer_frontend_ipconfigurations.rb', line 320

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

Gets all the load balancer frontend IP configurations.

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • load_balancer_name (String)

    The name of the load balancer.

  • 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-04-01/generated/azure_mgmt_network/load_balancer_frontend_ipconfigurations.rb', line 63

def list_async(resource_group_name, load_balancer_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'load_balancer_name is nil' if load_balancer_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/loadBalancers/{loadBalancerName}/frontendIPConfigurations'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'loadBalancerName' => load_balancer_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_04_01::Models::LoadBalancerFrontendIPConfigurationListResult.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) ⇒ LoadBalancerFrontendIPConfigurationListResult

Gets all the load balancer frontend IP configurations.

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:

  • (LoadBalancerFrontendIPConfigurationListResult)

    operation results.



229
230
231
232
# File 'lib/2018-04-01/generated/azure_mgmt_network/load_balancer_frontend_ipconfigurations.rb', line 229

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

Gets all the load balancer frontend IP configurations.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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

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_04_01::Models::LoadBalancerFrontendIPConfigurationListResult.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

Gets all the load balancer frontend IP configurations.

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

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



244
245
246
# File 'lib/2018-04-01/generated/azure_mgmt_network/load_balancer_frontend_ipconfigurations.rb', line 244

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

Gets all the load balancer frontend IP configurations.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • load_balancer_name (String)

    The name of the load balancer.

  • 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-04-01/generated/azure_mgmt_network/load_balancer_frontend_ipconfigurations.rb', line 49

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