ManagedClusterAgentPoolProfile interface
Profile for the container service agent pool.
- Extends
Properties
name | Windows agent pool names must be 6 characters or less. |
Inherited Properties
availability |
The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. |
capacity |
AKS will associate the specified agent pool with the Capacity Reservation Group. |
count | 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. |
creation |
CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot. |
current |
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. |
enable |
Whether to enable auto-scaler |
enable |
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 |
enable |
See Add a FIPS-enabled node pool for more details. |
enable |
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. |
enable |
Whether to enable UltraSSD |
gpu |
GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. |
host |
This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see Azure dedicated hosts. |
kubelet |
The Kubelet configuration on the agent pool nodes. |
kubelet |
Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. |
linux |
The OS configuration of Linux agent nodes. |
max |
The maximum number of nodes for auto-scaling |
max |
The maximum number of pods that can run on a node. |
min |
The minimum number of nodes for auto-scaling |
mode | 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 |
network |
Network-related settings of an agent pool. |
node |
The version of node image NOTE: This property will not be serialized. It can only be populated by the server. |
node |
The node labels to be persisted across all nodes in agent pool. |
node |
This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} |
node |
The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. |
orchestrator |
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. |
os |
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. |
os |
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. |
os |
The operating system type. The default is Linux. |
pod |
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} |
power |
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 |
provisioning |
The current deployment or provisioning state. NOTE: This property will not be serialized. It can only be populated by the server. |
proximity |
The ID for Proximity Placement Group. |
scale |
This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete. |
scale |
This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'. |
scale |
The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'. |
security |
The security settings of an agent pool. |
spot |
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 |
tags | The tags to be persisted on the agent pool virtual machine scale set. |
type | The type of Agent Pool. |
upgrade |
Settings for upgrading the agentpool |
vm |
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 |
vnet |
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} |
windows |
The Windows agent pool's specific profile. |
workload |
Determines the type of workload a node can run. |
Property Details
name
Windows agent pool names must be 6 characters or less.
name: string
Property Value
string
Inherited Property Details
availabilityZones
The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'.
availabilityZones?: string[]
Property Value
string[]
Inherited From ManagedClusterAgentPoolProfileProperties.availabilityZones
capacityReservationGroupID
AKS will associate the specified agent pool with the Capacity Reservation Group.
capacityReservationGroupID?: string
Property Value
string
Inherited From ManagedClusterAgentPoolProfileProperties.capacityReservationGroupID
count
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
number
Inherited From ManagedClusterAgentPoolProfileProperties.count
creationData
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
Inherited From ManagedClusterAgentPoolProfileProperties.creationData
currentOrchestratorVersion
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
string
Inherited From ManagedClusterAgentPoolProfileProperties.currentOrchestratorVersion
enableAutoScaling
Whether to enable auto-scaler
enableAutoScaling?: boolean
Property Value
boolean
Inherited From ManagedClusterAgentPoolProfileProperties.enableAutoScaling
enableEncryptionAtHost
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
boolean
Inherited From ManagedClusterAgentPoolProfileProperties.enableEncryptionAtHost
enableFips
See Add a FIPS-enabled node pool for more details.
enableFips?: boolean
Property Value
boolean
Inherited From ManagedClusterAgentPoolProfileProperties.enableFips
enableNodePublicIP
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
boolean
Inherited From ManagedClusterAgentPoolProfileProperties.enableNodePublicIP
enableUltraSSD
Whether to enable UltraSSD
enableUltraSSD?: boolean
Property Value
boolean
Inherited From ManagedClusterAgentPoolProfileProperties.enableUltraSSD
gpuInstanceProfile
GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.
gpuInstanceProfile?: string
Property Value
string
Inherited From ManagedClusterAgentPoolProfileProperties.gpuInstanceProfile
hostGroupID
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
string
Inherited From ManagedClusterAgentPoolProfileProperties.hostGroupID
kubeletConfig
The Kubelet configuration on the agent pool nodes.
kubeletConfig?: KubeletConfig
Property Value
Inherited From ManagedClusterAgentPoolProfileProperties.kubeletConfig
kubeletDiskType
Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage.
kubeletDiskType?: string
Property Value
string
Inherited From ManagedClusterAgentPoolProfileProperties.kubeletDiskType
linuxOSConfig
The OS configuration of Linux agent nodes.
linuxOSConfig?: LinuxOSConfig
Property Value
Inherited From ManagedClusterAgentPoolProfileProperties.linuxOSConfig
maxCount
The maximum number of nodes for auto-scaling
maxCount?: number
Property Value
number
Inherited From ManagedClusterAgentPoolProfileProperties.maxCount
maxPods
The maximum number of pods that can run on a node.
maxPods?: number
Property Value
number
Inherited From ManagedClusterAgentPoolProfileProperties.maxPods
minCount
The minimum number of nodes for auto-scaling
minCount?: number
Property Value
number
Inherited From ManagedClusterAgentPoolProfileProperties.minCount
mode
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
string
Inherited From ManagedClusterAgentPoolProfileProperties.mode
networkProfile
Network-related settings of an agent pool.
networkProfile?: AgentPoolNetworkProfile
Property Value
Inherited From ManagedClusterAgentPoolProfileProperties.networkProfile
nodeImageVersion
The version of node image NOTE: This property will not be serialized. It can only be populated by the server.
nodeImageVersion?: string
Property Value
string
Inherited From ManagedClusterAgentPoolProfileProperties.nodeImageVersion
nodeLabels
The node labels to be persisted across all nodes in agent pool.
nodeLabels?: {[propertyName: string]: string}
Property Value
{[propertyName: string]: string}
Inherited From ManagedClusterAgentPoolProfileProperties.nodeLabels
nodePublicIPPrefixID
This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}
nodePublicIPPrefixID?: string
Property Value
string
Inherited From ManagedClusterAgentPoolProfileProperties.nodePublicIPPrefixID
nodeTaints
The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.
nodeTaints?: string[]
Property Value
string[]
Inherited From ManagedClusterAgentPoolProfileProperties.nodeTaints
orchestratorVersion
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
string
Inherited From ManagedClusterAgentPoolProfileProperties.orchestratorVersion
osDiskSizeGB
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
number
Inherited From ManagedClusterAgentPoolProfileProperties.osDiskSizeGB
osDiskType
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
string
Inherited From ManagedClusterAgentPoolProfileProperties.osDiskType
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.
osSKU?: string
Property Value
string
Inherited From ManagedClusterAgentPoolProfileProperties.osSKU
osType
The operating system type. The default is Linux.
osType?: string
Property Value
string
Inherited From ManagedClusterAgentPoolProfileProperties.osType
podSubnetID
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
string
Inherited From ManagedClusterAgentPoolProfileProperties.podSubnetID
powerState
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
Inherited From ManagedClusterAgentPoolProfileProperties.powerState
provisioningState
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
string
Inherited From ManagedClusterAgentPoolProfileProperties.provisioningState
proximityPlacementGroupID
The ID for Proximity Placement Group.
proximityPlacementGroupID?: string
Property Value
string
Inherited From ManagedClusterAgentPoolProfileProperties.proximityPlacementGroupID
scaleDownMode
This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.
scaleDownMode?: string
Property Value
string
Inherited From ManagedClusterAgentPoolProfileProperties.scaleDownMode
scaleSetEvictionPolicy
This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'.
scaleSetEvictionPolicy?: string
Property Value
string
Inherited From ManagedClusterAgentPoolProfileProperties.scaleSetEvictionPolicy
scaleSetPriority
The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'.
scaleSetPriority?: string
Property Value
string
Inherited From ManagedClusterAgentPoolProfileProperties.scaleSetPriority
securityProfile
The security settings of an agent pool.
securityProfile?: AgentPoolSecurityProfile
Property Value
Inherited From ManagedClusterAgentPoolProfileProperties.securityProfile
spotMaxPrice
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
number
Inherited From ManagedClusterAgentPoolProfileProperties.spotMaxPrice
tags
The tags to be persisted on the agent pool virtual machine scale set.
tags?: {[propertyName: string]: string}
Property Value
{[propertyName: string]: string}
Inherited From ManagedClusterAgentPoolProfileProperties.tags
type
The type of Agent Pool.
type?: string
Property Value
string
Inherited From ManagedClusterAgentPoolProfileProperties.type
upgradeSettings
Settings for upgrading the agentpool
upgradeSettings?: AgentPoolUpgradeSettings
Property Value
Inherited From ManagedClusterAgentPoolProfileProperties.upgradeSettings
vmSize
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
string
Inherited From ManagedClusterAgentPoolProfileProperties.vmSize
vnetSubnetID
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
string
Inherited From ManagedClusterAgentPoolProfileProperties.vnetSubnetID
windowsProfile
The Windows agent pool's specific profile.
windowsProfile?: AgentPoolWindowsProfile
Property Value
Inherited From ManagedClusterAgentPoolProfileProperties.windowsProfile
workloadRuntime
Determines the type of workload a node can run.
workloadRuntime?: string
Property Value
string
Inherited From ManagedClusterAgentPoolProfileProperties.workloadRuntime