az elastic-san

Note

This reference is part of the elastic-san extension for the Azure CLI (version 2.75.0 or higher). The extension will automatically install the first time you run an az elastic-san command. Learn more about extensions.

Manage Elastic SAN.

Commands

Name Description Type Status
az elastic-san create

Create an Elastic SAN.

Extension GA
az elastic-san delete

Delete an Elastic SAN.

Extension GA
az elastic-san list

Get a list of Elastic SANs in a subscription.

Extension GA
az elastic-san list-sku

Get a list of Elastic SAN skus.

Extension GA
az elastic-san show

Get an Elastic SAN.

Extension GA
az elastic-san update

Update an Elastic SAN.

Extension GA
az elastic-san volume

Manage Elastic SAN Volume.

Extension GA
az elastic-san volume-group

Manage Elastic SAN Volume Group.

Extension GA
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 GA
az elastic-san volume-group test-restore

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

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

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

Extension GA

az elastic-san create

Create an Elastic SAN.

az elastic-san create --elastic-san-name --name
                      --resource-group
                      --sku
                      [--acquire-policy-token]
                      [--auto-scale-policy --auto-scale-policy-enforcement {Disabled, Enabled, None}]
                      [--availability-zones]
                      [--base-size-tib]
                      [--capacity-unit-scale-up --capacity-unit-scale-up-limit-tib]
                      [--change-reference]
                      [--extended-capacity-size-tib --extended-size]
                      [--increase-capacity-unit --increase-capacity-unit-by-tib]
                      [--location]
                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                      [--public-network-access {Disabled, Enabled}]
                      [--tags]
                      [--total-iops]
                      [--total-mbps]
                      [--total-size-tib]
                      [--unused-size-tib]
                      [--version {V1, V2}]

Examples

Create an Elastic SAN.

az elastic-san create -n "san_name" -g "rg" --tags '{key1810:aaaa}' -l southcentralusstg --base-size-tib 23 --extended-capacity-size-tib 14 --sku '{name:Premium_LRS,tier:Premium}' --public-network-access Enabled --auto-scale-policy-enforcement Enabled --capacity-unit-scale-up-limit-tib 17 --increase-capacity-unit-by-tib 4 --unused-size-tib 24

Create an ElasticSAN with auto scale params

az elastic-san create -n san_name -g rg_name -l eastus2 --base-size-tib 23 --extended-capacity-size-tib 14 --sku '{name:Premium_LRS,tier:Premium}' --availability-zones 1 --auto-scale-policy-enforcement Enabled --capacity-unit-scale-up-limit-tib 40 --increase-capacity-unit-by-tib 4 --unused-size-tib 24 --availability-zones 1

Required Parameters

--elastic-san-name --name -n

The name of the ElasticSan.

--resource-group -g

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

--sku

Resource sku Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--auto-scale-policy --auto-scale-policy-enforcement

Enable or disable scale up. For V2 creation, defaults to Enabled; None and Disabled are unsupported.

Property Value
Parameter group: AutoScaleProperties Arguments
Accepted values: Disabled, Enabled, None
--availability-zones

Logical zone for Elastic San resource; example: ["1"]. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--base-size-tib

Base size of the Elastic San appliance in TiB.

Property Value
Parameter group: Properties Arguments
Default value: 20
--capacity-unit-scale-up --capacity-unit-scale-up-limit-tib

Maximum scale up size in TiB. For V2 creation, defaults to the smaller of five times the total size and the regional SKU maximum, which requires an additional SKU lookup.

Property Value
Parameter group: AutoScaleProperties Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--extended-capacity-size-tib --extended-size

Extended size of the Elastic San appliance in TiB.

Property Value
Parameter group: Properties Arguments
Default value: 0
--increase-capacity-unit --increase-capacity-unit-by-tib

Unit to increase capacity in TiB. Defaults to 1 for V2 creation.

Property Value
Parameter group: AutoScaleProperties Arguments
--location -l

The geo-location where the resource lives. When not specified, the location of the resource group will be used.

Property Value
Parameter group: Parameters 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
--public-network-access

Allow or disallow public network access to ElasticSan. Value is optional but if passed in, must be 'Enabled' or 'Disabled'.

Property Value
Parameter group: Properties Arguments
Accepted values: Disabled, Enabled
--tags

Azure resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Parameters Arguments
--total-iops

Total Provisioned IOPS of the Elastic San appliance. Settable only for ElasticSanVersion V2, where it is required; read-only for V1.

Property Value
Parameter group: Properties Arguments
--total-mbps

Total Provisioned MBps Elastic San appliance. Settable only for ElasticSanVersion V2, where it is required; read-only for V1.

Property Value
Parameter group: Properties Arguments
--total-size-tib

Total size of the Elastic San appliance in TiB. Settable only for ElasticSanVersion V2, where it is required; read-only for V1.

Property Value
Parameter group: Properties Arguments
--unused-size-tib

Unused capacity threshold in TiB. Defaults to 1 for V2 creation.

Property Value
Parameter group: AutoScaleProperties Arguments
--version

Elastic San appliance version. Defaults to V1 if not specified.

Property Value
Parameter group: Properties Arguments
Accepted values: V1, V2
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 delete

Delete an Elastic SAN.

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

Examples

Delete an Elastic SAN.

az elastic-san delete -g "rg" -n "san_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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--elastic-san-name --name -n

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

Get a list of Elastic SANs in a subscription.

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

Examples

Get a list of Elastic SANs in a subscription.

az elastic-san list -g "rg"

Optional Parameters

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

--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
--resource-group -g

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

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

Get a list of Elastic SAN skus.

az elastic-san list-sku [--acquire-policy-token]
                        [--change-reference]
                        [--filter]

Examples

Get a list of Elastic SAN skus.

az elastic-san list-sku

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--filter

Specify $filter='location eq <location>' to filter on location.

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 show

Get an Elastic SAN.

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

Examples

Get an Elastic SAN.

az elastic-san show -g "rg" -n "san_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-name --name -n

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

Update an Elastic SAN.

az elastic-san update [--acquire-policy-token]
                      [--add]
                      [--auto-scale-policy --auto-scale-policy-enforcement {Disabled, Enabled, None}]
                      [--availability-zones]
                      [--base-size-tib]
                      [--capacity-unit-scale-up --capacity-unit-scale-up-limit-tib]
                      [--change-reference]
                      [--elastic-san-name --name]
                      [--extended-capacity-size-tib --extended-size]
                      [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                      [--ids]
                      [--increase-capacity-unit --increase-capacity-unit-by-tib]
                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                      [--public-network-access {Disabled, Enabled}]
                      [--remove]
                      [--resource-group]
                      [--set]
                      [--sku]
                      [--subscription]
                      [--tags]
                      [--total-iops]
                      [--total-mbps]
                      [--total-size-tib]
                      [--unused-size-tib]

Examples

Update an Elastic SAN.

az elastic-san update -n "san_name" -g "rg" --tags '{key1710:bbbb}' --base-size-tib 25 --extended-capacity-size-tib 15 --auto-scale-policy-enforcement Disabled --capacity-unit-scale-up-limit-tib 18 --increase-capacity-unit-by-tib 5 --unused-size-tib 25

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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
--auto-scale-policy --auto-scale-policy-enforcement

Enable or Disable scale up setting on Elastic San Appliance.

Property Value
Parameter group: AutoScaleProperties Arguments
Accepted values: Disabled, Enabled, None
--availability-zones

Logical zone for Elastic San resource; example: ["1"]. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--base-size-tib

Base size of the Elastic San appliance in TiB.

Property Value
Parameter group: Properties Arguments
--capacity-unit-scale-up --capacity-unit-scale-up-limit-tib

Maximum scale up size on Elastic San appliance in TiB.

Property Value
Parameter group: AutoScaleProperties Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--elastic-san-name --name -n

The name of the ElasticSan.

Property Value
Parameter group: Resource Id Arguments
--extended-capacity-size-tib --extended-size

Extended size of the Elastic San appliance in TiB.

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
--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
--increase-capacity-unit --increase-capacity-unit-by-tib

Unit to increase Capacity Unit on Elastic San appliance in TiB.

Property Value
Parameter group: AutoScaleProperties 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
--public-network-access

Allow or disallow public network access to ElasticSan Account. Value is optional but if passed in, must be 'Enabled' or 'Disabled'.

Property Value
Parameter group: Properties Arguments
Accepted values: Disabled, Enabled
--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
--sku

Resource SKU. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

Update tags Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Parameters Arguments
--total-iops

Total Provisioned IOPS of the Elastic San appliance. Supported only for ElasticSanVersion V2.

Property Value
Parameter group: Properties Arguments
--total-mbps

Total Provisioned MBps Elastic San appliance. Supported only for ElasticSanVersion V2.

Property Value
Parameter group: Properties Arguments
--total-size-tib

Total size of the Elastic San appliance in TiB. Settable only for ElasticSanVersion V2, where it is required; read-only for V1.

Property Value
Parameter group: Properties Arguments
--unused-size-tib

Unused size on Elastic San appliance in TiB.

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

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

az elastic-san wait [--acquire-policy-token]
                    [--change-reference]
                    [--created]
                    [--custom]
                    [--deleted]
                    [--elastic-san-name --name]
                    [--exists]
                    [--ids]
                    [--interval]
                    [--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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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-name --name -n

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