ManagedClusterAgentPoolProfile interface

Unique name of the agent pool profile in the context of the subscription and resource group. Windows agent pool names must be 6 characters or less.

name: string

Property Value

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

availabilityZones?: string[]

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.availabilityZones

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

capacityReservationGroupID?: string

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.capacityReservationGroupID

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

Inherited From ManagedClusterAgentPoolProfileProperties.count

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

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

currentOrchestratorVersion?: string

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.currentOrchestratorVersion

Whether to enable auto-scaler

enableAutoScaling?: boolean

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.enableAutoScaling

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

enableEncryptionAtHost?: boolean

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.enableEncryptionAtHost

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

enableFips?: boolean

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.enableFips

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.

enableNodePublicIP?: boolean

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.enableNodePublicIP

Whether to enable UltraSSD

enableUltraSSD?: boolean

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.enableUltraSSD

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

eTag?: string

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.eTag

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

gatewayProfile?: AgentPoolGatewayProfile

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.gatewayProfile

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

gpuInstanceProfile?: string

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.gpuInstanceProfile

GPU settings for the Agent Pool.

gpuProfile?: GPUProfile

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.gpuProfile

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.

hostGroupID?: string

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.hostGroupID

The Kubelet configuration on the agent pool nodes.

kubeletConfig?: KubeletConfig

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.kubeletConfig

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

kubeletDiskType?: string

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.kubeletDiskType

The OS configuration of Linux agent nodes.

linuxOSConfig?: LinuxOSConfig

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.linuxOSConfig

Configures the per-node local DNS, with VnetDNS and KubeDNS overrides. LocalDNS helps improve performance and reliability of DNS resolution in an AKS cluster. For more details see aka.ms/aks/localdns.

localDNSProfile?: LocalDNSProfile

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.localDNSProfile

The maximum number of nodes for auto-scaling

maxCount?: number

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.maxCount

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

maxPods?: number

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.maxPods

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

messageOfTheDay?: string

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.messageOfTheDay

The minimum number of nodes for auto-scaling

minCount?: number

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.minCount

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

mode?: string

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.mode

Network-related settings of an agent pool.

networkProfile?: AgentPoolNetworkProfile

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.networkProfile

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

nodeImageVersion?: string

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.nodeImageVersion

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

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

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.nodeLabels

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}

nodePublicIPPrefixID?: string

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.nodePublicIPPrefixID

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

nodeTaints?: string[]

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.nodeTaints

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.

orchestratorVersion?: string

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.orchestratorVersion

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

Inherited From ManagedClusterAgentPoolProfileProperties.osDiskSizeGB

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.

osDiskType?: string

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.osDiskType

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

Inherited From ManagedClusterAgentPoolProfileProperties.osSKU

The operating system type. The default is Linux.

osType?: string

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.osType

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

podIPAllocationMode?: string

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.podIPAllocationMode

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}

podSubnetID?: string

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.podSubnetID

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

powerState?: PowerState

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.powerState

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

Inherited From ManagedClusterAgentPoolProfileProperties.provisioningState

The ID for Proximity Placement Group.

proximityPlacementGroupID?: string

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.proximityPlacementGroupID

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.

scaleDownMode?: string

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.scaleDownMode

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

scaleSetEvictionPolicy?: string

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.scaleSetEvictionPolicy

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

scaleSetPriority?: string

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.scaleSetPriority

The security settings of an agent pool.

securityProfile?: AgentPoolSecurityProfile

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.securityProfile

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

spotMaxPrice?: number

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.spotMaxPrice

Contains read-only information about the Agent Pool.

status?: AgentPoolStatus

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.status

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

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

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.tags

The type of Agent Pool.

type?: string

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.type

Settings for upgrading the agentpool

upgradeSettings?: AgentPoolUpgradeSettings

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.upgradeSettings

The status of nodes in a VirtualMachines agent pool.

virtualMachineNodesStatus?: VirtualMachineNodes[]

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.virtualMachineNodesStatus

Specifications on VirtualMachines agent pool.

virtualMachinesProfile?: VirtualMachinesProfile

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.virtualMachinesProfile

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

vmSize?: string

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.vmSize

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}

vnetSubnetID?: string

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.vnetSubnetID

The Windows agent pool's specific profile.

windowsProfile?: AgentPoolWindowsProfile

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.windowsProfile

Determines the type of workload a node can run.

workloadRuntime?: string

Property Value

Inherited From ManagedClusterAgentPoolProfileProperties.workloadRuntime