Share via

az elastic-san volume snapshot

Note

This reference is part of the elastic-san extension for the Azure CLI (version 2.70.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 --elastic-san-name
                                      --name --snapshot-name
                                      --resource-group
                                      --volume-group --volume-group-name
                                      [--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

--creation-data

Data used when creating a volume snapshot. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--elastic-san --elastic-san-name -e

The name of the ElasticSan.

--name --snapshot-name -n

The name of the volume snapshot within the given volume group.

--resource-group -g

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

--volume-group --volume-group-name -v

The name of the VolumeGroup.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
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 elastic-san volume snapshot delete

Delete a Volume Snapshot.

az elastic-san volume snapshot delete [--elastic-san --elastic-san-name]
                                      [--ids]
                                      [--name --snapshot-name]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--resource-group]
                                      [--subscription]
                                      [--volume-group --volume-group-name]
                                      [--yes]

Examples

snapshot delete

az elastic-san volume snapshot delete -g "rg" -e "san_name" -v "vg_name" -n "snapshot_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.

--elastic-san --elastic-san-name -e

The name of the ElasticSan.

Property Value
Parameter group: Resource Id Arguments
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--name --snapshot-name -n

The name of the volume snapshot within the given volume group.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--volume-group --volume-group-name -v

The name of the VolumeGroup.

Property Value
Parameter group: Resource Id Arguments
--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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

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 --elastic-san-name
                                    --resource-group
                                    --volume-group --volume-group-name
                                    [--filter]
                                    [--max-items]
                                    [--next-token]

Examples

snapshot list

az elastic-san volume snapshot list -g "rg" -e "san_name" -v "vg_name"

Required Parameters

--elastic-san --elastic-san-name -e

The name of the ElasticSan.

--resource-group -g

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

--volume-group --volume-group-name -v

The name of the VolumeGroup.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--filter

Specify $filter='volumeName eq <volume name>' to filter on volume.

--max-items

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.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination Arguments
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 elastic-san volume snapshot show

Get a Volume Snapshot.

az elastic-san volume snapshot show [--elastic-san --elastic-san-name]
                                    [--ids]
                                    [--name --snapshot-name]
                                    [--resource-group]
                                    [--subscription]
                                    [--volume-group --volume-group-name]

Examples

snapshot show

az elastic-san volume snapshot show -g "rg" -e "san_name" -v "vg_name" -n "snapshot_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.

--elastic-san --elastic-san-name -e

The name of the ElasticSan.

Property Value
Parameter group: Resource Id Arguments
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--name --snapshot-name -n

The name of the volume snapshot within the given volume group.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--volume-group --volume-group-name -v

The name of the VolumeGroup.

Property Value
Parameter group: Resource Id Arguments
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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

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 --elastic-san-name]
                                    [--exists]
                                    [--ids]
                                    [--interval]
                                    [--name --snapshot-name]
                                    [--resource-group]
                                    [--subscription]
                                    [--timeout]
                                    [--updated]
                                    [--volume-group --volume-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.

--created

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

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

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

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--elastic-san --elastic-san-name -e

The name of the ElasticSan.

Property Value
Parameter group: Resource Id Arguments
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--name --snapshot-name -n

The name of the volume snapshot within the given volume group.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--volume-group --volume-group-name -v

The name of the VolumeGroup.

Property Value
Parameter group: Resource Id Arguments
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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False