az baremetalstorageinstance

Note

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

Handle Operations for Storage Azure Bare Metal Instances.

Commands

Name	Description	Type	Status
az baremetalstorageinstance create	Create an Azure Bare Metal Storage Instance for the specified subscription, resource group, and instance name.	Extension	GA
az baremetalstorageinstance delete	Delete an Azure Bare Metal Storage Instance for the specified subscription, resource group, and instance name.	Extension	GA
az baremetalstorageinstance list	List a list of AzureBareMetalStorage instances in the specified subscription. The operations returns various properties of each Azure Bare Metal Instance.	Extension	GA
az baremetalstorageinstance show	Get an Azure Bare Metal Storage instance for the specified subscription, resource group, and instance name.	Extension	GA
az baremetalstorageinstance update	Update an Azure Bare Metal Storage Instance for the specified subscription, resource group, and instance name.	Extension	GA

az baremetalstorageinstance create

Create an Azure Bare Metal Storage Instance for the specified subscription, resource group, and instance name.

az baremetalstorageinstance create --instance-name
                                   --resource-group
                                   [--azure-bare-metal-storage-instance-size --sku]
                                   [--billing-mode]
                                   [--bmsi-id --instance-id]
                                   [--generation]
                                   [--hardware-type]
                                   [--identity]
                                   [--location]
                                   [--offering-type]
                                   [--provisioning-state {Accepted, Canceled, Creating, Deleting, Failed, Migrating, Succeeded, Updating}]
                                   [--storage-type]
                                   [--tags]
                                   [--workload-type]

Examples

Create a storage resource

az baremetalstorageinstance create -g myResourceGroup -n myAzureBareMetalStorageInstance --location westus2 --sku S72

Required Parameters

--instance-name -n

Name of the Azure Bare Metal Storage Instance, also known as the ResourceName.

--resource-group -g

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.

--azure-bare-metal-storage-instance-size --sku

The SKU type that is provisioned.

Property	Value
Parameter group:	StorageBillingProperties Arguments

--billing-mode

The billing mode for the storage instance.

Property	Value
Parameter group:	StorageBillingProperties Arguments

--bmsi-id --instance-id

Specifies the AzureBareMetaStorageInstance unique ID.

Property	Value
Parameter group:	Properties Arguments

--generation

The kind of storage instance.

Property	Value
Parameter group:	StorageProperties Arguments

--hardware-type

The hardware type of the storage instance.

Property	Value
Parameter group:	StorageProperties Arguments

--identity

The identity of Azure Bare Metal Storage Instance, if configured. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	RequestBodyParameters 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:	RequestBodyParameters Arguments

--offering-type

The offering type for which the resource is getting provisioned.

Property	Value
Parameter group:	StorageProperties Arguments

--provisioning-state

State of provisioning of the AzureBareMetalStorageInstance.

Property	Value
Parameter group:	StorageProperties Arguments
Accepted values:	Accepted, Canceled, Creating, Deleting, Failed, Migrating, Succeeded, Updating

--storage-type

The storage protocol for which the resource is getting provisioned.

Property	Value
Parameter group:	StorageProperties Arguments

--tags

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

Property	Value
Parameter group:	RequestBodyParameters Arguments

--workload-type

The workload for which the resource is getting provisioned.

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

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

Delete an Azure Bare Metal Storage Instance for the specified subscription, resource group, and instance name.

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

Examples

Delete a storage resource

az baremetalstorageinstance delete -g myResourceGroup -n myAzureBareMetalStorageInstance

Optional Parameters

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

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

--instance-name -n

Name of the Azure Bare Metal Storage Instance, also known as the ResourceName.

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

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

List a list of AzureBareMetalStorage instances in the specified subscription. The operations returns various properties of each Azure Bare Metal Instance.

az baremetalstorageinstance list [--max-items]
                                 [--next-token]
                                 [--resource-group]

Examples

List all AzureBareMetalStorage instances in a subscription

az baremetalstorageinstance list

List all AzureBareMetalStorage instances in a subscription and resource group

az baremetalstorageinstance list -g myResourceGroup

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

Get an Azure Bare Metal Storage instance for the specified subscription, resource group, and instance name.

az baremetalstorageinstance show [--ids]
                                 [--instance-name]
                                 [--resource-group]
                                 [--subscription]

Examples

Get an AzureBareMetalStorage instance

az baremetalstorageinstance show -g myResourceGroup -n myAzureBareMetalStorageInstance

Optional Parameters

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

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

--instance-name -n

Name of the Azure Bare Metal Storage Instance, also known as the ResourceName.

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

Update an Azure Bare Metal Storage Instance for the specified subscription, resource group, and instance name.

az baremetalstorageinstance 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 add a key-value pair to the Tags field of a specific BareMetalStorage instance:

az baremetalstorageinstance update --resource-group $RESOURCE_GROUP --instance-name $BM_INSTANCE_NAME --identity "{type:SystemAssigned}"

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

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

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

--identity

The identity of Azure Bare Metal Storage Instance, if configured. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

--instance-name -n

Name of the Azure Bare Metal Storage Instance, also known as the ResourceName.

Property	Value
Parameter group:	Resource Id Arguments

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

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

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

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