az aks nodepool
Note
This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.
Commands to manage node pools in Kubernetes kubernetes cluster.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az aks nodepool add |
Add a node pool to the managed Kubernetes cluster. |
Core | GA |
| az aks nodepool add (aks-preview extension) |
Add a node pool to the managed Kubernetes cluster. |
Extension | GA |
| az aks nodepool delete |
Delete the agent pool in the managed Kubernetes cluster. |
Core | GA |
| az aks nodepool delete (aks-preview extension) |
Delete the agent pool in the managed Kubernetes cluster. |
Extension | GA |
| az aks nodepool delete-machines |
Delete specific machines in an agentpool for a managed cluster. |
Extension | GA |
| az aks nodepool get-upgrades |
Get the available upgrade versions for an agent pool of the managed Kubernetes cluster. |
Core | GA |
| az aks nodepool get-upgrades (aks-preview extension) |
Get the available upgrade versions for an agent pool of the managed Kubernetes cluster. |
Extension | GA |
| az aks nodepool list |
List node pools in the managed Kubernetes cluster. To get list of nodes in the cluster run |
Core | GA |
| az aks nodepool list (aks-preview extension) |
List node pools in the managed Kubernetes cluster. |
Extension | GA |
| az aks nodepool operation-abort |
Abort last running operation on nodepool. |
Core | GA |
| az aks nodepool operation-abort (aks-preview extension) |
Abort last running operation on nodepool. |
Extension | GA |
| az aks nodepool scale |
Scale the node pool in a managed Kubernetes cluster. |
Core | GA |
| az aks nodepool scale (aks-preview extension) |
Scale the node pool in a managed Kubernetes cluster. |
Extension | GA |
| az aks nodepool show |
Show the details for a node pool in the managed Kubernetes cluster. |
Core | GA |
| az aks nodepool show (aks-preview extension) |
Show the details for a node pool in the managed Kubernetes cluster. |
Extension | GA |
| az aks nodepool snapshot |
Commands to manage nodepool snapshots. |
Core and Extension | GA |
| az aks nodepool snapshot create |
Create a nodepool snapshot. |
Core | GA |
| az aks nodepool snapshot create (aks-preview extension) |
Create a nodepool snapshot. |
Extension | GA |
| az aks nodepool snapshot delete |
Delete a nodepool snapshot. |
Core | GA |
| az aks nodepool snapshot delete (aks-preview extension) |
Delete a nodepool snapshot. |
Extension | GA |
| az aks nodepool snapshot list |
List nodepool snapshots. |
Core | GA |
| az aks nodepool snapshot list (aks-preview extension) |
List nodepool snapshots. |
Extension | GA |
| az aks nodepool snapshot show |
Show the details of a nodepool snapshot. |
Core | GA |
| az aks nodepool snapshot show (aks-preview extension) |
Show the details of a nodepool snapshot. |
Extension | GA |
| az aks nodepool snapshot update |
Update tags on a snapshot of a nodepool. |
Core | GA |
| az aks nodepool snapshot update (aks-preview extension) |
Update tags on a snapshot of a nodepool. |
Extension | GA |
| az aks nodepool snapshot wait |
Wait for a nodepool snapshot to reach a desired state. |
Core | GA |
| az aks nodepool start |
Start stopped agent pool in the managed Kubernetes cluster. |
Core | GA |
| az aks nodepool start (aks-preview extension) |
Start stopped agent pool in the managed Kubernetes cluster. |
Extension | GA |
| az aks nodepool stop |
Stop running agent pool in the managed Kubernetes cluster. |
Core | GA |
| az aks nodepool stop (aks-preview extension) |
Stop running agent pool in the managed Kubernetes cluster. |
Extension | GA |
| az aks nodepool update |
Update a node pool properties. |
Core | GA |
| az aks nodepool update (aks-preview extension) |
Update a node pool properties. |
Extension | GA |
| az aks nodepool upgrade |
Upgrade the node pool in a managed Kubernetes cluster. |
Core | GA |
| az aks nodepool upgrade (aks-preview extension) |
Upgrade the node pool in a managed Kubernetes cluster. |
Extension | GA |
| az aks nodepool wait |
Wait for a node pool to reach a desired state. |
Core | GA |
az aks nodepool add
Add a node pool to the managed Kubernetes cluster.
az aks nodepool add --cluster-name
--name
--resource-group
[--aks-custom-headers]
[--allowed-host-ports]
[--asg-ids]
[--crg-id]
[--drain-timeout]
[--enable-cluster-autoscaler]
[--enable-encryption-at-host]
[--enable-fips-image]
[--enable-node-public-ip]
[--enable-ultra-ssd]
[--eviction-policy {Deallocate, Delete}]
[--gpu-instance-profile {MIG1g, MIG2g, MIG3g, MIG4g, MIG7g}]
[--host-group-id]
[--kubelet-config]
[--kubernetes-version]
[--labels]
[--linux-os-config]
[--max-count]
[--max-pods]
[--max-surge]
[--min-count]
[--mode {System, User}]
[--no-wait]
[--node-count]
[--node-osdisk-size]
[--node-osdisk-type {Ephemeral, Managed}]
[--node-public-ip-prefix-id]
[--node-public-ip-tags]
[--node-soak-duration]
[--node-taints]
[--node-vm-size]
[--os-sku {AzureLinux, CBLMariner, Mariner, Ubuntu, Windows2019, Windows2022}]
[--os-type]
[--pod-subnet-id]
[--ppg]
[--priority {Regular, Spot}]
[--scale-down-mode {Deallocate, Delete}]
[--snapshot-id]
[--spot-max-price]
[--tags]
[--vnet-subnet-id]
[--zones]Examples
Create a nodepool in an existing AKS cluster with ephemeral os enabled.
az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --node-osdisk-type Ephemeral --node-osdisk-size 48Create a nodepool with EncryptionAtHost enabled.
az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --enable-encryption-at-hostCreate a nodepool with UltraSSD enabled.
az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --enable-ultra-ssdCreate a nodepool cluster with a specific OS SKU
az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --os-sku UbuntuCreate a nodepool with FIPS-enabled OS
az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --enable-fips-imagecreate a kubernetes cluster with a snapshot id.
az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --kubernetes-version 1.20.9 --snapshot-id "/subscriptions/00000/resourceGroups/AnotherResourceGroup/providers/Microsoft.ContainerService/snapshots/mysnapshot1"create a nodepool in an existing AKS cluster with host group id
az aks nodepool add -g MyResourceGroup -n MyNodePool --cluster-name MyMC --host-group-id /subscriptions/00000/resourceGroups/AnotherResourceGroup/providers/Microsoft.ContainerService/hostGroups/myHostGroup --node-vm-size VMSizecreate a nodepool with a Capacity Reservation Group(CRG) ID.
az aks nodepool add -g MyResourceGroup -n MyNodePool --cluster-name MyMC --node-vm-size VMSize --crg-id "/subscriptions/SubID/resourceGroups/ResourceGroupName/providers/Microsoft.ContainerService/CapacityReservationGroups/MyCRGID"Required Parameters
The cluster name.
The node pool name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Comma-separated key-value pairs to specify custom headers.
Expose host ports on the node pool. When specified, format should be a space-separated list of ranges with protocol, eg. 80/TCP 443/TCP 4000-5000/TCP.
The IDs of the application security groups to which the node pool's network interface should belong. When specified, format should be a space-separated list of IDs.
The crg id used to associate the new nodepool with the existed Capacity Reservation Group resource.
When nodes are drain how many minutes to wait for all pods to be evicted.
Enable cluster autoscaler.
Enable EncryptionAtHost, default value is false.
Use FIPS-enabled OS on agent nodes.
Enable VMSS node public IP.
Enable UltraSSD, default value is false.
The eviction policy of the Spot node pool. It can only be set when --priority is Spot.
GPU instance profile to partition multi-gpu Nvidia GPUs.
The fully qualified dedicated host group id used to provision agent node pool.
Path to JSON file containing Kubelet configurations for agent nodes. https://aka.ms/aks/custom-node-config.
Version of Kubernetes to use for creating the cluster, such as "1.16.9".
The node labels for the node pool. See https://aka.ms/node-labels for syntax of labels.
Path to JSON file containing OS configurations for Linux agent nodes. https://aka.ms/aks/custom-node-config.
Maximum nodes count used for autoscaler, when "--enable-cluster-autoscaler" specified. Please specify the value in the range of [0, 1000] for user nodepool, and [1,1000] for system nodepool.
The maximum number of pods deployable to a node.
If not specified, defaults based on network-plugin. 30 for "azure", 110 for "kubenet", or 250 for "none".
Extra nodes used to speed upgrade. When specified, it represents the number or percent used, eg. 5 or 33%.
Minimum nodes count used for autoscaler, when "--enable-cluster-autoscaler" specified. Please specify the value in the range of [0, 1000] for user nodepool, and [1,1000] for system nodepool.
The mode for a node pool which defines a node pool's primary function. If set as "System", AKS prefers system pods scheduling to node pools with mode System. Learn more at https://aka.ms/aks/nodepool/mode.
Do not wait for the long-running operation to finish.
Number of nodes in the Kubernetes agent pool. After creating a cluster, you can change the size of its node pool with az aks scale.
Size in GiB of the OS disk for each node in the agent pool. Minimum 30 GiB.
OS disk type to be used for machines in a given agent pool. Defaults to 'Ephemeral' when possible in conjunction with VM size and OS disk size. May not be changed for this pool after creation. ('Ephemeral' or 'Managed').
Public IP prefix ID used to assign public IPs to VMSS nodes.
The ipTags of the node public IPs.
The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node.
The node taints for the node pool.
Size of Virtual Machines to create as Kubernetes nodes.
The OS SKU of the agent node pool. Ubuntu or CBLMariner for Linux. Windows2019 or Windows2022 for Windows.
The OS Type. Linux or Windows.
The Resource Id of a subnet in an existing VNet into which to assign pods in the cluster (requires azure network-plugin).
The ID of a PPG.
The priority of the node pool.
Describe how VMs are added to or removed from nodepools.
The source snapshot id used to create this nodepool.
It can only be set when --priority is Spot. 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. It can only include up to 5 decimal places.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
The Resource Id of a subnet in an existing VNet into which to deploy the cluster.
Availability zones where agent nodes will be placed. Also, to install agent nodes to more than one zone you need to pass zone numbers separated by blanks. For example - To have all 3 zones, you are expected to enter --zones 1 2 3.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az aks nodepool add (aks-preview extension)
Add a node pool to the managed Kubernetes cluster.
az aks nodepool add --cluster-name
--name
--resource-group
[--aks-custom-headers]
[--allowed-host-ports]
[--asg-ids]
[--crg-id]
[--disable-windows-outbound-nat]
[--drain-timeout]
[--enable-artifact-streaming]
[--enable-cluster-autoscaler]
[--enable-custom-ca-trust]
[--enable-encryption-at-host]
[--enable-fips-image]
[--enable-node-public-ip]
[--enable-secure-boot]
[--enable-ultra-ssd]
[--enable-vtpm]
[--eviction-policy {Deallocate, Delete}]
[--gpu-instance-profile {MIG1g, MIG2g, MIG3g, MIG4g, MIG7g}]
[--host-group-id]
[--kubelet-config]
[--kubernetes-version]
[--labels]
[--linux-os-config]
[--max-count]
[--max-pods]
[--max-surge]
[--message-of-the-day]
[--min-count]
[--mode {System, User}]
[--no-wait]
[--node-count]
[--node-osdisk-size]
[--node-osdisk-type {Ephemeral, Managed}]
[--node-public-ip-prefix-id]
[--node-public-ip-tags]
[--node-soak-duration]
[--node-taints]
[--node-vm-size]
[--os-sku {AzureLinux, CBLMariner, Mariner, Ubuntu, Windows2019, Windows2022}]
[--os-type]
[--pod-ip-allocation-mode {DynamicIndividual, StaticBlock}]
[--pod-subnet-id]
[--ppg]
[--priority {Regular, Spot}]
[--scale-down-mode {Deallocate, Delete}]
[--skip-gpu-driver-install]
[--snapshot-id]
[--spot-max-price]
[--ssh-access {disabled, localuser}]
[--tags]
[--vm-set-type]
[--vnet-subnet-id]
[--workload-runtime {KataCcIsolation, KataMshvVmIsolation, OCIContainer, WasmWasi}]
[--zones]Examples
Create a nodepool in an existing AKS cluster with ephemeral os enabled.
az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --node-osdisk-type Ephemeral --node-osdisk-size 48Create a nodepool with EncryptionAtHost enabled.
az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --enable-encryption-at-hostCreate a nodepool with a specific os-sku
az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --os-sku UbuntuCreate a nodepool which can run wasm workloads.
az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --workload-runtime WasmWasicreate a kubernetes cluster with a snapshot id.
az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --kubernetes-version 1.20.9 --snapshot-id "/subscriptions/00000/resourceGroups/AnotherResourceGroup/providers/Microsoft.ContainerService/snapshots/mysnapshot1"create a nodepool with a Capacity Reservation Group(CRG) ID.
az aks nodepool add -g MyResourceGroup -n MyNodePool --cluster-name MyMC --node-vm-size VMSize --crg-id "/subscriptions/SubID/resourceGroups/ResourceGroupName/providers/Microsoft.ContainerService/CapacityReservationGroups/MyCRGID"create a nodepool in an existing AKS cluster with host group id
az aks nodepool add -g MyResourceGroup -n MyNodePool --cluster-name MyMC --host-group-id /subscriptions/00000/resourceGroups/AnotherResourceGroup/providers/Microsoft.ContainerService/hostGroups/myHostGroup --node-vm-size VMSizeCreate a nodepool with ip allocation mode set to "StaticBlock" and using a pod subnet ID
az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --os-sku Ubuntu --pod-subnet-id /subscriptions/00000/resourceGroups/AnotherResourceGroup/providers/Microsoft.Network/virtualNetworks/MyVnet/subnets/MySubnet --pod-ip-allocation-mode StaticBlockRequired Parameters
The cluster name.
The node pool name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Send custom headers. When specified, format should be Key1=Value1,Key2=Value2.
Expose host ports on the node pool. When specified, format should be a comma-separated list of ranges with protocol, eg. 80/TCP,443/TCP,4000-5000/TCP. Must use VMSS agent pool type.
The IDs of the application security groups to which the node pool's network interface should belong. When specified, format should be a comma-separated list of IDs. Must use VMSS agent pool type.
The crg-id used to associate the new nodepool with the existed Capacity Reservation Group resource. Must use VMSS agent pool type.
Disable Windows OutboundNAT on Windows agent node pool. Must use VMSS agent pool type.
When nodes are drain how many minutes to wait for all pods to be evicted.
Enable artifact streaming for VirtualMachineScaleSets managed by a node pool, to speed up the cold-start of containers on a node through on-demand image loading. To use this feature, container images must also enable artifact streaming on ACR. If not specified, the default is false.
Enable cluster autoscaler. Must use VMSS agent pool type.
Enable Custom CA Trust on agent node pool.
Enable EncryptionAtHost on agent node pool.
Use FIPS-enabled OS on agent nodes.
Enable VMSS node public IP. Must use VMSS agent pool type.
Enable Secure Boot on agent node pool. Must use VMSS agent pool type.
Enable UltraSSD on agent node pool. Must use VMSS agent pool type.
Enable vTPM on agent node pool. Must use VMSS agent pool type.
The eviction policy of the Spot node pool. It can only be set when --priority is Spot.
GPU instance profile to partition multi-gpu Nvidia GPUs.
(PREVIEW) The fully qualified dedicated host group id used to provision agent node pool. Must use VMSS agent pool type.
Kubelet configurations for agent nodes.
Version of Kubernetes to use for creating the cluster, such as "1.7.12" or "1.8.7".
The node labels for the node pool. See https://aka.ms/node-labels for syntax of labels.
OS configurations for Linux agent nodes.
Maximum nodes count used for autoscaler, when "--enable-cluster-autoscaler" specified. Please specify the value in the range of [0, 1000] for user nodepool, and [1,1000] for system nodepool.
The maximum number of pods deployable to a node.
If not specified, defaults based on network-plugin. 30 for "azure", 110 for "kubenet", or 250 for "none".
Extra nodes used to speed upgrade. When specified, it represents the number or percent used, eg. 5 or 33%.
Path to a file containing the desired message of the day. Only valid for linux nodes. Will be written to /etc/motd.
Minimun nodes count used for autoscaler, when "--enable-cluster-autoscaler" specified. Please specify the value in the range of [0, 1000] for user nodepool, and [1,1000] for system nodepool.
The mode for a node pool which defines a node pool's primary function. If set as "System", AKS prefers system pods scheduling to node pools with mode System. Learn more at https://aka.ms/aks/nodepool/mode.
Do not wait for the long-running operation to finish.
Number of nodes in the Kubernetes agent pool. After creating a cluster, you can change the size of its node pool with az aks scale.
Size in GiB of the OS disk for each node in the agent pool. Minimum 30 GiB.
OS disk type to be used for machines in a given agent pool. Defaults to 'Ephemeral' when possible in conjunction with VM size and OS disk size. May not be changed for this pool after creation. ('Ephemeral' or 'Managed').
Public IP prefix ID used to assign public IPs to VMSS nodes. Must use VMSS agent pool type.
The ipTags of the node public IPs. Must use VMSS agent pool type.
The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node.
The node taints for the node pool.
Size of Virtual Machines to create as Kubernetes nodes.
The os-sku of the agent node pool. Ubuntu or CBLMariner when os-type is Linux, default is Ubuntu if not set; Windows2019 or Windows2022 when os-type is Windows, the current default is Windows2019 if not set, and the default will be changed to Windows2022 after Windows2019 is deprecated.
The OS Type. Linux or Windows. Windows not supported yet for "VirtualMachines" VM set type.
Set the ip allocation mode for how Pod IPs from the Azure Pod Subnet are allocated to the nodes in the AKS cluster. The choice is between dynamic batches of individual IPs or static allocation of a set of CIDR blocks. Accepted Values are "DynamicIndividual" or "StaticBlock".
Used together with the "azure" network plugin. Requires --pod-subnet-id.
The ID of a subnet in an existing VNet into which to assign pods in the cluster (requires azure network-plugin).
The ID of a PPG. Must use VMSS agent pool type.
The priority of the node pool.
Describes how VMs are added to or removed from nodepools.
To skip GPU driver auto installation by AKS on a nodepool using GPU vm size if customers want to manage GPU driver installation by their own. If not specified, the default is false.
The source snapshot id used to create this nodepool. Must use VMSS agent pool type.
It can only be set when --priority is Spot. 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. It can only include up to 5 decimal places.
Configure SSH setting for the node pool. Use "disabled" to disable SSH access, "localuser" to enable SSH access using private key.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Agent pool vm set type. VirtualMachineScaleSets, AvailabilitySet or VirtualMachines(Preview).
The ID of a subnet in an existing VNet into which to deploy the cluster.
Determines the type of workload a node can run. Defaults to OCIContainer.
Space-separated list of availability zones where agent nodes will be placed. Must use VMSS agent pool type.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az aks nodepool delete
Delete the agent pool in the managed Kubernetes cluster.
az aks nodepool delete --cluster-name
--name
--resource-group
[--no-wait]Required Parameters
The cluster name.
The node pool name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Do not wait for the long-running operation to finish.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az aks nodepool delete (aks-preview extension)
Delete the agent pool in the managed Kubernetes cluster.
az aks nodepool delete --cluster-name
--name
--resource-group
[--ignore-pod-disruption-budget]
[--no-wait]Examples
Delete an agent pool with ignore-pod-disruption-budget
az aks nodepool delete --resource-group MyResourceGroup --cluster-name MyManagedCluster --name nodepool1 --ignore-pod-disruption-budget=trueRequired Parameters
The cluster name.
The node pool name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
(PREVIEW) ignore-pod-disruption-budget deletes an existing nodepool without considering Pod Disruption Budget.
Do not wait for the long-running operation to finish.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az aks nodepool delete-machines
Delete specific machines in an agentpool for a managed cluster.
az aks nodepool delete-machines --cluster-name
--machine-names
--name
--resource-group
[--no-wait]Examples
Delete specific machines in an agent pool
az aks nodepool delete-machines -g myResourceGroup --nodepool-name nodepool1 --cluster-name myAKSCluster --machine-names machine1Required Parameters
The cluster name.
Space-separated list of machine names from the agent pool to be deleted.
The node pool name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Do not wait for the long-running operation to finish.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az aks nodepool get-upgrades
Get the available upgrade versions for an agent pool of the managed Kubernetes cluster.
az aks nodepool get-upgrades --cluster-name
--name
--resource-groupExamples
Get the available upgrade versions for an agent pool of the managed Kubernetes cluster.
az aks nodepool get-upgrades --resource-group MyResourceGroup --cluster-name MyManagedCluster --nodepool-name MyNodePoolRequired Parameters
The cluster name.
The node pool name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az aks nodepool get-upgrades (aks-preview extension)
Get the available upgrade versions for an agent pool of the managed Kubernetes cluster.
az aks nodepool get-upgrades --cluster-name
--name
--resource-groupExamples
Get the available upgrade versions for an agent pool of the managed Kubernetes cluster.
az aks nodepool get-upgrades --resource-group MyResourceGroup --cluster-name MyManagedCluster --nodepool-name MyNodePoolRequired Parameters
The cluster name.
The node pool name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az aks nodepool list
List node pools in the managed Kubernetes cluster. To get list of nodes in the cluster run kubectl get nodes command.
az aks nodepool list --cluster-name
--resource-groupRequired Parameters
The cluster name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az aks nodepool list (aks-preview extension)
List node pools in the managed Kubernetes cluster.
az aks nodepool list --cluster-name
--resource-groupRequired Parameters
The cluster name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az aks nodepool operation-abort
Abort last running operation on nodepool.
az aks nodepool operation-abort --cluster-name
--name
--resource-group
[--no-wait]Examples
Abort operation on agent pool
az aks nodepool operation-abort -g myResourceGroup --nodepool-name nodepool1 --cluster-name myAKSClusterRequired Parameters
The cluster name.
The node pool name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Do not wait for the long-running operation to finish.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az aks nodepool operation-abort (aks-preview extension)
Abort last running operation on nodepool.
az aks nodepool operation-abort --cluster-name
--name
--resource-group
[--aks-custom-headers]
[--no-wait]Examples
Abort operation on agent pool
az aks nodepool operation-abort -g myResourceGroup --nodepool-name nodepool1 --cluster-name myAKSClusterRequired Parameters
The cluster name.
The node pool name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Send custom headers. When specified, format should be Key1=Value1,Key2=Value2.
Do not wait for the long-running operation to finish.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az aks nodepool scale
Scale the node pool in a managed Kubernetes cluster.
az aks nodepool scale --cluster-name
--name
--resource-group
[--no-wait]
[--node-count]Required Parameters
The cluster name.
The node pool name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Do not wait for the long-running operation to finish.
Number of nodes in the Kubernetes node pool.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az aks nodepool scale (aks-preview extension)
Scale the node pool in a managed Kubernetes cluster.
az aks nodepool scale --cluster-name
--name
--resource-group
[--aks-custom-headers]
[--no-wait]
[--node-count]Required Parameters
The cluster name.
The node pool name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Send custom headers. When specified, format should be Key1=Value1,Key2=Value2.
Do not wait for the long-running operation to finish.
Number of nodes in the Kubernetes node pool.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az aks nodepool show
Show the details for a node pool in the managed Kubernetes cluster.
az aks nodepool show --cluster-name
--name
--resource-groupRequired Parameters
The cluster name.
The node pool name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az aks nodepool show (aks-preview extension)
Show the details for a node pool in the managed Kubernetes cluster.
az aks nodepool show --cluster-name
--name
--resource-groupRequired Parameters
The cluster name.
The node pool name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az aks nodepool start
Start stopped agent pool in the managed Kubernetes cluster.
az aks nodepool start --cluster-name
--name
--resource-group
[--aks-custom-headers]
[--no-wait]Examples
Start agent pool in the managed cluster
az aks nodepool start --nodepool-name nodepool1 -g MyResourceGroup --cluster-name MyManagedClusterRequired Parameters
The cluster name.
The node pool name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Send custom headers. When specified, format should be Key1=Value1,Key2=Value2.
Do not wait for the long-running operation to finish.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az aks nodepool start (aks-preview extension)
Start stopped agent pool in the managed Kubernetes cluster.
az aks nodepool start --cluster-name
--name
--resource-group
[--aks-custom-headers]
[--no-wait]Examples
Start agent pool in the managed cluster
az aks nodepool start --nodepool-name nodepool1 -g MyResourceGroup --cluster-name MyManagedClusterRequired Parameters
The cluster name.
The node pool name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Send custom headers. When specified, format should be Key1=Value1,Key2=Value2.
Do not wait for the long-running operation to finish.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az aks nodepool stop
Stop running agent pool in the managed Kubernetes cluster.
az aks nodepool stop --cluster-name
--name
--resource-group
[--aks-custom-headers]
[--no-wait]Examples
Stop agent pool in the managed cluster
az aks nodepool stop --nodepool-name nodepool1 -g MyResourceGroup --cluster-name MyManagedClusterRequired Parameters
The cluster name.
The node pool name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Send custom headers. When specified, format should be Key1=Value1,Key2=Value2.
Do not wait for the long-running operation to finish.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az aks nodepool stop (aks-preview extension)
Stop running agent pool in the managed Kubernetes cluster.
az aks nodepool stop --cluster-name
--name
--resource-group
[--aks-custom-headers]
[--no-wait]Examples
Stop agent pool in the managed cluster
az aks nodepool stop --nodepool-name nodepool1 -g MyResourceGroup --cluster-name MyManagedClusterRequired Parameters
The cluster name.
The node pool name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Send custom headers. When specified, format should be Key1=Value1,Key2=Value2.
Do not wait for the long-running operation to finish.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az aks nodepool update
Update a node pool properties.
Update a node pool to enable/disable cluster-autoscaler or change min-count or max-count. When called with no optional arguments this attempts to move the node pool to its goal state without changing the current node pool configuration. This can be used to move out of a non succeeded state.
az aks nodepool update --cluster-name
--name
--resource-group
[--aks-custom-headers]
[--allowed-host-ports]
[--asg-ids]
[--disable-cluster-autoscaler]
[--drain-timeout]
[--enable-cluster-autoscaler]
[--labels]
[--max-count]
[--max-surge]
[--min-count]
[--mode {System, User}]
[--no-wait]
[--node-soak-duration]
[--node-taints]
[--scale-down-mode {Deallocate, Delete}]
[--tags]
[--update-cluster-autoscaler]Examples
Reconcile the nodepool back to its current state.
az aks nodepool update -g MyResourceGroup -n nodepool1 --cluster-name MyManagedClusterEnable cluster-autoscaler within node count range [1,5]
az aks nodepool update --enable-cluster-autoscaler --min-count 1 --max-count 5 -g MyResourceGroup -n nodepool1 --cluster-name MyManagedClusterDisable cluster-autoscaler for an existing cluster
az aks nodepool update --disable-cluster-autoscaler -g MyResourceGroup -n nodepool1 --cluster-name MyManagedClusterUpdate min-count or max-count for cluster autoscaler.
az aks nodepool update --update-cluster-autoscaler --min-count 1 --max-count 10 -g MyResourceGroup -n nodepool1 --cluster-name MyManagedClusterRequired Parameters
The cluster name.
The node pool name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Comma-separated key-value pairs to specify custom headers.
Expose host ports on the node pool. When specified, format should be a space-separated list of ranges with protocol, eg. 80/TCP 443/TCP 4000-5000/TCP.
The IDs of the application security groups to which the node pool's network interface should belong. When specified, format should be a space-separated list of IDs.
Disable cluster autoscaler.
When nodes are drain how many minutes to wait for all pods to be evicted.
Enable cluster autoscaler.
The node labels for the node pool. See https://aka.ms/node-labels for syntax of labels.
Maximum nodes count used for autoscaler, when "--enable-cluster-autoscaler" specified. Please specify the value in the range of [0, 1000] for user nodepool, and [1,1000] for system nodepool.
Extra nodes used to speed upgrade. When specified, it represents the number or percent used, eg. 5 or 33%.
Minimum nodes count used for autoscaler, when "--enable-cluster-autoscaler" specified. Please specify the value in the range of [0, 1000] for user nodepool, and [1,1000] for system nodepool.
The mode for a node pool which defines a node pool's primary function. If set as "System", AKS prefers system pods scheduling to node pools with mode System. Learn more at https://aka.ms/aks/nodepool/mode.
Do not wait for the long-running operation to finish.
The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node.
The node taints for the node pool. You can update the existing node taint of a nodepool or create a new node taint for a nodepool. Pass the empty string "" to remove all taints.
Describe how VMs are added to or removed from nodepools.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Update min-count or max-count for cluster autoscaler.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az aks nodepool update (aks-preview extension)
Update a node pool properties.
Update a node pool to enable/disable cluster-autoscaler or change min-count or max-count. When called with no optional arguments this attempts to move the node pool to its goal state without changing the current node pool configuration. This can be used to move out of a non succeeded state.
az aks nodepool update --cluster-name
--name
--resource-group
[--aks-custom-headers]
[--allowed-host-ports]
[--asg-ids]
[--dcat]
[--disable-cluster-autoscaler]
[--disable-secure-boot]
[--disable-vtpm]
[--drain-timeout]
[--enable-artifact-streaming]
[--enable-cluster-autoscaler]
[--enable-custom-ca-trust]
[--enable-secure-boot]
[--enable-vtpm]
[--labels]
[--max-count]
[--max-surge]
[--min-count]
[--mode {System, User}]
[--no-wait]
[--node-soak-duration]
[--node-taints]
[--os-sku {AzureLinux, Ubuntu}]
[--scale-down-mode {Deallocate, Delete}]
[--ssh-access {disabled, localuser}]
[--tags]
[--update-cluster-autoscaler]
[--yes]Examples
Reconcile the nodepool back to its current state.
az aks nodepool update -g MyResourceGroup -n nodepool1 --cluster-name MyManagedClusterEnable cluster-autoscaler within node count range [1,5]
az aks nodepool update --enable-cluster-autoscaler --min-count 1 --max-count 5 -g MyResourceGroup -n nodepool1 --cluster-name MyManagedClusterDisable cluster-autoscaler for an existing cluster
az aks nodepool update --disable-cluster-autoscaler -g MyResourceGroup -n nodepool1 --cluster-name MyManagedClusterUpdate min-count or max-count for cluster autoscaler.
az aks nodepool update --update-cluster-autoscaler --min-count 1 --max-count 10 -g MyResourceGroup -n nodepool1 --cluster-name MyManagedClusterChange a node pool to system mode
az aks nodepool update --mode System -g MyResourceGroup -n nodepool1 --cluster-name MyManagedClusterRequired Parameters
The cluster name.
The node pool name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Send custom headers. When specified, format should be Key1=Value1,Key2=Value2.
Expose host ports on the node pool. When specified, format should be a comma-separated list of ranges with protocol, eg. 80/TCP,443/TCP,4000-5000/TCP. Must use VMSS agent pool type.
The IDs of the application security groups to which the node pool's network interface should belong. When specified, format should be a comma-separated list of IDs. Must use VMSS agent pool type.
Disable Custom CA Trust on agent node pool.
Disable cluster autoscaler.
Disable Secure Boot on on an existing Trusted Launch enabled agent node pool.
Disable vTPM on an existing Trusted Launch enabled agent node pool.
When nodes are drain how many minutes to wait for all pods to be evicted.
Enable artifact streaming for VirtualMachineScaleSets managed by a node pool, to speed up the cold-start of containers on a node through on-demand image loading. To use this feature, container images must also enable artifact streaming on ACR. If not specified, the default is false.
Enable cluster autoscaler. Must use VMSS agent pool type.
Enable Custom CA Trust on agent node pool.
Enable Secure Boot on an existing Trusted Launch enabled agent node pool. Must use VMSS agent pool type.
Enable vTPM on an existing Trusted Launch enabled agent node pool. Must use VMSS agent pool type.
The node labels for the node pool. See https://aka.ms/node-labels for syntax of labels.
Maximum nodes count used for autoscaler, when "--enable-cluster-autoscaler" specified. Please specify the value in the range of [0, 1000] for user nodepool, and [1,1000] for system nodepool.
Extra nodes used to speed upgrade. When specified, it represents the number or percent used, eg. 5 or 33%.
Minimun nodes count used for autoscaler, when "--enable-cluster-autoscaler" specified. Please specify the value in the range of [0, 1000] for user nodepool, and [1,1000] for system nodepool.
The mode for a node pool which defines a node pool's primary function. If set as "System", AKS prefers system pods scheduling to node pools with mode System. Learn more at https://aka.ms/aks/nodepool/mode.
Do not wait for the long-running operation to finish.
The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node.
The node taints for the node pool.
The os-sku of the agent node pool.
Describes how VMs are added to or removed from nodepools.
Update SSH setting for the node pool. Use "disabled" to disable SSH access, "localuser" to enable SSH access using private key.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Update min-count or max-count for cluster autoscaler.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az aks nodepool upgrade
Upgrade the node pool in a managed Kubernetes cluster.
az aks nodepool upgrade --cluster-name
--name
--resource-group
[--aks-custom-headers]
[--drain-timeout]
[--kubernetes-version]
[--max-surge]
[--no-wait]
[--node-image-only]
[--node-soak-duration]
[--snapshot-id]
[--yes]Required Parameters
The cluster name.
The node pool name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Comma-separated key-value pairs to specify custom headers.
When nodes are drain how long to wait for all pods to be evicted.
Version of Kubernetes to upgrade the node pool to, such as "1.16.9".
Extra nodes used to speed upgrade. When specified, it represents the number or percent used, eg. 5 or 33% (mutually exclusive with "--node-image-only". See "az aks nodepool update --max-surge" to update max surge before upgrading with "--node-image-only").
Do not wait for the long-running operation to finish.
Only upgrade agent pool's node image.
The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node.
The source snapshot id used to upgrade this nodepool.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az aks nodepool upgrade (aks-preview extension)
Upgrade the node pool in a managed Kubernetes cluster.
az aks nodepool upgrade --cluster-name
--name
--resource-group
[--aks-custom-headers]
[--drain-timeout]
[--kubernetes-version]
[--max-surge]
[--no-wait]
[--node-image-only]
[--node-soak-duration]
[--snapshot-id]
[--yes]Required Parameters
The cluster name.
The node pool name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Send custom headers. When specified, format should be Key1=Value1,Key2=Value2.
When nodes are drain how many minutes to wait for all pods to be evicted.
Version of Kubernetes to upgrade the node pool to, such as "1.11.12".
Extra nodes used to speed upgrade. When specified, it represents the number or percent used, eg. 5 or 33%.
Do not wait for the long-running operation to finish.
Only upgrade agent pool's node image.
The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node.
The source snapshot id used to upgrade this nodepool. Must use VMSS agent pool type.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az aks nodepool wait
Wait for a node pool to reach a desired state.
If an operation on a node pool was interrupted or was started with --no-wait, use this command to wait for it to complete.
az aks nodepool wait --cluster-name
--name
--resource-group
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]Examples
Wait for a node pool to reach a desired state, polling every minute for up to thirty minutes.
az aks nodepool wait --created --interval 60 --cluster-name MyManagedCluster --resource-group MyResourceGroup --nodepool-name MyNodePool --timeout 1800Required Parameters
The cluster name.
The node pool name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
Polling interval in seconds.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for