az elastic-san volume-group

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

Manage Elastic SAN Volume Group.

Commands

Name	Description	Type	Status
az elastic-san volume-group create	Create a Volume Group.	Extension	GA
az elastic-san volume-group delete	Delete a Volume Group.	Extension	GA
az elastic-san volume-group list	List Volume Groups.	Extension	GA
az elastic-san volume-group show	Get a Volume Group.	Extension	GA
az elastic-san volume-group test-backup	Validate whether a disk snapshot backup can be taken for list of volumes.	Extension	Preview
az elastic-san volume-group test-restore	Validate whether a list of backed up disk snapshots can be restored into ElasticSan volumes.	Extension	Preview
az elastic-san volume-group update	Update a Volume Group.	Extension	GA
az elastic-san volume-group wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az elastic-san volume-group create

Create a Volume Group.

az elastic-san volume-group create --elastic-san --elastic-san-name
                                   --name --volume-group-name
                                   --resource-group
                                   [--data-integrity-check --enforce-data-integrity-check-for-iscsi {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--delete-retention-period-days --retention-period]
                                   [--delete-retention-policy-state --delete-retention-state {Disabled, Enabled}]
                                   [--encryption {EncryptionAtRestWithCustomerManagedKey, EncryptionAtRestWithPlatformKey}]
                                   [--encryption-properties]
                                   [--identity]
                                   [--network-acls]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--protocol-type {Iscsi, None}]

Examples

Create a Volume Group with PlaformManagedkey and SystemAssignedIdentity

az elastic-san volume-group create -e "san_name" -n "vg_name" -g "rg" --tags '{key1910:bbbb}' --encryption EncryptionAtRestWithPlatformKey --protocol-type Iscsi --network-acls '{virtual-network-rules:[{id:"subnet_id",action:Allow}]}' --identity '{type:SystemAssigned}'

Create a volume group with CustomerManagedKey and UserAssignedIdentity

az elastic-san volume-group create -e "san_name" -n "vg_name" -g "rg" --encryption EncryptionAtRestWithCustomerManagedKey --protocol-type Iscsi --identity '{type:UserAssigned,user-assigned-identity:"uai_id"}' --encryption-properties '{key-vault-properties:{key-name:"key_name",key-vault-uri:"vault_uri"},identity:{user-assigned-identity:"uai_id"}}'

Create a volume group with delete retention policy params

az elastic-san volume-group create -e san_name -n volume_group_name -g rg_name --encryption EncryptionAtRestWithPlatformKey --protocol-type Iscsi --network-acls '{virtual-network-rules:[{id:{subnet_id},action:Allow}]}' --delete-retention-policy-state Enabled --delete-retention-period-days 7

Required Parameters

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

The name of the ElasticSan.

--name --volume-group-name -n

The name of the VolumeGroup.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults 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.

--data-integrity-check --enforce-data-integrity-check-for-iscsi

A boolean indicating whether or not Data Integrity Check is enabled.

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

--delete-retention-period-days --retention-period

Preview

The number of days to retain the resources after deletion.

Property	Value
Parameter group:	DeleteRetentionPolicy Arguments

--delete-retention-policy-state --delete-retention-state

Preview

Manage delete retention policy state.

Property	Value
Parameter group:	DeleteRetentionPolicy Arguments
Accepted values:	Disabled, Enabled

--encryption

Type of encryption.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	EncryptionAtRestWithCustomerManagedKey, EncryptionAtRestWithPlatformKey

--encryption-properties

Encryption Properties describing Key Vault and Identity information Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--identity

The identity of the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Parameters Arguments

--network-acls

A collection of rules governing the accessibility from specific network locations. 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

--protocol-type

Type of storage target.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Iscsi, None

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-group delete

Delete a Volume Group.

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

Examples

Delete a Volume Group.

az elastic-san volume-group delete -g "rg" -e "san_name" -n "vg_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 --volume-group-name -n

The name of the VolumeGroup.

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

--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-group list

List Volume Groups.

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

Examples

List Volume Groups.

az elastic-san volume-group list -g "rg" -e "san_name"

List soft-deleted volume groups

az elastic-san volume-group list -g rg_name -e san_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>.

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 volume groups if set to true. If set to false or if not specified, returns only active volume groups.

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-group show

Get a Volume Group.

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

Examples

Get a Volume Group.

az elastic-san volume-group show -g "rg" -e "san_name" -n "vg_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 --volume-group-name -n

The name of the VolumeGroup.

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

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-group test-backup

Preview

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

Validate whether a disk snapshot backup can be taken for list of volumes.

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

Examples

Test Backup

az elastic-san volume-group test-backup -g rg_name -e san_name -n volume_group_name --volume-names "[volume_name]"

Required Parameters

--volume-names

Array of volume names Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Parameters Arguments

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

The name of the VolumeGroup.

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

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

Preview

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

Validate whether a list of backed up disk snapshots can be restored into ElasticSan volumes.

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

Examples

Test Restore

az elastic-san volume-group test-restore -g rg_name -e san_name -n volume_group_name --disk-snapshot-ids "[snapshot_id]"

Required Parameters

--disk-snapshot-ids

Array of DiskSnapshot ARM IDs Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Parameters Arguments

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

The name of the VolumeGroup.

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

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-group update

Update a Volume Group.

az elastic-san volume-group update [--add]
                                   [--data-integrity-check --enforce-data-integrity-check-for-iscsi {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--delete-retention-period-days --retention-period]
                                   [--delete-retention-policy-state --delete-retention-state {Disabled, Enabled}]
                                   [--elastic-san --elastic-san-name]
                                   [--encryption {EncryptionAtRestWithCustomerManagedKey, EncryptionAtRestWithPlatformKey}]
                                   [--encryption-properties]
                                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--identity]
                                   [--ids]
                                   [--name --volume-group-name]
                                   [--network-acls]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--protocol-type {Iscsi, None}]
                                   [--remove]
                                   [--resource-group]
                                   [--set]
                                   [--subscription]

Examples

Update a Volume Group.

az elastic-san volume-group update -e "san_name" -n "vg_name" -g "rg" --protocol-type None --network-acls '{virtual-network-rules:[{id:"subnet_id_2",action:Allow}]}'

Update volume group to use CustomerManagedKey with keyvault details

az elastic-san volume-group update -e "san_name" -n "vg_name" -g "rg" --encryption EncryptionAtRestWithCustomerManagedKey --encryption-properties '{key-vault-properties:{key-name:"key_name",key-vault-uri:"vault_uri"}}'

Update volume group to use another UserAssignedIdentity

az elastic-san volume-group update -e "san_name" -n "vg_name" -g "rg" --identity '{type:UserAssigned,user-assigned-identity:"uai_2_id"}' --encryption-properties '{key-vault-properties:{key-name:"key_name",key-vault-uri:"vault_uri"},identity:{user-assigned-identity:"uai_2_id"}}'

Update volume group back to PlatformManagedKey

az elastic-san volume-group update -e "san_name" -n "vg_name" -g "rg" --encryption EncryptionAtRestWithPlatformKey

Update volume group back to SystemAssignedIdentity

az elastic-san volume-group update -e "san_name" -n "vg_name" -g "rg" --identity '{type:SystemAssigned}'

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

--data-integrity-check --enforce-data-integrity-check-for-iscsi

A boolean indicating whether or not Data Integrity Check is enabled.

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

--delete-retention-period-days --retention-period

Preview

The number of days to retain the resources after deletion.

Property	Value
Parameter group:	DeleteRetentionPolicy Arguments

--delete-retention-policy-state --delete-retention-state

Preview

Manage delete retention policy state.

Property	Value
Parameter group:	DeleteRetentionPolicy Arguments
Accepted values:	Disabled, Enabled

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

The name of the ElasticSan.

Property	Value
Parameter group:	Resource Id Arguments

--encryption

Type of encryption.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	EncryptionAtRestWithCustomerManagedKey, EncryptionAtRestWithPlatformKey

--encryption-properties

Encryption Properties describing Key Vault and Identity information Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

--identity

The identity of the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Parameters 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 --volume-group-name -n

The name of the VolumeGroup.

Property	Value
Parameter group:	Resource Id Arguments

--network-acls

A collection of rules governing the accessibility from specific network locations. 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

--protocol-type

Type of storage target.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Iscsi, None

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

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

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-group wait

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

az elastic-san volume-group wait [--created]
                                 [--custom]
                                 [--deleted]
                                 [--elastic-san --elastic-san-name]
                                 [--exists]
                                 [--ids]
                                 [--interval]
                                 [--name --volume-group-name]
                                 [--resource-group]
                                 [--subscription]
                                 [--timeout]
                                 [--updated]

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

The name of the VolumeGroup.

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

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