Microsoft.ContainerService managedClusters/agentPools 2020-09-01

The managedClusters/agentPools resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.ContainerService/managedClusters/agentPools resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.ContainerService/managedClusters/agentPools@2020-09-01' = {
  name: 'string'
  parent: parentSymbolicName
  properties: {
    availabilityZones: [ 'string' ]
    count: int
    enableAutoScaling: bool
    enableNodePublicIP: bool
    maxCount: int
    maxPods: int
    minCount: int
    mode: 'string'
    nodeLabels: {}
    nodeTaints: [ 'string' ]
    orchestratorVersion: 'string'
    osDiskSizeGB: int
    osDiskType: 'string'
    osType: 'string'
    proximityPlacementGroupID: 'string'
    scaleSetEvictionPolicy: 'string'
    scaleSetPriority: 'string'
    spotMaxPrice: int
    tags: {
      tagName1: 'tagValue1'
      tagName2: 'tagValue2'
    type: 'string'
    upgradeSettings: {
      maxSurge: 'string'
    vmSize: 'string'
    vnetSubnetID: 'string'

Property values


Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
properties Properties for the container service agent pool profile. ManagedClusterAgentPoolProfileProperties


Name Description Value
availabilityZones Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. string[]
count Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 100 (inclusive) for user pools and in the range of 1 to 100 (inclusive) for system pools. The default value is 1. int
enableAutoScaling Whether to enable auto-scaler bool
enableNodePublicIP Enable public IP for nodes bool
maxCount Maximum number of nodes for auto-scaling int
maxPods Maximum number of pods that can run on a node. int
minCount Minimum number of nodes for auto-scaling int
mode AgentPoolMode represents mode of an agent pool. 'System'
nodeLabels Agent pool node labels to be persisted across all nodes in agent pool. object
nodeTaints Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. string[]
orchestratorVersion Version of orchestrator specified when creating the managed cluster. string
osDiskSizeGB OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. int
osDiskType OSDiskType represents the type of an OS disk on an agent pool. 'Ephemeral'
osType OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. 'Linux'
proximityPlacementGroupID The ID for Proximity Placement Group. string
scaleSetEvictionPolicy ScaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set. Default to Delete. 'Deallocate'
scaleSetPriority ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. 'Regular'
spotMaxPrice SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. int
tags Agent pool tags to be persisted on the agent pool virtual machine scale set. Dictionary of tag names and values. See Tags in templates
type AgentPoolType represents types of an agent pool. 'AvailabilitySet'
upgradeSettings Settings for upgrading an agentpool AgentPoolUpgradeSettings
vmSize Size of agent VMs. 'Standard_A1'
vnetSubnetID VNet SubnetID specifies the VNet's subnet identifier. string


Name Description Value
maxSurge Count or percentage of additional nodes to be added during upgrade. If empty uses AKS default string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Deploy an AKS cluster for Azure ML

Deploy to Azure
This template allows you to deploy an entreprise compliant AKS cluster which can be attached to Azure ML