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.

处理计算 Azure 裸实例的操作。

命令

名称	说明	类型	Status
az baremetalinstance create	为指定的订阅、资源组和实例名称创建 Azure 裸机实例。	Extension	GA
az baremetalinstance delete	删除指定订阅、资源组和实例名称的 Azure 裸机实例。	Extension	GA
az baremetalinstance list	列出指定订阅中的 Azure 裸机实例列表。 这些作返回每个 Azure 裸机实例的各种属性。	Extension	GA
az baremetalinstance restart	重启 Azure 裸机实例的作。	Extension	GA
az baremetalinstance show	获取指定订阅、资源组和实例名称的 Azure 裸机实例。	Extension	GA
az baremetalinstance shutdown	关闭 Azure 裸机实例的作。	Extension	GA
az baremetalinstance start	启动 Azure 裸机实例的作。	Extension	GA
az baremetalinstance update	更新指定订阅、资源组和实例名称的 Azure 裸机实例。	Extension	GA

az baremetalinstance create

为指定的订阅、资源组和实例名称创建 Azure 裸机实例。

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]

示例

创建计算资源

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

必需参数

--instance-name -n

Azure 裸机实例的名称，也称为 ResourceName。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

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

指定 Azure 裸机实例 SKU。

属性	值
Parameter group:	HardwareProfile Arguments
接受的值:	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

指定 Azure 裸机实例唯一 ID。

属性	值
Parameter group:	Properties Arguments

--hardware-type

硬件类型的名称（供应商和/或其产品名称）。

属性	值
Parameter group:	HardwareProfile Arguments
接受的值:	Cisco_UCS, HPE, SDFLEX

--hw-revision

Azure 裸机实例的硬件修订版。

属性	值
Parameter group:	Properties Arguments

--location -l

未指定资源所在的地理位置，将使用资源组的位置。

属性	值
Parameter group:	RequestBodyParameters Arguments

--network-profile

指定 Azure 裸机实例的网络设置。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--os-profile

指定 Azure 裸机实例的操作系统设置。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--power-state

资源电源状态。

属性	值
Parameter group:	Properties Arguments
接受的值:	restarting, started, starting, stopped, stopping, unknown

--ppg --proximity-placement-group

资源邻近放置组。

属性	值
Parameter group:	Properties Arguments

--storage-profile

指定 Azure 裸机实例磁盘的存储设置。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--tags

Resource tags. 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	RequestBodyParameters Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az baremetalinstance delete

删除指定订阅、资源组和实例名称的 Azure 裸机实例。

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

示例

删除计算资源

az baremetalinstance delete -g myResourceGroup -n myAzureBareMetalInstance

可选参数

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

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性	值
Parameter group:	Resource Id Arguments

--instance-name -n

Azure 裸机实例的名称，也称为 ResourceName。

属性	值
Parameter group:	Resource Id Arguments

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

属性	值
Parameter group:	Resource Id Arguments

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性	值
Parameter group:	Resource Id Arguments

--yes -y

不要提示确认。

属性	值
默认值:	False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az baremetalinstance list

列出指定订阅中的 Azure 裸机实例列表。 这些作返回每个 Azure 裸机实例的各种属性。

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

示例

列出订阅中的所有 Azure 裸机实例

az baremetalinstance list

列出订阅和资源组中的所有 Azure 裸机实例

az baremetalinstance list -g myResourceGroup

可选参数

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

--max-items

命令输出中要返回的项总数。 如果可用的项总数大于指定的值，则会在命令的输出中提供令牌。 若要恢复分页，请在后续命令的 --next-token 参数中提供令牌值。

属性	值
Parameter group:	Pagination Arguments

--next-token

用于指定开始分页的位置的令牌。 这是先前截断的响应中的令牌值。

属性	值
Parameter group:	Pagination Arguments

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az baremetalinstance restart

重启 Azure 裸机实例的作。

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]

示例

重启 Azure 裸机实例

az baremetalinstance restart -g myResourceGroup -n myABMInstance

可选参数

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

--force-state

是否通过关闭所有进程来强制重启。

属性	值
Parameter group:	ForceParameter Arguments
接受的值:	active, inactive

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性	值
Parameter group:	Resource Id Arguments

--instance-name -n

Azure 裸机实例的名称，也称为 ResourceName。

属性	值
Parameter group:	Resource Id Arguments

--no-wait

不等待长时间运行的操作完成。

属性	值
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

属性	值
Parameter group:	Resource Id Arguments

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性	值
Parameter group:	Resource Id Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az baremetalinstance show

获取指定订阅、资源组和实例名称的 Azure 裸机实例。

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

示例

获取 Azure 裸机实例

az baremetalinstance show -g myResourceGroup -n myAzureBareMetalInstance

可选参数

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

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性	值
Parameter group:	Resource Id Arguments

--instance-name -n

Azure 裸机实例的名称，也称为 ResourceName。

属性	值
Parameter group:	Resource Id Arguments

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

属性	值
Parameter group:	Resource Id Arguments

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性	值
Parameter group:	Resource Id Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az baremetalinstance shutdown

关闭 Azure 裸机实例的作。

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

示例

关闭 Azure 裸机实例

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

可选参数

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

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性	值
Parameter group:	Resource Id Arguments

--instance-name -n

Azure 裸机实例的名称，也称为 ResourceName。

属性	值
Parameter group:	Resource Id Arguments

--no-wait

不等待长时间运行的操作完成。

属性	值
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

属性	值
Parameter group:	Resource Id Arguments

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性	值
Parameter group:	Resource Id Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az baremetalinstance start

启动 Azure 裸机实例的作。

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

示例

启动 Azure 裸机实例

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

可选参数

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

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性	值
Parameter group:	Resource Id Arguments

--instance-name -n

Azure 裸机实例的名称，也称为 ResourceName。

属性	值
Parameter group:	Resource Id Arguments

--no-wait

不等待长时间运行的操作完成。

属性	值
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

属性	值
Parameter group:	Resource Id Arguments

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性	值
Parameter group:	Resource Id Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az baremetalinstance update

更新指定订阅、资源组和实例名称的 Azure 裸机实例。

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]

示例

若要向特定 BareMetal 实例的“标记”字段添加键值对，请执行以下作：

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

若要更新特定 BareMetal 实例的 Tags 字段中的键值对，

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

若要从特定 BareMetal 实例的“标记”字段中删除键值对，

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

若要删除特定 BareMetal 实例的 Tags 字段中的所有键值对：

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

可选参数

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

--add

通过指定路径和键值对将对象添加到对象列表。 示例：--add property.listProperty <key=value, string or JSON string>。

属性	值
Parameter group:	Generic Update Arguments

--force-string

使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。

属性	值
Parameter group:	Generic Update Arguments
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性	值
Parameter group:	Resource Id Arguments

--instance-name -n

Azure 裸机实例的名称，也称为 ResourceName。

属性	值
Parameter group:	Resource Id Arguments

--remove

从列表中删除属性或元素。 示例： --remove property.list <indexToRemove> OR --remove propertyToRemove.

属性	值
Parameter group:	Generic Update Arguments

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

属性	值
Parameter group:	Resource Id Arguments

--set

通过指定要设置的属性路径和值来更新对象。 示例：--set property1.property2=<value>。

属性	值
Parameter group:	Generic Update Arguments

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性	值
Parameter group:	Resource Id Arguments

--tags

Resource tags. 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	RequestBodyParameters Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False