Class: Azure::ContainerInstance::Mgmt::V2020_11_01::Containers

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-11-01/generated/azure_mgmt_container_instance/containers.rb

Overview

Containers

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Containers

Creates and initializes a new instance of the Containers class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2020-11-01/generated/azure_mgmt_container_instance/containers.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/2020-11-01/generated/azure_mgmt_container_instance/containers.rb', line 22

def client
  @client
end

Instance Method Details

#attach(resource_group_name, container_group_name, container_name, custom_headers: nil) ⇒ ContainerAttachResponse

Attach to the output of a specific container instance.

Attach to the output stream of a specific container instance in a specified resource group and container group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • container_group_name (String) —

    The name of the container group.

  • container_name (String) —

    The name of the container instance.

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

    A hash of custom headers that

Returns:

  • (ContainerAttachResponse) —

    operation results.



281
282
283
284
 
# File 'lib/2020-11-01/generated/azure_mgmt_container_instance/containers.rb', line 281

def attach(resource_group_name, container_group_name, container_name, custom_headers:nil)
  response = attach_async(resource_group_name, container_group_name, container_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#attach_async(resource_group_name, container_group_name, container_name, custom_headers: nil) ⇒ Concurrent::Promise

Attach to the output of a specific container instance.

Attach to the output stream of a specific container instance in a specified resource group and container group.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • container_group_name (String) —

    The name of the container group.

  • container_name (String) —

    The name of the container instance.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/2020-11-01/generated/azure_mgmt_container_instance/containers.rb', line 318

def attach_async(resource_group_name, container_group_name, container_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'container_group_name is nil' if container_group_name.nil?
  fail ArgumentError, 'container_name is nil' if container_name.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.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/attach'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'containerGroupName' => container_group_name,'containerName' => container_name},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, 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::V2020_11_01::Models::ContainerAttachResponse.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

#attach_with_http_info(resource_group_name, container_group_name, container_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Attach to the output of a specific container instance.

Attach to the output stream of a specific container instance in a specified resource group and container group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • container_group_name (String) —

    The name of the container group.

  • container_name (String) —

    The name of the container instance.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



300
301
302
 
# File 'lib/2020-11-01/generated/azure_mgmt_container_instance/containers.rb', line 300

def attach_with_http_info(resource_group_name, container_group_name, container_name, custom_headers:nil)
  attach_async(resource_group_name, container_group_name, container_name, custom_headers:custom_headers).value!
end

#execute_command(resource_group_name, container_group_name, container_name, container_exec_request, custom_headers: nil) ⇒ ContainerExecResponse

Executes a command in a specific container instance.

Executes a command for a specific container instance in a specified resource group and container group.

command. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • container_group_name (String) —

    The name of the container group.

  • container_name (String) —

    The name of the container instance.

  • container_exec_request (ContainerExecRequest) —

    The request for the exec

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

    A hash of custom headers that

Returns:

  • (ContainerExecResponse) —

    operation results.



162
163
164
165
 
# File 'lib/2020-11-01/generated/azure_mgmt_container_instance/containers.rb', line 162

def execute_command(resource_group_name, container_group_name, container_name, container_exec_request, custom_headers:nil)
  response = execute_command_async(resource_group_name, container_group_name, container_name, container_exec_request, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#execute_command_async(resource_group_name, container_group_name, container_name, container_exec_request, custom_headers: nil) ⇒ Concurrent::Promise

Executes a command in a specific container instance.

Executes a command for a specific container instance in a specified resource group and container group.

command. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • container_group_name (String) —

    The name of the container group.

  • container_name (String) —

    The name of the container instance.

  • container_exec_request (ContainerExecRequest) —

    The request for the exec

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/2020-11-01/generated/azure_mgmt_container_instance/containers.rb', line 203

def execute_command_async(resource_group_name, container_group_name, container_name, container_exec_request, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'container_group_name is nil' if container_group_name.nil?
  fail ArgumentError, 'container_name is nil' if container_name.nil?
  fail ArgumentError, 'container_exec_request is nil' if container_exec_request.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?

  # Serialize Request
  request_mapper = Azure::ContainerInstance::Mgmt::V2020_11_01::Models::ContainerExecRequest.mapper()
  request_content = @client.serialize(request_mapper,  container_exec_request)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/exec'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'containerGroupName' => container_group_name,'containerName' => container_name},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, 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::V2020_11_01::Models::ContainerExecResponse.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

#execute_command_with_http_info(resource_group_name, container_group_name, container_name, container_exec_request, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Executes a command in a specific container instance.

Executes a command for a specific container instance in a specified resource group and container group.

command. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • container_group_name (String) —

    The name of the container group.

  • container_name (String) —

    The name of the container instance.

  • container_exec_request (ContainerExecRequest) —

    The request for the exec

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



183
184
185
 
# File 'lib/2020-11-01/generated/azure_mgmt_container_instance/containers.rb', line 183

def execute_command_with_http_info(resource_group_name, container_group_name, container_name, container_exec_request, custom_headers:nil)
  execute_command_async(resource_group_name, container_group_name, container_name, container_exec_request, custom_headers:custom_headers).value!
end

#list_logs(resource_group_name, container_group_name, container_name, tail: nil, timestamps: nil, custom_headers: nil) ⇒ Logs

Get the logs for a specified container instance.

Get the logs for a specified container instance in a specified resource group and container group.

container instance log. If not provided, all available logs are shown up to 4mb. every line of log output. If not provided, defaults to false. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • container_group_name (String) —

    The name of the container group.

  • container_name (String) —

    The name of the container instance.

  • tail (Integer) (defaults to: nil) —

    The number of lines to show from the tail of the

  • timestamps (Boolean) (defaults to: nil) —

    If true, adds a timestamp at the beginning of

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

    A hash of custom headers that

Returns:

  • (Logs) —

    operation results.



43
44
45
46
 
# File 'lib/2020-11-01/generated/azure_mgmt_container_instance/containers.rb', line 43

def list_logs(resource_group_name, container_group_name, container_name, tail:nil, timestamps:nil, custom_headers:nil)
  response = list_logs_async(resource_group_name, container_group_name, container_name, tail:tail, timestamps:timestamps, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_logs_async(resource_group_name, container_group_name, container_name, tail: nil, timestamps: nil, custom_headers: nil) ⇒ Concurrent::Promise

Get the logs for a specified container instance.

Get the logs for a specified container instance in a specified resource group and container group.

container instance log. If not provided, all available logs are shown up to 4mb. every line of log output. If not provided, defaults to false. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • container_group_name (String) —

    The name of the container group.

  • container_name (String) —

    The name of the container instance.

  • tail (Integer) (defaults to: nil) —

    The number of lines to show from the tail of the

  • timestamps (Boolean) (defaults to: nil) —

    If true, adds a timestamp at the beginning of

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/2020-11-01/generated/azure_mgmt_container_instance/containers.rb', line 90

def list_logs_async(resource_group_name, container_group_name, container_name, tail:nil, timestamps:nil, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'container_group_name is nil' if container_group_name.nil?
  fail ArgumentError, 'container_name is nil' if container_name.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.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/logs'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'containerGroupName' => container_group_name,'containerName' => container_name},
      query_params: {'api-version' => @client.api_version,'tail' => tail,'timestamps' => timestamps},
      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::V2020_11_01::Models::Logs.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_logs_with_http_info(resource_group_name, container_group_name, container_name, tail: nil, timestamps: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get the logs for a specified container instance.

Get the logs for a specified container instance in a specified resource group and container group.

container instance log. If not provided, all available logs are shown up to 4mb. every line of log output. If not provided, defaults to false. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • container_group_name (String) —

    The name of the container group.

  • container_name (String) —

    The name of the container instance.

  • tail (Integer) (defaults to: nil) —

    The number of lines to show from the tail of the

  • timestamps (Boolean) (defaults to: nil) —

    If true, adds a timestamp at the beginning of

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



67
68
69
 
# File 'lib/2020-11-01/generated/azure_mgmt_container_instance/containers.rb', line 67

def list_logs_with_http_info(resource_group_name, container_group_name, container_name, tail:nil, timestamps:nil, custom_headers:nil)
  list_logs_async(resource_group_name, container_group_name, container_name, tail:tail, timestamps:timestamps, custom_headers:custom_headers).value!
end