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
--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
Name of the AzureLargeStorageInstance.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Specifies the AzureLargeStorageInstance unique ID.
The SKU type that is provisioned.
The billing mode for the storage instance.
The kind of storage instance.
The hardware type of the storage instance.
The managed service identities assigned to this resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The geo-location where the resource lives When not specified, the location of the resource group will be used.
The offering type for which the resource is getting provisioned.
The storage protocol for which the resource is getting provisioned.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The workload for which the resource is getting provisioned.
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 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
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.
Name of the AzureLargeStorageInstance.
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 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
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.
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.
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 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
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.
Name of the AzureLargeStorageInstance.
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 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 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>
.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
The managed service identities assigned to this 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.
Name of the AzureLargeStorageInstance.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
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=<value>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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.