az akshybrid nodepool

  • Preview
  • Reference

Note

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

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

Manage nodepools in a provisioned cluster.

Commands

Name Description Type Status
az akshybrid nodepool add

Adds a nodepool in the provisioned cluster.

 Extension Preview
az akshybrid nodepool delete

Deletes the nodepool in the provisioned cluster.

 Extension Preview
az akshybrid nodepool list

Lists all the nodepools in the provisioned cluster.

 Extension Preview
az akshybrid nodepool scale

Scales the nodepool in the provisioned cluster .

 Extension Preview
az akshybrid nodepool show

Gets the nodepool in the provisioned cluster.

 Extension Preview

az akshybrid nodepool add

Preview

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

Adds a nodepool in the provisioned cluster.

az akshybrid nodepool add --cluster-name
                          --name
                          --resource-group
                          [--location]
                          [--no-wait]
                          [--node-count]
                          [--node-vm-size]
                          [--os-sku]
                          [--os-type]
                          [--tags]

Examples

AddNodepool

az akshybrid 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

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

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

default value: False
--node-count -c

Number of nodes to be created in the nodepool.

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

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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 akshybrid nodepool delete

Preview

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

Deletes the nodepool in the provisioned cluster.

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

Examples

DeleteNodepool

az akshybrid 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

--no-wait

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

default value: False
--yes -y

Do not prompt for confirmation.

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.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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 akshybrid nodepool list

Preview

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

Lists all the nodepools in the provisioned cluster.

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

Examples

ListNodepool

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

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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 akshybrid nodepool scale

Preview

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

Scales the nodepool in the provisioned cluster .

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

Examples

ScaleNodePool

az akshybrid 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 nodepool.

--resource-group -g

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

Optional Parameters

--no-wait

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

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.

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.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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 akshybrid nodepool show

Preview

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

Gets the nodepool in the provisioned cluster.

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

Examples

GetNodepool

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

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.