Class: Azure::ContainerInstance::Mgmt::V2018_10_01::ContainerInstanceManagementClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2018-10-01/generated/azure_mgmt_container_instance/container_instance_management_client.rb

Overview

A service client - single point of access to the REST API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials = nil, base_url = nil, options = nil) ⇒ ContainerInstanceManagementClient

Creates initializes a new instance of the ContainerInstanceManagementClient class.

Parameters:

  • credentials (MsRest::ServiceClientCredentials) (defaults to: nil) —

    credentials to authorize HTTP requests made by the service client.

  • base_url (String) (defaults to: nil) —

    the base URI of the service.

  • options (Array) (defaults to: nil) —

    filters to be applied to the HTTP requests.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/container_instance_management_client.rb', line 61

def initialize(credentials = nil, base_url = nil, options = nil)
  super(credentials, options)
  @base_url = base_url || 'https://management.azure.com'

  fail ArgumentError, 'invalid type of credentials input parameter' unless credentials.is_a?(MsRest::ServiceClientCredentials) unless credentials.nil?
  @credentials = credentials

  @container_groups = ContainerGroups.new(self)
  @operations = Operations.new(self)
  @container_group_usage = ContainerGroupUsage.new(self)
  @container_operations = ContainerOperations.new(self)
  @service_association_link = ServiceAssociationLink.new(self)
  @api_version = '2018-10-01'
  @accept_language = 'en-US'
  @long_running_operation_retry_timeout = 30
  @generate_client_request_id = true
  add_telemetry
end

Instance Attribute Details

#accept_language ⇒ String

Returns The preferred language for the response.

Returns:

  • (String) —

    The preferred language for the response.



29
30
31
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/container_instance_management_client.rb', line 29

def accept_language
  @accept_language
end

#api_version ⇒ String (readonly)

Returns Client API version.

Returns:

  • (String) —

    Client API version



26
27
28
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/container_instance_management_client.rb', line 26

def api_version
  @api_version
end

#base_url ⇒ String

Returns the base URI of the service.

Returns:

  • (String) —

    the base URI of the service.



15
16
17
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/container_instance_management_client.rb', line 15

def base_url
  @base_url
end

#container_group_usage ⇒ ContainerGroupUsage (readonly)

Returns container_group_usage.

Returns:



47
48
49
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/container_instance_management_client.rb', line 47

def container_group_usage
  @container_group_usage
end

#container_groups ⇒ ContainerGroups (readonly)

Returns container_groups.

Returns:



41
42
43
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/container_instance_management_client.rb', line 41

def container_groups
  @container_groups
end

#container_operations ⇒ ContainerOperations (readonly)

Returns container_operations.

Returns:



50
51
52
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/container_instance_management_client.rb', line 50

def container_operations
  @container_operations
end

#credentials ⇒ Object (readonly)

Returns Credentials needed for the client to connect to Azure.

Returns:

  • Credentials needed for the client to connect to Azure.



18
19
20
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/container_instance_management_client.rb', line 18

def credentials
  @credentials
end

#generate_client_request_id ⇒ Boolean

generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Returns:

  • (Boolean) —

    Whether a unique x-ms-client-request-id should be



38
39
40
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/container_instance_management_client.rb', line 38

def generate_client_request_id
  @generate_client_request_id
end

#long_running_operation_retry_timeout ⇒ Integer

Operations. Default value is 30.

Returns:

  • (Integer) —

    The retry timeout in seconds for Long Running



33
34
35
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/container_instance_management_client.rb', line 33

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#operations ⇒ Operations (readonly)

Returns operations.

Returns:



44
45
46
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/container_instance_management_client.rb', line 44

def operations
  @operations
end

#service_association_link ⇒ ServiceAssociationLink (readonly)

Returns service_association_link.

Returns:



53
54
55
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/container_instance_management_client.rb', line 53

def service_association_link
  @service_association_link
end

#subscription_id ⇒ String

Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Returns:

  • (String) —

    Subscription credentials which uniquely identify



23
24
25
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/container_instance_management_client.rb', line 23

def subscription_id
  @subscription_id
end

Instance Method Details

#list_cached_images(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.

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

    operation results.



150
151
152
153
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/container_instance_management_client.rb', line 150

def list_cached_images(location, custom_headers:nil)
  response = list_cached_images_async(location, custom_headers:custom_headers).value!
  response.body unless response.nil?
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.



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/container_instance_management_client.rb', line 183

def list_cached_images_async(location, custom_headers:nil)
  fail ArgumentError, 'subscription_id is nil' if subscription_id.nil?
  fail ArgumentError, 'location is nil' if location.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/cachedImages'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => subscription_id,'location' => location},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::V2018_10_01::Models::CachedImagesListResult.mapper()
        result.body = self.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_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.



167
168
169
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/container_instance_management_client.rb', line 167

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) ⇒ 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.

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

    operation results.



248
249
250
251
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/container_instance_management_client.rb', line 248

def list_capabilities(location, custom_headers:nil)
  response = list_capabilities_async(location, custom_headers:custom_headers).value!
  response.body unless response.nil?
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.



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
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/container_instance_management_client.rb', line 279

def list_capabilities_async(location, custom_headers:nil)
  fail ArgumentError, 'subscription_id is nil' if subscription_id.nil?
  fail ArgumentError, 'location is nil' if location.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/capabilities'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => subscription_id,'location' => location},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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::V2018_10_01::Models::CapabilitiesListResult.mapper()
        result.body = self.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_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.



264
265
266
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/container_instance_management_client.rb', line 264

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

#make_request(method, path, options = {}) ⇒ Hash{String=>String}

Makes a request and returns the body of the response. Example:

request_content = "{'location':'westus','tags':{'tag1':'val1','tag2':'val2'}}"
path = "/path"
options = {
  body: request_content,
  query_params: {'api-version' => '2016-02-01'}
}
result = @client.make_request(:put, path, options)

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (Hash{String=>String}) —

    containing the body of the response.



96
97
98
99
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/container_instance_management_client.rb', line 96

def make_request(method, path, options = {})
  result = make_request_with_http_info(method, path, options)
  result.body unless result.nil?
end

#make_request_async(method, path, options = {}) ⇒ Concurrent::Promise

Makes a request asynchronously.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/container_instance_management_client.rb', line 121

def make_request_async(method, path, options = {})
  fail ArgumentError, 'method is nil' if method.nil?
  fail ArgumentError, 'path is nil' if path.nil?

  request_url = options[:base_url] || @base_url
  if(!options[:headers].nil? && !options[:headers]['Content-Type'].nil?)
    @request_headers['Content-Type'] = options[:headers]['Content-Type']
  end

  request_headers = @request_headers
  request_headers.merge!({'accept-language' => @accept_language}) unless @accept_language.nil?
  options.merge!({headers: request_headers.merge(options[:headers] || {})})
  options.merge!({credentials: @credentials}) unless @credentials.nil?

  super(request_url, method, path, options)
end

#make_request_with_http_info(method, path, options = {}) ⇒ MsRestAzure::AzureOperationResponse

Makes a request and returns the operation response.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    Operation response containing the request, response and status.



108
109
110
111
112
 
# File 'lib/2018-10-01/generated/azure_mgmt_container_instance/container_instance_management_client.rb', line 108

def make_request_with_http_info(method, path, options = {})
  result = make_request_async(method, path, options).value!
  result.body = result.response.body.to_s.empty? ? nil : JSON.load(result.response.body)
  result
end