Share via

az aksarc nodepool

Note

This reference is part of the aksarc extension for the Azure CLI (version 2.32.0 or higher). The extension will automatically install the first time you run an az aksarc nodepool command. Learn more about extensions.

Manage nodepools in a provisioned cluster.

Commands

Name Description Type Status
az aksarc nodepool add

Adds a nodepool in the provisioned cluster.

 Extension GA
az aksarc nodepool delete

Deletes the nodepool in the provisioned cluster.

 Extension GA
az aksarc nodepool list

Lists all the nodepools in the provisioned cluster.

 Extension GA
az aksarc nodepool scale

Scales the nodepool in the provisioned cluster.

 Extension GA
az aksarc nodepool show

Gets the nodepool in the provisioned cluster.

 Extension GA
az aksarc nodepool update

Update a nodepool in the provisioned cluster.

 Extension GA

az aksarc nodepool add

Adds a nodepool in the provisioned cluster.

az aksarc nodepool add --cluster-name
                       --name
                       --resource-group
                       [--enable-cluster-autoscaler]
                       [--labels]
                       [--max-count]
                       [--max-pods]
                       [--min-count]
                       [--no-wait]
                       [--node-count]
                       [--node-taints]
                       [--node-vm-size]
                       [--os-sku]
                       [--os-type]
                       [--tags]

Examples

AddNodepool

az aksarc nodepool add --name "samplenodepool" --cluster-name "samplecluster" --resource-group "sample-rg"

Required Parameters

--cluster-name

Name of the provisioned cluster.

--name -n

Name of the nodepool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--enable-cluster-autoscaler -e

Enable cluster auto-scaler for the provisioned cluster.

Property Value
Default value: False
--labels

Space-separated labels: key[=value] [key[=value] ...].

--max-count

The maximum number of nodes for auto-scaling.

--max-pods -m

Maximum number of pods that can run on a node.

--min-count

The minimum number of nodes for auto-scaling.

--no-wait

Do not wait for the long-running operation to finish.

Property Value
Default value: False
--node-count -c

Number of nodes to be created in the nodepool.

--node-taints

Comma-separated list of nodepool taints.

--node-vm-size

VM Size of the nodes in the nodepool.

--os-sku

OS Sku for the nodes in the nodepool. Options: "CBLMariner" | "Windows2019" | "Windows2022".

--os-type

OS Type for the nodes in the nodepool. Options: "Linux" | "Windows".

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az aksarc nodepool delete

Deletes the nodepool in the provisioned cluster.

az aksarc nodepool delete --cluster-name
                          --name
                          --resource-group
                          [--no-wait]
                          [--yes]

Examples

DeleteNodepool

az aksarc nodepool delete --name "samplenodepool" --cluster-name "samplecluster" --resource-group "sample-rg"

Required Parameters

--cluster-name

Name of the provisioned cluster.

--name -n

Name of the nodepool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Do not wait for the long-running operation to finish.

Property Value
Default value: False
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az aksarc nodepool list

Lists all the nodepools in the provisioned cluster.

az aksarc nodepool list --cluster-name
                        --resource-group

Examples

ListNodepool

az aksarc nodepool list --cluster-name "samplecluster" --resource-group "sample-rg"

Required Parameters

--cluster-name

Name of the provisioned cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az aksarc nodepool scale

Scales the nodepool in the provisioned cluster.

az aksarc nodepool scale --cluster-name
                         --name
                         --resource-group
                         [--no-wait]
                         [--node-count]
                         [--node-vm-size]
                         [--yes]

Examples

ScaleNodePoolCount

az aksarc nodepool scale --name "samplenodepool" --cluster-name "samplecluster" --resource-group "sample-rg" --node-count 3

ScaleNodePoolVMSize

az aksarc nodepool scale --name "samplenodepool" --cluster-name "samplecluster" --resource-group "sample-rg" --node-vm-size "Standard_A2_v2"

Required Parameters

--cluster-name

Name of the provisioned cluster.

--name -n

Name of the nodepool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Do not wait for the long-running operation to finish.

Property Value
Default value: False
--node-count -c

Number of nodes to scale to in the nodepool.

--node-vm-size

VM Size of the nodes in the nodepool.

--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az aksarc nodepool show

Gets the nodepool in the provisioned cluster.

az aksarc nodepool show --cluster-name
                        --name
                        --resource-group

Examples

GetNodepool

az aksarc nodepool show --name "samplenodepool" --cluster-name "samplecluster" --resource-group "sample-rg"

Required Parameters

--cluster-name

Name of the provisioned cluster.

--name -n

Name of the nodepool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az aksarc nodepool update

Update a nodepool in the provisioned cluster.

az aksarc nodepool update --cluster-name
                          --name
                          --resource-group
                          [--disable-cluster-autoscaler]
                          [--enable-cluster-autoscaler]
                          [--labels]
                          [--max-count]
                          [--min-count]
                          [--no-wait]
                          [--node-taints]
                          [--update-cluster-autoscaler]

Examples

UpdateNodepool

az aksarc nodepool update --name "samplenodepool" --cluster-name "samplecluster" --resource-group "sample-rg" --disable-cluster-autoscaler

Required Parameters

--cluster-name

Name of the provisioned cluster.

--name -n

Name of the nodepool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--disable-cluster-autoscaler -d

Disable cluster auto-scaler for the provisioned cluster.

Property Value
Default value: False
--enable-cluster-autoscaler -e

Enable cluster auto-scaler for the provisioned cluster.

Property Value
Default value: False
--labels

Space-separated labels: key[=value] [key[=value] ...]. Pass an empty string to clear the labels.

--max-count

The maximum number of nodes for auto-scaling.

--min-count

The minimum number of nodes for auto-scaling.

--no-wait

Do not wait for the long-running operation to finish.

Property Value
Default value: False
--node-taints

Comma-separated list of nodepool taints. Pass an empty string to clear the taints.

--update-cluster-autoscaler -u

Update cluster auto-scaler for the provisioned cluster.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False