az aks snapshot

Commands to manage nodepool snapshots.

Commands

az aks snapshot create

Create a nodepool snapshot.

az aks snapshot delete

Delete a nodepool snapshot.

az aks snapshot list

List nodepool snapshots.

az aks snapshot show

Show the details of a nodepool snapshot.

az aks snapshot wait

Wait for a nodepool snapshot to reach a desired state.

az aks snapshot create

Create a nodepool snapshot.

az aks snapshot create --name
                       --nodepool-id
                       --resource-group
                       [--aks-custom-headers]
                       [--location]
                       [--no-wait]
                       [--tags]

Required Parameters

--name -n

The nodepool snapshot name.

--nodepool-id

The source nodepool id from which to create this snapshot.

--resource-group -g

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

Optional Parameters

--aks-custom-headers

Send custom headers. When specified, format should be Key1=Value1,Key2=Value2.

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

--tags

The tags of the snapshot.

az aks snapshot delete

Delete a nodepool snapshot.

az aks snapshot delete --name
                       --resource-group
                       [--no-wait]
                       [--yes]

Required Parameters

--name -n

The nodepool snapshot name.

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

--yes -y

Do not prompt for confirmation.

az aks snapshot list

List nodepool snapshots.

az aks snapshot list [--resource-group]

Optional Parameters

--resource-group -g

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

az aks snapshot show

Show the details of a nodepool snapshot.

az aks snapshot show --name
                     --resource-group

Required Parameters

--name -n

The nodepool snapshot name.

--resource-group -g

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

az aks snapshot wait

Wait for a nodepool snapshot to reach a desired state.

If an operation on a nodepool snapshot was interrupted or was started with --no-wait, use this command to wait for it to complete.

az aks snapshot wait --name
                     --resource-group
                     [--created]
                     [--custom]
                     [--deleted]
                     [--exists]
                     [--interval]
                     [--timeout]
                     [--updated]

Required Parameters

--name -n

Name of the managed cluster.

--resource-group -g

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

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--interval

Polling interval in seconds.

default value: 30
--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.