az elastic-san volume

  • Reference

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 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 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
                             --name
                             --resource-group
                             --size-gib
                             --volume-group
                             [--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.

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

The name of the VolumeGroup.

Optional Parameters

--creation-data

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

--no-wait

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

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

Delete a Volume.

az elastic-san volume delete [--elastic-san]
                             [--ids]
                             [--name]
                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                             [--resource-group]
                             [--subscription]
                             [--volume-group]
                             [--x-ms-delete-snapshots {false, true}]
                             [--x-ms-force-delete {false, true}]
                             [--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

Optional Parameters

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

The name of the ElasticSan.

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

--name --volume-name -n

The name of the Volume.

--no-wait

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

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

--subscription

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

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

The name of the VolumeGroup.

--x-ms-delete-snapshots

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

accepted values: false, true
--x-ms-force-delete

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

accepted values: false, true
--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 elastic-san volume list

List Volumes in a Volume Group.

az elastic-san volume list --elastic-san
                           --resource-group
                           --volume-group
                           [--max-items]
                           [--next-token]

Examples

List Volumes in a Volume Group.

az elastic-san volume 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

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

--next-token

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

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 elastic-san volume show

Get a Volume.

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

Examples

Get a Volume.

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

Optional Parameters

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

The name of the ElasticSan.

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

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

--subscription

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

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

The name of the VolumeGroup.

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 elastic-san volume update

Update a Volume.

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

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

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

--creation-data

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

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

The name of the ElasticSan.

--force-string

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

--name --volume-name -n

The name of the Volume.

--no-wait

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

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 OR --remove propertyToRemove.

--resource-group -g

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

--set

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

--size-gib

Volume size.

--subscription

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

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

The name of the VolumeGroup.

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

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
--elastic-san --elastic-san-name -e

The name of the ElasticSan.

--exists

Wait until the resource exists.

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.

--interval

Polling interval in seconds.

default value: 30
--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>.

--subscription

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

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

default value: False
--volume-group --volume-group-name -v

The name of the VolumeGroup.

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.