Share via

Agent Pools - Create Or Update

Service:
AKS
API Version:
2025-05-01

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

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}?api-version=2025-05-01

URI Parameters

Name In Required Type Description
agentPoolName
 path True

string

minLength: 1
maxLength: 12
pattern: ^[a-z][a-z0-9]{0,11}$

The name of the agent pool.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.
resourceName
 path True

string

minLength: 1
maxLength: 63
pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$

The name of the managed cluster resource.
subscriptionId
 path True

string (uuid)

The ID of the target subscription. The value must be an UUID.
api-version
 query True

string

minLength: 1

The API version to use for this operation.

Request Header

Name Required Type Description
If-Match

string

The request should only proceed if an entity matches this string.
If-None-Match

string

The request should only proceed if no entity matches this string.

Request Body

Name Type Description
properties.availabilityZones

string[]

The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'.
properties.capacityReservationGroupID

string (arm-id)

AKS will associate the specified agent pool with the Capacity Reservation Group.
properties.count

integer (int32)

Number 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.
properties.creationData

CreationData

CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot.
properties.enableAutoScaling

boolean

Whether to enable auto-scaler
properties.enableEncryptionAtHost

boolean

Whether 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
properties.enableFIPS

boolean

Whether to use a FIPS-enabled OS. See Add a FIPS-enabled node pool for more details.
properties.enableNodePublicIP

boolean

Whether 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.
properties.enableUltraSSD

boolean

Whether to enable UltraSSD
properties.gatewayProfile

AgentPoolGatewayProfile

Profile specific to a managed agent pool in Gateway mode. This field cannot be set if agent pool mode is not Gateway.
properties.gpuInstanceProfile

GPUInstanceProfile

GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.
properties.gpuProfile

GPUProfile

GPU settings for the Agent Pool.
properties.hostGroupID

string (arm-id)

The 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.
properties.kubeletConfig

KubeletConfig

The Kubelet configuration on the agent pool nodes.
properties.kubeletDiskType

KubeletDiskType

Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage.
properties.linuxOSConfig

LinuxOSConfig

The OS configuration of Linux agent nodes.
properties.maxCount

integer (int32)

The maximum number of nodes for auto-scaling
properties.maxPods

integer (int32)

The maximum number of pods that can run on a node.
properties.messageOfTheDay

string

Message 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).
properties.minCount

integer (int32)

The minimum number of nodes for auto-scaling
properties.mode

AgentPoolMode

The 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
properties.networkProfile

AgentPoolNetworkProfile

Network-related settings of an agent pool.
properties.nodeLabels

object

The node labels to be persisted across all nodes in agent pool.
properties.nodePublicIPPrefixID

string (arm-id)

The 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}
properties.nodeTaints

string[]

The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.
properties.orchestratorVersion

string

The version of Kubernetes specified by the user. Both patch version <major.minor.patch> (e.g. 1.20.13) and <major.minor> (e.g. 1.20) are supported. When <major.minor> is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same <major.minor> 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.
properties.osDiskSizeGB

integer (int32)

minimum: 0
maximum: 2048

OS 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.
properties.osDiskType

OSDiskType

The 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.
properties.osSKU

OSSKU

Specifies 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.
properties.osType

OSType

The operating system type. The default is Linux.
properties.podIPAllocationMode

PodIPAllocationMode

Pod IP Allocation Mode. The IP allocation mode for pods in the agent pool. Must be used with podSubnetId. The default is 'DynamicIndividual'.
properties.podSubnetID

string (arm-id)

The 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}
properties.powerState

PowerState

Whether 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
properties.proximityPlacementGroupID

string (arm-id)

The ID for Proximity Placement Group.
properties.scaleDownMode

ScaleDownMode

The scale down mode to use when scaling the Agent Pool. This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.
properties.scaleSetEvictionPolicy

ScaleSetEvictionPolicy

The Virtual Machine Scale Set eviction policy to use. This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'.
properties.scaleSetPriority

ScaleSetPriority

The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'.
properties.securityProfile

AgentPoolSecurityProfile

The security settings of an agent pool.
properties.spotMaxPrice

number

The 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
properties.status

AgentPoolStatus

Contains read-only information about the Agent Pool.
properties.tags

object

The tags to be persisted on the agent pool virtual machine scale set.
properties.type

AgentPoolType

The type of Agent Pool.
properties.upgradeSettings

AgentPoolUpgradeSettings

Settings for upgrading the agentpool
properties.virtualMachineNodesStatus

VirtualMachineNodes[]

The status of nodes in a VirtualMachines agent pool.
properties.virtualMachinesProfile

VirtualMachinesProfile

Specifications on VirtualMachines agent pool.
properties.vmSize

string

The 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
properties.vnetSubnetID

string (arm-id)

The 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}
properties.windowsProfile

AgentPoolWindowsProfile

The Windows agent pool's specific profile.
properties.workloadRuntime

WorkloadRuntime

Determines the type of workload a node can run.

Responses

Name Type Description
200 OK

AgentPool

The existing agent pool was successfully updated.
201 Created

AgentPool

The new agent pool was successfully created.
Other Status Codes

CloudError

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Create Agent Pool using an agent pool snapshot
Create Agent Pool with Capacity Reservation Group
Create Agent Pool with Dedicated Host Group
Create Agent Pool with EncryptionAtHost enabled
Create Agent Pool with Ephemeral OS Disk
Create Agent Pool with FIPS enabled OS
Create Agent Pool with GPUMIG
Create Agent Pool with Krustlet and the WASI runtime
Create Agent Pool with KubeletConfig and LinuxOSConfig
Create Agent Pool with Message of the Day
Create Agent Pool with OSSKU
Create Agent Pool with PPG
Create Agent Pool with UltraSSD enabled
Create Agent Pool with VirtualMachines pool type
Create Agent Pool with Windows OSSKU
Create Spot Agent Pool
Create Windows Agent Pool with disabling OutboundNAT
Create/Update Agent Pool
Start Agent Pool
Stop Agent Pool
Update Agent Pool

Create Agent Pool using an agent pool snapshot

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2025-05-01

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "enableFIPS": true,
    "creationData": {
      "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1"
    }
  }
}

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.19.6",
    "currentOrchestratorVersion": "1.19.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableFIPS": true,
    "creationData": {
      "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1"
    }
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.19.6",
    "currentOrchestratorVersion": "1.19.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableFIPS": true,
    "creationData": {
      "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1"
    }
  }
}

Create Agent Pool with Capacity Reservation Group

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2025-05-01

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1"
  }
}

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1"
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1"
  }
}

Create Agent Pool with Dedicated Host Group

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2025-05-01

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1"
  }
}

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.19.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1"
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.19.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1"
  }
}

Create Agent Pool with EncryptionAtHost enabled

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2025-05-01

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "enableEncryptionAtHost": true
  }
}

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.17.13",
    "currentOrchestratorVersion": "1.17.13",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableEncryptionAtHost": true
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.17.13",
    "currentOrchestratorVersion": "1.17.13",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableEncryptionAtHost": true
  }
}

Create Agent Pool with Ephemeral OS Disk

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2025-05-01

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "osDiskType": "Ephemeral",
    "osDiskSizeGB": 64
  }
}

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "osDiskType": "Ephemeral",
    "osDiskSizeGB": 64
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "osDiskType": "Ephemeral",
    "kubeletDiskType": "OS",
    "osDiskSizeGB": 64
  }
}

Create Agent Pool with FIPS enabled OS

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2025-05-01

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "enableFIPS": true
  }
}

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.19.6",
    "currentOrchestratorVersion": "1.19.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableFIPS": true
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.19.6",
    "currentOrchestratorVersion": "1.19.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableFIPS": true
  }
}

Create Agent Pool with GPUMIG

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2025-05-01

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_ND96asr_v4",
    "osType": "Linux",
    "gpuInstanceProfile": "MIG2g",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 12345,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_ND96asr_v4",
    "maxPods": 110,
    "osType": "Linux",
    "gpuInstanceProfile": "MIG2g",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 12345,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_ND96asr_v4",
    "maxPods": 110,
    "osType": "Linux",
    "gpuInstanceProfile": "MIG2g",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false,
      "podMaxPids": 100
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 65536,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}

Create Agent Pool with Krustlet and the WASI runtime

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2025-05-01

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "osDiskSizeGB": 64,
    "mode": "User",
    "workloadRuntime": "WasmWasi"
  }
}

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "osDiskSizeGB": 64,
    "mode": "User",
    "workloadRuntime": "WasmWasi"
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "osDiskSizeGB": 64,
    "mode": "User",
    "workloadRuntime": "WasmWasi"
  }
}

Create Agent Pool with KubeletConfig and LinuxOSConfig

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2025-05-01

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 12345,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 12345,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false,
      "podMaxPids": 100
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 65536,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}

Create Agent Pool with Message of the Day

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2025-05-01

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "osDiskSizeGB": 64,
    "mode": "User",
    "messageOfTheDay": "Zm9vCg=="
  }
}

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "osDiskSizeGB": 64,
    "mode": "User",
    "messageOfTheDay": "Zm9vCg=="
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "osDiskSizeGB": 64,
    "mode": "User",
    "messageOfTheDay": "Zm9vCg=="
  }
}

Create Agent Pool with OSSKU

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2025-05-01

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "osSKU": "AzureLinux",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 12345,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "osSKU": "AzureLinux",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 12345,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.17.8",
    "currentOrchestratorVersion": "1.17.8",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "osSKU": "AzureLinux",
    "kubeletConfig": {
      "cpuManagerPolicy": "static",
      "cpuCfsQuota": true,
      "cpuCfsQuotaPeriod": "200ms",
      "imageGcHighThreshold": 90,
      "imageGcLowThreshold": 70,
      "topologyManagerPolicy": "best-effort",
      "allowedUnsafeSysctls": [
        "kernel.msg*",
        "net.core.somaxconn"
      ],
      "failSwapOn": false,
      "podMaxPids": 100
    },
    "linuxOSConfig": {
      "sysctls": {
        "netCoreWmemDefault": 65536,
        "netIpv4TcpTwReuse": true,
        "netIpv4IpLocalPortRange": "20000 60000",
        "kernelThreadsMax": 99999
      },
      "transparentHugePageEnabled": "always",
      "transparentHugePageDefrag": "madvise",
      "swapFileSizeMB": 1500
    }
  }
}

Create Agent Pool with PPG

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2025-05-01

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1"
  }
}

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1"
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1"
  }
}

Create Agent Pool with UltraSSD enabled

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2025-05-01

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "osType": "Linux",
    "enableUltraSSD": true
  }
}

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.17.13",
    "currentOrchestratorVersion": "1.17.13",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableUltraSSD": true
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.17.13",
    "currentOrchestratorVersion": "1.17.13",
    "count": 3,
    "vmSize": "Standard_DS2_v2",
    "maxPods": 110,
    "osType": "Linux",
    "enableUltraSSD": true
  }
}

Create Agent Pool with VirtualMachines pool type

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2025-05-01

{
  "properties": {
    "orchestratorVersion": "1.9.6",
    "osType": "Linux",
    "tags": {
      "name1": "val1"
    },
    "nodeLabels": {
      "key1": "val1"
    },
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "type": "VirtualMachines",
    "virtualMachinesProfile": {
      "scale": {
        "manual": [
          {
            "size": "Standard_D2_v2",
            "count": 3
          },
          {
            "size": "Standard_D2_v3",
            "count": 2
          }
        ]
      }
    }
  }
}

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "maxPods": 110,
    "osType": "Linux",
    "tags": {
      "name1": "val1"
    },
    "nodeLabels": {
      "key1": "val1"
    },
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "type": "VirtualMachines",
    "virtualMachinesProfile": {
      "scale": {
        "manual": [
          {
            "size": "Standard_D2_v2",
            "count": 3
          },
          {
            "size": "Standard_D2_v3",
            "count": 2
          }
        ]
      }
    },
    "virtualMachineNodesStatus": [
      {
        "size": "Standard_D2_v2",
        "count": 3
      },
      {
        "size": "Standard_D2_v3",
        "count": 2
      }
    ],
    "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11"
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "maxPods": 110,
    "osType": "Linux",
    "tags": {
      "name1": "val1"
    },
    "nodeLabels": {
      "key1": "val1"
    },
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "type": "VirtualMachines",
    "virtualMachinesProfile": {
      "scale": {
        "manual": [
          {
            "size": "Standard_D2_v2",
            "count": 3
          },
          {
            "size": "Standard_D2_v3",
            "count": 2
          }
        ]
      }
    },
    "virtualMachineNodesStatus": [
      {
        "size": "Standard_D2_v2",
        "count": 3
      },
      {
        "size": "Standard_D2_v3",
        "count": 2
      }
    ],
    "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11"
  }
}

Create Agent Pool with Windows OSSKU

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2?api-version=2025-05-01

{
  "properties": {
    "orchestratorVersion": "1.23.3",
    "count": 3,
    "vmSize": "Standard_D4s_v3",
    "osType": "Windows",
    "osSKU": "Windows2022"
  }
}

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "wnp2",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.23.3",
    "currentOrchestratorVersion": "1.23.3",
    "count": 3,
    "vmSize": "Standard_D4s_v3",
    "maxPods": 110,
    "osType": "Windows",
    "osSKU": "Windows2022"
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "wnp2",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.23.3",
    "currentOrchestratorVersion": "1.23.3",
    "count": 3,
    "vmSize": "Standard_D4s_v3",
    "maxPods": 110,
    "osType": "Windows",
    "osSKU": "Windows2022"
  }
}

Create Spot Agent Pool

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2025-05-01

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS1_v2",
    "osType": "Linux",
    "tags": {
      "name1": "val1"
    },
    "nodeLabels": {
      "key1": "val1"
    },
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete"
  }
}

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "vmSize": "Standard_DS1_v2",
    "maxPods": 110,
    "osType": "Linux",
    "tags": {
      "name1": "val1"
    },
    "nodeLabels": {
      "key1": "val1"
    },
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete",
    "spotMaxPrice": -1
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "vmSize": "Standard_DS1_v2",
    "maxPods": 110,
    "osType": "Linux",
    "tags": {
      "name1": "val1"
    },
    "nodeLabels": {
      "key1": "val1"
    },
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete",
    "spotMaxPrice": -1
  }
}

Create Windows Agent Pool with disabling OutboundNAT

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2?api-version=2025-05-01

{
  "properties": {
    "orchestratorVersion": "1.23.8",
    "count": 3,
    "vmSize": "Standard_D4s_v3",
    "osType": "Windows",
    "osSKU": "Windows2022",
    "windowsProfile": {
      "disableOutboundNat": true
    }
  }
}

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "wnp2",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.23.8",
    "currentOrchestratorVersion": "1.23.8",
    "count": 3,
    "vmSize": "Standard_D4s_v3",
    "maxPods": 110,
    "osType": "Windows",
    "osSKU": "Windows2022",
    "windowsProfile": {
      "disableOutboundNat": true
    }
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "wnp2",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.23.8",
    "currentOrchestratorVersion": "1.23.8",
    "count": 3,
    "vmSize": "Standard_D4s_v3",
    "maxPods": 110,
    "osType": "Windows",
    "osSKU": "Windows2022",
    "windowsProfile": {
      "disableOutboundNat": true
    }
  }
}

Create/Update Agent Pool

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2025-05-01

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "vmSize": "Standard_DS1_v2",
    "osType": "Linux",
    "tags": {
      "name1": "val1"
    },
    "nodeLabels": {
      "key1": "val1"
    },
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete",
    "mode": "User"
  }
}

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "vmSize": "Standard_DS1_v2",
    "maxPods": 110,
    "osType": "Linux",
    "tags": {
      "name1": "val1"
    },
    "nodeLabels": {
      "key1": "val1"
    },
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete",
    "mode": "User",
    "nodeImageVersion": "AKSUbuntu:1604:2020.03.11"
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Creating",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "vmSize": "Standard_DS1_v2",
    "maxPods": 110,
    "osType": "Linux",
    "tags": {
      "name1": "val1"
    },
    "nodeLabels": {
      "key1": "val1"
    },
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete",
    "mode": "User"
  }
}

Start Agent Pool

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2025-05-01

{
  "properties": {
    "powerState": {
      "code": "Running"
    }
  }
}

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Starting",
    "count": 50,
    "enableAutoScaling": true,
    "minCount": 3,
    "maxCount": 55,
    "powerState": {
      "code": "Running"
    }
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Starting",
    "count": 50,
    "enableAutoScaling": true,
    "minCount": 3,
    "maxCount": 55,
    "powerState": {
      "code": "Running"
    }
  }
}

Stop Agent Pool

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2025-05-01

{
  "properties": {
    "powerState": {
      "code": "Stopped"
    }
  }
}

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Stopping",
    "count": 0,
    "enableAutoScaling": false,
    "minCount": null,
    "maxCount": null,
    "powerState": {
      "code": "Stopped"
    }
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Stopping",
    "count": 0,
    "enableAutoScaling": false,
    "minCount": null,
    "maxCount": null,
    "powerState": {
      "code": "Stopped"
    }
  }
}

Update Agent Pool

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1?api-version=2025-05-01

{
  "properties": {
    "orchestratorVersion": "",
    "count": 3,
    "enableAutoScaling": true,
    "minCount": 2,
    "maxCount": 2,
    "vmSize": "Standard_DS1_v2",
    "osType": "Linux",
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete"
  }
}

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Succeeded",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "enableAutoScaling": true,
    "minCount": 2,
    "maxCount": 2,
    "vmSize": "Standard_DS1_v2",
    "maxPods": 110,
    "osType": "Linux",
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete"
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
  "type": "Microsoft.ContainerService/managedClusters/agentPools",
  "name": "agentpool1",
  "properties": {
    "provisioningState": "Updating",
    "orchestratorVersion": "1.9.6",
    "currentOrchestratorVersion": "1.9.6",
    "count": 3,
    "enableAutoScaling": true,
    "minCount": 2,
    "maxCount": 2,
    "vmSize": "Standard_DS1_v2",
    "maxPods": 110,
    "osType": "Linux",
    "nodeTaints": [
      "Key1=Value1:NoSchedule"
    ],
    "scaleSetPriority": "Spot",
    "scaleSetEvictionPolicy": "Delete"
  }
}

Definitions

Name Description
AgentPool

Agent Pool.
AgentPoolGatewayProfile

Profile of the managed cluster gateway agent pool.
AgentPoolMode

The 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
AgentPoolNetworkProfile

Network settings of an agent pool.
AgentPoolSecurityProfile

The security settings of an agent pool.
AgentPoolStatus

Contains read-only information about the Agent Pool.
AgentPoolType

The type of Agent Pool.
AgentPoolUpgradeSettings

Settings for upgrading an agentpool
AgentPoolWindowsProfile

The Windows agent pool's specific profile.
CloudError

An error response from the Container service.
CloudErrorBody

An error response from the Container service.
code

Tells whether the cluster is Running or Stopped
CreationData

Data used when creating a target resource from a source resource.
GPUDriver

Whether to install GPU drivers. When it's not specified, default is Install.
GPUInstanceProfile

GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.
GPUProfile

GPU settings for the Agent Pool.
IPTag

Contains the IPTag associated with the object.
KubeletConfig

Kubelet configurations of agent nodes. See AKS custom node configuration for more details.
KubeletDiskType

Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage.
LinuxOSConfig

OS configurations of Linux agent nodes. See AKS custom node configuration for more details.
ManualScaleProfile

Specifications on number of machines.
OSDiskType

The 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.
OSSKU

Specifies 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.
OSType

The operating system type. The default is Linux.
PodIPAllocationMode

Pod IP Allocation Mode. The IP allocation mode for pods in the agent pool. Must be used with podSubnetId. The default is 'DynamicIndividual'.
PortRange

The port range.
PowerState

Describes the Power State of the cluster
Protocol

The network protocol of the port.
ScaleDownMode

Describes how VMs are added to or removed from Agent Pools. See billing states.
ScaleProfile

Specifications on how to scale a VirtualMachines agent pool.
ScaleSetEvictionPolicy

The 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
ScaleSetPriority

The Virtual Machine Scale Set priority.
SysctlConfig

Sysctl settings for Linux agent nodes.
UndrainableNodeBehavior

Defines the behavior for undrainable nodes during upgrade. The most common cause of undrainable nodes is Pod Disruption Budgets (PDBs), but other issues, such as pod termination grace period is exceeding the remaining per-node drain timeout or pod is still being in a running state, can also cause undrainable nodes.
VirtualMachineNodes

Current status on a group of nodes of the same vm size.
VirtualMachinesProfile

Specifications on VirtualMachines agent pool.
WorkloadRuntime

Determines the type of workload a node can run.

AgentPool

Object

Agent Pool.

Name Type Default value 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.availabilityZones

string[]

The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'.
properties.capacityReservationGroupID

string (arm-id)

AKS will associate the specified agent pool with the Capacity Reservation Group.
properties.count

integer (int32)

Number 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.
properties.creationData

CreationData

CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot.
properties.currentOrchestratorVersion

string

The version of Kubernetes the Agent Pool is running. If orchestratorVersion is a fully specified version <major.minor.patch>, this field will be exactly equal to it. If orchestratorVersion is <major.minor>, this field will contain the full <major.minor.patch> version being used.
properties.eTag

string

Unique 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.
properties.enableAutoScaling

boolean

Whether to enable auto-scaler
properties.enableEncryptionAtHost

boolean

Whether 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
properties.enableFIPS

boolean

Whether to use a FIPS-enabled OS. See Add a FIPS-enabled node pool for more details.
properties.enableNodePublicIP

boolean

Whether 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.
properties.enableUltraSSD

boolean

Whether to enable UltraSSD
properties.gatewayProfile

AgentPoolGatewayProfile

Profile specific to a managed agent pool in Gateway mode. This field cannot be set if agent pool mode is not Gateway.
properties.gpuInstanceProfile

GPUInstanceProfile

GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.
properties.gpuProfile

GPUProfile

GPU settings for the Agent Pool.
properties.hostGroupID

string (arm-id)

The 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.
properties.kubeletConfig

KubeletConfig

The Kubelet configuration on the agent pool nodes.
properties.kubeletDiskType

KubeletDiskType

Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage.
properties.linuxOSConfig

LinuxOSConfig

The OS configuration of Linux agent nodes.
properties.maxCount

integer (int32)

The maximum number of nodes for auto-scaling
properties.maxPods

integer (int32)

The maximum number of pods that can run on a node.
properties.messageOfTheDay

string

Message 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).
properties.minCount

integer (int32)

The minimum number of nodes for auto-scaling
properties.mode

AgentPoolMode

The 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
properties.networkProfile

AgentPoolNetworkProfile

Network-related settings of an agent pool.
properties.nodeImageVersion

string

The version of node image
properties.nodeLabels

object

The node labels to be persisted across all nodes in agent pool.
properties.nodePublicIPPrefixID

string (arm-id)

The 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}
properties.nodeTaints

string[]

The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.
properties.orchestratorVersion

string

The version of Kubernetes specified by the user. Both patch version <major.minor.patch> (e.g. 1.20.13) and <major.minor> (e.g. 1.20) are supported. When <major.minor> is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same <major.minor> 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.
properties.osDiskSizeGB

integer (int32)

minimum: 0
maximum: 2048

OS 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.
properties.osDiskType

OSDiskType

The 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.
properties.osSKU

OSSKU

Specifies 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.
properties.osType

OSType

Linux

The operating system type. The default is Linux.
properties.podIPAllocationMode

PodIPAllocationMode

Pod IP Allocation Mode. The IP allocation mode for pods in the agent pool. Must be used with podSubnetId. The default is 'DynamicIndividual'.
properties.podSubnetID

string (arm-id)

The 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}
properties.powerState

PowerState

Whether 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
properties.provisioningState

string

The current deployment or provisioning state.
properties.proximityPlacementGroupID

string (arm-id)

The ID for Proximity Placement Group.
properties.scaleDownMode

ScaleDownMode

The scale down mode to use when scaling the Agent Pool. This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.
properties.scaleSetEvictionPolicy

ScaleSetEvictionPolicy

Delete

The Virtual Machine Scale Set eviction policy to use. This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'.
properties.scaleSetPriority

ScaleSetPriority

Regular

The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'.
properties.securityProfile

AgentPoolSecurityProfile

The security settings of an agent pool.
properties.spotMaxPrice

number

-1

The 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
properties.status

AgentPoolStatus

Contains read-only information about the Agent Pool.
properties.tags

object

The tags to be persisted on the agent pool virtual machine scale set.
properties.type

AgentPoolType

The type of Agent Pool.
properties.upgradeSettings

AgentPoolUpgradeSettings

Settings for upgrading the agentpool
properties.virtualMachineNodesStatus

VirtualMachineNodes[]

The status of nodes in a VirtualMachines agent pool.
properties.virtualMachinesProfile

VirtualMachinesProfile

Specifications on VirtualMachines agent pool.
properties.vmSize

string

The 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
properties.vnetSubnetID

string (arm-id)

The 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}
properties.windowsProfile

AgentPoolWindowsProfile

The Windows agent pool's specific profile.
properties.workloadRuntime

WorkloadRuntime

Determines the type of workload a node can run.
type

string

Resource type

AgentPoolGatewayProfile

Object

Profile of the managed cluster gateway agent pool.

Name Type Default value Description
publicIPPrefixSize

integer (int32)

minimum: 28
maximum: 31 		31

The Gateway agent pool associates one public IPPrefix for each static egress gateway to provide public egress. The size of Public IPPrefix should be selected by the user. Each node in the agent pool is assigned with one IP from the IPPrefix. The IPPrefix size thus serves as a cap on the size of the Gateway agent pool. Due to Azure public IPPrefix size limitation, the valid value range is [28, 31] (/31 = 2 nodes/IPs, /30 = 4 nodes/IPs, /29 = 8 nodes/IPs, /28 = 16 nodes/IPs). The default value is 31.

AgentPoolMode

Enumeration

The 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

Value Description
System

System agent pools are primarily for hosting critical system pods such as CoreDNS and metrics-server. System agent pools osType must be Linux. System agent pools VM SKU must have at least 2vCPUs and 4GB of memory.
User

User agent pools are primarily for hosting your application pods.
Gateway

Gateway agent pools are dedicated to providing static egress IPs to pods. For more details, see https://aka.ms/aks/static-egress-gateway.

AgentPoolNetworkProfile

Object

Network settings of an agent pool.

Name Type Description
allowedHostPorts

PortRange[]

The port ranges that are allowed to access. The specified ranges are allowed to overlap.
applicationSecurityGroups

string[] (arm-id)

The IDs of the application security groups which agent pool will associate when created.
nodePublicIPTags

IPTag[]

IPTags of instance-level public IPs.

AgentPoolSecurityProfile

Object

The security settings of an agent pool.

Name Type Description
enableSecureBoot

boolean

Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false.
enableVTPM

boolean

vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false.

AgentPoolStatus

Object

Contains read-only information about the Agent Pool.

Name Type Description
provisioningError

CloudErrorBody

The error detail information of the agent pool. Preserves the detailed info of failure. If there was no error, this field is omitted.

AgentPoolType

Enumeration

The type of Agent Pool.

Value Description
VirtualMachineScaleSets

Create an Agent Pool backed by a Virtual Machine Scale Set.
AvailabilitySet

Use of this is strongly discouraged.
VirtualMachines

Create an Agent Pool backed by a Single Instance VM orchestration mode.

AgentPoolUpgradeSettings

Object

Settings for upgrading an agentpool

Name Type Description
drainTimeoutInMinutes

integer (int32)

minimum: 1
maximum: 1440

The drain timeout for a node. The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes.
maxSurge

string

The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 10%. For more information, including best practices, see: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster
maxUnavailable

string

The maximum number or percentage of nodes that can be simultaneously unavailable during upgrade. This can either be set to an integer (e.g. '1') or a percentage (e.g. '5%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 0. For more information, including best practices, see: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster
nodeSoakDurationInMinutes

integer (int32)

minimum: 0
maximum: 30

The soak duration for a node. The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes.
undrainableNodeBehavior

UndrainableNodeBehavior

Defines the behavior for undrainable nodes during upgrade. The most common cause of undrainable nodes is Pod Disruption Budgets (PDBs), but other issues, such as pod termination grace period is exceeding the remaining per-node drain timeout or pod is still being in a running state, can also cause undrainable nodes.

AgentPoolWindowsProfile

Object

The Windows agent pool's specific profile.

Name Type Description
disableOutboundNat

boolean

Whether to disable OutboundNAT in windows nodes. The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled.

CloudError

Object

An error response from the Container service.

Name Type Description
error

CloudErrorBody

Details about the error.

CloudErrorBody

Object

An error response from the Container service.

Name Type Description
code

string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details

CloudErrorBody[]

A list of additional details about the error.
message

string

A message describing the error, intended to be suitable for display in a user interface.
target

string

The target of the particular error. For example, the name of the property in error.

code

Enumeration

Tells whether the cluster is Running or Stopped

Value Description
Running

The cluster is running.
Stopped

The cluster is stopped.

CreationData

Object

Data used when creating a target resource from a source resource.

Name Type Description
sourceResourceId

string (arm-id)

This is the ARM ID of the source object to be used to create the target object.

GPUDriver

Enumeration

Whether to install GPU drivers. When it's not specified, default is Install.

Value Description
Install

Install driver.
None

Skip driver install.

GPUInstanceProfile

Enumeration

GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.

Value Description
MIG1g
MIG2g
MIG3g
MIG4g
MIG7g

GPUProfile

Object

GPU settings for the Agent Pool.

Name Type Description
driver

GPUDriver

Whether to install GPU drivers. When it's not specified, default is Install.

IPTag

Object

Contains the IPTag associated with the object.

Name Type Description
ipTagType

string

The IP tag type. Example: RoutingPreference.
tag

string

The value of the IP tag associated with the public IP. Example: Internet.

KubeletConfig

Object

Kubelet configurations of agent nodes. See AKS custom node configuration for more details.

Name Type Description
allowedUnsafeSysctls

string[]

Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in *).
containerLogMaxFiles

integer (int32)

minimum: 2

The maximum number of container log files that can be present for a container. The number must be ≥ 2.
containerLogMaxSizeMB

integer (int32)

The maximum size (e.g. 10Mi) of container log file before it is rotated.
cpuCfsQuota

boolean

If CPU CFS quota enforcement is enabled for containers that specify CPU limits. The default is true.
cpuCfsQuotaPeriod

string

The CPU CFS quota period value. The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'.
cpuManagerPolicy

string

The CPU Manager policy to use. The default is 'none'. See Kubernetes CPU management policies for more information. Allowed values are 'none' and 'static'.
failSwapOn

boolean

If set to true it will make the Kubelet fail to start if swap is enabled on the node.
imageGcHighThreshold

integer (int32)

The percent of disk usage after which image garbage collection is always run. To disable image garbage collection, set to 100. The default is 85%
imageGcLowThreshold

integer (int32)

The percent of disk usage before which image garbage collection is never run. This cannot be set higher than imageGcHighThreshold. The default is 80%
podMaxPids

integer (int32)

The maximum number of processes per pod.
topologyManagerPolicy

string

The Topology Manager policy to use. For more information see Kubernetes Topology Manager. The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'.

KubeletDiskType

Enumeration

Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage.

Value Description
OS

Kubelet will use the OS disk for its data.
Temporary

Kubelet will use the temporary disk for its data.

LinuxOSConfig

Object

OS configurations of Linux agent nodes. See AKS custom node configuration for more details.

Name Type Description
swapFileSizeMB

integer (int32)

The size in MB of a swap file that will be created on each node.
sysctls

SysctlConfig

Sysctl settings for Linux agent nodes.
transparentHugePageDefrag

string

Whether the kernel should make aggressive use of memory compaction to make more hugepages available. Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see Transparent Hugepages.
transparentHugePageEnabled

string

Whether transparent hugepages are enabled. Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see Transparent Hugepages.

ManualScaleProfile

Object

Specifications on number of machines.

Name Type Description
count

integer (int32)

Number of nodes.
size

string

VM size that AKS will use when creating and scaling e.g. 'Standard_E4s_v3', 'Standard_E16s_v3' or 'Standard_D16s_v5'.

OSDiskType

Enumeration

The 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.

Value Description
Managed

Azure replicates the operating system disk for a virtual machine to Azure storage to avoid data loss should the VM need to be relocated to another host. Since containers aren't designed to have local state persisted, this behavior offers limited value while providing some drawbacks, including slower node provisioning and higher read/write latency.
Ephemeral

Ephemeral OS disks are stored only on the host machine, just like a temporary disk. This provides lower read/write latency, along with faster node scaling and cluster upgrades.

OSSKU

Enumeration

Specifies 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.

Value Description
Ubuntu

Use Ubuntu as the OS for node images.
CBLMariner

Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead.
AzureLinux

Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information.
Windows2019

Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa.
Windows2022

Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa.
Ubuntu2204

Use Ubuntu2204 as the OS for node images, however, Ubuntu 22.04 may not be supported for all nodepools. For limitations and supported kubernetes versions, see see https://aka.ms/aks/supported-ubuntu-versions

OSType

Enumeration

The operating system type. The default is Linux.

Value Description
Linux

Use Linux.
Windows

Use Windows.

PodIPAllocationMode

Enumeration

Pod IP Allocation Mode. The IP allocation mode for pods in the agent pool. Must be used with podSubnetId. The default is 'DynamicIndividual'.

Value Description
DynamicIndividual

Each node gets allocated with a non-contiguous list of IP addresses assignable to pods. This is better for maximizing a small to medium subnet of size /16 or smaller. The Azure CNI cluster with dynamic IP allocation defaults to this mode if the customer does not explicitly specify a podIPAllocationMode
StaticBlock

Each node is statically allocated CIDR block(s) of size /28 = 16 IPs per block to satisfy the maxPods per node. Number of CIDR blocks >= (maxPods / 16). The block, rather than a single IP, counts against the Azure Vnet Private IP limit of 65K. Therefore block mode is suitable for running larger workloads with more than the current limit of 65K pods in a cluster. This mode is better suited to scale with larger subnets of /15 or bigger

PortRange

Object

The port range.

Name Type Description
portEnd

integer (int32)

minimum: 1
maximum: 65535

The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart.
portStart

integer (int32)

minimum: 1
maximum: 65535

The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd.
protocol

Protocol

The network protocol of the port.

PowerState

Object

Describes the Power State of the cluster

Name Type Description
code

code

Tells whether the cluster is Running or Stopped

Protocol

Enumeration

The network protocol of the port.

Value Description
TCP

TCP protocol.
UDP

UDP protocol.

ScaleDownMode

Enumeration

Describes how VMs are added to or removed from Agent Pools. See billing states.

Value Description
Delete

Create new instances during scale up and remove instances during scale down.
Deallocate

Attempt to start deallocated instances (if they exist) during scale up and deallocate instances during scale down.

ScaleProfile

Object

Specifications on how to scale a VirtualMachines agent pool.

Name Type Description
manual

ManualScaleProfile[]

Specifications on how to scale the VirtualMachines agent pool to a fixed size.

ScaleSetEvictionPolicy

Enumeration

The 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

Value Description
Delete

Nodes in the underlying Scale Set of the node pool are deleted when they're evicted.
Deallocate

Nodes in the underlying Scale Set of the node pool are set to the stopped-deallocated state upon eviction. Nodes in the stopped-deallocated state count against your compute quota and can cause issues with cluster scaling or upgrading.

ScaleSetPriority

Enumeration

The Virtual Machine Scale Set priority.

Value Description
Spot

Spot priority VMs will be used. There is no SLA for spot nodes. See spot on AKS for more information.
Regular

Regular VMs will be used.

SysctlConfig

Object

Sysctl settings for Linux agent nodes.

Name Type Description
fsAioMaxNr

integer (int32)

Sysctl setting fs.aio-max-nr.
fsFileMax

integer (int32)

Sysctl setting fs.file-max.
fsInotifyMaxUserWatches

integer (int32)

Sysctl setting fs.inotify.max_user_watches.
fsNrOpen

integer (int32)

Sysctl setting fs.nr_open.
kernelThreadsMax

integer (int32)

Sysctl setting kernel.threads-max.
netCoreNetdevMaxBacklog

integer (int32)

Sysctl setting net.core.netdev_max_backlog.
netCoreOptmemMax

integer (int32)

Sysctl setting net.core.optmem_max.
netCoreRmemDefault

integer (int32)

Sysctl setting net.core.rmem_default.
netCoreRmemMax

integer (int32)

Sysctl setting net.core.rmem_max.
netCoreSomaxconn

integer (int32)

Sysctl setting net.core.somaxconn.
netCoreWmemDefault

integer (int32)

Sysctl setting net.core.wmem_default.
netCoreWmemMax

integer (int32)

Sysctl setting net.core.wmem_max.
netIpv4IpLocalPortRange

string

Sysctl setting net.ipv4.ip_local_port_range.
netIpv4NeighDefaultGcThresh1

integer (int32)

Sysctl setting net.ipv4.neigh.default.gc_thresh1.
netIpv4NeighDefaultGcThresh2

integer (int32)

Sysctl setting net.ipv4.neigh.default.gc_thresh2.
netIpv4NeighDefaultGcThresh3

integer (int32)

Sysctl setting net.ipv4.neigh.default.gc_thresh3.
netIpv4TcpFinTimeout

integer (int32)

Sysctl setting net.ipv4.tcp_fin_timeout.
netIpv4TcpKeepaliveProbes

integer (int32)

Sysctl setting net.ipv4.tcp_keepalive_probes.
netIpv4TcpKeepaliveTime

integer (int32)

Sysctl setting net.ipv4.tcp_keepalive_time.
netIpv4TcpMaxSynBacklog

integer (int32)

Sysctl setting net.ipv4.tcp_max_syn_backlog.
netIpv4TcpMaxTwBuckets

integer (int32)

Sysctl setting net.ipv4.tcp_max_tw_buckets.
netIpv4TcpTwReuse

boolean

Sysctl setting net.ipv4.tcp_tw_reuse.
netIpv4TcpkeepaliveIntvl

integer (int32)

minimum: 10
maximum: 90

Sysctl setting net.ipv4.tcp_keepalive_intvl.
netNetfilterNfConntrackBuckets

integer (int32)

minimum: 65536
maximum: 524288

Sysctl setting net.netfilter.nf_conntrack_buckets.
netNetfilterNfConntrackMax

integer (int32)

minimum: 131072
maximum: 2097152

Sysctl setting net.netfilter.nf_conntrack_max.
vmMaxMapCount

integer (int32)

Sysctl setting vm.max_map_count.
vmSwappiness

integer (int32)

Sysctl setting vm.swappiness.
vmVfsCachePressure

integer (int32)

Sysctl setting vm.vfs_cache_pressure.

UndrainableNodeBehavior

Enumeration

Defines the behavior for undrainable nodes during upgrade. The most common cause of undrainable nodes is Pod Disruption Budgets (PDBs), but other issues, such as pod termination grace period is exceeding the remaining per-node drain timeout or pod is still being in a running state, can also cause undrainable nodes.

Value Description
Schedule

AKS will mark the blocked nodes schedulable, but the blocked nodes are not upgraded. A best-effort attempt will be made to delete all surge nodes. The upgrade operation and the managed cluster will be in failed state if there are any blocked nodes.
Cordon

AKS will cordon the blocked nodes and replace them with surge nodes during upgrade. The blocked nodes will be cordoned and replaced by surge nodes. The blocked nodes will have label 'kubernetes.azure.com/upgrade-status:Quarantined'. A surge node will be retained for each blocked node. A best-effort attempt will be made to delete all other surge nodes. If there are enough surge nodes to replace blocked nodes, then the upgrade operation and the managed cluster will be in failed state. Otherwise, the upgrade operation and the managed cluster will be in canceled state.

VirtualMachineNodes

Object

Current status on a group of nodes of the same vm size.

Name Type Description
count

integer (int32)

Number of nodes.
size

string

The VM size of the agents used to host this group of nodes.

VirtualMachinesProfile

Object

Specifications on VirtualMachines agent pool.

Name Type Description
scale

ScaleProfile

Specifications on how to scale a VirtualMachines agent pool.

WorkloadRuntime

Enumeration

Determines the type of workload a node can run.

Value Description
OCIContainer

Nodes will use Kubelet to run standard OCI container workloads.
WasmWasi

Nodes will use Krustlet to run WASM workloads using the WASI provider (Preview).