共用方式為

az hdinsight-on-aks clusterpool

  • 預覽
  • 參考

注意

此參考是 Azure CLI 的 hdinsightonaks 延伸模組的一部分（2.57.0 版或更高版本）。 擴充功能會在您第一次執行 az hdinsight-on-aks clusterpool 命令時自動安裝。 深入了解擴充功能。

此命令群組處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

Clusterpool 作業。

命令

名稱 Description 類型 狀態
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

如果叢集集區已啟用記錄分析，則為 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 叢集預設會將 API 伺服器公開至公用因特網。 如果您將此屬性設定為 true，將會建立私人 AKS 叢集，而且會使用未公開至公用因特網的私人 apiserver。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--subnet-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

訂用帳戶的名稱或識別碼。 您可以使用 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

一或多個資源識別碼 (以空格分隔)。 它應該是完整資源識別碼，其中包含「資源標識碼」引數的所有資訊。 您應該提供 --ids 或其他「資源識別碼」引數。

--no-wait

請勿等候長時間執行的作業完成。

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

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 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

訂用帳戶的名稱或識別碼。 您可以使用 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

訂用帳戶的名稱或識別碼。 您可以使用 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

一或多個資源識別碼 (以空格分隔)。 它應該是完整資源識別碼，其中包含「資源標識碼」引數的所有資訊。 您應該提供 --ids 或其他「資源識別碼」引數。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 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

訂用帳戶的名稱或識別碼。 您可以使用 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]

範例

更新現有的叢集啟用記錄分析。

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

IP 範圍以 CIDR 格式指定，例如 137.117.106.88/29。 此功能與私人 AKS 叢集不相容。 因此，您無法同時將 enablePrivateApiServer 設為 true 和 apiServerAuthorizedIpRanges。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

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

叢集集區的名稱。

--cluster-pool-version --version

叢集集區版本為 2 部分版本。

--compute-profile

CLuster 集區計算配置檔。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

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

一或多個資源識別碼 (以空格分隔)。 它應該是完整資源識別碼，其中包含「資源標識碼」引數的所有資訊。 您應該提供 --ids 或其他「資源識別碼」引數。

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

要與 OMS 代理程式建立關聯的 Log Analytics 工作區。

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

從清單中移除屬性或專案。 範例：--remove property.list OR --remove 屬性ToRemove。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--set

指定要設定的屬性路徑和值，以更新物件。 範例：--set property1.property2=。

--subnet-id

叢集集區子網資源標識碼。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 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

訂用帳戶的名稱或識別碼。 您可以使用 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

一或多個資源識別碼 (以空格分隔)。 它應該是完整資源識別碼，其中包含「資源標識碼」引數的所有資訊。 您應該提供 --ids 或其他「資源識別碼」引數。

--interval

輪詢間隔以秒為單位。

預設值: 30
--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 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

訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。