Skip to main content

agent_pools

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

Overview​

Nameagent_pools
TypeResource
Idazure.container_service.agent_pools

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringFully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
namestringThe name of the resource.
artifactStreamingProfileobjectConfiguration for using artifact streaming on AKS.
availabilityZonesarrayThe list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'.
capacityReservationGroupIDstringThe fully qualified resource ID of the Capacity Reservation Group to provide virtual machines from a reserved group of Virtual Machines. This is of the form: '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Compute/capacityreservationgroups/{capacityReservationGroupName}' Customers use it to create an agentpool with a specified CRG. For more information see Capacity Reservation _.
countintegerNumber of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1.
creationDataobjectCreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot.
currentOrchestratorVersionstringThe version of Kubernetes the Agent Pool is running. If orchestratorVersion is a fully specified version , this field will be exactly equal to it. If orchestratorVersion is , this field will contain the full version being used.
eTagstringUnique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal eTag convention.
enableAutoScalingbooleanWhether to enable auto-scaler.
enableEncryptionAtHostbooleanWhether to enable host based OS and data drive encryption. This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption _.
enableFIPSbooleanWhether to use a FIPS-enabled OS. See Add a FIPS-enabled node pool _ for more details.
enableNodePublicIPbooleanWhether each node is allocated its own public IP. Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see assigning a public IP per node _. The default is false.
enableOSDiskFullCachingbooleanWhether to enable the full-cache ephemeral OS disk feature. When this feature is enabled, the entire operating system will be locally cached on the ephemeral OS disk, preventing E17 events caused by network failures.
enableUltraSSDbooleanWhether to enable UltraSSD.
gatewayProfileobjectProfile specific to a managed agent pool in Gateway mode. This field cannot be set if agent pool mode is not Gateway.
gpuInstanceProfilestringGPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. Known values are: "MIG1g", "MIG2g", "MIG3g", "MIG4g", and "MIG7g". (MIG1g, MIG2g, MIG3g, MIG4g, MIG7g)
gpuProfileobjectGPU settings for the Agent Pool.
hostGroupIDstringThe fully qualified resource ID of the Dedicated Host Group to provision virtual machines from, used only in creation scenario and not allowed to changed once set. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see Azure dedicated hosts _.
kubeletConfigobjectThe Kubelet configuration on the agent pool nodes.
kubeletDiskTypestringDetermines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. Known values are: "OS" and "Temporary". (OS, Temporary)
linuxOSConfigobjectThe OS configuration of Linux agent nodes.
localDNSProfileobjectConfigures the per-node local DNS, with VnetDNS and KubeDNS overrides. LocalDNS helps improve performance and reliability of DNS resolution in an AKS cluster. For more details see aka.ms/aks/localdns.
maxCountintegerThe maximum number of nodes for auto-scaling.
maxPodsintegerThe maximum number of pods that can run on a node.
messageOfTheDaystringMessage of the day for Linux nodes, base64-encoded. A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script).
minCountintegerThe minimum number of nodes for auto-scaling.
modestringThe mode of an agent pool. A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools _. Known values are: "System", "User", "Gateway", "ManagedSystem", and "Machines". (System, User, Gateway, ManagedSystem, Machines)
networkProfileobjectNetwork-related settings of an agent pool.
nodeImageVersionstringThe version of the node image. Setting this value triggers an agentPool rollback. Only values from recentlyUsedVersions are allowed.
nodeInitializationTaintsarrayTaints added on the nodes during creation that will not be reconciled by AKS. These taints will not be reconciled by AKS and can be removed with a kubectl call. This field can be modified after node pool is created, but nodes will not be recreated with new taints until another operation that requires recreation (e.g. node image upgrade) happens. These taints allow for required configuration to run before the node is ready to accept workloads, for example 'key1=value1:NoSchedule' that then can be removed with kubectl taint nodes node1 key1=value1:NoSchedule-.
nodeLabelsobjectThe node labels to be persisted across all nodes in agent pool.
nodePublicIPPrefixIDstringThe public IP prefix ID which VM nodes should use IPs from. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}.
nodeTaintsarrayThe taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.
orchestratorVersionstringThe version of Kubernetes specified by the user. Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see upgrading a node pool _.
osDiskSizeGBintegerOS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified.
osDiskTypestringThe OS disk type to be used for machines in the agent pool. The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see Ephemeral OS _. Known values are: "Managed" and "Ephemeral". (Managed, Ephemeral)
osSKUstringSpecifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows. Known values are: "Ubuntu", "AzureLinux", "AzureLinux3", "Mariner", "Flatcar", "CBLMariner", "Windows2019", "Windows2022", "Ubuntu2204", "Windows2025", "WindowsAnnual", "Ubuntu2404", and "AzureContainerLinux". (Ubuntu, AzureLinux, AzureLinux3, Mariner, Flatcar, CBLMariner, Windows2019, Windows2022, Ubuntu2204, Windows2025, WindowsAnnual, Ubuntu2404, AzureContainerLinux)
osTypestringThe operating system type. The default is Linux. Known values are: "Linux" and "Windows". (Linux, Windows)
podIPAllocationModestringPod IP Allocation Mode. The IP allocation mode for pods in the agent pool. Must be used with podSubnetId. The default is 'DynamicIndividual'. Known values are: "DynamicIndividual" and "StaticBlock". (DynamicIndividual, StaticBlock)
podSubnetIDstringThe ID of the subnet which pods will join when launched. If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
powerStateobjectWhether the Agent Pool is running or stopped. When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded.
preparedImageSpecificationProfileobjectSettings to determine the prepared image specification used to provision nodes in a pool.
provisioningStatestringThe current deployment or provisioning state.
proximityPlacementGroupIDstringThe ID for Proximity Placement Group.
scaleDownModestringThe scale down mode to use when scaling the Agent Pool. This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete. Known values are: "Delete" and "Deallocate". (Delete, Deallocate)
scaleSetEvictionPolicystringThe Virtual Machine Scale Set eviction policy. The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see spot VMs _. Known values are: "Delete" and "Deallocate". (Delete, Deallocate)
scaleSetPrioritystringThe Virtual Machine Scale Set priority. Known values are: "Spot" and "Regular". (Spot, Regular)
securityProfileobjectThe security settings of an agent pool.
spotMaxPricenumberThe max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see spot VMs pricing _.
statusobjectContains read-only information about the Agent Pool.
systemDataobjectAzure Resource Manager metadata containing createdBy and modifiedBy information.
tagsobjectThe tags to be persisted on the agent pool virtual machine scale set.
typestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
upgradeSettingsobjectSettings for upgrading the agentpool.
upgradeSettingsBlueGreenobjectSettings for Blue-Green upgrade on the agentpool. Applies when upgrade strategy is set to BlueGreen.
upgradeStrategystringDefines the upgrade strategy for the agent pool. The default is Rolling. Known values are: "Rolling" and "BlueGreen". (Rolling, BlueGreen)
virtualMachineNodesStatusarrayThe status of nodes in a VirtualMachines agent pool.
virtualMachinesProfileobjectSpecifications on VirtualMachines agent pool.
vmSizestringThe size of the agent pool VMs. VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions _.
vnetSubnetIDstringThe ID of the subnet which agent pool nodes and optionally pods will join on startup. If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
windowsProfileobjectThe Windows agent pool's specific profile.
workloadRuntimestringDetermines the type of workload a node can run. Known values are: "OCIContainer", "WasmWasi", "KataMshvVmIsolation", and "KataVmIsolation". (OCIContainer, WasmWasi, KataMshvVmIsolation, KataVmIsolation)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectresource_group_name, resource_name, agent_pool_name, subscription_idGets the specified managed cluster agent pool.
listselectresource_group_name, resource_name, subscription_idGets a list of agent pools in the specified managed cluster.
create_or_updateinsertresource_group_name, resource_name, agent_pool_name, subscription_idCreates or updates an agent pool in the specified managed cluster.
create_or_updatereplaceresource_group_name, resource_name, agent_pool_name, subscription_idCreates or updates an agent pool in the specified managed cluster.
deletedeleteresource_group_name, resource_name, agent_pool_name, subscription_idignore-pod-disruption-budgetDeletes an agent pool in the specified managed cluster.
get_available_agent_pool_versionsexecresource_group_name, resource_name, subscription_idGets a list of supported Kubernetes versions for the specified agent pool. See supported Kubernetes versions _ for more details about the version lifecycle.
get_upgrade_profileexecresource_group_name, resource_name, agent_pool_name, subscription_idGets the upgrade profile for an agent pool.
abort_latest_operationexecresource_group_name, resource_name, agent_pool_name, subscription_idAborts last operation running on agent pool. 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.
complete_upgradeexecresource_group_name, resource_name, agent_pool_name, subscription_idCompletes the upgrade of an agent pool. Completes the upgrade operation for the specified agent pool.
delete_machinesexecresource_group_name, resource_name, agent_pool_name, subscription_id, machineNamesDeletes specific machines in an agent pool.
upgrade_node_image_versionexecresource_group_name, resource_name, agent_pool_name, subscription_idUpgrades the node image version of an agent pool to the latest. 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.

NameDatatypeDescription
agent_pool_namestringThe name of the agent pool. Required.
resource_group_namestringThe name of the resource group. The name is case insensitive. Required.
resource_namestringThe name of the managed cluster resource. Required.
subscription_idstring
ignore-pod-disruption-budgetbooleanignore-pod-disruption-budget=true to delete those pods on a node without considering Pod Disruption Budget. Default value is None.

SELECT examples​

Gets the specified managed cluster agent pool.

SELECT
id,
name,
artifactStreamingProfile,
availabilityZones,
capacityReservationGroupID,
count,
creationData,
currentOrchestratorVersion,
eTag,
enableAutoScaling,
enableEncryptionAtHost,
enableFIPS,
enableNodePublicIP,
enableOSDiskFullCaching,
enableUltraSSD,
gatewayProfile,
gpuInstanceProfile,
gpuProfile,
hostGroupID,
kubeletConfig,
kubeletDiskType,
linuxOSConfig,
localDNSProfile,
maxCount,
maxPods,
messageOfTheDay,
minCount,
mode,
networkProfile,
nodeImageVersion,
nodeInitializationTaints,
nodeLabels,
nodePublicIPPrefixID,
nodeTaints,
orchestratorVersion,
osDiskSizeGB,
osDiskType,
osSKU,
osType,
podIPAllocationMode,
podSubnetID,
powerState,
preparedImageSpecificationProfile,
provisioningState,
proximityPlacementGroupID,
scaleDownMode,
scaleSetEvictionPolicy,
scaleSetPriority,
securityProfile,
spotMaxPrice,
status,
systemData,
tags,
type,
upgradeSettings,
upgradeSettingsBlueGreen,
upgradeStrategy,
virtualMachineNodesStatus,
virtualMachinesProfile,
vmSize,
vnetSubnetID,
windowsProfile,
workloadRuntime
FROM azure.container_service.agent_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND agent_pool_name = '{{ agent_pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples​

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

INSERT INTO azure.container_service.agent_pools (
properties,
resource_group_name,
resource_name,
agent_pool_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ agent_pool_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

REPLACE examples​

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

REPLACE azure.container_service.agent_pools
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND agent_pool_name = '{{ agent_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples​

Deletes an agent pool in the specified managed cluster.

DELETE FROM azure.container_service.agent_pools
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND agent_pool_name = '{{ agent_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND ignore-pod-disruption-budget = '{{ ignore-pod-disruption-budget }}'
;

Lifecycle Methods​

Gets a list of supported Kubernetes versions for the specified agent pool. See supported Kubernetes versions _ for more details about the version lifecycle.

EXEC azure.container_service.agent_pools.get_available_agent_pool_versions 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;