Class: Azure::ContainerInstance::Mgmt::V2019_12_01::Location

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-12-01/generated/azure_mgmt_container_instance/location.rb

Overview

Location

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Location

Creates and initializes a new instance of the Location class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2019-12-01/generated/azure_mgmt_container_instance/location.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ ContainerInstanceManagementClient (readonly)

Returns reference to the ContainerInstanceManagementClient.

Returns:



22
23
24
 
# File 'lib/2019-12-01/generated/azure_mgmt_container_instance/location.rb', line 22

def client
  @client
end

Instance Method Details

#list_cached_images(location, custom_headers: nil) ⇒ Array<CachedImages>

Get the list of cached images.

Get the list of cached images on specific OS type for a subscription in a region.

will be added to the HTTP request.

Parameters:

  • location (String) —

    The identifier for the physical azure location.

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

    A hash of custom headers that

Returns:

  • (Array<CachedImages>) —

    operation results.



126
127
128
129
 
# File 'lib/2019-12-01/generated/azure_mgmt_container_instance/location.rb', line 126

def list_cached_images(location, custom_headers:nil)
  first_page = list_cached_images_as_lazy(location, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_cached_images_as_lazy(location, custom_headers: nil) ⇒ CachedImagesListResult

Get the list of cached images.

Get the list of cached images on specific OS type for a subscription in a region.

will be added to the HTTP request.

response.

Parameters:

  • location (String) —

    The identifier for the physical azure location.

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

    A hash of custom headers that

Returns:

  • (CachedImagesListResult) —

    which provide lazy access to pages of the



517
518
519
520
521
522
523
524
525
526
 
# File 'lib/2019-12-01/generated/azure_mgmt_container_instance/location.rb', line 517

def list_cached_images_as_lazy(location, custom_headers:nil)
  response = list_cached_images_async(location, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_cached_images_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_cached_images_async(location, custom_headers: nil) ⇒ Concurrent::Promise

Get the list of cached images.

Get the list of cached images on specific OS type for a subscription in a region.

to the HTTP request.

Parameters:

  • location (String) —

    The identifier for the physical azure location.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



159
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/2019-12-01/generated/azure_mgmt_container_instance/location.rb', line 159

def list_cached_images_async(location, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'location is nil' if location.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}/providers/Microsoft.ContainerInstance/locations/{location}/cachedImages'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'location' => location},
      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::ContainerInstance::Mgmt::V2019_12_01::Models::CachedImagesListResult.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_cached_images_next(next_page_link, custom_headers: nil) ⇒ CachedImagesListResult

Get the list of cached images.

Get the list of cached images on specific OS type for a subscription in a region.

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:

  • (CachedImagesListResult) —

    operation results.



322
323
324
325
 
# File 'lib/2019-12-01/generated/azure_mgmt_container_instance/location.rb', line 322

def list_cached_images_next(next_page_link, custom_headers:nil)
  response = list_cached_images_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_cached_images_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Get the list of cached images.

Get the list of cached images on specific OS type for a subscription in a region.

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.



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
 
# File 'lib/2019-12-01/generated/azure_mgmt_container_instance/location.rb', line 357

def list_cached_images_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::ContainerInstance::Mgmt::V2019_12_01::Models::CachedImagesListResult.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_cached_images_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get the list of cached images.

Get the list of cached images on specific OS type for a subscription in a region.

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.



340
341
342
 
# File 'lib/2019-12-01/generated/azure_mgmt_container_instance/location.rb', line 340

def list_cached_images_next_with_http_info(next_page_link, custom_headers:nil)
  list_cached_images_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_cached_images_with_http_info(location, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get the list of cached images.

Get the list of cached images on specific OS type for a subscription in a region.

will be added to the HTTP request.

Parameters:

  • location (String) —

    The identifier for the physical azure location.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



143
144
145
 
# File 'lib/2019-12-01/generated/azure_mgmt_container_instance/location.rb', line 143

def list_cached_images_with_http_info(location, custom_headers:nil)
  list_cached_images_async(location, custom_headers:custom_headers).value!
end

#list_capabilities(location, custom_headers: nil) ⇒ Array<Capabilities>

Get the list of capabilities of the location.

Get the list of CPU/memory/GPU capabilities of a region.

will be added to the HTTP request.

Parameters:

  • location (String) —

    The identifier for the physical azure location.

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

    A hash of custom headers that

Returns:

  • (Array<Capabilities>) —

    operation results.



224
225
226
227
 
# File 'lib/2019-12-01/generated/azure_mgmt_container_instance/location.rb', line 224

def list_capabilities(location, custom_headers:nil)
  first_page = list_capabilities_as_lazy(location, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_capabilities_as_lazy(location, custom_headers: nil) ⇒ CapabilitiesListResult

Get the list of capabilities of the location.

Get the list of CPU/memory/GPU capabilities of a region.

will be added to the HTTP request.

response.

Parameters:

  • location (String) —

    The identifier for the physical azure location.

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

    A hash of custom headers that

Returns:

  • (CapabilitiesListResult) —

    which provide lazy access to pages of the



540
541
542
543
544
545
546
547
548
549
 
# File 'lib/2019-12-01/generated/azure_mgmt_container_instance/location.rb', line 540

def list_capabilities_as_lazy(location, custom_headers:nil)
  response = list_capabilities_async(location, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_capabilities_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_capabilities_async(location, custom_headers: nil) ⇒ Concurrent::Promise

Get the list of capabilities of the location.

Get the list of CPU/memory/GPU capabilities of a region.

to the HTTP request.

Parameters:

  • location (String) —

    The identifier for the physical azure location.

  • 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
305
306
307
 
# File 'lib/2019-12-01/generated/azure_mgmt_container_instance/location.rb', line 255

def list_capabilities_async(location, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'location is nil' if location.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}/providers/Microsoft.ContainerInstance/locations/{location}/capabilities'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'location' => location},
      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::ContainerInstance::Mgmt::V2019_12_01::Models::CapabilitiesListResult.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_capabilities_next(next_page_link, custom_headers: nil) ⇒ CapabilitiesListResult

Get the list of capabilities of the location.

Get the list of CPU/memory/GPU capabilities of a region.

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:

  • (CapabilitiesListResult) —

    operation results.



420
421
422
423
 
# File 'lib/2019-12-01/generated/azure_mgmt_container_instance/location.rb', line 420

def list_capabilities_next(next_page_link, custom_headers:nil)
  response = list_capabilities_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_capabilities_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Get the list of capabilities of the location.

Get the list of CPU/memory/GPU capabilities of a region.

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.



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
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
 
# File 'lib/2019-12-01/generated/azure_mgmt_container_instance/location.rb', line 453

def list_capabilities_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::ContainerInstance::Mgmt::V2019_12_01::Models::CapabilitiesListResult.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_capabilities_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get the list of capabilities of the location.

Get the list of CPU/memory/GPU capabilities of a region.

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.



437
438
439
 
# File 'lib/2019-12-01/generated/azure_mgmt_container_instance/location.rb', line 437

def list_capabilities_next_with_http_info(next_page_link, custom_headers:nil)
  list_capabilities_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_capabilities_with_http_info(location, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get the list of capabilities of the location.

Get the list of CPU/memory/GPU capabilities of a region.

will be added to the HTTP request.

Parameters:

  • location (String) —

    The identifier for the physical azure location.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



240
241
242
 
# File 'lib/2019-12-01/generated/azure_mgmt_container_instance/location.rb', line 240

def list_capabilities_with_http_info(location, custom_headers:nil)
  list_capabilities_async(location, custom_headers:custom_headers).value!
end

#list_usage(location, custom_headers: nil) ⇒ UsageListResult

Get the usage for a subscription

will be added to the HTTP request.

Parameters:

  • location (String) —

    The identifier for the physical azure location.

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

    A hash of custom headers that

Returns:

  • (UsageListResult) —

    operation results.



33
34
35
36
 
# File 'lib/2019-12-01/generated/azure_mgmt_container_instance/location.rb', line 33

def list_usage(location, custom_headers:nil)
  response = list_usage_async(location, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_usage_async(location, custom_headers: nil) ⇒ Concurrent::Promise

Get the usage for a subscription

to the HTTP request.

Parameters:

  • location (String) —

    The identifier for the physical azure location.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



60
61
62
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
 
# File 'lib/2019-12-01/generated/azure_mgmt_container_instance/location.rb', line 60

def list_usage_async(location, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'location is nil' if location.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}/providers/Microsoft.ContainerInstance/locations/{location}/usages'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'location' => location},
      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::ContainerInstance::Mgmt::V2019_12_01::Models::UsageListResult.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_usage_with_http_info(location, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get the usage for a subscription

will be added to the HTTP request.

Parameters:

  • location (String) —

    The identifier for the physical azure location.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



47
48
49
 
# File 'lib/2019-12-01/generated/azure_mgmt_container_instance/location.rb', line 47

def list_usage_with_http_info(location, custom_headers:nil)
  list_usage_async(location, custom_headers:custom_headers).value!
end