Share via

az large-storage-instance

  • Reference

Note

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

Handle Operations for Storage Azure Large Instances.

Commands

Name Description Type Status
az large-storage-instance create

Create an Azure Large Storage Instance for the specified subscription,.

 Extension GA
az large-storage-instance delete

Delete an Azure Large Storage Instance for the specified subscription,.

 Extension GA
az large-storage-instance list

List a list of Azure Large Storage Instances in the specified subscription. The operations returns various properties of each Azure Large Storage instance.

 Extension GA
az large-storage-instance show

Get an Azure Large Storage instance for the specified subscription, resource.

 Extension GA
az large-storage-instance update

Update an Azure Large Storage Instance for the specified subscription,.

 Extension GA

az large-storage-instance create

Create an Azure Large Storage Instance for the specified subscription,.

Resource group, and instance name.

az large-storage-instance create --instance-name
                                 --resource-group
                                 [--alsi-id]
                                 [--azure-large-storage-instance-size]
                                 [--billing-mode]
                                 [--generation]
                                 [--hardware-type {Cisco_UCS, HPE, SDFLEX}]
                                 [--identity]
                                 [--location]
                                 [--offering-type]
                                 [--storage-type]
                                 [--tags]
                                 [--workload-type]

Examples

Create an Azure Large Storage Instance

az large-storage-instance create -g myResourceGroup -n myAzureLargeStorageInstance -l westus2 --sku S72

Required Parameters

--instance-name --name -n

Name of the AzureLargeStorageInstance.

--resource-group -g

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

Optional Parameters

--alsi-id --instance-id

Specifies the AzureLargeStorageInstance unique ID.

--azure-large-storage-instance-size --sku

The SKU type that is provisioned.

--billing-mode

The billing mode for the storage instance.

--generation

The kind of storage instance.

--hardware-type

The hardware type of the storage instance.

Accepted values: Cisco_UCS, HPE, SDFLEX
--identity

The managed service identities assigned to this resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--location -l

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

--offering-type

The offering type for which the resource is getting provisioned.

--storage-type

The storage protocol for which the resource is getting provisioned.

--tags

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

--workload-type

The workload for which the resource is getting provisioned.

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 large-storage-instance delete

Delete an Azure Large Storage Instance for the specified subscription,.

Resource group, and instance name.

az large-storage-instance delete [--ids]
                                 [--instance-name]
                                 [--resource-group]
                                 [--subscription]
                                 [--yes]

Examples

AzureLargeStorageInstance_Delete

az large-storage-instance delete --resource-group myResourceGroup --instance-name myAzureLargeStorageInstance

Optional Parameters

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

--instance-name --name -n

Name of the AzureLargeStorageInstance.

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

--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 large-storage-instance list

List a list of Azure Large Storage Instances in the specified subscription. The operations returns various properties of each Azure Large Storage instance.

az large-storage-instance list [--max-items]
                               [--next-token]
                               [--resource-group]

Examples

To list Azure Large Storage Instances in a specific subscription and resource group

az large-storage-instance list --subscription $SUBSCRIPTIONID --resource-group $RESOURCE_GROUP

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.

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

--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 large-storage-instance show

Get an Azure Large Storage instance for the specified subscription, resource.

Group, and instance name.

az large-storage-instance show [--ids]
                               [--instance-name]
                               [--resource-group]
                               [--subscription]

Examples

To show details about a specific Azure Large Storage Instance

az large-storage-instance show --subscription $SUBSCRIPTION_ID --instance-name $INSTANCE_NAME --resource-group $RESOURCE_GROUP

Optional Parameters

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

--instance-name --name -n

Name of the AzureLargeStorageInstance.

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

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 large-storage-instance update

Update an Azure Large Storage Instance for the specified subscription,.

Resource group, and instance name.

az large-storage-instance update [--add]
                                 [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--identity]
                                 [--ids]
                                 [--instance-name]
                                 [--remove]
                                 [--resource-group]
                                 [--set]
                                 [--subscription]
                                 [--tags]

Examples

To create a new tags object

az large-storage-instance update -g myResourceGroup -n myAzureLargeStorageInstance --tags "{key:value}"

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

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

The managed service identities assigned to this resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

--instance-name --name -n

Name of the AzureLargeStorageInstance.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> 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=<value>.

--subscription

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

--tags

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

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.