az elastic-san volume snapshot
Note
This reference is part of the elastic-san extension for the Azure CLI (version 2.55.0 or higher). The extension will automatically install the first time you run an az elastic-san volume snapshot command. Learn more about extensions.
Manage volume snapshot.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az elastic-san volume snapshot create |
Create a Volume Snapshot. |
Extension | GA |
| az elastic-san volume snapshot delete |
Delete a Volume Snapshot. |
Extension | GA |
| az elastic-san volume snapshot list |
List Snapshots in a VolumeGroup or List Snapshots by Volume (name) in a VolumeGroup using filter. |
Extension | GA |
| az elastic-san volume snapshot show |
Get a Volume Snapshot. |
Extension | GA |
| az elastic-san volume snapshot wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az elastic-san volume snapshot create
Create a Volume Snapshot.
az elastic-san volume snapshot create --creation-data
--elastic-san
--name
--resource-group
--volume-group
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]Examples
snapshot create
az elastic-san volume snapshot create -g "rg" -e "san_name" -v "vg_name" -n "snapshot_name" --creation-data '{source-id:"volume_id"}'Required Parameters
Data used when creating a volume snapshot. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The name of the ElasticSan.
The name of the volume snapshot within the given volume group.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the VolumeGroup.
Optional Parameters
Do not wait for the long-running operation to finish.
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 elastic-san volume snapshot delete
Delete a Volume Snapshot.
az elastic-san volume snapshot delete [--elastic-san]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--volume-group]
[--yes]Examples
snapshot delete
az elastic-san volume snapshot delete -g "rg" -e "san_name" -v "vg_name" -n "snapshot_name"Optional Parameters
The name of the ElasticSan.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The name of the volume snapshot within the given volume group.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
The name of the VolumeGroup.
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 elastic-san volume snapshot list
List Snapshots in a VolumeGroup or List Snapshots by Volume (name) in a VolumeGroup using filter.
az elastic-san volume snapshot list --elastic-san
--resource-group
--volume-group
[--filter]
[--max-items]
[--next-token]Examples
snapshot list
az elastic-san volume snapshot list -g "rg" -e "san_name" -v "vg_name"Required Parameters
The name of the ElasticSan.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the VolumeGroup.
Optional Parameters
Specify $filter='volumeName eq ' to filter on volume.
Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.
Token to specify where to start paginating. This is the token value from a previously truncated response.
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 elastic-san volume snapshot show
Get a Volume Snapshot.
az elastic-san volume snapshot show [--elastic-san]
[--ids]
[--name]
[--resource-group]
[--subscription]
[--volume-group]Examples
snapshot show
az elastic-san volume snapshot show -g "rg" -e "san_name" -v "vg_name" -n "snapshot_name"Optional Parameters
The name of the ElasticSan.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The name of the volume snapshot within the given volume group.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
The name of the VolumeGroup.
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 elastic-san volume snapshot wait
Place the CLI in a waiting state until a condition is met.
az elastic-san volume snapshot wait [--created]
[--custom]
[--deleted]
[--elastic-san]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
[--volume-group]Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
The name of the ElasticSan.
Wait until the resource exists.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Polling interval in seconds.
The name of the volume snapshot within the given volume group.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
The name of the VolumeGroup.
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
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: https://aka.ms/ContentUserFeedback.
Submit and view feedback for