Class: Azure::ARM::Network::LoadBalancerBackendAddressPools

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

Overview

Network Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ LoadBalancerBackendAddressPools

Creates and initializes a new instance of the LoadBalancerBackendAddressPools class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def client
  @client
end

Instance Method Details

#get(resource_group_name, load_balancer_name, backend_address_pool_name, custom_headers = nil) ⇒ BackendAddressPool

Gets load balancer backend address pool.

pool. 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.

  • backend_address_pool_name (String) —

    The name of the backend address

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

    A hash of custom headers that

Returns:

  • (BackendAddressPool) —

    operation results.



127
128
129
130
 
# File 'lib/generated/azure_mgmt_network/load_balancer_backend_address_pools.rb', line 127

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

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

Gets load balancer backend address pool.

pool. 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.

  • backend_address_pool_name (String) —

    The name of the backend address

  • 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
 
# File 'lib/generated/azure_mgmt_network/load_balancer_backend_address_pools.rb', line 160

def get_async(resource_group_name, load_balancer_name, backend_address_pool_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, 'backend_address_pool_name is nil' if backend_address_pool_name.nil?
  api_version = '2017-08-01'
  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/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}'

  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,'backendAddressPoolName' => backend_address_pool_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => 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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::Network::Models::BackendAddressPool.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, backend_address_pool_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets load balancer backend address pool.

pool. 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.

  • backend_address_pool_name (String) —

    The name of the backend address

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



144
145
146
 
# File 'lib/generated/azure_mgmt_network/load_balancer_backend_address_pools.rb', line 144

def get_with_http_info(resource_group_name, load_balancer_name, backend_address_pool_name, custom_headers = nil)
  get_async(resource_group_name, load_balancer_name, backend_address_pool_name, custom_headers).value!
end

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

Gets all the load balancer backed address pools.

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<BackendAddressPool>) —

    operation results.



34
35
36
37
 
# File 'lib/generated/azure_mgmt_network/load_balancer_backend_address_pools.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)
  first_page.get_all_items
end

#list_as_lazy(resource_group_name, load_balancer_name, custom_headers = nil) ⇒ LoadBalancerBackendAddressPoolListResult

Gets all the load balancer backed address pools.

will be added to the HTTP request.

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:

  • (LoadBalancerBackendAddressPoolListResult) —

    which provide lazy access



311
312
313
314
315
316
317
318
319
320
 
# File 'lib/generated/azure_mgmt_network/load_balancer_backend_address_pools.rb', line 311

def list_as_lazy(resource_group_name, load_balancer_name, custom_headers = nil)
  response = list_async(resource_group_name, load_balancer_name, 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)
    end
    page
  end
end

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

Gets all the load balancer backed address pools.

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
 
# File 'lib/generated/azure_mgmt_network/load_balancer_backend_address_pools.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?
  api_version = '2017-08-01'
  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/loadBalancers/{loadBalancerName}/backendAddressPools'

  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' => 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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::Network::Models::LoadBalancerBackendAddressPoolListResult.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) ⇒ LoadBalancerBackendAddressPoolListResult

Gets all the load balancer backed address pools.

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:

  • (LoadBalancerBackendAddressPoolListResult) —

    operation results.



223
224
225
226
 
# File 'lib/generated/azure_mgmt_network/load_balancer_backend_address_pools.rb', line 223

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

Gets all the load balancer backed address pools.

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.



252
253
254
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
 
# File 'lib/generated/azure_mgmt_network/load_balancer_backend_address_pools.rb', line 252

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}'

  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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::Network::Models::LoadBalancerBackendAddressPoolListResult.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 backed address pools.

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.



238
239
240
 
# File 'lib/generated/azure_mgmt_network/load_balancer_backend_address_pools.rb', line 238

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

Gets all the load balancer backed address pools.

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/generated/azure_mgmt_network/load_balancer_backend_address_pools.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).value!
end