az aksarc nodepool

Preview

Note

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

Command group 'aksarc' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manages node pools in a provisioned cluster.

Commands

Name	Description	Type	Status
az aksarc nodepool add	Adds a node pool in the provisioned cluster.	Extension	Preview
az aksarc nodepool delete	Deletes the nodepool in the provisioned cluster.	Extension	Preview
az aksarc nodepool list	Lists all the node pools in the provisioned cluster.	Extension	Preview
az aksarc nodepool scale	Scales the node pool in the provisioned cluster.	Extension	Preview
az aksarc nodepool show	Gets the node pool in the provisioned cluster.	Extension	Preview

az aksarc nodepool add

Preview

Command group 'aksarc nodepool' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Adds a node pool in the provisioned cluster.

az aksarc nodepool add --cluster-name
                       --name
                       --resource-group
                       [--no-wait]
                       [--node-count]
                       [--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 node pool.

--resource-group -g

Name of the 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 be created in the node pool.

--node-vm-size

VM size of the nodes in the node pool.

--os-sku

OS SKU for the nodes in the node pool. Options: "CBLMariner" | "Windows2019" | "Windows2022".

--os-type

OS type for the nodes in the node pool. 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.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

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

az aksarc nodepool delete

Preview

Command group 'aksarc nodepool' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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 node pool.

--resource-group -g

Name of the 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.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

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

az aksarc nodepool list

Preview

Command group 'aksarc nodepool' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Lists all the node pools 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.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

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

az aksarc nodepool scale

Preview

Command group 'aksarc nodepool' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Scales the node pool in the provisioned cluster.

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

Examples

ScaleNodePool

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

Required Parameters

--cluster-name

Name of the provisioned cluster.

--name -n

Name of the node pool.

--resource-group -g

Name of the 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 node pool.

--node-vm-size

VM size of the nodes in the node pool.

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

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

az aksarc nodepool show

Preview

Command group 'aksarc nodepool' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Gets the node pool 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 node pool.

--resource-group -g

Name of the 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.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

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

Feedback

Was this page helpful?