AgentPool interface

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

availabilityZones?: string[]

Property Value

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

capacityReservationGroupID?: string

Property Value

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.

count?: number

Property Value

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

creationData?: CreationData

Property Value

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. NOTE: This property will not be serialized. It can only be populated by the server.

currentOrchestratorVersion?: string

Property Value

Whether to enable auto-scaler

enableAutoScaling?: boolean

Property Value

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

enableEncryptionAtHost?: boolean

Property Value

See Add a FIPS-enabled node pool for more details.

enableFips?: boolean

Property Value

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.

enableNodePublicIP?: boolean

Property Value

Whether to enable UltraSSD

enableUltraSSD?: boolean

Property Value

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

gpuInstanceProfile?: string

Property Value

This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see Azure dedicated hosts.

hostGroupID?: string

Property Value

The Kubelet configuration on the agent pool nodes.

kubeletConfig?: KubeletConfig

Property Value

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

kubeletDiskType?: string

Property Value

The OS configuration of Linux agent nodes.

linuxOSConfig?: LinuxOSConfig

Property Value

The maximum number of nodes for auto-scaling

maxCount?: number

Property Value

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

maxPods?: number

Property Value

The minimum number of nodes for auto-scaling

minCount?: number

Property Value

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

mode?: string

Property Value

Network-related settings of an agent pool.

networkProfile?: AgentPoolNetworkProfile

Property Value

The version of node image NOTE: This property will not be serialized. It can only be populated by the server.

nodeImageVersion?: string

Property Value

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

nodeLabels?: {[propertyName: string]: string}

Property Value

This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}

nodePublicIPPrefixID?: string

Property Value

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

nodeTaints?: string[]

Property Value

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.

orchestratorVersion?: string

Property Value

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.

osDiskSizeGB?: number

Property Value

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.

osDiskType?: string

Property Value

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.

osSKU?: string

Property Value

The operating system type. The default is Linux.

osType?: string

Property Value

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}

podSubnetID?: string

Property Value

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

powerState?: PowerState

Property Value

The current deployment or provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

The ID for Proximity Placement Group.

proximityPlacementGroupID?: string

Property Value

This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.

scaleDownMode?: string

Property Value

This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'.

scaleSetEvictionPolicy?: string

Property Value

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

scaleSetPriority?: string

Property Value

The security settings of an agent pool.

securityProfile?: AgentPoolSecurityProfile

Property Value

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

spotMaxPrice?: number

Property Value

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

tags?: {[propertyName: string]: string}

Property Value

The type of Agent Pool.

typePropertiesType?: string

Property Value

Settings for upgrading the agentpool

upgradeSettings?: AgentPoolUpgradeSettings

Property Value

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

vmSize?: string

Property Value

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}

vnetSubnetID?: string

Property Value

The Windows agent pool's specific profile.

windowsProfile?: AgentPoolWindowsProfile

Property Value

Determines the type of workload a node can run.

workloadRuntime?: string

Property Value

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

Inherited From SubResource.id

The name of the resource that is unique within a resource group. This name can be used to access the resource. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

Inherited From SubResource.name

Resource type NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

Inherited From SubResource.type