az networkcloud kubernetescluster agentpool

注意

此參考是 Azure CLI 網路雲端 擴充功能的一部分 （2.51.0 版或更高版本）。 擴充功能會在您第一次執行 az networkcloud kubernetescluster agentpool 命令時自動安裝。 深入了解擴充功能。

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

管理 Kubernetes 叢集的代理程式組件區。

命令

名稱	Description	類型	狀態
az networkcloud kubernetescluster agentpool create	建立新的 Kubernetes 叢集代理程式組件區，或更新現有集區的屬性。	副檔名	預覽版
az networkcloud kubernetescluster agentpool delete	刪除提供的 Kubernetes 叢集代理程式組件區。	副檔名	預覽版
az networkcloud kubernetescluster agentpool list	列出所提供 Kubernetes 叢集的代理程式組件區。	副檔名	預覽版
az networkcloud kubernetescluster agentpool show	取得所提供 Kubernetes 叢集代理程式組件區的屬性。	副檔名	預覽版
az networkcloud kubernetescluster agentpool update	更新所提供 Kubernetes 叢集代理程式組件區的屬性，或更新與 Kubernetes 叢集代理程式組件區相關聯的標記。 屬性和標記更新可以獨立完成。	副檔名	預覽版
az networkcloud kubernetescluster agentpool wait	將 CLI 置於等候狀態，直到符合條件為止。	副檔名	預覽版

az networkcloud kubernetescluster agentpool create

預覽

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

建立新的 Kubernetes 叢集代理程式組件區，或更新現有集區的屬性。

az networkcloud kubernetescluster agentpool create --agent-pool-name
                                                   --count
                                                   --kubernetes-cluster-name
                                                   --mode {NotApplicable, System, User}
                                                   --resource-group
                                                   --vm-sku-name
                                                   [--admin-username]
                                                   [--agent-options]
                                                   [--attached-network-configuration]
                                                   [--availability-zones]
                                                   [--extended-location]
                                                   [--generate-ssh-keys {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--labels]
                                                   [--location]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--ssh-dest-key-path]
                                                   [--ssh-key-values]
                                                   [--tags]
                                                   [--taints]
                                                   [--upgrade-settings]

範例

建立或更新 Kubernetes 叢集的代理程式組件區

az networkcloud kubernetescluster agentpool create --name "poolName" --kubernetes-cluster-name "kubernetesClusterName" --resource-group "resourceGroupName" --admin-username "azureuser" --ssh-key-values 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgt5SjWU= admin@vm' --count 3 --mode "System" --vm-sku-name "NC-XXXXX" --agent-options hugepages-count=96 hugepages-size="1G" --attached-network-configuration l2-networks="[{networkId:'/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName',pluginType:'DPDK'}]" l3-networks="[{networkId:'/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName,pluginType:'SRIOV',ipamEnabled:'False'}]" trunked-networks="[{networkId:'/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName',pluginType:'MACVLAN'}]" --labels="[{key:'kubernetes.label',value:'true'}]" --taints="[{key:'kubernetes.taint',value:'true'}]" --upgrade-settings max-surge="1" --availability-zones="['zone1','zone2']"

必要參數

--agent-pool-name --name -n

Kubernetes 叢集代理程式組件區的名稱。

--count

使用此組態的虛擬機器數目。

--kubernetes-cluster-name

Kubernetes 叢集的名稱。

--mode

選取此代理程式組件區的方式，無論是作為系統集區還是使用者集區。 系統集區會執行 Kubernetes 叢集的功能和重要服務，而使用者集區則專用於使用者工作負載。 每個 Kubernetes 叢集都必須包含至少一個具有至少一個節點的系統節點集區。

接受的值: NotApplicable, System, User

--resource-group -g

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

--vm-sku-name

決定為節點 VM 配置之資源大小的 VM SKU 名稱。

選擇性參數

--admin-username

將套用至執行 Kubernetes 節點之作業系統之系統管理員的使用者名稱。 如果未提供，服務將會選擇使用者名稱。

--agent-options

將套用至此代理程式組件區中每個代理程式的組態。 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--attached-network-configuration

要連結至代理程式組件區的網路組態，以供此 Kubernetes 叢集上執行的工作負載使用。 這些網路除了 Kubernetes 叢集連結網路組態中連線的網路之外。 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--availability-zones

用於布建此代理程式組件區中節點的網路雲端叢集可用性區域清單。 如果未指定，則會使用所有可用性區域。 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--extended-location

與資源相關聯的叢集擴充位置。 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--generate-ssh-keys

如果遺失，請產生 SSH 公開和私密金鑰檔案。 金鑰會儲存在 '~/.ssh' 底下。

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

--labels

套用至此代理程式組件區中節點的標籤。 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--location -l

未指定資源所在的地理位置，將會使用資源群組的位置。

--no-wait

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

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

--ssh-dest-key-path

ssh 公開金鑰的空間分隔路徑清單。 您可以提供檔案路徑或目錄。 如果提供目錄，將會嘗試載入找到的所有公開金鑰（.pub）。 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--ssh-key-values

以空格分隔的 SSH 公開金鑰清單。 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--tags

資源標籤。 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--taints

套用至此代理程式組件區中節點的污點。 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--upgrade-settings

代理程式組件區的組態。 支援速記語法、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 networkcloud kubernetescluster agentpool delete

預覽

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

刪除提供的 Kubernetes 叢集代理程式組件區。

az networkcloud kubernetescluster agentpool delete [--agent-pool-name]
                                                   [--ids]
                                                   [--kubernetes-cluster-name]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--resource-group]
                                                   [--subscription]
                                                   [--yes]

範例

刪除 Kubernetes 叢集的代理程式組件區

az networkcloud kubernetescluster agentpool delete --name "poolName" --kubernetes-cluster-name "kubernetesClusterName" --resource-group "resourceGroupName"

選擇性參數

--agent-pool-name --name -n

Kubernetes 叢集代理程式組件區的名稱。

--ids

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

--kubernetes-cluster-name

Kubernetes 叢集的名稱。

--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 networkcloud kubernetescluster agentpool list

預覽

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

列出所提供 Kubernetes 叢集的代理程式組件區。

az networkcloud kubernetescluster agentpool list --kubernetes-cluster-name
                                                 --resource-group
                                                 [--max-items]
                                                 [--next-token]

範例

列出 Kubernetes 叢集的代理程式組件區

az networkcloud kubernetescluster agentpool list --kubernetes-cluster-name "kubernetesClusterName" --resource-group "resourceGroupName"

必要參數

--kubernetes-cluster-name

Kubernetes 叢集的名稱。

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

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

--verbose

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

az networkcloud kubernetescluster agentpool show

預覽

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

取得所提供 Kubernetes 叢集代理程式組件區的屬性。

az networkcloud kubernetescluster agentpool show [--agent-pool-name]
                                                 [--ids]
                                                 [--kubernetes-cluster-name]
                                                 [--resource-group]
                                                 [--subscription]

範例

取得 Kubernetes 叢集的代理程式組件區

az networkcloud kubernetescluster agentpool show --name "poolName" --kubernetes-cluster-name "kubernetesClusterName" --resource-group "resourceGroupName"

選擇性參數

--agent-pool-name --name -n

Kubernetes 叢集代理程式組件區的名稱。

--ids

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

--kubernetes-cluster-name

Kubernetes 叢集的名稱。

--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 networkcloud kubernetescluster agentpool update

預覽

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

更新所提供 Kubernetes 叢集代理程式組件區的屬性，或更新與 Kubernetes 叢集代理程式組件區相關聯的標記。 屬性和標記更新可以獨立完成。

az networkcloud kubernetescluster agentpool update [--agent-pool-name]
                                                   [--count]
                                                   [--generate-ssh-keys {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--ids]
                                                   [--kubernetes-cluster-name]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--resource-group]
                                                   [--ssh-dest-key-path]
                                                   [--ssh-key-values]
                                                   [--subscription]
                                                   [--tags]
                                                   [--upgrade-settings]

範例

修補 Kubernetes 叢集的代理程式組件區

az networkcloud kubernetescluster agentpool update --name "poolName" --kubernetes-cluster-name "kubernetesClusterName" --resource-group "resourceGroupName" --count 3 --upgrade-settings max-surge="1"

更新 Agent 集區系統管理員認證

az networkcloud kubernetescluster agentpool update --name "poolName" --kubernetes-cluster-name "kubernetesClusterName" --resource-group "resourceGroupName" --ssh-key-values 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgt5SjWU= admin@vm'

選擇性參數

--agent-pool-name --name -n

Kubernetes 叢集代理程式組件區的名稱。

--count

使用此組態的虛擬機器數目。

--generate-ssh-keys

如果遺失，請產生 SSH 公開和私密金鑰檔案。 金鑰會儲存在 '~/.ssh' 底下。

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

--ids

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

--kubernetes-cluster-name

Kubernetes 叢集的名稱。

--no-wait

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

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

--resource-group -g

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

--ssh-dest-key-path

ssh 公開金鑰的空間分隔路徑清單。 您可以提供檔案路徑或目錄。 如果提供目錄，將會嘗試載入找到的所有公開金鑰（.pub）。 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--ssh-key-values

以空格分隔的 SSH 公開金鑰清單。 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--subscription

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

--tags

將取代現有資源的 Azure 資源標籤。 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--upgrade-settings

代理程式組件區的組態。 支援速記語法、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 networkcloud kubernetescluster agentpool wait

預覽

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

將 CLI 置於等候狀態，直到符合條件為止。

az networkcloud kubernetescluster agentpool wait [--agent-pool-name]
                                                 [--created]
                                                 [--custom]
                                                 [--deleted]
                                                 [--exists]
                                                 [--ids]
                                                 [--interval]
                                                 [--kubernetes-cluster-name]
                                                 [--resource-group]
                                                 [--subscription]
                                                 [--timeout]
                                                 [--updated]

選擇性參數

--agent-pool-name --name -n

Kubernetes 叢集代理程式組件區的名稱。

--created

請等候在 'Succeeded' 使用 'provisioningState' 建立。

預設值: False

--custom

等到條件符合自訂 JMESPath 查詢為止。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到刪除為止。

預設值: False

--exists

等候資源存在。

預設值: False

--ids

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

--interval

輪詢間隔以秒為單位。

預設值: 30

--kubernetes-cluster-name

Kubernetes 叢集的名稱。

--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 來取得完整偵錯記錄。