Share via

az baremetalstorageinstance

  • Reference

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]
                                   [--billing-mode]
                                   [--bmsi-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

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

The SKU type that is provisioned.

--billing-mode

The billing mode for the storage instance.

--bmsi-id --instance-id

Specifies the AzureBareMetaStorageInstance unique ID.

--generation

The kind of storage instance.

--hardware-type

The hardware type of the storage instance.

--identity

The identity of Azure Bare Metal Storage Instance, if configured. 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.

--provisioning-state

State of provisioning of the AzureBareMetalStorageInstance.

Accepted values: Accepted, Canceled, Creating, Deleting, Failed, Migrating, Succeeded, Updating
--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 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

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

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

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

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

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

--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 identity of Azure Bare Metal Storage Instance, if configured. 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 -n

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

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