az large-storage-instance
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 --name
--resource-group
[--alsi-id --instance-id]
[--azure-large-storage-instance-size --sku]
[--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
Name of the AzureLargeStorageInstance.
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.
Specifies the AzureLargeStorageInstance unique ID.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The SKU type that is provisioned.
Property | Value |
---|---|
Parameter group: | StorageProperties Arguments |
The billing mode for the storage instance.
Property | Value |
---|---|
Parameter group: | StorageProperties Arguments |
The kind of storage instance.
Property | Value |
---|---|
Parameter group: | StorageProperties Arguments |
The hardware type of the storage instance.
Property | Value |
---|---|
Parameter group: | StorageProperties Arguments |
Accepted values: | Cisco_UCS, HPE, SDFLEX |
The managed service identities assigned to this resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Resource Arguments |
The geo-location where the resource lives When not specified, the location of the resource group will be used.
Property | Value |
---|---|
Parameter group: | Resource Arguments |
The offering type for which the resource is getting provisioned.
Property | Value |
---|---|
Parameter group: | StorageProperties Arguments |
The storage protocol for which the resource is getting provisioned.
Property | Value |
---|---|
Parameter group: | StorageProperties Arguments |
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Resource Arguments |
The workload for which the resource is getting provisioned.
Property | Value |
---|---|
Parameter group: | StorageProperties Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
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 --name]
[--resource-group]
[--subscription]
[--yes]
Examples
AzureLargeStorageInstance_Delete
az large-storage-instance delete --resource-group myResourceGroup --instance-name myAzureLargeStorageInstance
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 of the AzureLargeStorageInstance.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
Do not prompt for confirmation.
Property | Value |
---|---|
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
Token to specify where to start paginating. This is the token value from a previously truncated response.
Property | Value |
---|---|
Parameter group: | Pagination Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
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 --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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 of the AzureLargeStorageInstance.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
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 --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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
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 |
The managed service identities assigned to this resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Resource Arguments |
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 of the AzureLargeStorageInstance.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
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 |
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Resource Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |