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

az stack-hci extension

Note

This reference is part of the stack-hci extension for the Azure CLI (version 2.54.0 or higher). 该扩展将在首次运行 az stack-hci 扩展 命令时自动安装。 Learn more about extensions.

使用 stack hci 管理扩展。

命令

名称	说明	类型	Status
az stack-hci extension create	为 HCI 群集创建扩展。	Extension	GA
az stack-hci extension delete	删除 HCI 群集的特定弧线扩展。	Extension	GA
az stack-hci extension list	列出 arc 设置资源下的所有扩展。	Extension	GA
az stack-hci extension show	获取 HCI 群集的特定弧线扩展。	Extension	GA
az stack-hci extension wait	将 CLI 置于等待状态，直到满足条件。	Extension	GA

az stack-hci extension create

为 HCI 群集创建扩展。

az stack-hci extension create --arc-setting-name
                              --cluster-name
                              --extension-name --name
                              --resource-group
                              [--auto-upgrade {0, 1, f, false, n, no, t, true, y, yes}]
                              [--force-update-tag]
                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                              [--protected-settings]
                              [--publisher]
                              [--settings]
                              [--type]
                              [--type-handler-version]

示例

创建弧线扩展

az stack-hci extension create --arc-setting-name "default" --cluster-name "myCluster" --type "MicrosoftMonitoringAgent" --protected-settings '{"workspaceId": "xx", "port": "6516"}' --publisher "Microsoft.Compute" --settings '{"workspaceKey": "xx"}' --type-handler-version "1.10" --name "MicrosoftMonitoringAgent" --resource-group "test-rg"

必需参数

--arc-setting-name

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

--cluster-name

群集的名称。

--extension-name --name -n

计算机扩展的名称。

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

--auto-upgrade

指示扩展是否应在部署时使用较新的次要版本。但是，部署后，除非重新部署，否则扩展不会升级次要版本，即使此属性设置为 true 也是如此。

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

--force-update-tag

即使扩展配置未更改，扩展处理程序也应强制更新。

属性	值
Parameter group:	ExtensionParameters Arguments

--no-wait

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

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

--protected-settings

受保护的设置（可能包含机密）。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	ExtensionParameters Arguments

--publisher

扩展处理程序发布者的名称。

属性	值
Parameter group:	ExtensionParameters Arguments

--settings

扩展的 Json 格式公共设置。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	ExtensionParameters Arguments

--type

指定扩展的类型;例如“CustomScriptExtension”。

属性	值
Parameter group:	ExtensionParameters Arguments

--type-handler-version

指定脚本处理程序的版本。如果未指定，将使用最新版本。

属性	值
Parameter group:	ExtensionParameters 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 stack-hci extension delete

删除 HCI 群集的特定弧线扩展。

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

示例

删除弧线扩展

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

可选参数

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

--arc-setting-name

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

属性	值
Parameter group:	Resource Id Arguments

--cluster-name

群集的名称。

属性	值
Parameter group:	Resource Id Arguments

--extension-name --name -n

计算机扩展的名称。

属性	值
Parameter group:	Resource Id Arguments

--ids

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

属性	值
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

--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 stack-hci extension list

列出 arc 设置资源下的所有扩展。

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

示例

在 arc 设置资源下列出扩展

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

必需参数

--arc-setting-name

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

--cluster-name

群集的名称。

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

--max-items

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

属性	值
Parameter group:	Pagination Arguments

--next-token

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

属性	值
Parameter group:	Pagination 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 stack-hci extension show

获取 HCI 群集的特定弧线扩展。

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

示例

获取 arc 设置扩展

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

可选参数

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

--arc-setting-name

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

属性	值
Parameter group:	Resource Id Arguments

--cluster-name

群集的名称。

属性	值
Parameter group:	Resource Id Arguments

--extension-name --name -n

计算机扩展的名称。

属性	值
Parameter group:	Resource Id Arguments

--ids

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

属性	值
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 stack-hci extension wait

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

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

可选参数

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

--arc-setting-name

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

属性	值
Parameter group:	Resource Id Arguments

--cluster-name

群集的名称。

属性	值
Parameter group:	Resource Id Arguments

--created

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

属性	值
Parameter group:	Wait Condition Arguments
默认值:	False

--custom

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

属性	值
Parameter group:	Wait Condition Arguments

--deleted

等到删除为止。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	False

--exists

等待资源存在。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	False

--extension-name --name -n

计算机扩展的名称。

属性	值
Parameter group:	Resource Id Arguments

--ids

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

属性	值
Parameter group:	Resource Id Arguments

--interval

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

属性	值
Parameter group:	Wait Condition Arguments
默认值:	30

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

--timeout

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

属性	值
Parameter group:	Wait Condition Arguments
默认值:	3600

--updated

等到 provisioningState 更新为“Succeeded”。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	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 stack-hci extension

命令

az stack-hci extension create

示例

必需参数

可选参数

az stack-hci extension delete

示例

可选参数

az stack-hci extension list

示例

必需参数

可选参数

az stack-hci extension show

示例

可选参数

az stack-hci extension wait

可选参数

反馈