az elastic-san volume

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 command. Learn more about extensions.

Manage Elastic SAN Volume.

Commands

Name	Description	Type	Status
az elastic-san volume create	Create a Volume.	Extension	GA
az elastic-san volume delete	Delete a Volume.	Extension	GA
az elastic-san volume list	List Volumes in a Volume Group.	Extension	GA
az elastic-san volume restore	Restore Soft Deleted Volumes.	Extension	Preview
az elastic-san volume show	Get a Volume.	Extension	GA
az elastic-san volume snapshot	Manage volume snapshot.	Extension	GA
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 update	Update a Volume.	Extension	GA
az elastic-san volume wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az elastic-san volume create

Create a Volume.

az elastic-san volume create --elastic-san --elastic-san-name
                             --name --volume-name
                             --resource-group
                             --size-gib
                             --volume-group --volume-group-name
                             [--creation-data]
                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Create a Volume.

az elastic-san volume create -g "rg" -e "san_name" -v "vg_name" -n "volume_name" --size-gib 2

Create a Volume from snapshot.

az elastic-san volume create -g "rg" -e "san_name" -v "vg_name" -n "volume_name_2" --size-gib 2 --creation-data '{source-id:"snapshot_id",create-source:VolumeSnapshot}'

Required Parameters

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

The name of the ElasticSan.

--name --volume-name -n

The name of the Volume.

--resource-group -g

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

--size-gib

Volume size.

Property	Value
Parameter group:	Properties Arguments

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

--creation-data

State of the operation on the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties 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

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 delete

Delete a Volume.

az elastic-san volume delete [--delete-snapshots --x-ms-delete-snapshots {false, true}]
                             [--delete-type {permanent}]
                             [--elastic-san --elastic-san-name]
                             [--force-delete --x-ms-force-delete {false, true}]
                             [--ids]
                             [--name --volume-name]
                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                             [--resource-group]
                             [--subscription]
                             [--volume-group --volume-group-name]
                             [--yes]

Examples

Delete a Volume.

az elastic-san volume delete -g "rg" -e "san_name" -v "vg_name" -n "volume_name"

Delete a volume with its snapshot

az elastic-san volume delete -g "rg" -e "san_name" -v "vg_name" -n "volume_name" -y --x-ms-delete-snapshots true --x-ms-force-delete true

Delete a deleted volume permanently

az elastic-san volume delete -g rg_name -e san_name -v volume_group_name -n deleted_volume_name -y --delete-type permanent

Optional Parameters

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

--delete-snapshots --x-ms-delete-snapshots

Optional, used to delete snapshots under volume. Allowed value are only true or false. Default value is false.

Property	Value
Accepted values:	false, true

--delete-type

Preview

Optional. Specifies that the delete operation should be a permanent delete for the soft deleted volume. The value of deleteType can only be 'permanent'.

Property	Value
Accepted values:	permanent

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

The name of the ElasticSan.

Property	Value
Parameter group:	Resource Id Arguments

--force-delete --x-ms-force-delete

Optional, used to delete volume if active sessions present. Allowed value are only true or false. Default value is false.

Property	Value
Accepted values:	false, true

--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 --volume-name -n

The name of the Volume.

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 list

List Volumes in a Volume Group.

az elastic-san volume list --elastic-san --elastic-san-name
                           --resource-group
                           --volume-group --volume-group-name
                           [--access-soft-deleted-resources --soft-deleted-only --x-ms-access-soft-deleted-resources {false, true}]
                           [--max-items]
                           [--next-token]

Examples

List Volumes in a Volume Group.

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

List soft-deleted volumes

az elastic-san volume list -g rg_name -e san_name -v volume_group_name --access-soft-deleted-resources true

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.

--access-soft-deleted-resources --soft-deleted-only --x-ms-access-soft-deleted-resources

Preview

Optional, returns only soft deleted volumes if set to true. If set to false or if not specified, returns only active volumes.

Property	Value
Accepted values:	false, true

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

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Restore Soft Deleted Volumes.

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

Examples

Restore a deleted volume

az elastic-san volume restore -g rg_name -e san_name -v volume_group_name -n deleted_volume_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

Property	Value
Parameter group:	Resource Id Arguments

--name --volume-name -n

The name of the Volume.

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

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 show

Get a Volume.

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

Examples

Get a Volume.

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

Property	Value
Parameter group:	Resource Id Arguments

--name --volume-name -n

The name of the Volume.

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 update

Update a Volume.

az elastic-san volume update [--add]
                             [--creation-data]
                             [--elastic-san --elastic-san-name]
                             [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                             [--ids]
                             [--name --volume-name]
                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                             [--remove]
                             [--resource-group]
                             [--set]
                             [--size-gib]
                             [--subscription]
                             [--volume-group --volume-group-name]

Examples

Update a Volume.

az elastic-san volume update -g "rg" -e "san_name" -v "vg_name" -n "volume_name" --size-gib 3

Optional Parameters

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

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property	Value
Parameter group:	Generic Update Arguments

--creation-data

State of the operation on the resource. 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.

Property	Value
Parameter group:	Resource Id Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name --volume-name -n

The name of the Volume.

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

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update 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

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update Arguments

--size-gib

Volume size.

Property	Value
Parameter group:	Properties 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 wait

Place the CLI in a waiting state until a condition is met.

az elastic-san volume wait [--created]
                           [--custom]
                           [--deleted]
                           [--elastic-san --elastic-san-name]
                           [--exists]
                           [--ids]
                           [--interval]
                           [--name --volume-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

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--name --volume-name -n

The name of the Volume.

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

Share via

az elastic-san volume

Commands

az elastic-san volume create

Examples

Required Parameters

Optional Parameters

az elastic-san volume delete

Examples

Optional Parameters

az elastic-san volume list

Examples

Required Parameters

Optional Parameters

az elastic-san volume restore

Examples

Optional Parameters

az elastic-san volume show

Examples

Optional Parameters

az elastic-san volume update

Examples

Optional Parameters

az elastic-san volume wait

Optional Parameters

Feedback