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

az stack-hci arc-setting

参考

注意

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

使用堆栈 hci 管理 arc 设置。

命令

名称	说明	类型	状态
az stack-hci arc-setting consent-and-install-default-extension	为默认扩展添加同意时间并启动扩展安装。	扩展	GA
az stack-hci arc-setting create	为 HCI 群集创建弧线设置。	扩展	GA
az stack-hci arc-setting create-identity	为 arc 设置创建 AAD 标识。	扩展	GA
az stack-hci arc-setting delete	删除 HCI 群集的 arc 设置资源详细信息。	扩展	GA
az stack-hci arc-setting generate-password	为 arc 设置生成密码。	扩展	GA
az stack-hci arc-setting initialize-disable-proces	初始化群集上的 ARC 禁用进程。	扩展	GA
az stack-hci arc-setting list	列出 HCI 群集的 arc 设置资源。	扩展	GA
az stack-hci arc-setting show	获取 HCI 群集的 arc 设置资源详细信息。	扩展	GA
az stack-hci arc-setting update	更新 HCI 群集的 arc 设置。	扩展	GA
az stack-hci arc-setting wait	将 CLI 置于等待状态，直到满足条件。	扩展	GA

为默认扩展添加同意时间并启动扩展安装。

az stack-hci arc-setting consent-and-install-default-extension [--arc-setting-name]
                                                               [--cluster-name]
                                                               [--ids]
                                                               [--resource-group]
                                                               [--subscription]

同意并安装默认扩展

az stack-hci arc-setting consent-and-install-default-extension -g rg --arc-setting-name default --cluster-name name

--arc-setting-name

包含 HCI ArcSetting 信息的代理资源的名称。

--cluster-name

群集的名称。

--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 arc-setting create

为 HCI 群集创建弧线设置。

az stack-hci arc-setting create --arc-setting-name
                                --cluster-name
                                --resource-group
                                [--arc-application-client-id]
                                [--arc-application-object-id]
                                [--arc-application-tenant-id]
                                [--arc-instance-rg]
                                [--arc-service-principal-object-id]
                                [--connectivity-properties]

示例

创建弧线设置

az stack-hci arc-setting create --name "default" --cluster-name "myCluster" --resource-group "test-rg"

必需参数

--arc-setting-name --name -n

包含 HCI ArcSetting 信息的代理资源的名称。

--cluster-name

群集的名称。

--resource-group -g

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

可选参数

--arc-application-client-id

arc AAD 标识的应用 ID。

--arc-application-object-id

arc AAD 标识的对象 ID。

--arc-application-tenant-id

arc AAD 标识的租户 ID。

--arc-instance-rg

托管 Arc 代理的资源组，即。混合计算计算机资源。

--arc-service-principal-object-id

arc AAD 服务主体的对象 ID。

--connectivity-properties

包含 ARC 资源的连接相关配置，支持速记语法、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 arc-setting create-identity

为 arc 设置创建 AAD 标识。

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

示例

创建 arc 标识

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

可选参数

--arc-setting-name --name -n

包含 HCI ArcSetting 信息的代理资源的名称。

--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 arc-setting delete

删除 HCI 群集的 arc 设置资源详细信息。

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

示例

删除弧线设置

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

可选参数

--arc-setting-name --name -n

包含 HCI ArcSetting 信息的代理资源的名称。

--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 配置默认订阅。

--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 arc-setting generate-password

为 arc 设置生成密码。

az stack-hci arc-setting generate-password [--arc-setting-name]
                                           [--cluster-name]
                                           [--ids]
                                           [--resource-group]
                                           [--subscription]

示例

生成密码

az stack-hci arc-setting generate-password --name "default" --cluster-name "myCluster" --resource-group "test-rg"

可选参数

--arc-setting-name --name -n

包含 HCI ArcSetting 信息的代理资源的名称。

--cluster-name

群集的名称。

--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 arc-setting initialize-disable-proces

初始化群集上的 ARC 禁用进程。

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

示例

初始化禁用过程

az stack-hci arc-setting initialize-disable-proces -g rg --arc-setting-name default --cluster-name name

可选参数

--arc-setting-name

包含 HCI ArcSetting 信息的代理资源的名称。

--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 arc-setting list

列出 HCI 群集的 arc 设置资源。

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

示例

按 HCI 群集列出 arc 设置资源

az stack-hci arc-setting list --cluster-name "myCluster" --resource-group "test-rg"

必需参数

--cluster-name

群集的名称。

--resource-group -g

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

可选参数

--max-items

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

--next-token

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

全局参数

--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 arc-setting show

获取 HCI 群集的 arc 设置资源详细信息。

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

示例

获取弧线设置

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

可选参数

--arc-setting-name --name -n

包含 HCI ArcSetting 信息的代理资源的名称。

--cluster-name

群集的名称。

--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 arc-setting update

更新 HCI 群集的 arc 设置。

az stack-hci arc-setting update [--add]
                                [--arc-setting-name]
                                [--cluster-name]
                                [--connectivity-properties]
                                [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                [--ids]
                                [--remove]
                                [--resource-group]
                                [--set]
                                [--subscription]

示例

更新 arc 设置

az stack-hci arc-setting update --resource-group "test-rg" --cluster-name "myCluster" --name "default" --tags "{tag:tag}"

可选参数

--add

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

--arc-setting-name --name -n

包含 HCI ArcSetting 信息的代理资源的名称。

--cluster-name

群集的名称。

--connectivity-properties

包含 ARC 资源的连接相关配置，支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--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 配置默认订阅。

全局参数

--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 arc-setting wait

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

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

可选参数

--arc-setting-name --name -n

包含 HCI ArcSetting 信息的代理资源的名称。

--cluster-name

群集的名称。

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

命令

az stack-hci arc-setting consent-and-install-default-extension

示例

可选参数

az stack-hci arc-setting create

示例

必需参数

可选参数

az stack-hci arc-setting create-identity

示例

可选参数

az stack-hci arc-setting delete

示例

可选参数

az stack-hci arc-setting generate-password

示例

可选参数

az stack-hci arc-setting initialize-disable-proces

示例

可选参数

az stack-hci arc-setting list

示例

必需参数

可选参数

az stack-hci arc-setting show

示例

可选参数

az stack-hci arc-setting update

示例

可选参数

az stack-hci arc-setting wait

可选参数

其他资源