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

az aks nodepool

注意

此命令组具有在 Azure CLI 和至少一个扩展中定义的命令。 安装每个扩展,使其受益于其扩展功能。 详细了解扩展。

用于管理 Kubernetes kubernetes 群集中的节点池的命令。

命令

名称 说明 类型 Status
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 代理池的现有手动操作。

扩展 GA
az aks nodepool manual-scale update

更新托管 Kubernetes 群集中 VirtualMachines 代理池的现有手册。

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

用于管理节点池快照的命令。

核心和扩展 GA
az aks nodepool snapshot create

创建节点池快照。

核心 GA
az aks nodepool snapshot create (aks-preview 扩展)

创建节点池快照。

扩展 GA
az aks nodepool snapshot delete

删除节点池快照。

核心 GA
az aks nodepool snapshot delete (aks-preview 扩展)

删除节点池快照。

扩展 GA
az aks nodepool snapshot list

列出节点池快照。

核心 GA
az aks nodepool snapshot list (aks-preview 扩展)

列出节点池快照。

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

等待节点池快照达到所需状态。

核心 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 群集中创建节点池。

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

创建启用了 EncryptionAtHost 的节点池。

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 创建节点池群集

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

创建启用了 FIPS 的 OS 的节点池

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

使用快照 ID 创建 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"

在具有主机组 ID 的现有 AKS 群集中创建节点池

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)ID 的节点池。

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

节点池网络接口应属于的应用程序安全组的 ID。 指定时,格式应为空格分隔的 ID 列表。

--crg-id

用于将新节点池与现有容量预留组资源关联的 crg ID。

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

用于预配代理节点池的完全限定专用主机组 ID。

--kubelet-config

包含代理节点的 Kubelet 配置的 JSON 文件的路径。 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

包含 Linux 代理节点 OS 配置的 JSON 文件的路径。 https://aka.ms/aks/custom-node-config

--max-count

指定了“--enable-cluster-autoscaler”时用于自动缩放程序的最大节点计数。 请为用户节点池指定 [0, 1000] 范围内的值,并为系统节点池指定 [1,1000]。

--max-pods -m

可部署到节点的最大 Pod 数。

如果未指定,则基于网络插件的默认值。 30(对于“azure”),对于“kubenet”为 110,对于“none”,则为 250。

--max-surge

用于加快升级速度的额外节点。 指定时,它表示所使用的数字或百分比,例如。5 或 33%。

--min-count

指定“--enable-cluster-autoscaler”时用于自动缩放程序的最小节点计数。 请为用户节点池指定 [0, 1000] 范围内的值,并为系统节点池指定 [1,1000]。

--mode

用于定义节点池主函数的节点池的模式。 如果设置为“系统”,AKS 首选系统 Pod 计划为模式 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 前缀 ID。

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

要将群集中的 Pod 分配到的现有 VNet 中的子网的资源 ID(需要 azure 网络插件)。

--ppg

PPG 的 ID。

--priority

节点池的优先级。

接受的值: Regular, Spot
默认值: Regular
--scale-down-mode

描述如何将 VM 添加到节点池或从节点池中删除。

接受的值: Deallocate, Delete
默认值: Delete
--snapshot-id

用于创建此 nodepool 的源快照 ID。

--spot-max-price

只能在 --priority 为 Spot 时设置它。 指定你愿意以美元支付的最高价格。 可能的值是大于零或 -1 的任何小数值,指示默认价格是按需的。 它最多可以包含 5 个小数位数。

默认值: nan
--tags

空格分隔标记:key[=value] [key[=value] ...]。使用“”清除现有标记。

--vnet-subnet-id

要在其中部署群集的现有 VNet 中的子网的资源 ID。

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

订阅的名称或 ID。 可以使用 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 群集中创建节点池。

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

创建启用了 EncryptionAtHost 的节点池。

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

使用特定 os-sku 创建节点池

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

使用快照 ID 创建 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)ID 的节点池。

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"

在具有主机组 ID 的现有 AKS 群集中创建节点池

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 子网 ID 的节点池

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 类型的节点池

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

节点池网络接口应属于的应用程序安全组的 ID。 指定后,格式应为逗号分隔的 ID 列表。 必须使用 VMSS 代理池类型。

--crg-id
预览

用于将新节点池与现有容量预留组资源关联的 crg-id。 必须使用 VMSS 代理池类型。

--disable-windows-outbound-nat

在 Windows 代理节点池上禁用 Windows 出站NAT。 必须使用 VMSS 代理池类型。

默认值: False
--drain-timeout

当节点耗尽等待所有 Pod 逐出多少分钟时。

--enable-artifact-streaming
预览

为节点池管理的 VirtualMachineScaleSet 启用项目流式处理,以便通过按需映像加载加快节点上容器的冷启动速度。 若要使用此功能,容器映像还必须在 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

(预览)用于预配代理节点池的完全限定专用主机组 ID。 必须使用 VMSS 代理池类型。

--if-match

如果与操作匹配,则所提供的值将与 Agentpool 的 ETag 进行比较。 如果不匹配,将拒绝请求以防止意外覆盖。 创建新代理池时,不得指定此项。

--if-none-match

设置为“*”以允许创建新的代理池,但要防止更新现有代理池。 将忽略其他值。

--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”时用于自动缩放程序的最大节点计数。 请为用户节点池指定 [0, 1000] 范围内的值,并为系统节点池指定 [1,1000]。

--max-pods -m

可部署到节点的最大 Pod 数。

如果未指定,则基于网络插件的默认值。 30(对于“azure”),对于“kubenet”为 110,对于“none”,则为 250。

默认值: 0
--max-surge

用于加快升级速度的额外节点。 指定时,它表示所使用的数字或百分比,例如。5 或 33%。

--message-of-the-day

包含当天所需消息的文件的路径。 仅适用于 Linux 节点。 将写入 /etc/motd。

--min-count

指定“--enable-cluster-autoscaler”时用于自动缩放程序的微型节点计数。 请为用户节点池指定 [0, 1000] 范围内的值,并为系统节点池指定 [1,1000]。

--mode

用于定义节点池主函数的节点池的模式。 如果设置为“系统”,AKS 首选系统 Pod 计划为模式 System的节点池。 更多信息请访问 https://aka.ms/aks/nodepool/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

要用于给定代理池中的计算机的 OS 磁盘类型。 如果可能与 VM 大小和 OS 磁盘大小结合使用,则默认为“临时”。 创建后可能不会更改此池。 (“临时”或“Managed”)。

接受的值: Ephemeral, Managed
--node-public-ip-prefix-id

用于将公共 IP 分配给 VMSS 节点的公共 IP 前缀 ID。 必须使用 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(如果未设置);当 os 类型为 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

要将群集中的 Pod 分配到的现有 VNet 中的子网 ID(需要 azure 网络插件)。

--ppg

PPG 的 ID。 必须使用 VMSS 代理池类型。

--priority

节点池的优先级。

接受的值: Regular, Spot
默认值: Regular
--scale-down-mode

描述如何向节点池添加或删除 VM。

接受的值: Deallocate, Delete
默认值: Delete
--skip-gpu-driver-install
预览

如果客户想要自行管理 GPU 驱动程序安装,请使用 GPU vm 大小的节点池中的 AKS 跳过 GPU 驱动程序自动安装。 如果未指定,则默认值为 false。

默认值: False
--snapshot-id

用于创建此 nodepool 的源快照 ID。 必须使用 VMSS 代理池类型。

--spot-max-price

只能在 --priority 为 Spot 时设置它。 指定你愿意以美元支付的最高价格。 可能的值是大于零或 -1 的任何小数值,指示默认价格是按需的。 它最多可以包含 5 个小数位数。

默认值: nan
--ssh-access
预览

配置节点池的 SSH 设置。 使用“disabled”禁用 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 中子网的 ID。

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

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 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 进行比较。 如果不匹配,将拒绝请求以防止意外覆盖。 创建新代理池时,不得指定此项。

--ignore-pod-disruption-budget -i
预览

(预览版) ignore-pod-disruption-budget 删除现有节点池,而不考虑 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

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az aks nodepool update

更新节点池属性。

更新节点池以启用/禁用群集自动缩放程序或更改最小计数或最大计数。 在没有可选参数的情况下调用时,这会尝试将节点池移动到其目标状态,而无需更改当前节点池配置。 这可用于移出非成功状态。

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]

示例

将节点池重新协调回其当前状态。

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

节点池网络接口应属于的应用程序安全组的 ID。 指定时,格式应为空格分隔的 ID 列表。

--disable-cluster-autoscaler -d

禁用群集自动缩放程序。

默认值: False
--drain-timeout

当节点耗尽等待所有 Pod 逐出多少分钟时。

--enable-cluster-autoscaler -e

启用群集自动缩放程序。

默认值: False
--labels

节点池的节点标签。 请参阅 https://aka.ms/node-labels 标签语法。

--max-count

指定了“--enable-cluster-autoscaler”时用于自动缩放程序的最大节点计数。 请为用户节点池指定 [0, 1000] 范围内的值,并为系统节点池指定 [1,1000]。

--max-surge

用于加快升级速度的额外节点。 指定时,它表示所使用的数字或百分比,例如。5 或 33%。

--min-count

指定“--enable-cluster-autoscaler”时用于自动缩放程序的最小节点计数。 请为用户节点池指定 [0, 1000] 范围内的值,并为系统节点池指定 [1,1000]。

--mode

用于定义节点池主函数的节点池的模式。 如果设置为“系统”,AKS 首选系统 Pod 计划为模式 System的节点池。 更多信息请访问 https://aka.ms/aks/nodepool/mode

接受的值: System, User
--no-wait

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

默认值: False
--node-soak-duration

清空节点后以及重新映像节点并转到下一个节点之前等待的时间(以分钟为单位)。

--node-taints

节点池的节点排斥。 可以更新节点池的现有节点污点,或者为节点池创建新的节点污点。 传递空字符串 "" 以删除所有污点。

--os-sku

代理节点池的 os-sku。

接受的值: AzureLinux, CBLMariner, Mariner
--scale-down-mode

描述如何将 VM 添加到节点池或从节点池中删除。

接受的值: 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

订阅的名称或 ID。 可以使用 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]

示例

将节点池重新协调回其当前状态。

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

节点池网络接口应属于的应用程序安全组的 ID。 指定后,格式应为逗号分隔的 ID 列表。 必须使用 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
预览

为节点池管理的 VirtualMachineScaleSet 启用项目流式处理,以便通过按需映像加载加快节点上容器的冷启动速度。 若要使用此功能,容器映像还必须在 ACR 上启用项目流式处理。 如果未指定,则默认值为 false。

默认值: 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 进行比较。 如果不匹配,将拒绝请求以防止意外覆盖。 创建新代理池时,不得指定此项。

--if-none-match

设置为“*”以允许创建新节点池,但为了防止更新现有节点池。 将忽略其他值。

--labels

节点池的节点标签。 请参阅 https://aka.ms/node-labels 标签语法。

--max-count

指定了“--enable-cluster-autoscaler”时用于自动缩放程序的最大节点计数。 请为用户节点池指定 [0, 1000] 范围内的值,并为系统节点池指定 [1,1000]。

--max-surge

用于加快升级速度的额外节点。 指定时,它表示所使用的数字或百分比,例如。5 或 33%。

--min-count

指定“--enable-cluster-autoscaler”时用于自动缩放程序的微型节点计数。 请为用户节点池指定 [0, 1000] 范围内的值,并为系统节点池指定 [1,1000]。

--mode

用于定义节点池主函数的节点池的模式。 如果设置为“系统”,AKS 首选系统 Pod 计划为模式 System的节点池。 更多信息请访问 https://aka.ms/aks/nodepool/mode

接受的值: Gateway, System, User
--no-wait

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

默认值: False
--node-soak-duration

清空节点后以及重新映像节点并转到下一个节点之前等待的时间(以分钟为单位)。

--node-taints

节点池的节点排斥。

--os-sku

代理节点池的 os-sku。

接受的值: AzureLinux, Ubuntu
--scale-down-mode

描述如何向节点池添加或删除 VM。

接受的值: Deallocate, Delete
--ssh-access
预览

更新节点池的 SSH 设置。 使用“disabled”禁用 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

订阅的名称或 ID。 可以使用 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”,在仅使用“--node-image-only”升级之前更新最大激增。

--no-wait

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

默认值: False
--node-image-only

仅升级代理池的节点映像。

默认值: False
--node-soak-duration

清空节点后以及重新映像节点并转到下一个节点之前等待的时间(以分钟为单位)。

--snapshot-id

用于升级此 nodepool 的源快照 ID。

--yes -y

不提示确认。

默认值: False
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az 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 进行比较。 如果不匹配,将拒绝请求以防止意外覆盖。 创建新代理池时,不得指定此项。 对于升级节点映像版本请求,将忽略此版本。

--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 的源快照 ID。 必须使用 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

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。