مشاركة عبر

az aks snapshot

  • Deprecated
  • Reference

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.

This command group has been deprecated and will be removed in a future release. Use 'aks nodepool snapshot' instead.

Commands to manage nodepool snapshots.

Commands

Name Description Type Status
az aks snapshot create

Create a nodepool snapshot.

 Core Deprecated
az aks snapshot create (aks-preview extension)

Create a snapshot of a cluster.

 Extension GA
az aks snapshot delete

Delete a nodepool snapshot.

 Core Deprecated
az aks snapshot delete (aks-preview extension)

Delete a cluster snapshot.

 Extension GA
az aks snapshot list

List nodepool snapshots.

 Core Deprecated
az aks snapshot list (aks-preview extension)

List cluster snapshots.

 Extension GA
az aks snapshot show

Show the details of a nodepool snapshot.

 Core Deprecated
az aks snapshot show (aks-preview extension)

Show the details of a cluster snapshot.

 Extension GA
az aks snapshot wait

Wait for a nodepool snapshot to reach a desired state.

 Core Deprecated

az aks snapshot create

Edit
Deprecated

This command is implicitly deprecated because command group 'aks snapshot' is deprecated and will be removed in a future release. Use 'aks nodepool snapshot' instead.

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.

Default value: False
--tags

The tags of the snapshot.

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 aks snapshot create (aks-preview extension)

Create a snapshot of a cluster.

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

Examples

Create a cluster snapshot.

az aks snapshot create -g MyResourceGroup -n snapshot1 --cluster-id "/subscriptions/00000/resourceGroups/AnotherResourceGroup/providers/Microsoft.ContainerService/managedClusters/akscluster1"

Create a cluster snapshot with custom tags.

az aks snapshot create -g MyResourceGroup -n snapshot1 --cluster-id "/subscriptions/00000/resourceGroups/AnotherResourceGroup/providers/Microsoft.ContainerService/managedClusters/akscluster1" --tags "foo=bar" "key1=val1"

Required Parameters

--cluster-id

The source cluster id from which to create this snapshot.

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

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

Default value: False
--tags

The tags of the snapshot.

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 aks snapshot delete

Edit
Deprecated

This command is implicitly deprecated because command group 'aks snapshot' is deprecated and will be removed in a future release. Use 'aks nodepool snapshot' instead.

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.

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 aks snapshot delete (aks-preview extension)

Delete a cluster snapshot.

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

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

--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 aks snapshot list

Edit
Deprecated

This command is implicitly deprecated because command group 'aks snapshot' is deprecated and will be removed in a future release. Use 'aks nodepool snapshot' instead.

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

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 aks snapshot list (aks-preview extension)

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

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 aks snapshot show

Edit
Deprecated

This command is implicitly deprecated because command group 'aks snapshot' is deprecated and will be removed in a future release. Use 'aks nodepool snapshot' instead.

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

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 aks snapshot show (aks-preview extension)

Show the details of a cluster snapshot.

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

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

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 aks snapshot wait

Edit
Deprecated

This command is implicitly deprecated because command group 'aks snapshot' is deprecated and will be removed in a future release. Use 'aks nodepool snapshot' instead.

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

Default value: False
--custom

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

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--interval

Polling interval in seconds.

Default value: 30
--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

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.