agent_pool

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

Overview

Name	agent_pool
Type	Resource
Id	azure.hybrid_container_service.agent_pool

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
count	integer	Number of nodes in the agent pool. The default value is 1.
enableAutoScaling	boolean	Whether to enable auto-scaler. Default value is false.
extendedLocation	object	Extended location pointing to the underlying infrastructure.
kubernetesVersion	string	Version of Kubernetes in use by the agent pool. This is inherited from the kubernetesVersion of the provisioned cluster.
maxCount	integer	The maximum number of nodes for auto-scaling.
maxPods	integer	The maximum number of pods that can run on a node.
minCount	integer	The minimum number of nodes for auto-scaling.
nodeLabels	object	The node labels to be persisted across all nodes in agent pool.
nodeTaints	array	Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.
osSKU	string	Specifies the OS SKU used by the agent pool. The default is CBLMariner if OSType is Linux. The default is Windows2019 when OSType is Windows. Known values are: "CBLMariner", "Windows2019", and "Windows2022".
osType	string	The particular KubernetesVersion Image OS Type (Linux, Windows). Known values are: "Windows" and "Linux".
provisioningState	string	The status of the latest long running operation for the agent pool. Known values are: "Succeeded", "Failed", "Canceled", "Pending", "Creating", "Deleting", "Updating", "Upgrading", and "Accepted".
status	object	The observed status of the agent pool.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
vmSize	string	The VM sku size of the agent pool node VMs.

list_by_provisioned_cluster

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
count	integer	Number of nodes in the agent pool. The default value is 1.
enableAutoScaling	boolean	Whether to enable auto-scaler. Default value is false.
extendedLocation	object	Extended location pointing to the underlying infrastructure.
kubernetesVersion	string	Version of Kubernetes in use by the agent pool. This is inherited from the kubernetesVersion of the provisioned cluster.
maxCount	integer	The maximum number of nodes for auto-scaling.
maxPods	integer	The maximum number of pods that can run on a node.
minCount	integer	The minimum number of nodes for auto-scaling.
nodeLabels	object	The node labels to be persisted across all nodes in agent pool.
nodeTaints	array	Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.
osSKU	string	Specifies the OS SKU used by the agent pool. The default is CBLMariner if OSType is Linux. The default is Windows2019 when OSType is Windows. Known values are: "CBLMariner", "Windows2019", and "Windows2022".
osType	string	The particular KubernetesVersion Image OS Type (Linux, Windows). Known values are: "Windows" and "Linux".
provisioningState	string	The status of the latest long running operation for the agent pool. Known values are: "Succeeded", "Failed", "Canceled", "Pending", "Creating", "Deleting", "Updating", "Upgrading", and "Accepted".
status	object	The observed status of the agent pool.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
vmSize	string	The VM sku size of the agent pool node VMs.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	connected_cluster_resource_uri, agent_pool_name		Gets the specified agent pool in the provisioned cluster. Gets the specified agent pool in the provisioned cluster.
list_by_provisioned_cluster	select	connected_cluster_resource_uri		Gets the list of agent pools in the specified provisioned cluster. Gets the list of agent pools in the specified provisioned cluster.
create_or_update	insert	connected_cluster_resource_uri, agent_pool_name		Creates or updates the agent pool in the provisioned cluster. Creates or updates the agent pool in the provisioned cluster.
create_or_update	replace	connected_cluster_resource_uri, agent_pool_name		Creates or updates the agent pool in the provisioned cluster. Creates or updates the agent pool in the provisioned cluster.
delete	delete	connected_cluster_resource_uri, agent_pool_name		Deletes the specified agent pool in the provisioned cluster. Deletes the specified agent pool in the provisioned cluster.

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
agent_pool_name	string	Parameter for the name of the agent pool in the provisioned cluster. Required.
connected_cluster_resource_uri	string	The fully qualified Azure Resource Manager identifier of the connected cluster resource. Required.

SELECT examples

get

Gets the specified agent pool in the provisioned cluster. Gets the specified agent pool in the provisioned cluster.

SELECT
id,
name,
count,
enableAutoScaling,
extendedLocation,
kubernetesVersion,
maxCount,
maxPods,
minCount,
nodeLabels,
nodeTaints,
osSKU,
osType,
provisioningState,
status,
systemData,
tags,
type,
vmSize
FROM azure.hybrid_container_service.agent_pool
WHERE connected_cluster_resource_uri = '{{ connected_cluster_resource_uri }}' -- required
AND agent_pool_name = '{{ agent_pool_name }}' -- required
;

list_by_provisioned_cluster

Gets the list of agent pools in the specified provisioned cluster. Gets the list of agent pools in the specified provisioned cluster.

SELECT
id,
name,
count,
enableAutoScaling,
extendedLocation,
kubernetesVersion,
maxCount,
maxPods,
minCount,
nodeLabels,
nodeTaints,
osSKU,
osType,
provisioningState,
status,
systemData,
tags,
type,
vmSize
FROM azure.hybrid_container_service.agent_pool
WHERE connected_cluster_resource_uri = '{{ connected_cluster_resource_uri }}' -- required
;

INSERT examples

create_or_update

Creates or updates the agent pool in the provisioned cluster. Creates or updates the agent pool in the provisioned cluster.

INSERT INTO azure.hybrid_container_service.agent_pool (
properties,
tags,
extendedLocation,
connected_cluster_resource_uri,
agent_pool_name
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ extendedLocation }}',
'{{ connected_cluster_resource_uri }}',
'{{ agent_pool_name }}'
RETURNING
id,
name,
extendedLocation,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: agent_pool
props:
  - name: connected_cluster_resource_uri
    value: "{{ connected_cluster_resource_uri }}"
    description: Required parameter for the agent_pool resource.
  - name: agent_pool_name
    value: "{{ agent_pool_name }}"
    description: Required parameter for the agent_pool resource.
  - name: properties
    description: |
      Properties of the agent pool resource.
    value:
      osType: "{{ osType }}"
      osSKU: "{{ osSKU }}"
      nodeLabels: "{{ nodeLabels }}"
      nodeTaints:
        - "{{ nodeTaints }}"
      maxCount: {{ maxCount }}
      minCount: {{ minCount }}
      enableAutoScaling: {{ enableAutoScaling }}
      maxPods: {{ maxPods }}
      count: {{ count }}
      vmSize: "{{ vmSize }}"
      kubernetesVersion: "{{ kubernetesVersion }}"
      provisioningState: "{{ provisioningState }}"
      status:
        currentState: "{{ currentState }}"
        errorMessage: "{{ errorMessage }}"
        readyReplicas:
          - count: {{ count }}
            vmSize: "{{ vmSize }}"
            kubernetesVersion: "{{ kubernetesVersion }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: extendedLocation
    description: |
      Extended location pointing to the underlying infrastructure.
    value:
      type: "{{ type }}"
      name: "{{ name }}"

REPLACE examples

create_or_update

Creates or updates the agent pool in the provisioned cluster. Creates or updates the agent pool in the provisioned cluster.

REPLACE azure.hybrid_container_service.agent_pool
SET 
properties = '{{ properties }}',
tags = '{{ tags }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
connected_cluster_resource_uri = '{{ connected_cluster_resource_uri }}' --required
AND agent_pool_name = '{{ agent_pool_name }}' --required
RETURNING
id,
name,
extendedLocation,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes the specified agent pool in the provisioned cluster. Deletes the specified agent pool in the provisioned cluster.

DELETE FROM azure.hybrid_container_service.agent_pool
WHERE connected_cluster_resource_uri = '{{ connected_cluster_resource_uri }}' --required
AND agent_pool_name = '{{ agent_pool_name }}' --required
;