az aks nodepool snapshot
Note
This reference is part of the aks-preview extension for the Azure CLI (version 2.56.0 or higher). The extension will automatically install the first time you run an az aks nodepool snapshot command. Learn more about extensions.
Commands to manage nodepool snapshots.
Commands
Name | Description | Type | Status |
---|---|---|---|
az aks nodepool snapshot create |
Create a nodepool snapshot. |
Extension | GA |
az aks nodepool snapshot delete |
Delete a nodepool snapshot. |
Extension | GA |
az aks nodepool snapshot list |
List nodepool snapshots. |
Extension | GA |
az aks nodepool snapshot show |
Show the details of a nodepool snapshot. |
Extension | GA |
az aks nodepool snapshot update |
Update tags on a snapshot of a nodepool. |
Extension | GA |
az aks nodepool snapshot create
Create a nodepool snapshot.
az aks nodepool snapshot create --name
--nodepool-id
--resource-group
[--aks-custom-headers]
[--location]
[--no-wait]
[--tags]
Examples
Create a nodepool snapshot.
az aks nodepool snapshot create -g MyResourceGroup -n snapshot1 --nodepool-id "/subscriptions/00000/resourceGroups/AnotherResourceGroup/providers/Microsoft.ContainerService/managedClusters/akscluster1/agentPools/nodepool1"
Create a nodepool snapshot with custom tags.
az aks nodepool snapshot create -g MyResourceGroup -n snapshot1 --nodepool-id "/subscriptions/00000/resourceGroups/AnotherResourceGroup/providers/Microsoft.ContainerService/managedClusters/akscluster1/agentPools/nodepool1" --tags "foo=bar" "key1=val1"
Required Parameters
The nodepool snapshot name.
The source nodepool id from which to create this snapshot.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Send custom headers. When specified, format should be Key1=Value1,Key2=Value2.
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Do not wait for the long-running operation to finish.
The tags of the snapshot.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az aks nodepool snapshot delete
Delete a nodepool snapshot.
az aks nodepool snapshot delete --name
--resource-group
[--no-wait]
[--yes]
Required Parameters
The nodepool snapshot name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Do not wait for the long-running operation to finish.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az aks nodepool snapshot list
List nodepool snapshots.
az aks nodepool snapshot list [--resource-group]
Optional Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az aks nodepool snapshot show
Show the details of a nodepool snapshot.
az aks nodepool snapshot show --name
--resource-group
Required Parameters
The nodepool snapshot name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az aks nodepool snapshot update
Update tags on a snapshot of a nodepool.
az aks nodepool snapshot update --name
--resource-group
--tags
Examples
Update tags on a nodepool snapshot.
az aks nodepool snapshot update -g MyResourceGroup -n snapshot1 --tags "foo=bar" "key1=val1"
Clear tags on a nodepool snapshot.
az aks nodepool snapshot update -g MyResourceGroup -n snapshot1 --tags ""
Required Parameters
The nodepool snapshot name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The tags to set to the snapshot.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for