az aks nodepool auto-scale

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 nodepool virtualMachinesProfile.scale.autoscale.

Commands

Name Description Type Status
az aks nodepool auto-scale add

Add a new autoscale profile to a VirtualMachines agentpool in the managed Kubernetes cluster.

Core GA
az aks nodepool auto-scale add (aks-preview extension)

Add a new autoscale profile to a VirtualMachines agentpool in the managed Kubernetes cluster.

Extension GA
az aks nodepool auto-scale delete

Delete an existing autoscale profile from a VirtualMachines agentpool in the managed Kubernetes cluster.

Core GA
az aks nodepool auto-scale delete (aks-preview extension)

Delete an existing autoscale profile from a VirtualMachines agentpool in the managed Kubernetes cluster.

Extension GA
az aks nodepool auto-scale update

Update an existing autoscale profile of a VirtualMachines agentpool in the managed Kubernetes cluster.

Core GA
az aks nodepool auto-scale update (aks-preview extension)

Update an existing autoscale profile of a VirtualMachines agentpool in the managed Kubernetes cluster.

Extension GA

az aks nodepool auto-scale add

Add a new autoscale profile to a VirtualMachines agentpool in the managed Kubernetes cluster.

az aks nodepool auto-scale add --cluster-name
                               --max-count
                               --min-count
                               --name --nodepool-name
                               --node-vm-size
                               --resource-group
                               [--acquire-policy-token]
                               [--change-reference]
                               [--no-wait]

Examples

Add an autoscale profile to a VirtualMachines agentpool

az aks nodepool auto-scale add -g MyResourceGroup --cluster-name MyMC --name MyNodePool --node-vm-size Standard_D2s_v3 --min-count 3 --max-count 5

Required Parameters

--cluster-name

The cluster name.

--max-count

Maximum number of nodes for autoscaling.

--min-count

Minimum number of nodes for autoscaling.

--name --nodepool-name -n

The node pool name.

--node-vm-size

VM size for the autoscale profile.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--no-wait

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

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 aks nodepool auto-scale add (aks-preview extension)

Add a new autoscale profile to a VirtualMachines agentpool in the managed Kubernetes cluster.

az aks nodepool auto-scale add --cluster-name
                               --max-count
                               --min-count
                               --name --nodepool-name
                               --node-vm-size
                               --resource-group
                               [--acquire-policy-token]
                               [--change-reference]
                               [--no-wait]

Examples

Add an autoscale profile to a VirtualMachines agentpool

az aks nodepool auto-scale add -g MyResourceGroup --cluster-name MyMC --name MyNodePool --node-vm-size Standard_D2s_v3 --min-count 3 --max-count 5

Required Parameters

--cluster-name

The cluster name.

--max-count
Preview

Maximum number of nodes for autoscaling.

--min-count
Preview

Minimum number of nodes for autoscaling.

--name --nodepool-name -n

The node pool name.

--node-vm-size
Preview

VM size for the autoscale profile.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--no-wait

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

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 aks nodepool auto-scale delete

Delete an existing autoscale profile from a VirtualMachines agentpool in the managed Kubernetes cluster.

az aks nodepool auto-scale delete --cluster-name
                                  --current-node-vm-size
                                  --name --nodepool-name
                                  --resource-group
                                  [--acquire-policy-token]
                                  [--change-reference]
                                  [--no-wait]
                                  [--yes]

Examples

Delete an autoscale profile from a VirtualMachines agentpool

az aks nodepool auto-scale delete -g MyResourceGroup --cluster-name MyMC --name MyNodePool --current-node-vm-size Standard_D2s_v3

Required Parameters

--cluster-name

The cluster name.

--current-node-vm-size

The VM size of the autoscale profile to be deleted.

--name --nodepool-name -n

The node pool name.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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 aks nodepool auto-scale delete (aks-preview extension)

Delete an existing autoscale profile from a VirtualMachines agentpool in the managed Kubernetes cluster.

az aks nodepool auto-scale delete --cluster-name
                                  --current-node-vm-size
                                  --name --nodepool-name
                                  --resource-group
                                  [--acquire-policy-token]
                                  [--change-reference]
                                  [--no-wait]

Examples

Delete an autoscale profile from a VirtualMachines agentpool

az aks nodepool auto-scale delete -g MyResourceGroup --cluster-name MyMC --name MyNodePool --current-node-vm-size Standard_D2s_v3

Required Parameters

--cluster-name

The cluster name.

--current-node-vm-size
Preview

The VM size of the autoscale profile to be deleted.

--name --nodepool-name -n

The node pool name.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--no-wait

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

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 aks nodepool auto-scale update

Update an existing autoscale profile of a VirtualMachines agentpool in the managed Kubernetes cluster.

az aks nodepool auto-scale update --cluster-name
                                  --current-node-vm-size
                                  --name --nodepool-name
                                  --resource-group
                                  [--acquire-policy-token]
                                  [--change-reference]
                                  [--max-count]
                                  [--min-count]
                                  [--no-wait]
                                  [--node-vm-size]

Examples

Update an existing autoscale profile in a VirtualMachines agentpool

az aks nodepool auto-scale update -g MyResourceGroup --cluster-name MyMC --name MyNodePool --current-node-vm-size Standard_D2s_v3 --node-vm-size Standard_D8s_v3 --min-count 2 --max-count 4

Required Parameters

--cluster-name

The cluster name.

--current-node-vm-size

The current VM size of the autoscale profile to be updated.

--name --nodepool-name -n

The node pool name.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--max-count

Maximum number of nodes for autoscaling.

--min-count

Minimum number of nodes for autoscaling.

--no-wait

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

Property Value
Default value: False
--node-vm-size

The new VM size for the autoscale profile.

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 aks nodepool auto-scale update (aks-preview extension)

Update an existing autoscale profile of a VirtualMachines agentpool in the managed Kubernetes cluster.

az aks nodepool auto-scale update --cluster-name
                                  --current-node-vm-size
                                  --name --nodepool-name
                                  --resource-group
                                  [--acquire-policy-token]
                                  [--change-reference]
                                  [--max-count]
                                  [--min-count]
                                  [--no-wait]
                                  [--node-vm-size]

Examples

Update an existing autoscale profile in a VirtualMachines agentpool

az aks nodepool auto-scale update -g MyResourceGroup --cluster-name MyMC --name MyNodePool --current-node-vm-size Standard_D2s_v3 --node-vm-size Standard_D8s_v3 --min-count 2 --max-count 4

Required Parameters

--cluster-name

The cluster name.

--current-node-vm-size
Preview

The current VM size of the autoscale profile to be updated.

--name --nodepool-name -n

The node pool name.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--max-count
Preview

Maximum number of nodes for autoscaling.

--min-count
Preview

Minimum number of nodes for autoscaling.

--no-wait

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

Property Value
Default value: False
--node-vm-size
Preview

The new VM size for the autoscale profile.

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