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

az hdinsight-on-aks clusterpool

预览
参考

注意

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

此命令组处于预览状态，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

群集池操作。

命令

名称	说明	类型	Status
az hdinsight-on-aks clusterpool create	创建群集池。	扩展	预览
az hdinsight-on-aks clusterpool delete	删除群集池。	扩展	预览
az hdinsight-on-aks clusterpool list	列出订阅中的群集池列表。	扩展	预览
az hdinsight-on-aks clusterpool show	获取群集池。	扩展	预览
az hdinsight-on-aks clusterpool update	更新群集池。	扩展	预览
az hdinsight-on-aks clusterpool upgrade	升级 clusterpool。	扩展	预览
az hdinsight-on-aks clusterpool upgrade history	列出升级历史记录的列表。	扩展	预览
az hdinsight-on-aks clusterpool upgrade list	列出可用的群集池升级。	扩展	预览
az hdinsight-on-aks clusterpool upgrade run	升级群集池。	扩展	预览
az hdinsight-on-aks clusterpool wait	将 CLI 置于等待状态，直到满足条件。	扩展	预览

az hdinsight-on-aks clusterpool create

预览

命令组“az hdinsight-on-aks clusterpool”处于预览状态，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

创建群集池。

az hdinsight-on-aks clusterpool create --cluster-pool-name
                                       --resource-group
                                       [--api-server-authorized-ip-ranges]
                                       [--availability-zones]
                                       [--cluster-pool-version]
                                       [--enable-log-analytics {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--la-workspace-id]
                                       [--location]
                                       [--managed-rg-name]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--outbound-type {loadBalancer, userDefinedRouting}]
                                       [--private-server-enabled {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--subnet-id]
                                       [--tags]
                                       [--workernode-size]

示例

创建群集池。

az hdinsight-on-aks clusterpool create -g {RG} -n {poolName} -l {westus3} --workernode-size {Standard_E4s_v3} --version {1.1}

必需参数

--cluster-pool-name --name -n

群集池的名称。

--resource-group -g

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

可选参数

--api-server-authorized-ip-ranges --api-server-ip-ranges

IP 范围以 CIDR 格式指定，例如 137.117.106.88/29。此功能与专用 AKS 群集不兼容。因此，不能同时将 enablePrivateApiServer 设置为 true 和 apiServerAuthorizedIpRanges。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--availability-zones

用于 AKS VMSS 节点的可用性区域列表。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--cluster-pool-version --version

群集池版本是 2 部分版本。

--enable-log-analytics

如果为群集池启用了 Log Analytics，则为 True，否则为 false。

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

--la-workspace-id --log-analytic-workspace-id

要与 OMS 代理关联的 Log Analytics 工作区。

--location -l

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

--managed-rg-name

由 RP 创建的资源组，用于保存由 RP 代表客户创建的资源。它还将用于按模式生成 aksManagedResourceGroupName：MC_{managedResourceGroupName}{clusterPoolName}{region}。请确保它符合资源组名称限制。

--no-wait

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

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

--outbound-type

这只能在群集池创建时设置，以后无法更改。

接受的值: loadBalancer, userDefinedRouting

默认值: loadBalancer

--private-server-enabled

ClusterPool 基于 AKS 群集。默认情况下，AKS 群集向公共 Internet 公开 API 服务器。如果将此属性设置为 true，则会创建专用 AKS 群集，并使用不向公共 Internet 公开的专用 apiserver。

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

--subnet-id

群集池子网资源 ID。

--tags

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

--workernode-size

虚拟机 SKU。

全局参数

--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 hdinsight-on-aks clusterpool delete

预览

命令组“az hdinsight-on-aks clusterpool”处于预览状态，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

删除群集池。

az hdinsight-on-aks clusterpool delete [--cluster-pool-name]
                                       [--ids]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--resource-group]
                                       [--subscription]
                                       [--yes]

示例

删除群集池。

az hdinsight-on-aks clusterpool delete -g {RG} -n {poolName}

可选参数

--cluster-pool-name --name -n

群集池的名称。

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource 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 hdinsight-on-aks clusterpool list

预览

命令组“az hdinsight-on-aks clusterpool”处于预览状态，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

列出订阅中的群集池列表。

az hdinsight-on-aks clusterpool list [--max-items]
                                     [--next-token]
                                     [--resource-group]

示例

列出资源组中的群集池列表。

az hdinsight-on-aks clusterpool list -g {RG}

列出订阅中的群集池列表。

az hdinsightonaks clusterpool 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 hdinsight-on-aks clusterpool show

预览

命令组“az hdinsight-on-aks clusterpool”处于预览状态，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

获取群集池。

az hdinsight-on-aks clusterpool show [--cluster-pool-name]
                                     [--ids]
                                     [--resource-group]
                                     [--subscription]

示例

获取群集池。

az hdinsight-on-aks clusterpool show -g {RG} -n {poolName}

可选参数

--cluster-pool-name --name -n

群集池的名称。

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource 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 hdinsight-on-aks clusterpool update

预览

命令组“az hdinsight-on-aks clusterpool”处于预览状态，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

更新群集池。

az hdinsight-on-aks clusterpool update [--add]
                                       [--api-server-authorized-ip-ranges]
                                       [--cluster-pool-name]
                                       [--cluster-pool-version]
                                       [--compute-profile]
                                       [--enable-log-analytics {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--ids]
                                       [--la-workspace-id]
                                       [--managed-rg-name]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--outbound-type {loadBalancer, userDefinedRouting}]
                                       [--remove]
                                       [--resource-group]
                                       [--set]
                                       [--subnet-id]
                                       [--subscription]
                                       [--tags]

示例

更新现有群集，启用 Log Analytic。

az hdinsight-on-aksclusterpool update -g {RG} -n {poolName} --enable-log-analytics --log-analytic-workspace-id {"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/microsoft.operationalinsights/workspaces/yourworkspace"}

可选参数

--add

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

--api-server-authorized-ip-ranges --api-server-ip-ranges

--cluster-pool-name --name -n

群集池的名称。

--cluster-pool-version --version

群集池版本是 2 部分版本。

--compute-profile

CLuster 池计算配置文件。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--enable-log-analytics

如果为群集池启用了 Log Analytics，则为 True，否则为 false。

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

--force-string

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

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

--ids

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

--la-workspace-id --log-analytic-workspace-id

要与 OMS 代理关联的 Log Analytics 工作区。

--managed-rg-name

--no-wait

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

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

--outbound-type

这只能在群集池创建时设置，以后无法更改。

接受的值: loadBalancer, userDefinedRouting

--remove

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

--resource-group -g

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

--set

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

--subnet-id

群集池子网资源 ID。

--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 hdinsight-on-aks clusterpool wait

预览

命令组“az hdinsight-on-aks clusterpool”处于预览状态，正在开发中。参考和支持级别： https://aka.ms/CLI_refstatus

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

az hdinsight-on-aks clusterpool wait [--cluster-pool-name]
                                     [--created]
                                     [--custom]
                                     [--deleted]
                                     [--exists]
                                     [--ids]
                                     [--interval]
                                     [--resource-group]
                                     [--subscription]
                                     [--timeout]
                                     [--updated]

可选参数

--cluster-pool-name --name -n

群集池的名称。

--created

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

默认值: False

--custom

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

--deleted

等到删除为止。

默认值: False

--exists

等待资源存在。

默认值: False

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource 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 hdinsight-on-aks clusterpool

命令

az hdinsight-on-aks clusterpool create

示例

必需参数

可选参数

az hdinsight-on-aks clusterpool delete

示例

可选参数

az hdinsight-on-aks clusterpool list

示例

可选参数

az hdinsight-on-aks clusterpool show

示例

可选参数

az hdinsight-on-aks clusterpool update

示例

可选参数

az hdinsight-on-aks clusterpool wait

可选参数

其他资源