az elastic-san volume-group
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-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 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
--name
--resource-group
[--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"}}'Required Parameters
The name of the ElasticSan.
The name of the VolumeGroup.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Type of encryption.
Encryption Properties describing Key Vault and Identity information Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The identity of the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
A collection of rules governing the accessibility from specific network locations. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Do not wait for the long-running operation to finish.
Type of storage target.
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-group delete
Delete a Volume Group.
az elastic-san volume-group delete [--elastic-san]
[--ids]
[--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 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 VolumeGroup.
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.
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-group list
List Volume Groups.
az elastic-san volume-group list --elastic-san
--resource-group
[--max-items]
[--next-token]Examples
List Volume Groups.
az elastic-san volume-group list -g "rg" -e "san_name"Required Parameters
The name of the ElasticSan.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
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-group show
Get a Volume Group.
az elastic-san volume-group show [--elastic-san]
[--ids]
[--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 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 VolumeGroup.
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.
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-group update
Update a Volume Group.
az elastic-san volume-group update [--add]
[--elastic-san]
[--encryption {EncryptionAtRestWithCustomerManagedKey, EncryptionAtRestWithPlatformKey}]
[--encryption-properties]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--identity]
[--ids]
[--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 EncryptionAtRestWithPlatformKeyUpdate volume group back to SystemAssignedIdentity
az elastic-san volume-group update -e "san_name" -n "vg_name" -g "rg" --identity '{type:SystemAssigned}'Optional Parameters
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>.
The name of the ElasticSan.
Type of encryption.
Encryption Properties describing Key Vault and Identity information Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
The identity of the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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 VolumeGroup.
A collection of rules governing the accessibility from specific network locations. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Do not wait for the long-running operation to finish.
Type of storage target.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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-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]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]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 VolumeGroup.
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'.
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