agent_pools

Creates, updates, deletes, gets or lists an agent_pools resource.

Overview

Name	agent_pools
Type	Resource
Id	azure.aks.agent_pools

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties	object	Properties of an agent pool.
type	string	Resource type

list

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties	object	Properties of an agent pool.
type	string	Resource type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, resourceName, agentPoolName
list	select	subscriptionId, resourceGroupName, resourceName
create_or_update	insert	subscriptionId, resourceGroupName, resourceName, agentPoolName
delete	delete	subscriptionId, resourceGroupName, resourceName, agentPoolName
abort_latest_operation	exec	subscriptionId, resourceGroupName, resourceName, agentPoolName		Aborts the currently running operation on the agent pool. The Agent Pool will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, a 409 error code is returned.
upgrade_node_image_version	exec	subscriptionId, resourceGroupName, resourceName, agentPoolName		Upgrading the node image version of an agent pool applies the newest OS and runtime updates to the nodes. AKS provides one new image per week with the latest updates. For more details on node image versions, see: https://docs.microsoft.com/azure/aks/node-image-upgrade

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
agentPoolName	string	The name of the agent pool.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
resourceName	string	The name of the managed cluster resource.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

OK

SELECT
id,
name,
properties,
type
FROM azure.aks.agent_pools
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND agentPoolName = '{{ agentPoolName }}' -- required
;

list

OK

SELECT
id,
name,
properties,
type
FROM azure.aks.agent_pools
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
;

INSERT examples

create_or_update

No description available.

INSERT INTO azure.aks.agent_pools (
data__properties,
subscriptionId,
resourceGroupName,
resourceName,
agentPoolName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ agentPoolName }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: agent_pools
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the agent_pools resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the agent_pools resource.
    - name: resourceName
      value: string
      description: Required parameter for the agent_pools resource.
    - name: agentPoolName
      value: string
      description: Required parameter for the agent_pools resource.
    - name: properties
      value: object
      description: |
        Properties of an agent pool.

DELETE examples

delete

No description available.

DELETE FROM azure.aks.agent_pools
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
AND agentPoolName = '{{ agentPoolName }}' --required
;

Lifecycle Methods

abort_latest_operation

Aborts the currently running operation on the agent pool. The Agent Pool will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, a 409 error code is returned.

EXEC azure.aks.agent_pools.abort_latest_operation 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@resourceName='{{ resourceName }}' --required, 
@agentPoolName='{{ agentPoolName }}' --required
;

upgrade_node_image_version

Upgrading the node image version of an agent pool applies the newest OS and runtime updates to the nodes. AKS provides one new image per week with the latest updates. For more details on node image versions, see: https://docs.microsoft.com/azure/aks/node-image-upgrade

EXEC azure.aks.agent_pools.upgrade_node_image_version 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@resourceName='{{ resourceName }}' --required, 
@agentPoolName='{{ agentPoolName }}' --required
;