Class: Azure::ContainerInstance::Mgmt::V2018_04_01::ContainerGroups

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

Overview

ContainerGroups

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ContainerGroups

Creates and initializes a new instance of the ContainerGroups class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, container_group_name, container_group, custom_headers: nil) ⇒ ContainerGroup

Create or update container groups.

Create or update container groups with specified configurations.

to be created or updated. 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_group (ContainerGroup) —

    The properties of the container group

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

    A hash of custom headers that

Returns:

  • (ContainerGroup) —

    operation results.



624
625
626
627
 
# File 'lib/2018-04-01/generated/azure_mgmt_container_instance/container_groups.rb', line 624

def begin_create_or_update(resource_group_name, container_group_name, container_group, custom_headers:nil)
  response = begin_create_or_update_async(resource_group_name, container_group_name, container_group, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_create_or_update_async(resource_group_name, container_group_name, container_group, custom_headers: nil) ⇒ Concurrent::Promise

Create or update container groups.

Create or update container groups with specified configurations.

to be created or updated. 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_group (ContainerGroup) —

    The properties of the container group

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
 
# File 'lib/2018-04-01/generated/azure_mgmt_container_instance/container_groups.rb', line 661

def begin_create_or_update_async(resource_group_name, container_group_name, container_group, 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_group is nil' if container_group.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::V2018_04_01::Models::ContainerGroup.mapper()
  request_content = @client.serialize(request_mapper,  container_group)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

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

  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},
      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(:put, 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 || status_code == 201
      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_04_01::Models::ContainerGroup.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
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ContainerInstance::Mgmt::V2018_04_01::Models::ContainerGroup.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

#begin_create_or_update_with_http_info(resource_group_name, container_group_name, container_group, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Create or update container groups.

Create or update container groups with specified configurations.

to be created or updated. 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_group (ContainerGroup) —

    The properties of the container group

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



643
644
645
 
# File 'lib/2018-04-01/generated/azure_mgmt_container_instance/container_groups.rb', line 643

def begin_create_or_update_with_http_info(resource_group_name, container_group_name, container_group, custom_headers:nil)
  begin_create_or_update_async(resource_group_name, container_group_name, container_group, custom_headers:custom_headers).value!
end

#create_or_update(resource_group_name, container_group_name, container_group, custom_headers: nil) ⇒ ContainerGroup

Create or update container groups.

Create or update container groups with specified configurations.

to be created or updated. 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_group (ContainerGroup) —

    The properties of the container group

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

    A hash of custom headers that

Returns:

  • (ContainerGroup) —

    operation results.



356
357
358
359
 
# File 'lib/2018-04-01/generated/azure_mgmt_container_instance/container_groups.rb', line 356

def create_or_update(resource_group_name, container_group_name, container_group, custom_headers:nil)
  response = create_or_update_async(resource_group_name, container_group_name, container_group, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(resource_group_name, container_group_name, container_group, custom_headers: nil) ⇒ Concurrent::Promise

to be created or updated. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • container_group_name (String) —

    The name of the container group.

  • container_group (ContainerGroup) —

    The properties of the container group

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/2018-04-01/generated/azure_mgmt_container_instance/container_groups.rb', line 372

def create_or_update_async(resource_group_name, container_group_name, container_group, custom_headers:nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, container_group_name, container_group, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::ContainerInstance::Mgmt::V2018_04_01::Models::ContainerGroup.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#delete(resource_group_name, container_group_name, custom_headers: nil) ⇒ ContainerGroup

Delete the specified container group.

Delete the specified container group in the specified subscription and resource group. The operation does not delete other resources provided by the user, such as volumes.

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.

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

    A hash of custom headers that

Returns:

  • (ContainerGroup) —

    operation results.



518
519
520
521
 
# File 'lib/2018-04-01/generated/azure_mgmt_container_instance/container_groups.rb', line 518

def delete(resource_group_name, container_group_name, custom_headers:nil)
  response = delete_async(resource_group_name, container_group_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

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

Delete the specified container group.

Delete the specified container group in the specified subscription and resource group. The operation does not delete other resources provided by the user, such as volumes.

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.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
 
# File 'lib/2018-04-01/generated/azure_mgmt_container_instance/container_groups.rb', line 555

def delete_async(resource_group_name, container_group_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?


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

  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},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, 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 || status_code == 204
      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_04_01::Models::ContainerGroup.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

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

Delete the specified container group.

Delete the specified container group in the specified subscription and resource group. The operation does not delete other resources provided by the user, such as volumes.

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.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



537
538
539
 
# File 'lib/2018-04-01/generated/azure_mgmt_container_instance/container_groups.rb', line 537

def delete_with_http_info(resource_group_name, container_group_name, custom_headers:nil)
  delete_async(resource_group_name, container_group_name, custom_headers:custom_headers).value!
end

#get(resource_group_name, container_group_name, custom_headers: nil) ⇒ ContainerGroup

Get the properties of the specified container group.

Gets the properties of the specified container group in the specified subscription and resource group. The operation returns the properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.

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.

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

    A hash of custom headers that

Returns:

  • (ContainerGroup) —

    operation results.



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

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

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

Get the properties of the specified container group.

Gets the properties of the specified container group in the specified subscription and resource group. The operation returns the properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.

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.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
332
333
334
335
336
337
338
339
340
 
# File 'lib/2018-04-01/generated/azure_mgmt_container_instance/container_groups.rb', line 287

def get_async(resource_group_name, container_group_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?


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

  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},
      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::V2018_04_01::Models::ContainerGroup.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, container_group_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get the properties of the specified container group.

Gets the properties of the specified container group in the specified subscription and resource group. The operation returns the properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.

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.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



268
269
270
 
# File 'lib/2018-04-01/generated/azure_mgmt_container_instance/container_groups.rb', line 268

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

#list(custom_headers: nil) ⇒ Array<ContainerGroup>

Get a list of container groups in the specified subscription.

Get a list of container groups in the specified subscription. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (Array<ContainerGroup>) —

    operation results.



37
38
39
40
 
# File 'lib/2018-04-01/generated/azure_mgmt_container_instance/container_groups.rb', line 37

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

#list_as_lazy(custom_headers: nil) ⇒ ContainerGroupListResult

Get a list of container groups in the specified subscription.

Get a list of container groups in the specified subscription. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.

will be added to the HTTP request.

response.

Parameters:

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

    A hash of custom headers that

Returns:

  • (ContainerGroupListResult) —

    which provide lazy access to pages of the



961
962
963
964
965
966
967
968
969
970
 
# File 'lib/2018-04-01/generated/azure_mgmt_container_instance/container_groups.rb', line 961

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

Get a list of container groups in the specified subscription.

Get a list of container groups in the specified subscription. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.

to the HTTP request.

Parameters:

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
117
118
119
120
121
122
123
 
# File 'lib/2018-04-01/generated/azure_mgmt_container_instance/container_groups.rb', line 72

def list_async(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?


  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/containerGroups'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'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::ContainerInstance::Mgmt::V2018_04_01::Models::ContainerGroupListResult.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_by_resource_group(resource_group_name, custom_headers: nil) ⇒ Array<ContainerGroup>

Get a list of container groups in the specified subscription and resource group.

Get a list of container groups in a specified subscription and resource group. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

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

    A hash of custom headers that

Returns:

  • (Array<ContainerGroup>) —

    operation results.



140
141
142
143
 
# File 'lib/2018-04-01/generated/azure_mgmt_container_instance/container_groups.rb', line 140

def list_by_resource_group(resource_group_name, custom_headers:nil)
  first_page = list_by_resource_group_as_lazy(resource_group_name, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_resource_group_as_lazy(resource_group_name, custom_headers: nil) ⇒ ContainerGroupListResult

Get a list of container groups in the specified subscription and resource group.

Get a list of container groups in a specified subscription and resource group. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

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

    A hash of custom headers that

Returns:

  • (ContainerGroupListResult) —

    which provide lazy access to pages of the



988
989
990
991
992
993
994
995
996
997
 
# File 'lib/2018-04-01/generated/azure_mgmt_container_instance/container_groups.rb', line 988

def list_by_resource_group_as_lazy(resource_group_name, custom_headers:nil)
  response = list_by_resource_group_async(resource_group_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_resource_group_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_resource_group_async(resource_group_name, custom_headers: nil) ⇒ Concurrent::Promise

Get a list of container groups in the specified subscription and resource group.

Get a list of container groups in a specified subscription and resource group. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/2018-04-01/generated/azure_mgmt_container_instance/container_groups.rb', line 179

def list_by_resource_group_async(resource_group_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?


  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'

  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},
      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::V2018_04_01::Models::ContainerGroupListResult.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_by_resource_group_next(next_page_link, custom_headers: nil) ⇒ ContainerGroupListResult

Get a list of container groups in the specified subscription and resource group.

Get a list of container groups in a specified subscription and resource group. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.

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:

  • (ContainerGroupListResult) —

    operation results.



855
856
857
858
 
# File 'lib/2018-04-01/generated/azure_mgmt_container_instance/container_groups.rb', line 855

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

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

Get a list of container groups in the specified subscription and resource group.

Get a list of container groups in a specified subscription and resource group. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.

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.



896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
 
# File 'lib/2018-04-01/generated/azure_mgmt_container_instance/container_groups.rb', line 896

def list_by_resource_group_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::V2018_04_01::Models::ContainerGroupListResult.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_by_resource_group_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get a list of container groups in the specified subscription and resource group.

Get a list of container groups in a specified subscription and resource group. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.

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.



876
877
878
 
# File 'lib/2018-04-01/generated/azure_mgmt_container_instance/container_groups.rb', line 876

def list_by_resource_group_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_resource_group_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_resource_group_with_http_info(resource_group_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get a list of container groups in the specified subscription and resource group.

Get a list of container groups in a specified subscription and resource group. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



160
161
162
 
# File 'lib/2018-04-01/generated/azure_mgmt_container_instance/container_groups.rb', line 160

def list_by_resource_group_with_http_info(resource_group_name, custom_headers:nil)
  list_by_resource_group_async(resource_group_name, custom_headers:custom_headers).value!
end

#list_next(next_page_link, custom_headers: nil) ⇒ ContainerGroupListResult

Get a list of container groups in the specified subscription.

Get a list of container groups in the specified subscription. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.

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:

  • (ContainerGroupListResult) —

    operation results.



749
750
751
752
 
# File 'lib/2018-04-01/generated/azure_mgmt_container_instance/container_groups.rb', line 749

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

Get a list of container groups in the specified subscription.

Get a list of container groups in the specified subscription. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.

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.



788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
 
# File 'lib/2018-04-01/generated/azure_mgmt_container_instance/container_groups.rb', line 788

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::ContainerInstance::Mgmt::V2018_04_01::Models::ContainerGroupListResult.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

Get a list of container groups in the specified subscription.

Get a list of container groups in the specified subscription. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.

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.



769
770
771
 
# File 'lib/2018-04-01/generated/azure_mgmt_container_instance/container_groups.rb', line 769

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

Get a list of container groups in the specified subscription.

Get a list of container groups in the specified subscription. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



55
56
57
 
# File 'lib/2018-04-01/generated/azure_mgmt_container_instance/container_groups.rb', line 55

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

#update(resource_group_name, container_group_name, resource, custom_headers: nil) ⇒ ContainerGroup

Update container groups.

Updates container group tags with specified values.

be updated. 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.

  • resource (Resource) —

    The container group resource with just the tags to

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

    A hash of custom headers that

Returns:

  • (ContainerGroup) —

    operation results.



404
405
406
407
 
# File 'lib/2018-04-01/generated/azure_mgmt_container_instance/container_groups.rb', line 404

def update(resource_group_name, container_group_name, resource, custom_headers:nil)
  response = update_async(resource_group_name, container_group_name, resource, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#update_async(resource_group_name, container_group_name, resource, custom_headers: nil) ⇒ Concurrent::Promise

Update container groups.

Updates container group tags with specified values.

be updated. 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.

  • resource (Resource) —

    The container group resource with just the tags to

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



441
442
443
444
445
446
447
448
449
450
451
452
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/2018-04-01/generated/azure_mgmt_container_instance/container_groups.rb', line 441

def update_async(resource_group_name, container_group_name, resource, 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, 'resource is nil' if resource.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::V2018_04_01::Models::Resource.mapper()
  request_content = @client.serialize(request_mapper,  resource)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

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

  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},
      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(:patch, 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_04_01::Models::ContainerGroup.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

#update_with_http_info(resource_group_name, container_group_name, resource, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Update container groups.

Updates container group tags with specified values.

be updated. 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.

  • resource (Resource) —

    The container group resource with just the tags to

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



423
424
425
 
# File 'lib/2018-04-01/generated/azure_mgmt_container_instance/container_groups.rb', line 423

def update_with_http_info(resource_group_name, container_group_name, resource, custom_headers:nil)
  update_async(resource_group_name, container_group_name, resource, custom_headers:custom_headers).value!
end