共用方式為

az networkcloud kubernetescluster

  • 參考

注意

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

管理 Kubernetes 叢集。

命令

名稱 Description 類型 狀態
az networkcloud kubernetescluster agentpool

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

 副檔名 加語
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 create

建立新的 Kubernetes 叢集，或更新現有叢集的屬性。

 副檔名 預覽​​
az networkcloud kubernetescluster delete

刪除提供的 Kubernetes 叢集。

 副檔名 預覽​​
az networkcloud kubernetescluster feature

管理 Kubernetes 叢集的功能。

 副檔名 加語
az networkcloud kubernetescluster feature create

如果 Kubernetes 叢集功能存在，請建立新的 Kubernetes 叢集功能，或更新其屬性。

 副檔名 預覽​​
az networkcloud kubernetescluster feature delete

刪除提供的 Kubernetes 叢集功能。

 副檔名 預覽​​
az networkcloud kubernetescluster feature list

列出所提供 Kubernetes 叢集的功能清單。

 副檔名 預覽​​
az networkcloud kubernetescluster feature show

取得提供的 Kubernetes 叢集功能屬性。

 副檔名 預覽​​
az networkcloud kubernetescluster feature update

更新所提供 Kubernetes 叢集功能的屬性。

 副檔名 預覽​​
az networkcloud kubernetescluster feature wait

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

 副檔名 加語
az networkcloud kubernetescluster list

列出所提供訂用帳戶中的 Kubernetes 叢集。

 副檔名 預覽​​
az networkcloud kubernetescluster restart-node

重新啟動 Kubernetes 叢集的目標節點。

 副檔名 預覽​​
az networkcloud kubernetescluster show

取得所提供 Kubernetes 叢集的屬性。

 副檔名 預覽​​
az networkcloud kubernetescluster update

更新所提供 Kubernetes 叢集的屬性，或更新與 Kubernetes 叢集相關聯的標記。 屬性和標籤更新可以獨立完成。

 副檔名 預覽​​
az networkcloud kubernetescluster wait

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

 副檔名 加語

az networkcloud kubernetescluster create

預覽

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

建立新的 Kubernetes 叢集，或更新現有叢集的屬性。

az networkcloud kubernetescluster create --control-plane-node-configuration
                                         --extended-location
                                         --initial-agent-pool-configurations
                                         --kubernetes-cluster-name
                                         --kubernetes-version
                                         --network-configuration
                                         --resource-group
                                         [--aad-configuration]
                                         [--admin-username]
                                         [--generate-ssh-keys {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--location]
                                         [--managed-resource-group-configuration]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--ssh-dest-key-path]
                                         [--ssh-key-values]
                                         [--tags]

範例

建立或更新 Kubernetes 叢集

az networkcloud kubernetescluster create --name "kubernetesClusterName" --resource-group "resourceGroupName" --location "location" --kubernetes-version "1.XX.Y" --extended-location name="/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" type=CustomLocation --aad-configuration admin-group-object-ids=["f110271b-XXXX-4163-9b99-214d91660f0e"] --admin-username "azureuser" --ssh-key-values "ssh-rsa AAAAB3NzaC1yc2EAAAADAQAt5SjWU= admin@vm" --initial-agent-pool-configurations "[{count:1,mode:'System',name:'systemPool-1',vmSkuName:'NC-XXXXX',agentOptions:{hugepagesCount:96,hugepagesSize:1G},upgradeSettings:{maxSurge:'10%'},adminUsername:'azureuser',ssh-key-values:['ssh-rsa AAAAB3NzaC1yc2EAAAADAQAt5SjWU= admin@vm']}]" --control-plane-node-configuration count=1 vmSkuName='NC-YYYYY' adminUsername='azureuser' ssh-key-values="['ssh-rsa AAAAB3NzaC1yc2EAAAADAQAt5SjWU= admin@vm']" --network-configuration cloud-services-network-id="/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName" cni-network-id="/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName" pod-cidrs=["10.244.0.0/16"] service-cidrs=["10.96.0.0/16"] dns-service-ip="10.96.0.10" attached-network-configuration.l2-networks="[{networkId:'/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName',pluginType:'DPDK'}]" attached-network-configuration.l3-networks="[{networkId:'/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName',pluginType:'SRIOV',ipamEnabled:'False'}]" attached-network-configuration.trunked-networks="[{networkId:'/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName',pluginType:'MACVLAN'}]" bgp-service-load-balancer-configuration.bgp-advertisements="[{advertiseToFabric:'True',communities:['64512:100'],ipAddressPools:['pool1'],peers:['peer1']}]" bgp-service-load-balancer-configuration.fabric-peering-enabled="True" bgp-service-load-balancer-configuration.bgp-peers="[{bfdEnabled:'False',bgpMultiHop:'False',holdTime:'P300s',keepAliveTime:'P300s',myAsn:64512,name:'peer1',peerAddress:'203.0.113.254',peerAsn:64497,peerPort:179}]" bgp-service-load-balancer-configuration.ip-address-pools="[{addresses:['198.51.102.0/24'],autoAssign:'True',name:'pool1',onlyUseHostIps:'True'}]"

必要參數

--control-plane-node-configuration

這個 Kubernetes 叢集控制平面的定義特性。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--extended-location

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

--initial-agent-pool-configurations

使用此 Kubernetes 叢集建立的代理程式集區，用於執行重要的系統服務和工作負載。 此欄位中的這項數據只會在建立期間使用，而且在建立 Kubernetes 叢集之後，欄位將會是空的。 建立之後，代理程式集區的管理會使用 agentPools 子資源來完成。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--kubernetes-cluster-name --name -n

Kubernetes 叢集的名稱。

--kubernetes-version

此叢集的 Kubernetes 版本。 接受 n.n、n.n.n 和 n.n.n-n 格式。 建立或更新之後，所使用的解譯版本將會解析為此欄位。

--network-configuration

Kubernetes 叢集網路的設定，包括跨越叢集的網路附件。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--resource-group -g

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

選擇性參數

--aad-configuration

Azure Active Directory 整合屬性。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--admin-username

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

--generate-ssh-keys

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

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

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

--managed-resource-group-configuration

與資源相關聯的受控資源群組組態。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--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。 請嘗試 “？？” 以顯示更多。

全域參數
--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 delete

預覽

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

刪除提供的 Kubernetes 叢集。

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

範例

刪除 Kubernetes 叢集

az networkcloud kubernetescluster delete --name "kubernetesClusterName" --resource-group "resourceGroupName"

選擇性參數

--ids

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

--kubernetes-cluster-name --name -n

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 list

預覽

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

列出所提供訂用帳戶中的 Kubernetes 叢集。

az networkcloud kubernetescluster list [--max-items]
                                       [--next-token]
                                       [--resource-group]

範例

列出訂用帳戶的 Kubernetes 叢集

az networkcloud kubernetescluster list

列出資源群組的 Kubernetes 叢集

az networkcloud kubernetescluster list --resource-group "resourceGroupName"

選擇性參數

--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 networkcloud kubernetescluster restart-node

預覽

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

重新啟動 Kubernetes 叢集的目標節點。

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

範例

重新啟動 Kubernetes 叢集節點

az networkcloud kubernetescluster restart-node --node-name "nodeName" --kubernetes-cluster-name "kubernetesClusterName" --resource-group "resourceGroupName"

必要參數

--node-name

要重新啟動的節點名稱。

選擇性參數

--ids

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

--kubernetes-cluster-name --name -n

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 設定預設訂用帳戶。

全域參數
--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 show

預覽

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

取得所提供 Kubernetes 叢集的屬性。

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

範例

取得 Kubernetes 叢集

az networkcloud kubernetescluster show --name "kubernetesClusterName" --resource-group "resourceGroupName"

選擇性參數

--ids

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

--kubernetes-cluster-name --name -n

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 update

預覽

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

更新所提供 Kubernetes 叢集的屬性，或更新與 Kubernetes 叢集相關聯的標記。 屬性和標籤更新可以獨立完成。

az networkcloud kubernetescluster update [--control-plane-node-configuration]
                                         [--generate-ssh-keys {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--ids]
                                         [--kubernetes-cluster-name]
                                         [--kubernetes-version]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--resource-group]
                                         [--ssh-dest-key-path]
                                         [--ssh-key-values]
                                         [--subscription]
                                         [--tags]

範例

修補 Kubernetes 叢集

az networkcloud kubernetescluster update --name "kubernetesClusterName" --resource-group "resourceGroupName" --kubernetes-version "1.25.4" --control-plane-node-configuration count="3" --tags key1="myvalue1" key2="myvalue2"

更新 Kubernetes 叢集管理員認證

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

更新 Kubernetes 叢集控制節點系統管理員認證

az networkcloud kubernetescluster update --name "kubernetesClusterName" --resource-group "resourceGroupName" --control-plane-node-configuration ssh-key-values="['ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgt5SjWU= admin@vm']"

選擇性參數

--control-plane-node-configuration

可針對這個 Kubernetes 叢集修補的控制平面定義特性。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--generate-ssh-keys

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

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

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

--kubernetes-cluster-name --name -n

Kubernetes 叢集的名稱。

--kubernetes-version

此叢集的 Kubernetes 版本。 接受 n.n、n.n.n 和 n.n.n-n 格式。 建立或更新之後，所使用的解譯版本將會解析為此欄位。

--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。 請嘗試 “？？” 以顯示更多。

全域參數
--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 wait

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

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

選擇性參數

--created

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

預設值: False
--custom

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

--deleted

等到刪除為止。

預設值: False
--exists

等候資源存在。

預設值: False
--ids

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

--interval

輪詢間隔以秒為單位。

預設值: 30
--kubernetes-cluster-name --name -n

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