az aks nodepool

參考

注意

此命令群組具有 Azure CLI 和至少一個擴充功能中定義的命令。安裝每個擴充功能以受益於其擴充功能。深入了解擴充功能。

用來管理 Kubernetes kubernetes 叢集中節點集區的命令。

命令

名稱	Description	類型	狀態
az aks nodepool add	將節點集區新增至受控 Kubernetes 叢集。	核心	GA
az aks nodepool add (aks-preview 擴充功能)	將節點集區新增至受控 Kubernetes 叢集。	副檔名	GA
az aks nodepool delete	刪除受控 Kubernetes 叢集中的代理程式集區。	核心	GA
az aks nodepool delete (aks-preview 擴充功能)	刪除受控 Kubernetes 叢集中的代理程式集區。	副檔名	GA
az aks nodepool delete-machines	刪除受控叢集代理程式集區中的特定機器。	副檔名	GA
az aks nodepool get-upgrades	取得受控 Kubernetes 叢集之代理程式集區的可用升級版本。	核心	GA
az aks nodepool get-upgrades (aks-preview 擴充功能)	取得受控 Kubernetes 叢集之代理程式集區的可用升級版本。	副檔名	GA
az aks nodepool list	列出受控 Kubernetes 叢集中的節點集區。若要取得叢集執行 `kubectl get nodes` 命令中的節點清單。	核心	GA
az aks nodepool list (aks-preview 擴充功能)	列出受控 Kubernetes 叢集中的節點集區。	副檔名	GA
az aks nodepool manual-scale	管理 nodepool virtualMachineProfile.scale.manual 的命令。	副檔名	GA
az aks nodepool manual-scale add	將新的手動新增至受控 Kubernetes 叢集中的 VirtualMachines 代理程式集池。	副檔名	GA
az aks nodepool manual-scale delete	刪除受控 Kubernetes 叢集中 VirtualMachines Agentpool 的現有手動。	副檔名	GA
az aks nodepool manual-scale update	更新受控 Kubernetes 叢集中 VirtualMachines Agentpool 的現有手動。	副檔名	GA
az aks nodepool operation-abort	中止 nodepool 上最後一次執行作業。	核心	GA
az aks nodepool operation-abort (aks-preview 擴充功能)	中止 nodepool 上最後一次執行作業。	副檔名	GA
az aks nodepool scale	調整受控 Kubernetes 叢集中的節點集區。	核心	GA
az aks nodepool scale (aks-preview 擴充功能)	調整受控 Kubernetes 叢集中的節點集區。	副檔名	GA
az aks nodepool show	顯示受控 Kubernetes 叢集中節點集區的詳細數據。	核心	GA
az aks nodepool show (aks-preview 擴充功能)	顯示受控 Kubernetes 叢集中節點集區的詳細數據。	副檔名	GA
az aks nodepool snapshot	管理 nodepool 快照集的命令。	核心和擴充功能	GA
az aks nodepool snapshot create	建立 nodepool 快照集。	核心	GA
az aks nodepool snapshot create (aks-preview 擴充功能)	建立 nodepool 快照集。	副檔名	GA
az aks nodepool snapshot delete	刪除 nodepool 快照集。	核心	GA
az aks nodepool snapshot delete (aks-preview 擴充功能)	刪除 nodepool 快照集。	副檔名	GA
az aks nodepool snapshot list	列出 nodepool 快照集。	核心	GA
az aks nodepool snapshot list (aks-preview 擴充功能)	列出 nodepool 快照集。	副檔名	GA
az aks nodepool snapshot show	顯示 nodepool 快照集的詳細數據。	核心	GA
az aks nodepool snapshot show (aks-preview 擴充功能)	顯示 nodepool 快照集的詳細數據。	副檔名	GA
az aks nodepool snapshot update	更新 nodepool 快照集上的標籤。	核心	GA
az aks nodepool snapshot update (aks-preview 擴充功能)	更新 nodepool 快照集上的標籤。	副檔名	GA
az aks nodepool snapshot wait	等候 nodepool 快照集達到所需的狀態。	核心	GA
az aks nodepool start	在受控 Kubernetes 叢集中啟動已停止的代理程式集區。	核心	GA
az aks nodepool start (aks-preview 擴充功能)	在受控 Kubernetes 叢集中啟動已停止的代理程式集區。	副檔名	GA
az aks nodepool stop	停止在受控 Kubernetes 叢集中執行代理程式集區。	核心	GA
az aks nodepool stop (aks-preview 擴充功能)	停止在受控 Kubernetes 叢集中執行代理程式集區。	副檔名	GA
az aks nodepool update	更新節點集區屬性。	核心	GA
az aks nodepool update (aks-preview 擴充功能)	更新節點集區屬性。	副檔名	GA
az aks nodepool upgrade	升級受控 Kubernetes 叢集中的節點集區。	核心	GA
az aks nodepool upgrade (aks-preview 擴充功能)	升級受控 Kubernetes 叢集中的節點集區。	副檔名	GA
az aks nodepool wait	等候節點集區達到所需的狀態。	核心	GA

az aks nodepool add

編輯

將節點集區新增至受控 Kubernetes 叢集。

az aks nodepool add --cluster-name
                    --name
                    --resource-group
                    [--aks-custom-headers]
                    [--allowed-host-ports]
                    [--asg-ids]
                    [--crg-id]
                    [--disable-windows-outbound-nat]
                    [--drain-timeout]
                    [--enable-cluster-autoscaler]
                    [--enable-encryption-at-host]
                    [--enable-fips-image]
                    [--enable-node-public-ip]
                    [--enable-ultra-ssd]
                    [--eviction-policy {Deallocate, Delete}]
                    [--gpu-instance-profile {MIG1g, MIG2g, MIG3g, MIG4g, MIG7g}]
                    [--host-group-id]
                    [--kubelet-config]
                    [--kubernetes-version]
                    [--labels]
                    [--linux-os-config]
                    [--max-count]
                    [--max-pods]
                    [--max-surge]
                    [--min-count]
                    [--mode {System, User}]
                    [--no-wait]
                    [--node-count]
                    [--node-osdisk-size]
                    [--node-osdisk-type {Ephemeral, Managed}]
                    [--node-public-ip-prefix-id]
                    [--node-public-ip-tags]
                    [--node-soak-duration]
                    [--node-taints]
                    [--node-vm-size]
                    [--os-sku {AzureLinux, CBLMariner, Mariner, Ubuntu, Windows2019, Windows2022}]
                    [--os-type]
                    [--pod-subnet-id]
                    [--ppg]
                    [--priority {Regular, Spot}]
                    [--scale-down-mode {Deallocate, Delete}]
                    [--snapshot-id]
                    [--spot-max-price]
                    [--tags]
                    [--vnet-subnet-id]
                    [--zones]

範例

在已啟用暫時 os 的現有 AKS 叢集中建立 nodepool。

az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --node-osdisk-type Ephemeral --node-osdisk-size 48

建立已啟用 EncryptionAtHost 的 nodepool。

az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --enable-encryption-at-host

建立已啟用 UltraSSD 的節點集區。

az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --enable-ultra-ssd

建立具有特定OS SKU的 nodepool 叢集

az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --os-sku Ubuntu

使用已啟用 FIPS 的 OS 建立 nodepool

az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --enable-fips-image

使用快照集標識碼建立 kubernetes 叢集。

az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --kubernetes-version 1.20.9 --snapshot-id "/subscriptions/00000/resourceGroups/AnotherResourceGroup/providers/Microsoft.ContainerService/snapshots/mysnapshot1"

在具有主機群組標識碼的現有 AKS 叢集中建立 nodepool

az aks nodepool add -g MyResourceGroup -n MyNodePool --cluster-name MyMC --host-group-id /subscriptions/00000/resourceGroups/AnotherResourceGroup/providers/Microsoft.ContainerService/hostGroups/myHostGroup --node-vm-size VMSize

建立具有容量保留群組（CRG）識別碼的節點集區。

az aks nodepool add -g MyResourceGroup -n MyNodePool --cluster-name MyMC --node-vm-size VMSize --crg-id "/subscriptions/SubID/resourceGroups/ResourceGroupName/providers/Microsoft.ContainerService/CapacityReservationGroups/MyCRGID"

必要參數

--cluster-name

叢集名稱。

--name --nodepool-name -n

節點集區名稱。

--resource-group -g

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

選擇性參數

--aks-custom-headers

以逗號分隔的索引鍵/值組來指定自定義標頭。

--allowed-host-ports

公開節點集區上的主機埠。指定時，格式應該是具有通訊協定的範圍以空格分隔的清單，例如 80/TCP 443/TCP 4000-5000/TCP.

--asg-ids

節點集區網路介面所屬之應用程式安全組的標識碼。指定時，格式應該是以空格分隔的標識符清單。

--crg-id

用來將新 nodepool 與現有的容量保留群組資源產生關聯的crg識別碼。

--disable-windows-outbound-nat

停用 Windows 代理程式節點集區上的 Windows 輸出NAT。

預設值: False

--drain-timeout

當節點清空等候所有 Pod 收回的分鐘數時。

--enable-cluster-autoscaler -e

啟用叢集自動調整程式。

預設值: False

--enable-encryption-at-host

啟用 EncryptionAtHost，預設值為 false。

預設值: False

--enable-fips-image

在代理程序節點上使用已啟用 FIPS 的 OS。

預設值: False

--enable-node-public-ip

啟用 VMSS 節點公用 IP。

預設值: False

--enable-ultra-ssd

啟用 UltraSSD，預設值為 false。

預設值: False

--eviction-policy

現成節點集區的收回原則。只有當 --priority 為 Spot 時，才能設定它。

接受的值: Deallocate, Delete

預設值: Delete

--gpu-instance-profile

用來分割多 gpu Nvidia GPU 的 GPU 實例配置檔。

接受的值: MIG1g, MIG2g, MIG3g, MIG4g, MIG7g

--host-group-id

用來布建代理程式節點集區的完整專用主機群組標識碼。

--kubelet-config

JSON 檔案的路徑，其中包含代理程序節點的 Kubelet 組態。 https://aka.ms/aks/custom-node-config.

--kubernetes-version -k

用來建立叢集的 Kubernetes 版本，例如「1.16.9」。。

值來源: `az aks get-versions`

--labels

節點集區的節點標籤。如需標籤法，請參閱 https://aka.ms/node-labels 。

--linux-os-config

JSON 檔案的路徑，其中包含 Linux 代理程式節點的 OS 組態。 https://aka.ms/aks/custom-node-config.

--max-count

指定「--enable-cluster-autoscaler」時，用於自動調整程式的最大節點計數。請針對使用者 nodepool 指定 [0， 1000] 範圍中的值，並針對系統 nodepool 指定 [1,1000]。

--max-pods -m

可部署到節點的 Pod 數目上限。

如果未指定，則預設會根據網路外掛程式。 “azure” 為 30、“kubenet” 為 110 或 “none” 為 250。

--max-surge

用來加速升級的額外節點。指定時，它代表所使用的數位或百分比，例如5 或 33%。

--min-count

指定「--enable-cluster-autoscaler」時，用於自動調整程式的最低節點計數。請針對使用者 nodepool 指定 [0， 1000] 範圍中的值，並針對系統 nodepool 指定 [1,1000]。

--mode

定義節點集區主要函式之節點集區的模式。如果設定為「系統」，AKS 偏好使用模式 System排程到節點集區。請至https://aka.ms/aks/nodepool/mode，即可深入瞭解。

接受的值: System, User

預設值: User

--no-wait

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

預設值: False

--node-count -c

Kubernetes 代理程式集區中的節點數目。建立叢集之後，您可以使用變更其節點集 az aks scale區的大小。

預設值: 3

--node-osdisk-size

代理程式集區中每個節點的OS磁碟 GiB 大小。最小 30 GiB。

--node-osdisk-type

要用於指定代理程式集區中機器的OS磁碟類型。盡可能搭配 VM 大小和 OS 磁碟大小，預設為「暫時」。建立之後可能無法變更此集區。（'暫時' 或 'Managed'）。

接受的值: Ephemeral, Managed

--node-public-ip-prefix-id

用來將公用IP指派給VMSS節點的公用IP前綴標識碼。

--node-public-ip-tags

節點公用IP的ipTag。

--node-soak-duration

清空節點並重新製作映射並移至下一個節點之前，等待的時間量（以分鐘為單位）。

--node-taints

節點集區的節點污點。

--node-vm-size -s

要建立為 Kubernetes 節點的虛擬機器大小。

--os-sku

代理程式節點集區的 OS SKU。適用於 Linux 的 Ubuntu 或 CBLMariner。 Windows2019 或 Windows2022 for Windows。

接受的值: AzureLinux, CBLMariner, Mariner, Ubuntu, Windows2019, Windows2022

--os-type

OS 類型。 Linux 或 Windows。

--pod-subnet-id

現有 VNet 中要指派叢集中 Pod 的子網資源標識碼（需要 azure network-plugin）。

--ppg

PPG 的識別碼。

--priority

節點集區的優先順序。

接受的值: Regular, Spot

預設值: Regular

--scale-down-mode

描述如何將 VM 新增至 nodepools 或從 nodepools 中移除。

接受的值: Deallocate, Delete

預設值: Delete

--snapshot-id

用來建立這個 nodepool 的來源快照集標識碼。

--spot-max-price

只有當 --priority 為 Spot 時，才能設定它。指定您願意以美元支付的最高價格。可能的值是大於零或 -1 的任何十進位值，表示默認價格為隨選。它最多只能包含5個小數字數。

預設值: nan

--tags

以空格分隔的標記：key[=value] [key[=value] ...]。使用「清除現有的標記」。

--vnet-subnet-id

要在其中部署叢集的現有 VNet 中子網的資源標識碼。

--zones -z

將放置代理程序節點的可用性區域。此外，若要將代理程式節點安裝到多個區域，您需要將區域號碼以空白分隔。例如 - 若要擁有所有 3 個區域，您應該輸入 --zones 1 2 3。

全域參數

--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 aks nodepool add (aks-preview 擴充功能)

將節點集區新增至受控 Kubernetes 叢集。

az aks nodepool add --cluster-name
                    --name
                    --resource-group
                    [--aks-custom-headers]
                    [--allowed-host-ports]
                    [--asg-ids]
                    [--crg-id]
                    [--disable-windows-outbound-nat]
                    [--drain-timeout]
                    [--enable-artifact-streaming]
                    [--enable-cluster-autoscaler]
                    [--enable-custom-ca-trust]
                    [--enable-encryption-at-host]
                    [--enable-fips-image]
                    [--enable-node-public-ip]
                    [--enable-secure-boot]
                    [--enable-ultra-ssd]
                    [--enable-vtpm]
                    [--eviction-policy {Deallocate, Delete}]
                    [--gateway-prefix-size]
                    [--gpu-instance-profile {MIG1g, MIG2g, MIG3g, MIG4g, MIG7g}]
                    [--host-group-id]
                    [--if-match]
                    [--if-none-match]
                    [--kubelet-config]
                    [--kubernetes-version]
                    [--labels]
                    [--linux-os-config]
                    [--max-count]
                    [--max-pods]
                    [--max-surge]
                    [--message-of-the-day]
                    [--min-count]
                    [--mode {Gateway, System, User}]
                    [--no-wait]
                    [--node-count]
                    [--node-osdisk-size]
                    [--node-osdisk-type {Ephemeral, Managed}]
                    [--node-public-ip-prefix-id]
                    [--node-public-ip-tags]
                    [--node-soak-duration]
                    [--node-taints]
                    [--node-vm-size]
                    [--os-sku {AzureLinux, CBLMariner, Mariner, Ubuntu, Windows2019, Windows2022, WindowsAnnual}]
                    [--os-type]
                    [--pod-ip-allocation-mode {DynamicIndividual, StaticBlock}]
                    [--pod-subnet-id]
                    [--ppg]
                    [--priority {Regular, Spot}]
                    [--scale-down-mode {Deallocate, Delete}]
                    [--skip-gpu-driver-install]
                    [--snapshot-id]
                    [--spot-max-price]
                    [--ssh-access {disabled, localuser}]
                    [--tags]
                    [--vm-set-type]
                    [--vm-sizes]
                    [--vnet-subnet-id]
                    [--workload-runtime {KataCcIsolation, KataMshvVmIsolation, OCIContainer, WasmWasi}]
                    [--zones]

範例

在已啟用暫時 os 的現有 AKS 叢集中建立 nodepool。

az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --node-osdisk-type Ephemeral --node-osdisk-size 48

建立已啟用 EncryptionAtHost 的 nodepool。

az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --enable-encryption-at-host

建立具有特定os-sku的 nodepool

az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster  --os-sku Ubuntu

建立可執行 wasm 工作負載的 nodepool。

az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster  --workload-runtime WasmWasi

使用快照集標識碼建立 kubernetes 叢集。

az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --kubernetes-version 1.20.9 --snapshot-id "/subscriptions/00000/resourceGroups/AnotherResourceGroup/providers/Microsoft.ContainerService/snapshots/mysnapshot1"

建立具有容量保留群組（CRG）識別碼的節點集區。

az aks nodepool add -g MyResourceGroup -n MyNodePool --cluster-name MyMC --node-vm-size VMSize --crg-id "/subscriptions/SubID/resourceGroups/ResourceGroupName/providers/Microsoft.ContainerService/CapacityReservationGroups/MyCRGID"

在具有主機群組標識碼的現有 AKS 叢集中建立 nodepool

az aks nodepool add -g MyResourceGroup -n MyNodePool --cluster-name MyMC --host-group-id /subscriptions/00000/resourceGroups/AnotherResourceGroup/providers/Microsoft.ContainerService/hostGroups/myHostGroup --node-vm-size VMSize

建立節點集區，並將IP配置模式設定為「StaticBlock」，並使用Pod子網標識碼

az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster  --os-sku Ubuntu --pod-subnet-id /subscriptions/00000/resourceGroups/AnotherResourceGroup/providers/Microsoft.Network/virtualNetworks/MyVnet/subnets/MySubnet --pod-ip-allocation-mode StaticBlock

建立 VirtualMachines 類型的 nodepool

az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --vm-set-type VirtualMachines --vm-sizes "Standard_D4s_v3,Standard_D8s_v3" --node-count 3

必要參數

--cluster-name

叢集名稱。

--name --nodepool-name -n

節點集區名稱。

--resource-group -g

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

選擇性參數

--aks-custom-headers

傳送自定義標頭。指定時，格式應該是 Key1=Value1，Key2=Value2。

--allowed-host-ports

預覽

公開節點集區上的主機埠。指定時，格式應該是以逗號分隔的範圍清單，例如通訊協定。80/TCP，443/TCP，4000-5000/TCP。必須使用 VMSS 代理程式集區類型。

--asg-ids

預覽

節點集區網路介面所屬之應用程式安全組的標識碼。指定時，格式應該是逗號分隔的標識符清單。必須使用 VMSS 代理程式集區類型。

--crg-id

預覽

crg-id，用來將新的 nodepool 與現有的容量保留群組資源產生關聯。必須使用 VMSS 代理程式集區類型。

--disable-windows-outbound-nat

停用 Windows 代理程式節點集區上的 Windows 輸出NAT。必須使用 VMSS 代理程式集區類型。

預設值: False

--drain-timeout

當節點清空等候所有 Pod 收回的分鐘數時。

--enable-artifact-streaming

預覽

針對節點集區所管理的 VirtualMachineScaleSets 啟用成品串流，以透過隨選映射載入加速節點上的容器冷啟動。若要使用這項功能，容器映像也必須在 ACR 上啟用成品串流。如果未指定，則預設值為 false。

預設值: False

--enable-cluster-autoscaler -e

啟用叢集自動調整程式。必須使用 VMSS 代理程式集區類型。

預設值: False

--enable-custom-ca-trust

在代理程式節點集區上啟用自定義 CA 信任。

預設值: False

--enable-encryption-at-host

在代理程式節點集區上啟用 EncryptionAtHost。

預設值: False

--enable-fips-image

在代理程序節點上使用已啟用 FIPS 的 OS。

預設值: False

--enable-node-public-ip

啟用 VMSS 節點公用 IP。必須使用 VMSS 代理程式集區類型。

預設值: False

--enable-secure-boot

預覽

在代理程式節點集區上啟用安全開機。必須使用 VMSS 代理程式集區類型。

預設值: False

--enable-ultra-ssd

在代理程式節點集區上啟用 UltraSSD。必須使用 VMSS 代理程式集區類型。

預設值: False

--enable-vtpm

預覽

在代理程序節點集區上啟用 vTPM。必須使用 VMSS 代理程式集區類型。

預設值: False

--eviction-policy

現成節點集區的收回原則。只有當 --priority 為 Spot 時，才能設定它。

接受的值: Deallocate, Delete

預設值: Delete

--gateway-prefix-size

預覽

連結至閘道模式節點集區的公用IPPrefix大小。節點集區必須處於閘道模式。

--gpu-instance-profile

用來分割多 gpu Nvidia GPU 的 GPU 實例配置檔。

接受的值: MIG1g, MIG2g, MIG3g, MIG4g, MIG7g

--host-group-id

（預覽）用來布建代理程式節點集區的完整專用主機群組標識碼。必須使用 VMSS 代理程式集區類型。

--if-match

如果與作業相符，所提供的值將會與 Agentpool 的 ETag 進行比較。如果不符合，將會拒絕要求，以防止意外覆寫。建立新的 Agentpool 時，不得指定這個值。

--if-none-match

設定為『*』以允許建立新的 Agentpool，但為了避免更新現有的 Agentpool。將會忽略其他值。

--kubelet-config

代理程序節點的 Kubelet 組態。

--kubernetes-version -k

用來建立叢集的 Kubernetes 版本，例如 “1.7.12” 或 “1.8.7”。

值來源: `az aks get-versions`

--labels

節點集區的節點標籤。如需標籤法，請參閱 https://aka.ms/node-labels 。

--linux-os-config

Linux 代理程序節點的 OS 組態。

--max-count

指定「--enable-cluster-autoscaler」時，用於自動調整程式的最大節點計數。請針對使用者 nodepool 指定 [0， 1000] 範圍中的值，並針對系統 nodepool 指定 [1,1000]。

--max-pods -m

可部署到節點的 Pod 數目上限。

如果未指定，則預設會根據網路外掛程式。 “azure” 為 30、“kubenet” 為 110 或 “none” 為 250。

預設值: 0

--max-surge

用來加速升級的額外節點。指定時，它代表所使用的數位或百分比，例如5 或 33%。

--message-of-the-day

包含當天所需訊息的檔案路徑。僅適用於Linux節點。將會寫入 /etc/motd。

--min-count

指定「--enable-cluster-autoscaler」時，用於自動調整程式的迷你節點計數。請針對使用者 nodepool 指定 [0， 1000] 範圍中的值，並針對系統 nodepool 指定 [1,1000]。

--mode

接受的值: Gateway, System, User

預設值: User

--no-wait

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

預設值: False

--node-count -c

Kubernetes 代理程式集區中的節點數目。建立叢集之後，您可以使用變更其節點集 az aks scale區的大小。

預設值: 3

--node-osdisk-size

代理程式集區中每個節點的OS磁碟 GiB 大小。最小 30 GiB。

預設值: 0

--node-osdisk-type

接受的值: Ephemeral, Managed

--node-public-ip-prefix-id

用來將公用IP指派給VMSS節點的公用IP前綴標識碼。必須使用 VMSS 代理程式集區類型。

--node-public-ip-tags

節點公用IP的ipTag。必須使用 VMSS 代理程式集區類型。

--node-soak-duration

清空節點並重新製作映射並移至下一個節點之前，等待的時間量（以分鐘為單位）。

--node-taints

節點集區的節點污點。

--node-vm-size -s

要建立為 Kubernetes 節點的虛擬機器大小。

--os-sku

代理程序節點集區的os-sku。當 os 類型為 Linux 時 Ubuntu 或 CBLMariner，預設值為 Ubuntu，如果未設定則為 Ubuntu;當操作系統類型為 Windows 時，Windows2019、Windows2022 或 WindowsAnnual，目前的預設值為 Windows2022 如果未設定。

接受的值: AzureLinux, CBLMariner, Mariner, Ubuntu, Windows2019, Windows2022, WindowsAnnual

--os-type

OS 類型。 Linux 或 Windows。 “VirtualMachines” VM 集類型尚不支援 Windows。

--pod-ip-allocation-mode

設定IP配置模式，以瞭解如何將來自 Azure Pod 子網的 Pod IP 配置給 AKS 叢集中的節點。選擇是在個別IP的動態批次或一組 CIDR 區塊的靜態配置之間。接受的值是「DynamicIndividual」或「StaticBlock」。。

與「azure」網路外掛程式搭配使用。需要 --pod-subnet-id。

接受的值: DynamicIndividual, StaticBlock

--pod-subnet-id

現有 VNet 中要指派叢集中 Pod 的子網標識碼（需要 azure 網路外掛程式）。

--ppg

PPG 的識別碼。必須使用 VMSS 代理程式集區類型。

--priority

節點集區的優先順序。

接受的值: Regular, Spot

預設值: Regular

--scale-down-mode

描述如何將 VM 新增至節點集區或從 nodepools 中移除。

接受的值: Deallocate, Delete

預設值: Delete

--skip-gpu-driver-install

預覽

如果客戶想要自行管理 GPU 驅動程式安裝，請使用 GPU vm 大小略過節點集區上的 AKS 自動安裝 GPU 驅動程式。如果未指定，則預設值為 false。

預設值: False

--snapshot-id

用來建立這個 nodepool 的來源快照集標識碼。必須使用 VMSS 代理程式集區類型。

--spot-max-price

預設值: nan

--ssh-access

預覽

設定節點集區的SSH設定。使用「已停用」來停用 SSH 存取、「localuser」，以使用私鑰啟用 SSH 存取。

接受的值: disabled, localuser

預設值: localuser

--tags

以空格分隔的標記：key[=value] [key[=value] ...]。使用「清除現有的標記」。

--vm-set-type

代理程式集區 vm 集合類型。 VirtualMachineScaleSets、AvailabilitySet 或 VirtualMachines（預覽）。

--vm-sizes

預覽

大小逗號分隔清單。必須使用 VirtualMachines 代理程式集區類型。

--vnet-subnet-id

要在其中部署叢集之現有 VNet 中的子網標識碼。

--workload-runtime

決定節點可執行的工作負載類型。預設為 OCIContainer。

接受的值: KataCcIsolation, KataMshvVmIsolation, OCIContainer, WasmWasi

預設值: OCIContainer

--zones -z

將放置代理程式節點的可用性區域空間分隔清單。必須使用 VMSS 代理程式集區類型。

全域參數

--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 aks nodepool delete

編輯

刪除受控 Kubernetes 叢集中的代理程式集區。

az aks nodepool delete --cluster-name
                       --name
                       --resource-group
                       [--no-wait]

必要參數

--cluster-name

叢集名稱。

--name --nodepool-name -n

節點集區名稱。

--resource-group -g

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

選擇性參數

--no-wait

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

預設值: 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 aks nodepool delete (aks-preview 擴充功能)

刪除受控 Kubernetes 叢集中的代理程式集區。

az aks nodepool delete --cluster-name
                       --name
                       --resource-group
                       [--if-match]
                       [--ignore-pod-disruption-budget]
                       [--no-wait]

範例

使用ignore-pod-disruption-budget 刪除代理程式集區

az aks nodepool delete --resource-group MyResourceGroup --cluster-name MyManagedCluster --name nodepool1 --ignore-pod-disruption-budget=true

必要參數

--cluster-name

叢集名稱。

--name --nodepool-name -n

節點集區名稱。

--resource-group -g

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

選擇性參數

--if-match

如果符合作業，所提供的值將會與節點集區的 ETag 進行比較。如果不符合，將會拒絕要求，以防止意外覆寫。建立新的 Agentpool 時，不得指定這個值。

--ignore-pod-disruption-budget -i

預覽

（預覽） ignore-pod-disruption-budget 會刪除現有的 nodepool，而不考慮 Pod 中斷預算。

--no-wait

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

預設值: 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 aks nodepool delete-machines

刪除受控叢集代理程式集區中的特定機器。

az aks nodepool delete-machines --cluster-name
                                --machine-names
                                --name
                                --resource-group
                                [--no-wait]

範例

刪除代理程式集區中的特定計算機

az aks nodepool delete-machines -g myResourceGroup --nodepool-name nodepool1 --cluster-name myAKSCluster --machine-names machine1

必要參數

--cluster-name

叢集名稱。

--machine-names

要刪除之代理程式集區的計算機名稱空間分隔清單。

--name --nodepool-name -n

節點集區名稱。

--resource-group -g

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

選擇性參數

--no-wait

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

預設值: 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 aks nodepool get-upgrades

編輯

取得受控 Kubernetes 叢集之代理程式集區的可用升級版本。

az aks nodepool get-upgrades --cluster-name
                             --name
                             --resource-group

範例

取得受控 Kubernetes 叢集之代理程式集區的可用升級版本。

az aks nodepool get-upgrades --resource-group MyResourceGroup --cluster-name MyManagedCluster --nodepool-name MyNodePool

必要參數

--cluster-name

叢集名稱。

--name --nodepool-name -n

節點集區名稱。

--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 aks nodepool get-upgrades (aks-preview 擴充功能)

取得受控 Kubernetes 叢集之代理程式集區的可用升級版本。

az aks nodepool get-upgrades --cluster-name
                             --name
                             --resource-group

範例

取得受控 Kubernetes 叢集之代理程式集區的可用升級版本。

az aks nodepool get-upgrades --resource-group MyResourceGroup --cluster-name MyManagedCluster --nodepool-name MyNodePool

必要參數

--cluster-name

叢集名稱。

--name --nodepool-name -n

節點集區名稱。

--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 aks nodepool list

編輯

列出受控 Kubernetes 叢集中的節點集區。若要取得叢集執行 kubectl get nodes 命令中的節點清單。

az aks nodepool list --cluster-name
                     --resource-group

必要參數

--cluster-name

叢集名稱。

--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 aks nodepool list (aks-preview 擴充功能)

列出受控 Kubernetes 叢集中的節點集區。

az aks nodepool list --cluster-name
                     --resource-group

必要參數

--cluster-name

叢集名稱。

--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 aks nodepool operation-abort

編輯

中止 nodepool 上最後一次執行作業。

az aks nodepool operation-abort --cluster-name
                                --name
                                --resource-group
                                [--no-wait]

範例

代理程式集區上的中止作業

az aks nodepool operation-abort -g myResourceGroup --nodepool-name nodepool1 --cluster-name myAKSCluster

必要參數

--cluster-name

叢集名稱。

--name --nodepool-name -n

節點集區名稱。

--resource-group -g

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

選擇性參數

--no-wait

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

預設值: 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 aks nodepool operation-abort (aks-preview 擴充功能)

中止 nodepool 上最後一次執行作業。

az aks nodepool operation-abort --cluster-name
                                --name
                                --resource-group
                                [--aks-custom-headers]
                                [--no-wait]

範例

代理程式集區上的中止作業

az aks nodepool operation-abort -g myResourceGroup --nodepool-name nodepool1 --cluster-name myAKSCluster

必要參數

--cluster-name

叢集名稱。

--name --nodepool-name -n

節點集區名稱。

--resource-group -g

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

選擇性參數

--aks-custom-headers

傳送自定義標頭。指定時，格式應該是 Key1=Value1，Key2=Value2。

--no-wait

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

預設值: 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 aks nodepool scale

編輯

調整受控 Kubernetes 叢集中的節點集區。

az aks nodepool scale --cluster-name
                      --name
                      --resource-group
                      [--no-wait]
                      [--node-count]

必要參數

--cluster-name

叢集名稱。

--name --nodepool-name -n

節點集區名稱。

--resource-group -g

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

選擇性參數

--no-wait

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

預設值: False

--node-count -c

Kubernetes節點集區中的節點數目。

預設值: 3

全域參數

--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 aks nodepool scale (aks-preview 擴充功能)

調整受控 Kubernetes 叢集中的節點集區。

az aks nodepool scale --cluster-name
                      --name
                      --resource-group
                      [--aks-custom-headers]
                      [--no-wait]
                      [--node-count]

必要參數

--cluster-name

叢集名稱。

--name --nodepool-name -n

節點集區名稱。

--resource-group -g

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

選擇性參數

--aks-custom-headers

傳送自定義標頭。指定時，格式應該是 Key1=Value1，Key2=Value2。

--no-wait

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

預設值: False

--node-count -c

Kubernetes節點集區中的節點數目。

預設值: 3

全域參數

--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 aks nodepool show

編輯

顯示受控 Kubernetes 叢集中節點集區的詳細數據。

az aks nodepool show --cluster-name
                     --name
                     --resource-group

必要參數

--cluster-name

叢集名稱。

--name --nodepool-name -n

節點集區名稱。

--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 aks nodepool show (aks-preview 擴充功能)

顯示受控 Kubernetes 叢集中節點集區的詳細數據。

az aks nodepool show --cluster-name
                     --name
                     --resource-group

必要參數

--cluster-name

叢集名稱。

--name --nodepool-name -n

節點集區名稱。

--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 aks nodepool start

編輯

在受控 Kubernetes 叢集中啟動已停止的代理程式集區。

az aks nodepool start --cluster-name
                      --name
                      --resource-group
                      [--aks-custom-headers]
                      [--no-wait]

範例

在受控叢集中啟動代理程式集區

az aks nodepool start --nodepool-name nodepool1 -g MyResourceGroup --cluster-name MyManagedCluster

必要參數

--cluster-name

叢集名稱。

--name --nodepool-name -n

節點集區名稱。

--resource-group -g

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

選擇性參數

--aks-custom-headers

傳送自定義標頭。指定時，格式應該是 Key1=Value1，Key2=Value2。

--no-wait

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

預設值: 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 aks nodepool start (aks-preview 擴充功能)

在受控 Kubernetes 叢集中啟動已停止的代理程式集區。

az aks nodepool start --cluster-name
                      --name
                      --resource-group
                      [--aks-custom-headers]
                      [--no-wait]

範例

在受控叢集中啟動代理程式集區

az aks nodepool start --nodepool-name nodepool1 -g MyResourceGroup --cluster-name MyManagedCluster

必要參數

--cluster-name

叢集名稱。

--name --nodepool-name -n

節點集區名稱。

--resource-group -g

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

選擇性參數

--aks-custom-headers

傳送自定義標頭。指定時，格式應該是 Key1=Value1，Key2=Value2。

--no-wait

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

預設值: 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 aks nodepool stop

編輯

停止在受控 Kubernetes 叢集中執行代理程式集區。

az aks nodepool stop --cluster-name
                     --name
                     --resource-group
                     [--aks-custom-headers]
                     [--no-wait]

範例

停止受控叢集中的代理程式集區

az aks nodepool stop --nodepool-name nodepool1 -g MyResourceGroup --cluster-name MyManagedCluster

必要參數

--cluster-name

叢集名稱。

--name --nodepool-name -n

節點集區名稱。

--resource-group -g

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

選擇性參數

--aks-custom-headers

傳送自定義標頭。指定時，格式應該是 Key1=Value1，Key2=Value2。

--no-wait

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

預設值: 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 aks nodepool stop (aks-preview 擴充功能)

停止在受控 Kubernetes 叢集中執行代理程式集區。

az aks nodepool stop --cluster-name
                     --name
                     --resource-group
                     [--aks-custom-headers]
                     [--no-wait]

範例

停止受控叢集中的代理程式集區

az aks nodepool stop --nodepool-name nodepool1 -g MyResourceGroup --cluster-name MyManagedCluster

必要參數

--cluster-name

叢集名稱。

--name --nodepool-name -n

節點集區名稱。

--resource-group -g

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

選擇性參數

--aks-custom-headers

傳送自定義標頭。指定時，格式應該是 Key1=Value1，Key2=Value2。

--no-wait

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

預設值: 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 aks nodepool update

編輯

更新節點集區屬性。

更新節點集區以啟用/停用叢集自動調整程式，或變更最小計數或 max-count。在沒有選擇性自變數的情況下呼叫時，這會嘗試將節點集區移至其目標狀態，而不需要變更目前的節點集區組態。這可以用來移出非成功狀態。

az aks nodepool update --cluster-name
                       --name
                       --resource-group
                       [--aks-custom-headers]
                       [--allowed-host-ports]
                       [--asg-ids]
                       [--disable-cluster-autoscaler]
                       [--drain-timeout]
                       [--enable-cluster-autoscaler]
                       [--labels]
                       [--max-count]
                       [--max-surge]
                       [--min-count]
                       [--mode {System, User}]
                       [--no-wait]
                       [--node-soak-duration]
                       [--node-taints]
                       [--os-sku {AzureLinux, CBLMariner, Mariner}]
                       [--scale-down-mode {Deallocate, Delete}]
                       [--tags]
                       [--update-cluster-autoscaler]

範例

將 nodepool 調和回其目前狀態。

az aks nodepool update -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster

在節點計數範圍內啟用叢集自動調整程式 [1,5]

az aks nodepool update --enable-cluster-autoscaler --min-count 1 --max-count 5 -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster

停用現有叢集的叢集自動調整程式

az aks nodepool update --disable-cluster-autoscaler -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster

更新叢集自動調整程式的最大計數或最大計數。

az aks nodepool update --update-cluster-autoscaler --min-count 1 --max-count 10 -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster

必要參數

--cluster-name

叢集名稱。

--name --nodepool-name -n

節點集區名稱。

--resource-group -g

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

選擇性參數

--aks-custom-headers

以逗號分隔的索引鍵/值組來指定自定義標頭。

--allowed-host-ports

公開節點集區上的主機埠。指定時，格式應該是具有通訊協定的範圍以空格分隔的清單，例如 80/TCP 443/TCP 4000-5000/TCP.

--asg-ids

節點集區網路介面所屬之應用程式安全組的標識碼。指定時，格式應該是以空格分隔的標識符清單。

--disable-cluster-autoscaler -d

停用叢集自動調整程式。

預設值: False

--drain-timeout

當節點清空等候所有 Pod 收回的分鐘數時。

--enable-cluster-autoscaler -e

啟用叢集自動調整程式。

預設值: False

--labels

節點集區的節點標籤。如需標籤法，請參閱 https://aka.ms/node-labels 。

--max-count

指定「--enable-cluster-autoscaler」時，用於自動調整程式的最大節點計數。請針對使用者 nodepool 指定 [0， 1000] 範圍中的值，並針對系統 nodepool 指定 [1,1000]。

--max-surge

用來加速升級的額外節點。指定時，它代表所使用的數位或百分比，例如5 或 33%。

--min-count

指定「--enable-cluster-autoscaler」時，用於自動調整程式的最低節點計數。請針對使用者 nodepool 指定 [0， 1000] 範圍中的值，並針對系統 nodepool 指定 [1,1000]。

--mode

接受的值: System, User

--no-wait

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

預設值: False

--node-soak-duration

清空節點並重新製作映射並移至下一個節點之前，等待的時間量（以分鐘為單位）。

--node-taints

節點集區的節點污點。您可以更新 nodepool 的現有節點污點，或為 nodepool 建立新的節點污點。傳遞空字串 "" 以移除所有污點。

--os-sku

代理程序節點集區的os-sku。

接受的值: AzureLinux, CBLMariner, Mariner

--scale-down-mode

描述如何將 VM 新增至 nodepools 或從 nodepools 中移除。

接受的值: Deallocate, Delete

--tags

以空格分隔的標記：key[=value] [key[=value] ...]。使用「清除現有的標記」。

--update-cluster-autoscaler -u

更新叢集自動調整程式的最大計數或最大計數。

預設值: 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 aks nodepool update (aks-preview 擴充功能)

更新節點集區屬性。

az aks nodepool update --cluster-name
                       --name
                       --resource-group
                       [--aks-custom-headers]
                       [--allowed-host-ports]
                       [--asg-ids]
                       [--dcat]
                       [--disable-cluster-autoscaler]
                       [--disable-fips-image]
                       [--disable-secure-boot]
                       [--disable-vtpm]
                       [--drain-timeout]
                       [--enable-artifact-streaming]
                       [--enable-cluster-autoscaler]
                       [--enable-custom-ca-trust]
                       [--enable-fips-image]
                       [--enable-secure-boot]
                       [--enable-vtpm]
                       [--if-match]
                       [--if-none-match]
                       [--labels]
                       [--max-count]
                       [--max-surge]
                       [--min-count]
                       [--mode {Gateway, System, User}]
                       [--no-wait]
                       [--node-soak-duration]
                       [--node-taints]
                       [--os-sku {AzureLinux, Ubuntu}]
                       [--scale-down-mode {Deallocate, Delete}]
                       [--ssh-access {disabled, localuser}]
                       [--tags]
                       [--update-cluster-autoscaler]
                       [--yes]

範例

將 nodepool 調和回其目前狀態。

az aks nodepool update -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster

在節點計數範圍內啟用叢集自動調整程式 [1,5]

az aks nodepool update --enable-cluster-autoscaler --min-count 1 --max-count 5 -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster

停用現有叢集的叢集自動調整程式

az aks nodepool update --disable-cluster-autoscaler -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster

更新叢集自動調整程式的最大計數或最大計數。

az aks nodepool update --update-cluster-autoscaler --min-count 1 --max-count 10 -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster

將節點集區變更為系統模式

az aks nodepool update --mode System -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster

必要參數

--cluster-name

叢集名稱。

--name --nodepool-name -n

節點集區名稱。

--resource-group -g

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

選擇性參數

--aks-custom-headers

傳送自定義標頭。指定時，格式應該是 Key1=Value1，Key2=Value2。

--allowed-host-ports

預覽

公開節點集區上的主機埠。指定時，格式應該是以逗號分隔的範圍清單，例如通訊協定。80/TCP，443/TCP，4000-5000/TCP。必須使用 VMSS 代理程式集區類型。

--asg-ids

預覽

節點集區網路介面所屬之應用程式安全組的標識碼。指定時，格式應該是逗號分隔的標識符清單。必須使用 VMSS 代理程式集區類型。

--dcat --disable-custom-ca-trust

停用代理程式節點集區上的自定義 CA 信任。

預設值: False

--disable-cluster-autoscaler -d

停用叢集自動調整程式。

預設值: False

--disable-fips-image

切換為在代理程序節點上使用未啟用 FIPS 的 OS。

預設值: False

--disable-secure-boot

預覽

在已啟用信任啟動的現有代理程序節點集區上停用安全開機。

預設值: False

--disable-vtpm

預覽

在已啟用信任啟動的現有代理程序節點集區上停用 vTPM。

預設值: False

--drain-timeout

當節點清空等候所有 Pod 收回的分鐘數時。

--enable-artifact-streaming

預覽

預設值: False

--enable-cluster-autoscaler -e

啟用叢集自動調整程式。必須使用 VMSS 代理程式集區類型。

預設值: False

--enable-custom-ca-trust

在代理程式節點集區上啟用自定義 CA 信任。

預設值: False

--enable-fips-image

切換至在代理程序節點上使用已啟用 FIPS 的 OS。

預設值: False

--enable-secure-boot

預覽

在已啟用信任啟動的現有代理程序節點集區上啟用安全開機。必須使用 VMSS 代理程式集區類型。

預設值: False

--enable-vtpm

預覽

在已啟用信任啟動的現有代理程序節點集區上啟用 vTPM。必須使用 VMSS 代理程式集區類型。

預設值: False

--if-match

如果符合作業，所提供的值將會與節點集區的 ETag 進行比較。如果不符合，將會拒絕要求，以防止意外覆寫。建立新的 Agentpool 時，不得指定這個值。

--if-none-match

設定為『*』以允許建立新的節點集區，但為了避免更新現有的節點集區。將會忽略其他值。

--labels

節點集區的節點標籤。如需標籤法，請參閱 https://aka.ms/node-labels 。

--max-count

指定「--enable-cluster-autoscaler」時，用於自動調整程式的最大節點計數。請針對使用者 nodepool 指定 [0， 1000] 範圍中的值，並針對系統 nodepool 指定 [1,1000]。

--max-surge

用來加速升級的額外節點。指定時，它代表所使用的數位或百分比，例如5 或 33%。

--min-count

指定「--enable-cluster-autoscaler」時，用於自動調整程式的迷你節點計數。請針對使用者 nodepool 指定 [0， 1000] 範圍中的值，並針對系統 nodepool 指定 [1,1000]。

--mode

接受的值: Gateway, System, User

--no-wait

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

預設值: False

--node-soak-duration

清空節點並重新製作映射並移至下一個節點之前，等待的時間量（以分鐘為單位）。

--node-taints

節點集區的節點污點。

--os-sku

代理程序節點集區的os-sku。

接受的值: AzureLinux, Ubuntu

--scale-down-mode

描述如何將 VM 新增至節點集區或從 nodepools 中移除。

接受的值: Deallocate, Delete

--ssh-access

預覽

更新節點集區的SSH設定。使用「已停用」來停用 SSH 存取、「localuser」，以使用私鑰啟用 SSH 存取。

接受的值: disabled, localuser

--tags

以空格分隔的標記：key[=value] [key[=value] ...]。使用「清除現有的標記」。

--update-cluster-autoscaler -u

更新叢集自動調整程式的最大計數或最大計數。

預設值: False

--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 aks nodepool upgrade

編輯

升級受控 Kubernetes 叢集中的節點集區。

az aks nodepool upgrade --cluster-name
                        --name
                        --resource-group
                        [--aks-custom-headers]
                        [--drain-timeout]
                        [--kubernetes-version]
                        [--max-surge]
                        [--no-wait]
                        [--node-image-only]
                        [--node-soak-duration]
                        [--snapshot-id]
                        [--yes]

必要參數

--cluster-name

叢集名稱。

--name --nodepool-name -n

節點集區名稱。

--resource-group -g

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

選擇性參數

--aks-custom-headers

以逗號分隔的索引鍵/值組來指定自定義標頭。

--drain-timeout

當節點清空等候所有 Pod 收回的時間長度時。

--kubernetes-version -k

要升級節點集區的 Kubernetes 版本，例如「1.16.9」。。

--max-surge

用來加速升級的額外節點。指定時，它代表所使用的數位或百分比，例如5 或 33% （與 “--node-image-only” 互斥。請參閱“az aks nodepool update --max-surge” 以更新 max surge，再使用 “--node-image-only” 升級。

--no-wait

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

預設值: False

--node-image-only

僅升級代理程式集區的節點映像。

預設值: False

--node-soak-duration

清空節點並重新製作映射並移至下一個節點之前，等待的時間量（以分鐘為單位）。

--snapshot-id

用來升級此 nodepool 的來源快照集標識碼。

--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 aks nodepool upgrade (aks-preview 擴充功能)

升級受控 Kubernetes 叢集中的節點集區。

az aks nodepool upgrade --cluster-name
                        --name
                        --resource-group
                        [--aks-custom-headers]
                        [--drain-timeout]
                        [--if-match]
                        [--if-none-match]
                        [--kubernetes-version]
                        [--max-surge]
                        [--no-wait]
                        [--node-image-only]
                        [--node-soak-duration]
                        [--snapshot-id]
                        [--yes]

必要參數

--cluster-name

叢集名稱。

--name --nodepool-name -n

節點集區名稱。

--resource-group -g

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

選擇性參數

--aks-custom-headers

傳送自定義標頭。指定時，格式應該是 Key1=Value1，Key2=Value2。

--drain-timeout

當節點清空等候所有 Pod 收回的分鐘數時。

--if-match

如果符合作業，所提供的值將會與節點集區的 ETag 進行比較。如果不符合，將會拒絕要求，以防止意外覆寫。建立新的 Agentpool 時，不得指定這個值。若為升級節點映像版本要求，將會忽略此要求。

--if-none-match

設定為『*』以允許建立新的節點集區，但為了避免更新現有的節點集區。將會忽略其他值。

--kubernetes-version -k

要升級節點集區的 Kubernetes 版本，例如「1.11.12」。。

--max-surge

用來加速升級的額外節點。指定時，它代表所使用的數位或百分比，例如5 或 33%。

--no-wait

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

預設值: False

--node-image-only

僅升級代理程式集區的節點映像。

預設值: False

--node-soak-duration

清空節點並重新製作映射並移至下一個節點之前，等待的時間量（以分鐘為單位）。

--snapshot-id

用來升級此 nodepool 的來源快照集標識碼。必須使用 VMSS 代理程式集區類型。

--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 aks nodepool wait

編輯

等候節點集區達到所需的狀態。

如果節點集區上的作業中斷或以啟動 --no-wait，請使用此命令等候它完成。

az aks nodepool wait --cluster-name
                     --name
                     --resource-group
                     [--created]
                     [--custom]
                     [--deleted]
                     [--exists]
                     [--interval]
                     [--timeout]
                     [--updated]

範例

等候節點集區達到所需的狀態，每分鐘輪詢最多 30 分鐘。

az aks nodepool wait --created --interval 60 --cluster-name MyManagedCluster --resource-group MyResourceGroup --nodepool-name MyNodePool --timeout 1800

必要參數

--cluster-name

叢集名稱。

--name --nodepool-name -n

節點集區名稱。

--resource-group -g

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

選擇性參數

--created

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

預設值: False

--custom

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

--deleted

等到刪除為止。

預設值: False

--exists

等候資源存在。

預設值: False

--interval

輪詢間隔以秒為單位。

預設值: 30

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

共用方式為

az aks nodepool

命令

az aks nodepool add

範例

必要參數

選擇性參數

az aks nodepool add (aks-preview 擴充功能)

範例

必要參數

選擇性參數

az aks nodepool delete

必要參數

選擇性參數

az aks nodepool delete (aks-preview 擴充功能)

範例

必要參數

選擇性參數

az aks nodepool delete-machines

範例

必要參數

選擇性參數

az aks nodepool get-upgrades

範例

必要參數

az aks nodepool get-upgrades (aks-preview 擴充功能)

範例

必要參數

az aks nodepool list

必要參數

az aks nodepool list (aks-preview 擴充功能)

必要參數

az aks nodepool operation-abort

範例

必要參數

選擇性參數

az aks nodepool operation-abort (aks-preview 擴充功能)

範例

必要參數

選擇性參數

az aks nodepool scale

必要參數

選擇性參數

az aks nodepool scale (aks-preview 擴充功能)

必要參數

選擇性參數

az aks nodepool show

必要參數

az aks nodepool show (aks-preview 擴充功能)

必要參數

az aks nodepool start

範例

必要參數

選擇性參數

az aks nodepool start (aks-preview 擴充功能)

範例

必要參數

選擇性參數

az aks nodepool stop

範例

必要參數

選擇性參數

az aks nodepool stop (aks-preview 擴充功能)

範例

必要參數

選擇性參數

az aks nodepool update

範例

必要參數

選擇性參數

az aks nodepool update (aks-preview 擴充功能)

範例

必要參數

選擇性參數

az aks nodepool upgrade

必要參數

選擇性參數

az aks nodepool upgrade (aks-preview 擴充功能)

必要參數

選擇性參數