Share via

az baremetalinstance

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 baremetalinstance command. Learn more about extensions.

Handle Operations for Compute Azure Bare Instances.

Commands

Name Description Type Status
az baremetalinstance create

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

 Extension GA
az baremetalinstance delete

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

 Extension GA
az baremetalinstance list

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

 Extension GA
az baremetalinstance restart

The operation to restart an Azure Bare Metal Instance.

 Extension GA
az baremetalinstance show

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

 Extension GA
az baremetalinstance shutdown

The operation to shutdown an Azure Bare Metal Instance.

 Extension GA
az baremetalinstance start

The operation to start an Azure Bare Metal instance.

 Extension GA
az baremetalinstance update

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

 Extension GA

az baremetalinstance create

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

az baremetalinstance create --instance-name
                            --resource-group
                            [--azure-bare-metal-instance-size --sku {S112, S144, S144m, S192, S192m, S192xm, S224, S224m, S224om, S224oo, S224oom, S224ooo, S384, S384m, S384xm, S384xxm, S448, S448m, S448om, S448oo, S448oom, S448ooo, S448se, S576m, S576xm, S672, S672m, S672om, S672oo, S672oom, S672ooo, S72, S72m, S768, S768m, S768xm, S896, S896m, S896om, S896oo, S896oom, S896ooo, S96, S960m}]
                            [--bmi-id --instance-id]
                            [--hardware-type {Cisco_UCS, HPE, SDFLEX}]
                            [--hw-revision]
                            [--location]
                            [--network-profile]
                            [--os-profile]
                            [--power-state {restarting, started, starting, stopped, stopping, unknown}]
                            [--ppg --proximity-placement-group]
                            [--storage-profile]
                            [--tags]

Examples

Create a compute resource

az baremetalinstance create --resource-group myResourceGroup --instance-name myBMIInstance --location westus --sku S72

Required Parameters

--instance-name -n

Name of the Azure Bare Metal 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-instance-size --sku

Specifies the Azure Bare Metal Instance SKU.

Property Value
Parameter group: HardwareProfile Arguments
Accepted values: S112, S144, S144m, S192, S192m, S192xm, S224, S224m, S224om, S224oo, S224oom, S224ooo, S384, S384m, S384xm, S384xxm, S448, S448m, S448om, S448oo, S448oom, S448ooo, S448se, S576m, S576xm, S672, S672m, S672om, S672oo, S672oom, S672ooo, S72, S72m, S768, S768m, S768xm, S896, S896m, S896om, S896oo, S896oom, S896ooo, S96, S960m
--bmi-id --instance-id

Specifies the Azure Bare Metal Instance unique ID.

Property Value
Parameter group: Properties Arguments
--hardware-type

Name of the hardware type (vendor and/or their product name).

Property Value
Parameter group: HardwareProfile Arguments
Accepted values: Cisco_UCS, HPE, SDFLEX
--hw-revision

Hardware revision of an Azure Bare Metal Instance.

Property Value
Parameter group: Properties 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
--network-profile

Specifies the network settings for the Azure Bare Metal Instance. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--os-profile

Specifies the operating system settings for the Azure Bare Metal Instance. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--power-state

Resource power state.

Property Value
Parameter group: Properties Arguments
Accepted values: restarting, started, starting, stopped, stopping, unknown
--ppg --proximity-placement-group

Resource proximity placement group.

Property Value
Parameter group: Properties Arguments
--storage-profile

Specifies the storage settings for the Azure Bare Metal Instance disks. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

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

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

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

Examples

Delete a compute resource

az baremetalinstance delete -g myResourceGroup -n myAzureBareMetalInstance

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

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

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

Examples

List all Azure Bare Metal Instances in a subscription

az baremetalinstance list

List all Azure Bare Metal Instances in a subscription and resource group

az baremetalinstance 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 baremetalinstance restart

The operation to restart an Azure Bare Metal Instance.

az baremetalinstance restart [--force-state {active, inactive}]
                             [--ids]
                             [--instance-name]
                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                             [--resource-group]
                             [--subscription]

Examples

Restart an Azure Bare Metal Instance

az baremetalinstance restart -g myResourceGroup -n myABMInstance

Optional Parameters

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

--force-state

Whether to force restart by shutting all processes.

Property Value
Parameter group: ForceParameter Arguments
Accepted values: active, inactive
--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 Instance, also known as the ResourceName.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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 baremetalinstance show

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

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

Examples

Get an Azure Bare Metal Instance

az baremetalinstance show -g myResourceGroup -n myAzureBareMetalInstance

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

The operation to shutdown an Azure Bare Metal Instance.

az baremetalinstance shutdown [--ids]
                              [--instance-name]
                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                              [--resource-group]
                              [--subscription]

Examples

Shutdown an Azure Bare Metal Instance

az baremetalinstance shutdown --resource-group myResourceGroup --instance-name myABMInstance

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 Instance, also known as the ResourceName.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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 baremetalinstance start

The operation to start an Azure Bare Metal instance.

az baremetalinstance start [--ids]
                           [--instance-name]
                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                           [--resource-group]
                           [--subscription]

Examples

Start an Azure Bare Metal instance

az baremetalinstance start --resource-group myResourceGroup --instance-name myABMInstance

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 Instance, also known as the ResourceName.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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 baremetalinstance update

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

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

Examples

To add a key-value pair to the Tags field of a specific BareMetal instance:

az baremetalinstance update -g $RESOURCE_GROUP -n $BM_INSTANCE_NAME --set tags.newKey=value

To update a key-value pair in the Tags field of a specific BareMetal instance:

az baremetalinstance update --resource-group $RESOURCE_GROUP --instance-name $BM_INSTANCE_NAME --set tags.key=updatedValue

To delete a key-value pair from the Tags field of a specific BareMetal instance:

az baremetalinstance update --resource-group $RESOURCE_GROUP --instance-name $BM_INSTANCE_NAME --remove tags.key

To delete all key-value pairs in the Tags field of a specific BareMetal instance:

az baremetalinstance update --resource-group $RESOURCE_GROUP --instance-name $BM_INSTANCE_NAME --set tags={}

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