Class: Azure::ContainerService::Mgmt::V2020_06_01::AgentPools

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-06-01/generated/azure_mgmt_container_service/agent_pools.rb

Overview

The Container Service Client.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ AgentPools

Creates and initializes a new instance of the AgentPools class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/agent_pools.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ ContainerServiceClient (readonly)

Returns reference to the ContainerServiceClient.

Returns:



22
23
24
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/agent_pools.rb', line 22

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, resource_name, agent_pool_name, parameters, custom_headers: nil) ⇒ AgentPool

Creates or updates an agent pool.

Creates or updates an agent pool in the specified managed cluster.

agent pool operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • resource_name (String) —

    The name of the managed cluster resource.

  • agent_pool_name (String) —

    The name of the agent pool.

  • parameters (AgentPool) —

    Parameters supplied to the Create or Update an

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

    A hash of custom headers that

Returns:

  • (AgentPool) —

    operation results.



561
562
563
564
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/agent_pools.rb', line 561

def begin_create_or_update(resource_group_name, resource_name, agent_pool_name, parameters, custom_headers:nil)
  response = begin_create_or_update_async(resource_group_name, resource_name, agent_pool_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_create_or_update_async(resource_group_name, resource_name, agent_pool_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Creates or updates an agent pool.

Creates or updates an agent pool in the specified managed cluster.

agent pool operation. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • resource_name (String) —

    The name of the managed cluster resource.

  • agent_pool_name (String) —

    The name of the agent pool.

  • parameters (AgentPool) —

    Parameters supplied to the Create or Update an

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/agent_pools.rb', line 600

def begin_create_or_update_async(resource_group_name, resource_name, agent_pool_name, parameters, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, 'resource_name is nil' if resource_name.nil?
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'MaxLength': '63'" if !resource_name.nil? && resource_name.length > 63
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'MinLength': '1'" if !resource_name.nil? && resource_name.length < 1
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$'" if !resource_name.nil? && resource_name.match(Regexp.new('^^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$$')).nil?
  fail ArgumentError, 'agent_pool_name is nil' if agent_pool_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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::ContainerService::Mgmt::V2020_06_01::Models::AgentPool.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}'

  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,'resourceName' => resource_name,'agentPoolName' => agent_pool_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::ContainerService::Mgmt::V2020_06_01::Models::AgentPool.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::ContainerService::Mgmt::V2020_06_01::Models::AgentPool.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, resource_name, agent_pool_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates or updates an agent pool.

Creates or updates an agent pool in the specified managed cluster.

agent pool operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • resource_name (String) —

    The name of the managed cluster resource.

  • agent_pool_name (String) —

    The name of the agent pool.

  • parameters (AgentPool) —

    Parameters supplied to the Create or Update an

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



581
582
583
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/agent_pools.rb', line 581

def begin_create_or_update_with_http_info(resource_group_name, resource_name, agent_pool_name, parameters, custom_headers:nil)
  begin_create_or_update_async(resource_group_name, resource_name, agent_pool_name, parameters, custom_headers:custom_headers).value!
end

#begin_delete(resource_group_name, resource_name, agent_pool_name, custom_headers: nil) ⇒ Object

Deletes an agent pool.

Deletes the agent pool in the specified managed cluster.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • resource_name (String) —

    The name of the managed cluster resource.

  • agent_pool_name (String) —

    The name of the agent pool.

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

    A hash of custom headers that



690
691
692
693
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/agent_pools.rb', line 690

def begin_delete(resource_group_name, resource_name, agent_pool_name, custom_headers:nil)
  response = begin_delete_async(resource_group_name, resource_name, agent_pool_name, custom_headers:custom_headers).value!
  nil
end

#begin_delete_async(resource_group_name, resource_name, agent_pool_name, custom_headers: nil) ⇒ Concurrent::Promise

Deletes an agent pool.

Deletes the agent pool in the specified managed cluster.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • resource_name (String) —

    The name of the managed cluster resource.

  • agent_pool_name (String) —

    The name of the agent pool.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/agent_pools.rb', line 725

def begin_delete_async(resource_group_name, resource_name, agent_pool_name, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, 'resource_name is nil' if resource_name.nil?
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'MaxLength': '63'" if !resource_name.nil? && resource_name.length > 63
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'MinLength': '1'" if !resource_name.nil? && resource_name.length < 1
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$'" if !resource_name.nil? && resource_name.match(Regexp.new('^^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$$')).nil?
  fail ArgumentError, 'agent_pool_name is nil' if agent_pool_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.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}'

  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,'resourceName' => resource_name,'agentPoolName' => agent_pool_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 == 202 || 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?

    result
  end

  promise.execute
end

#begin_delete_with_http_info(resource_group_name, resource_name, agent_pool_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes an agent pool.

Deletes the agent pool in the specified managed cluster.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • resource_name (String) —

    The name of the managed cluster resource.

  • agent_pool_name (String) —

    The name of the agent pool.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



708
709
710
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/agent_pools.rb', line 708

def begin_delete_with_http_info(resource_group_name, resource_name, agent_pool_name, custom_headers:nil)
  begin_delete_async(resource_group_name, resource_name, agent_pool_name, custom_headers:custom_headers).value!
end

#create_or_update(resource_group_name, resource_name, agent_pool_name, parameters, custom_headers: nil) ⇒ AgentPool

Creates or updates an agent pool.

Creates or updates an agent pool in the specified managed cluster.

agent pool operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • resource_name (String) —

    The name of the managed cluster resource.

  • agent_pool_name (String) —

    The name of the agent pool.

  • parameters (AgentPool) —

    Parameters supplied to the Create or Update an

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

    A hash of custom headers that

Returns:

  • (AgentPool) —

    operation results.



254
255
256
257
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/agent_pools.rb', line 254

def create_or_update(resource_group_name, resource_name, agent_pool_name, parameters, custom_headers:nil)
  response = create_or_update_async(resource_group_name, resource_name, agent_pool_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(resource_group_name, resource_name, agent_pool_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

agent pool operation. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • resource_name (String) —

    The name of the managed cluster resource.

  • agent_pool_name (String) —

    The name of the agent pool.

  • parameters (AgentPool) —

    Parameters supplied to the Create or Update an

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/agent_pools.rb', line 271

def create_or_update_async(resource_group_name, resource_name, agent_pool_name, parameters, custom_headers:nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, resource_name, agent_pool_name, parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::ContainerService::Mgmt::V2020_06_01::Models::AgentPool.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, resource_name, agent_pool_name, custom_headers: nil) ⇒ Object

Deletes an agent pool.

Deletes the agent pool in the specified managed cluster.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • resource_name (String) —

    The name of the managed cluster resource.

  • agent_pool_name (String) —

    The name of the agent pool.

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

    A hash of custom headers that



300
301
302
303
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/agent_pools.rb', line 300

def delete(resource_group_name, resource_name, agent_pool_name, custom_headers:nil)
  response = delete_async(resource_group_name, resource_name, agent_pool_name, custom_headers:custom_headers).value!
  nil
end

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

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • resource_name (String) —

    The name of the managed cluster resource.

  • agent_pool_name (String) —

    The name of the agent pool.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/agent_pools.rb', line 315

def delete_async(resource_group_name, resource_name, agent_pool_name, custom_headers:nil)
  # Send request
  promise = begin_delete_async(resource_group_name, resource_name, agent_pool_name, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

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

  promise
end

#get(resource_group_name, resource_name, agent_pool_name, custom_headers: nil) ⇒ AgentPool

Gets the agent pool.

Gets the details of the agent pool by managed cluster and resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • resource_name (String) —

    The name of the managed cluster resource.

  • agent_pool_name (String) —

    The name of the agent pool.

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

    A hash of custom headers that

Returns:

  • (AgentPool) —

    operation results.



144
145
146
147
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/agent_pools.rb', line 144

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

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

Gets the agent pool.

Gets the details of the agent pool by managed cluster and resource group.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • resource_name (String) —

    The name of the managed cluster resource.

  • agent_pool_name (String) —

    The name of the agent pool.

  • 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
232
233
234
235
236
237
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/agent_pools.rb', line 179

def get_async(resource_group_name, resource_name, agent_pool_name, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, 'resource_name is nil' if resource_name.nil?
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'MaxLength': '63'" if !resource_name.nil? && resource_name.length > 63
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'MinLength': '1'" if !resource_name.nil? && resource_name.length < 1
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$'" if !resource_name.nil? && resource_name.match(Regexp.new('^^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$$')).nil?
  fail ArgumentError, 'agent_pool_name is nil' if agent_pool_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.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}'

  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,'resourceName' => resource_name,'agentPoolName' => agent_pool_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::ContainerService::Mgmt::V2020_06_01::Models::AgentPool.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_available_agent_pool_versions(resource_group_name, resource_name, custom_headers: nil) ⇒ AgentPoolAvailableVersions

Gets a list of supported versions for the specified agent pool.

Gets a list of supported versions for the specified agent pool.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • resource_name (String) —

    The name of the managed cluster resource.

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

    A hash of custom headers that

Returns:

  • (AgentPoolAvailableVersions) —

    operation results.



454
455
456
457
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/agent_pools.rb', line 454

def get_available_agent_pool_versions(resource_group_name, resource_name, custom_headers:nil)
  response = get_available_agent_pool_versions_async(resource_group_name, resource_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_available_agent_pool_versions_async(resource_group_name, resource_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets a list of supported versions for the specified agent pool.

Gets a list of supported versions for the specified agent pool.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • resource_name (String) —

    The name of the managed cluster resource.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/agent_pools.rb', line 487

def get_available_agent_pool_versions_async(resource_group_name, resource_name, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, 'resource_name is nil' if resource_name.nil?
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'MaxLength': '63'" if !resource_name.nil? && resource_name.length > 63
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'MinLength': '1'" if !resource_name.nil? && resource_name.length < 1
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$'" if !resource_name.nil? && resource_name.match(Regexp.new('^^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$$')).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.ContainerService/managedClusters/{resourceName}/availableAgentPoolVersions'

  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,'resourceName' => resource_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::ContainerService::Mgmt::V2020_06_01::Models::AgentPoolAvailableVersions.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_available_agent_pool_versions_with_http_info(resource_group_name, resource_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a list of supported versions for the specified agent pool.

Gets a list of supported versions for the specified agent pool.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • resource_name (String) —

    The name of the managed cluster resource.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



471
472
473
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/agent_pools.rb', line 471

def get_available_agent_pool_versions_with_http_info(resource_group_name, resource_name, custom_headers:nil)
  get_available_agent_pool_versions_async(resource_group_name, resource_name, custom_headers:custom_headers).value!
end

#get_upgrade_profile(resource_group_name, resource_name, agent_pool_name, custom_headers: nil) ⇒ AgentPoolUpgradeProfile

Gets upgrade profile for an agent pool.

Gets the details of the upgrade profile for an agent pool with a specified resource group and managed cluster name.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • resource_name (String) —

    The name of the managed cluster resource.

  • agent_pool_name (String) —

    The name of the agent pool.

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

    A hash of custom headers that

Returns:

  • (AgentPoolUpgradeProfile) —

    operation results.



345
346
347
348
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/agent_pools.rb', line 345

def get_upgrade_profile(resource_group_name, resource_name, agent_pool_name, custom_headers:nil)
  response = get_upgrade_profile_async(resource_group_name, resource_name, agent_pool_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_upgrade_profile_async(resource_group_name, resource_name, agent_pool_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets upgrade profile for an agent pool.

Gets the details of the upgrade profile for an agent pool with a specified resource group and managed cluster name.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • resource_name (String) —

    The name of the managed cluster resource.

  • agent_pool_name (String) —

    The name of the agent pool.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/agent_pools.rb', line 382

def get_upgrade_profile_async(resource_group_name, resource_name, agent_pool_name, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, 'resource_name is nil' if resource_name.nil?
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'MaxLength': '63'" if !resource_name.nil? && resource_name.length > 63
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'MinLength': '1'" if !resource_name.nil? && resource_name.length < 1
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$'" if !resource_name.nil? && resource_name.match(Regexp.new('^^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$$')).nil?
  fail ArgumentError, 'agent_pool_name is nil' if agent_pool_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.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeProfiles/default'

  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,'resourceName' => resource_name,'agentPoolName' => agent_pool_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::ContainerService::Mgmt::V2020_06_01::Models::AgentPoolUpgradeProfile.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_upgrade_profile_with_http_info(resource_group_name, resource_name, agent_pool_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets upgrade profile for an agent pool.

Gets the details of the upgrade profile for an agent pool with a specified resource group and managed cluster name.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • resource_name (String) —

    The name of the managed cluster resource.

  • agent_pool_name (String) —

    The name of the agent pool.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



364
365
366
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/agent_pools.rb', line 364

def get_upgrade_profile_with_http_info(resource_group_name, resource_name, agent_pool_name, custom_headers:nil)
  get_upgrade_profile_async(resource_group_name, resource_name, agent_pool_name, custom_headers:custom_headers).value!
end

#get_with_http_info(resource_group_name, resource_name, agent_pool_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the agent pool.

Gets the details of the agent pool by managed cluster and resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • resource_name (String) —

    The name of the managed cluster resource.

  • agent_pool_name (String) —

    The name of the agent pool.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



162
163
164
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/agent_pools.rb', line 162

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

#list(resource_group_name, resource_name, custom_headers: nil) ⇒ Array<AgentPool>

Gets a list of agent pools in the specified managed cluster.

Gets a list of agent pools in the specified managed cluster. The operation returns properties of each agent pool.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • resource_name (String) —

    The name of the managed cluster resource.

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

    A hash of custom headers that

Returns:

  • (Array<AgentPool>) —

    operation results.



37
38
39
40
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/agent_pools.rb', line 37

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

#list_as_lazy(resource_group_name, resource_name, custom_headers: nil) ⇒ AgentPoolListResult

Gets a list of agent pools in the specified managed cluster.

Gets a list of agent pools in the specified managed cluster. The operation returns properties of each agent pool.

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • resource_name (String) —

    The name of the managed cluster resource.

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

    A hash of custom headers that

Returns:

  • (AgentPoolListResult) —

    which provide lazy access to pages of the



888
889
890
891
892
893
894
895
896
897
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/agent_pools.rb', line 888

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

Gets a list of agent pools in the specified managed cluster.

Gets a list of agent pools in the specified managed cluster. The operation returns properties of each agent pool.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • resource_name (String) —

    The name of the managed cluster resource.

  • 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
124
125
126
127
128
129
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/agent_pools.rb', line 72

def list_async(resource_group_name, resource_name, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, 'resource_name is nil' if resource_name.nil?
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'MaxLength': '63'" if !resource_name.nil? && resource_name.length > 63
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'MinLength': '1'" if !resource_name.nil? && resource_name.length < 1
  fail ArgumentError, "'resource_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$'" if !resource_name.nil? && resource_name.match(Regexp.new('^^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$$')).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.ContainerService/managedClusters/{resourceName}/agentPools'

  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,'resourceName' => resource_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::ContainerService::Mgmt::V2020_06_01::Models::AgentPoolListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_next(next_page_link, custom_headers: nil) ⇒ AgentPoolListResult

Gets a list of agent pools in the specified managed cluster.

Gets a list of agent pools in the specified managed cluster. The operation returns properties of each agent pool.

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:

  • (AgentPoolListResult) —

    operation results.



788
789
790
791
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/agent_pools.rb', line 788

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

Gets a list of agent pools in the specified managed cluster.

Gets a list of agent pools in the specified managed cluster. The operation returns properties of each agent pool.

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.



823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/agent_pools.rb', line 823

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::ContainerService::Mgmt::V2020_06_01::Models::AgentPoolListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a list of agent pools in the specified managed cluster.

Gets a list of agent pools in the specified managed cluster. The operation returns properties of each agent pool.

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.



806
807
808
 
# File 'lib/2020-06-01/generated/azure_mgmt_container_service/agent_pools.rb', line 806

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

Gets a list of agent pools in the specified managed cluster.

Gets a list of agent pools in the specified managed cluster. The operation returns properties of each agent pool.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • resource_name (String) —

    The name of the managed cluster resource.

  • 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/2020-06-01/generated/azure_mgmt_container_service/agent_pools.rb', line 55

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