你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az stack-hci cluster

参考

注意

此参考是 Azure CLI（版本 2.54.0 或更高版本）的 stack-hci 扩展的一部分。该扩展将在首次运行 az stack-hci cluster 命令时自动安装。详细了解扩展。

使用 stack hci 管理群集。

命令

名称	说明	类型	状态
az stack-hci cluster create	创建 HCI 群集。	扩展	GA
az stack-hci cluster create-identity	创建群集标识。	扩展	GA
az stack-hci cluster delete	删除 HCI 群集。	扩展	GA
az stack-hci cluster extend-software-assurance-benefit	将软件保障权益扩展到群集。	扩展	GA
az stack-hci cluster identity	管理标识。	扩展	GA
az stack-hci cluster identity assign	分配标识。	扩展	GA
az stack-hci cluster identity remove	删除标识。	扩展	GA
az stack-hci cluster list	列出订阅中的所有 HCI 群集。	扩展	GA
az stack-hci cluster show	获取 HCI 群集。	扩展	GA
az stack-hci cluster update	更新 HCI 群集。	扩展	GA
az stack-hci cluster wait	将 CLI 置于等待状态，直到满足条件。	扩展	GA

az stack-hci cluster create

创建 HCI 群集。

az stack-hci cluster create --cluster-name
                            --resource-group
                            [--aad-application-object-id]
                            [--aad-client-id]
                            [--aad-service-principal-object-id]
                            [--aad-tenant-id]
                            [--desired-properties]
                            [--endpoint]
                            [--location]
                            [--mi-system-assigned {0, 1, f, false, n, no, t, true, y, yes}]
                            [--tags]

示例

创建群集

az stack-hci cluster create --location "East US" --aad-client-id "24a6e53d-04e5-44d2-b7cc-1b732a847dfc" --aad-tenant-id "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94" --endpoint "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com" --name "myCluster" --resource- group "test-rg"

必需参数

--cluster-name --name -n

群集的名称。

--resource-group -g

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

可选参数

--aad-application-object-id

群集 AAD 标识的对象 ID。

--aad-client-id

群集 AAD 标识的应用 ID。

--aad-service-principal-object-id

群集标识服务主体的 ID。

--aad-tenant-id

群集 AAD 标识的租户 ID。

--desired-properties

群集的所需属性。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--endpoint

为Azure 门户的管理配置的终结点。

--location -l

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

--mi-system-assigned

启用系统分配的标识。

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

--tags

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

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az stack-hci cluster create-identity

创建群集标识。

az stack-hci cluster create-identity [--cluster-name]
                                     [--ids]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--resource-group]
                                     [--subscription]

示例

创建群集标识

az stack-hci cluster create-identity --name "myCluster" --resource-group "test-rg"

可选参数

--cluster-name

群集的名称。

--ids

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

--no-wait

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

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

--resource-group -g

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

--subscription

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

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az stack-hci cluster delete

删除 HCI 群集。

az stack-hci cluster delete [--cluster-name]
                            [--ids]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--resource-group]
                            [--subscription]
                            [--yes]

示例

删除群集

az stack-hci cluster delete --name "myCluster" --resource-group "test-rg"

可选参数

--cluster-name --name -n

群集的名称。

--ids

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

--no-wait

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

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

--resource-group -g

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

--subscription

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

--yes -y

不提示确认。

默认值: False

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az stack-hci cluster extend-software-assurance-benefit

将软件保障权益扩展到群集。

az stack-hci cluster extend-software-assurance-benefit [--cluster-name]
                                                       [--ids]
                                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                       [--resource-group]
                                                       [--software-assurance-intent {Disable, Enable}]
                                                       [--subscription]

示例

扩展软件保障权益

az stack-hci cluster extend-software-assurance-benefit --cluster-name name -g rg --software-assurance-intent enable

可选参数

--cluster-name

群集的名称。

--ids

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

--no-wait

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

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

--resource-group -g

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

--software-assurance-intent

软件保障权益的客户意向。

接受的值: Disable, Enable

--subscription

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

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az stack-hci cluster list

列出订阅中的所有 HCI 群集。

az stack-hci cluster list [--max-items]
                          [--next-token]
                          [--resource-group]

示例

列出给定资源组中的群集

az stack-hci cluster list --resource-group "test-rg"

列出给定订阅中的群集

az stack-hci cluster list

可选参数

--max-items

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

--next-token

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

--resource-group -g

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

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az stack-hci cluster show

获取 HCI 群集。

az stack-hci cluster show [--cluster-name]
                          [--ids]
                          [--resource-group]
                          [--subscription]

示例

获取群集

az stack-hci cluster show --name "myCluster" --resource-group "test-rg"

可选参数

--cluster-name --name -n

群集的名称。

--ids

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

--resource-group -g

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

--subscription

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

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az stack-hci cluster update

更新 HCI 群集。

az stack-hci cluster update [--aad-client-id]
                            [--aad-tenant-id]
                            [--add]
                            [--cluster-name]
                            [--desired-properties]
                            [--endpoint]
                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                            [--ids]
                            [--remove]
                            [--resource-group]
                            [--set]
                            [--subscription]
                            [--tags]

示例

更新群集

az stack-hci cluster update --endpoint "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com" --desired-properties "{diagnosticLevel:Basic,windowsServerSubscription:Enabled}" --tags "tag:"value" --name "myCluster" --resource-group "test-rg"

可选参数

--aad-client-id

群集 AAD 标识的应用 ID。

--aad-tenant-id

群集 AAD 标识的租户 ID。

--add

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

--cluster-name --name -n

群集的名称。

--desired-properties

群集的所需属性。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--endpoint

为Azure 门户的管理配置的终结点。

--force-string

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

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

--ids

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

--remove

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

--resource-group -g

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

--set

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

--subscription

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

--tags

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

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az stack-hci cluster wait

将 CLI 置于等待状态，直到满足条件。

az stack-hci cluster wait [--cluster-name]
                          [--created]
                          [--custom]
                          [--deleted]
                          [--exists]
                          [--ids]
                          [--interval]
                          [--resource-group]
                          [--subscription]
                          [--timeout]
                          [--updated]

可选参数

--cluster-name --name -n

群集的名称。

--created

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False

--custom

等待条件满足自定义 JMESPath 查询。例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到删除为止。

默认值: False

--exists

等待资源存在。

默认值: False

--ids

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

--interval

轮询间隔（以秒为单位）。

默认值: 30

--resource-group -g

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

--subscription

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

--timeout

最大等待（以秒为单位）。

默认值: 3600

--updated

等到 provisioningState 更新为“Succeeded”。

默认值: False

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

通过

az stack-hci cluster

命令

az stack-hci cluster create

示例

必需参数

可选参数

az stack-hci cluster create-identity

示例

可选参数

az stack-hci cluster delete

示例

可选参数

az stack-hci cluster extend-software-assurance-benefit

示例

可选参数

az stack-hci cluster list

示例

可选参数

az stack-hci cluster show

示例

可选参数

az stack-hci cluster update

示例

可选参数

az stack-hci cluster wait

可选参数

其他资源