Share via

ManagedClusterAgentPoolProfileProperties interface

Package:
@azure-rest/arm-containerservice

Properties for the container service agent pool profile.

Properties

availabilityZones

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

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

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

Whether to enable auto-scaler
enableCustomCATrust

When set to true, AKS deploys a daemonset and host services to sync custom certificate authorities from a user-provided config map into node trust stores. Defaults to false.
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
enableFIPS

See Add a FIPS-enabled node pool for more details.
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.
enableUltraSSD

Whether to enable UltraSSD
gpuInstanceProfile

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

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

The Kubelet configuration on the agent pool nodes.
kubeletDiskType

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

The OS configuration of Linux agent nodes.
maxCount

The maximum number of nodes for auto-scaling
maxPods

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

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

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
nodeLabels

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

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

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

Both patch version <major.minor.patch> and <major.minor> are supported. When <major.minor> is specified, the latest supported patch version is chosen automatically. Updating the agent pool with the same <major.minor> once it has been created 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.
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.
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.
osSKU

Specifies the OS SKU used by the agent pool. If not specified, the default is Ubuntu if OSType=Linux or Windows2019 if OSType=Windows. And the default Windows OSSKU will be changed to Windows2022 after Windows2019 is deprecated.
osType

The operating system type. The default is Linux.
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}
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
proximityPlacementGroupID

The ID for Proximity Placement Group.
scaleDownMode

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

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

The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'.
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
tags

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

The type of Agent Pool.
upgradeSettings

Settings for upgrading the agentpool
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
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}
workloadRuntime

Determines the type of workload a node can run.

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[]

capacityReservationGroupID

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

capacityReservationGroupID?: string

Property Value

string

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

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

CreationData

enableAutoScaling

Whether to enable auto-scaler

enableAutoScaling?: boolean

Property Value

boolean

enableCustomCATrust

When set to true, AKS deploys a daemonset and host services to sync custom certificate authorities from a user-provided config map into node trust stores. Defaults to false.

enableCustomCATrust?: boolean

Property Value

boolean

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

enableFIPS

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

enableFIPS?: boolean

Property Value

boolean

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

enableUltraSSD

Whether to enable UltraSSD

enableUltraSSD?: boolean

Property Value

boolean

gpuInstanceProfile

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

gpuInstanceProfile?: "MIG1g" | "MIG2g" | "MIG3g" | "MIG4g" | "MIG7g"

Property Value

"MIG1g" | "MIG2g" | "MIG3g" | "MIG4g" | "MIG7g"

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

kubeletConfig

The Kubelet configuration on the agent pool nodes.

kubeletConfig?: KubeletConfig

Property Value

KubeletConfig

kubeletDiskType

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

kubeletDiskType?: "OS" | "Temporary"

Property Value

"OS" | "Temporary"

linuxOSConfig

The OS configuration of Linux agent nodes.

linuxOSConfig?: LinuxOSConfig

Property Value

LinuxOSConfig

maxCount

The maximum number of nodes for auto-scaling

maxCount?: number

Property Value

number

maxPods

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

maxPods?: number

Property Value

number

messageOfTheDay

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

messageOfTheDay?: string

Property Value

string

minCount

The minimum number of nodes for auto-scaling

minCount?: number

Property Value

number

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?: "System" | "User"

Property Value

"System" | "User"

nodeLabels

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

nodeLabels?: Record<string, string>

Property Value

Record<string, string>

nodePublicIPPrefixID

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

nodePublicIPPrefixID?: string

Property Value

string

nodeTaints

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

nodeTaints?: string[]

Property Value

string[]

orchestratorVersion

Both patch version <major.minor.patch> and <major.minor> are supported. When <major.minor> is specified, the latest supported patch version is chosen automatically. Updating the agent pool with the same <major.minor> once it has been created 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

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

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?: "Managed" | "Ephemeral"

Property Value

"Managed" | "Ephemeral"

osSKU

Specifies the OS SKU used by the agent pool. If not specified, the default is Ubuntu if OSType=Linux or Windows2019 if OSType=Windows. And the default Windows OSSKU will be changed to Windows2022 after Windows2019 is deprecated.

osSKU?: "Ubuntu" | "CBLMariner" | "Windows2019" | "Windows2022"

Property Value

"Ubuntu" | "CBLMariner" | "Windows2019" | "Windows2022"

osType

The operating system type. The default is Linux.

osType?: "Linux" | "Windows"

Property Value

"Linux" | "Windows"

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

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

PowerState

proximityPlacementGroupID

The ID for Proximity Placement Group.

proximityPlacementGroupID?: string

Property Value

string

scaleDownMode

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

scaleDownMode?: "Delete" | "Deallocate"

Property Value

"Delete" | "Deallocate"

scaleSetEvictionPolicy

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

scaleSetEvictionPolicy?: "Delete" | "Deallocate"

Property Value

"Delete" | "Deallocate"

scaleSetPriority

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

scaleSetPriority?: "Spot" | "Regular"

Property Value

"Spot" | "Regular"

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

tags

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

tags?: Record<string, string>

Property Value

Record<string, string>

type

The type of Agent Pool.

type?: "VirtualMachineScaleSets" | "AvailabilitySet"

Property Value

"VirtualMachineScaleSets" | "AvailabilitySet"

upgradeSettings

Settings for upgrading the agentpool

upgradeSettings?: AgentPoolUpgradeSettings

Property Value

AgentPoolUpgradeSettings

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

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

workloadRuntime

Determines the type of workload a node can run.

workloadRuntime?: "OCIContainer" | "WasmWasi"

Property Value

"OCIContainer" | "WasmWasi"