通过

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

ManagedClusterAgentPoolProfile interface

  • 参考
包:
@azure/arm-containerservice

容器服务代理池的配置文件。

扩展
ManagedClusterAgentPoolProfileProperties

属性

name

Windows 代理池名称必须为 6 个字符或更少。

继承属性

availabilityZones

要用于节点的可用性区域列表。 仅当 AgentPoolType 属性为“VirtualMachineScaleSets”时，才能指定此值。
capacityReservationGroupID

AKS 会将指定的代理池与容量预留组相关联。
count

用于托管 docker 容器的代理数（VM）。 允许的值必须在用户池的 0 到 1000（含）范围内，系统池的范围为 1 到 1000（含）。 默认值为 1。
creationData

如果使用快照创建/升级节点池，则用于指定源快照 ID 的 CreationData。
currentOrchestratorVersion

如果 orchestratorVersion 是一个完全指定的版本，<major.minor.patch>，则此字段将完全等于它。 如果 orchestratorVersion <major.minor>，则此字段将包含正在使用的完整 <major.minor.patch> 版本。 注意：此属性不会序列化。 它只能由服务器填充。
enableAutoScaling

是否启用自动缩放程序
enableEncryptionAtHost

这仅在某些 VM 大小和某些 Azure 区域中受支持。 有关详细信息，请参阅：https://docs.microsoft.com/azure/aks/enable-host-encryption
enableFips

有关详细信息，请参阅 添加启用了 FIPS 的节点池。
enableNodePublicIP

某些方案可能需要节点池中的节点接收其自己的专用公共 IP 地址。 一种常见方案适用于游戏工作负载，其中主机需要与云虚拟机建立直接连接，以最大程度地减少跃点。 有关详细信息，请参阅 为每个节点分配公共 IP。 默认值为 false。
enableUltraSSD

是否启用 UltraSSD
eTag

用于实现乐观并发的唯一只读字符串。 更新资源时，eTag 值将更改。 使用后续请求的 eTag 值指定 if-match 或 if-none-match 标头，以便根据正常的 etag 约定启用乐观并发。 注意：此属性不会序列化。 它只能由服务器填充。
gpuInstanceProfile

用于为支持的 GPU VM SKU 指定 GPU MIG 实例配置文件的 GPUInstanceProfile。
hostGroupID

此格式为：/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}。 有关详细信息，请参阅 Azure 专用主机。
kubeletConfig

代理池节点上的 Kubelet 配置。
kubeletDiskType

确定 emptyDir 卷、容器运行时数据根目录和 Kubelet 临时存储的位置。
linuxOSConfig

Linux 代理节点的 OS 配置。
maxCount

自动缩放的最大节点数
maxPods

可在节点上运行的 Pod 的最大数目。
minCount

自动缩放的最小节点数
mode

群集必须随时至少有一个“系统”代理池。 有关代理池限制和最佳做法的其他信息，请参阅：https://docs.microsoft.com/azure/aks/use-system-pools
networkProfile

代理池的网络相关设置。
nodeImageVersion

节点映像的版本注意：此属性不会序列化。 它只能由服务器填充。
nodeLabels

要跨代理池中的所有节点保留的节点标签。
nodePublicIPPrefixID

此格式为：/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}
nodeTaints

在节点池创建和缩放期间添加到新节点的污点。 例如，key=value：NoSchedule。
orchestratorVersion

支持两个修补程序版本 <major.minor.patch>（例如 1.20.13）和 <major.minor>（例如 1.20）。 指定 <major.minor> 时，会自动选择最新的受支持的 GA 修补程序版本。 创建群集后使用相同的 <major.minor>（例如 1.14.x -> 1.14）更新群集不会触发升级，即使更新的修补程序版本可用也是如此。 最佳做法是，应将 AKS 群集中的所有节点池升级到同一 Kubernetes 版本。 节点池版本必须与控制平面具有相同的主版本。 节点池次要版本必须位于控制平面版本的两个次要版本中。 节点池版本不能大于控制平面版本。 有关详细信息，请参阅 升级节点池。
osDiskSizeGB

OS 磁盘大小（以 GB 为单位）用于为主/代理池中的每个计算机指定磁盘大小。 如果指定 0，它将根据指定的 vmSize 应用默认 osDisk 大小。
osDiskType

如果 VM 支持该 VM 并且缓存磁盘大于请求的 OSDiskSizeGB，则默认值为“临时”。 否则，默认为“Managed”。 创建后可能不会更改。 有关详细信息，请参阅 临时 OS。
osSKU

指定代理池使用的 OS SKU。 如果 OSType 为 Linux，则默认值为 Ubuntu。 当 Kubernetes <= 1.24 或 Windows2022 时，Kubernetes >= 1.25（如果 OSType 为 Windows）时，默认值为 Windows2019。
osType

操作系统类型。 默认值为 Linux。
podSubnetID

如果省略，则会在节点子网上静态分配 Pod IP（有关详细信息，请参阅 vnetSubnetID）。 此格式为：/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
powerState

首次创建代理池时，它最初正在运行。 可以通过将此字段设置为“已停止”来停止代理池。 已停止的代理池会停止其所有 VM，不会产生计费费用。 仅当代理池正在运行并且预配状态为“成功”时，才能停止代理池
provisioningState

当前部署或预配状态。 注意：此属性不会序列化。 它只能由服务器填充。
proximityPlacementGroupID

邻近放置组的 ID。
scaleDownMode

这也会影响群集自动缩放程序的行为。 如果未指定，则默认为 Delete。
scaleSetEvictionPolicy

除非 scaleSetPriority 为“Spot”，否则无法指定此项。 如果未指定，则默认值为“Delete”。
scaleSetPriority

虚拟机规模集优先级。 如果未指定，则默认值为“Regular”。
securityProfile

代理池的安全设置。
spotMaxPrice

可能的值是大于零或 -1 的任何小数值，表示愿意支付任何按需价格。 有关现成定价的更多详细信息，请参阅 现成 VM 定价
tags

要保留在代理池虚拟机规模集上的标记。
type

代理池的类型。
upgradeSettings

用于升级代理池的设置
vmSize

VM 大小可用性因区域而异。 如果节点包含的计算资源（内存、cpu 等）Pod 不足，可能无法正常运行。 有关受限 VM 大小的更多详细信息，请参阅：https://docs.microsoft.com/azure/aks/quotas-skus-regions
vnetSubnetID

如果未指定，将生成和使用 VNET 和子网。 如果未指定 podSubnetID，则这适用于节点和 Pod，否则它仅适用于节点。 此格式为：/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
windowsProfile

Windows 代理池的特定配置文件。
workloadRuntime

确定节点可以运行的工作负荷的类型。

属性详细信息

name

Windows 代理池名称必须为 6 个字符或更少。

name: string

属性值

string

继承属性详细信息

availabilityZones

要用于节点的可用性区域列表。 仅当 AgentPoolType 属性为“VirtualMachineScaleSets”时，才能指定此值。

availabilityZones?: string[]

属性值

string[]

继承自ManagedClusterAgentPoolProfileProperties.availabilityZones

capacityReservationGroupID

AKS 会将指定的代理池与容量预留组相关联。

capacityReservationGroupID?: string

属性值

string

继承自ManagedClusterAgentPoolProfileProperties.capacityReservationGroupID

count

用于托管 docker 容器的代理数（VM）。 允许的值必须在用户池的 0 到 1000（含）范围内，系统池的范围为 1 到 1000（含）。 默认值为 1。

count?: number

属性值

number

继承自ManagedClusterAgentPoolProfileProperties.count

creationData

如果使用快照创建/升级节点池，则用于指定源快照 ID 的 CreationData。

creationData?: CreationData

属性值

CreationData

继承自ManagedClusterAgentPoolProfileProperties.creationData

currentOrchestratorVersion

如果 orchestratorVersion 是一个完全指定的版本，<major.minor.patch>，则此字段将完全等于它。 如果 orchestratorVersion <major.minor>，则此字段将包含正在使用的完整 <major.minor.patch> 版本。 注意：此属性不会序列化。 它只能由服务器填充。

currentOrchestratorVersion?: string

属性值

string

继承自ManagedClusterAgentPoolProfileProperties.currentOrchestratorVersion

enableAutoScaling

是否启用自动缩放程序

enableAutoScaling?: boolean

属性值

boolean

继承自ManagedClusterAgentPoolProfileProperties.enableAutoScaling

enableEncryptionAtHost

这仅在某些 VM 大小和某些 Azure 区域中受支持。 有关详细信息，请参阅：https://docs.microsoft.com/azure/aks/enable-host-encryption

enableEncryptionAtHost?: boolean

属性值

boolean

继承自ManagedClusterAgentPoolProfileProperties.enableEncryptionAtHost

enableFips

有关详细信息，请参阅 添加启用了 FIPS 的节点池。

enableFips?: boolean

属性值

boolean

继承自ManagedClusterAgentPoolProfileProperties.enableFips

enableNodePublicIP

某些方案可能需要节点池中的节点接收其自己的专用公共 IP 地址。 一种常见方案适用于游戏工作负载，其中主机需要与云虚拟机建立直接连接，以最大程度地减少跃点。 有关详细信息，请参阅 为每个节点分配公共 IP。 默认值为 false。

enableNodePublicIP?: boolean

属性值

boolean

继承自ManagedClusterAgentPoolProfileProperties.enableNodePublicIP

enableUltraSSD

是否启用 UltraSSD

enableUltraSSD?: boolean

属性值

boolean

继承自ManagedClusterAgentPoolProfileProperties.enableUltraSSD

eTag

用于实现乐观并发的唯一只读字符串。 更新资源时，eTag 值将更改。 使用后续请求的 eTag 值指定 if-match 或 if-none-match 标头，以便根据正常的 etag 约定启用乐观并发。 注意：此属性不会序列化。 它只能由服务器填充。

eTag?: string

属性值

string

继承自ManagedClusterAgentPoolProfileProperties.eTag

gpuInstanceProfile

用于为支持的 GPU VM SKU 指定 GPU MIG 实例配置文件的 GPUInstanceProfile。

gpuInstanceProfile?: string

属性值

string

继承自ManagedClusterAgentPoolProfileProperties.gpuInstanceProfile

hostGroupID

此格式为：/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}。 有关详细信息，请参阅 Azure 专用主机。

hostGroupID?: string

属性值

string

继承自ManagedClusterAgentPoolProfileProperties.hostGroupID

kubeletConfig

代理池节点上的 Kubelet 配置。

kubeletConfig?: KubeletConfig

属性值

KubeletConfig

继承自ManagedClusterAgentPoolProfileProperties.kubeletConfig

kubeletDiskType

确定 emptyDir 卷、容器运行时数据根目录和 Kubelet 临时存储的位置。

kubeletDiskType?: string

属性值

string

继承自ManagedClusterAgentPoolProfileProperties.kubeletDiskType

linuxOSConfig

Linux 代理节点的 OS 配置。

linuxOSConfig?: LinuxOSConfig

属性值

LinuxOSConfig

继承自ManagedClusterAgentPoolProfileProperties.linuxOSConfig

maxCount

自动缩放的最大节点数

maxCount?: number

属性值

number

继承自ManagedClusterAgentPoolProfileProperties.maxCount

maxPods

可在节点上运行的 Pod 的最大数目。

maxPods?: number

属性值

number

继承自ManagedClusterAgentPoolProfileProperties.maxPods

minCount

自动缩放的最小节点数

minCount?: number

属性值

number

继承自ManagedClusterAgentPoolProfileProperties.minCount

mode

群集必须随时至少有一个“系统”代理池。 有关代理池限制和最佳做法的其他信息，请参阅：https://docs.microsoft.com/azure/aks/use-system-pools

mode?: string

属性值

string

继承自ManagedClusterAgentPoolProfileProperties.mode

networkProfile

代理池的网络相关设置。

networkProfile?: AgentPoolNetworkProfile

属性值

AgentPoolNetworkProfile

继承自ManagedClusterAgentPoolProfileProperties.networkProfile

nodeImageVersion

节点映像的版本注意：此属性不会序列化。 它只能由服务器填充。

nodeImageVersion?: string

属性值

string

继承自ManagedClusterAgentPoolProfileProperties.nodeImageVersion

nodeLabels

要跨代理池中的所有节点保留的节点标签。

nodeLabels?: {[propertyName: string]: string}

属性值

{[propertyName: string]: string}

继承自ManagedClusterAgentPoolProfileProperties.nodeLabels

nodePublicIPPrefixID

此格式为：/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}

nodePublicIPPrefixID?: string

属性值

string

继承自ManagedClusterAgentPoolProfileProperties.nodePublicIPPrefixID

nodeTaints

在节点池创建和缩放期间添加到新节点的污点。 例如，key=value：NoSchedule。

nodeTaints?: string[]

属性值

string[]

继承自ManagedClusterAgentPoolProfileProperties.nodeTaints

orchestratorVersion

支持两个修补程序版本 <major.minor.patch>（例如 1.20.13）和 <major.minor>（例如 1.20）。 指定 <major.minor> 时，会自动选择最新的受支持的 GA 修补程序版本。 创建群集后使用相同的 <major.minor>（例如 1.14.x -> 1.14）更新群集不会触发升级，即使更新的修补程序版本可用也是如此。 最佳做法是，应将 AKS 群集中的所有节点池升级到同一 Kubernetes 版本。 节点池版本必须与控制平面具有相同的主版本。 节点池次要版本必须位于控制平面版本的两个次要版本中。 节点池版本不能大于控制平面版本。 有关详细信息，请参阅 升级节点池。

orchestratorVersion?: string

属性值

string

继承自ManagedClusterAgentPoolProfileProperties.orchestratorVersion

osDiskSizeGB

OS 磁盘大小（以 GB 为单位）用于为主/代理池中的每个计算机指定磁盘大小。 如果指定 0，它将根据指定的 vmSize 应用默认 osDisk 大小。

osDiskSizeGB?: number

属性值

number

继承自ManagedClusterAgentPoolProfileProperties.osDiskSizeGB

osDiskType

如果 VM 支持该 VM 并且缓存磁盘大于请求的 OSDiskSizeGB，则默认值为“临时”。 否则，默认为“Managed”。 创建后可能不会更改。 有关详细信息，请参阅 临时 OS。

osDiskType?: string

属性值

string

继承自ManagedClusterAgentPoolProfileProperties.osDiskType

osSKU

指定代理池使用的 OS SKU。 如果 OSType 为 Linux，则默认值为 Ubuntu。 当 Kubernetes <= 1.24 或 Windows2022 时，Kubernetes >= 1.25（如果 OSType 为 Windows）时，默认值为 Windows2019。

osSKU?: string

属性值

string

继承自ManagedClusterAgentPoolProfileProperties.osSKU

osType

操作系统类型。 默认值为 Linux。

osType?: string

属性值

string

继承自ManagedClusterAgentPoolProfileProperties.osType

podSubnetID

如果省略，则会在节点子网上静态分配 Pod IP（有关详细信息，请参阅 vnetSubnetID）。 此格式为：/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}

podSubnetID?: string

属性值

string

继承自ManagedClusterAgentPoolProfileProperties.podSubnetID

powerState

首次创建代理池时，它最初正在运行。 可以通过将此字段设置为“已停止”来停止代理池。 已停止的代理池会停止其所有 VM，不会产生计费费用。 仅当代理池正在运行并且预配状态为“成功”时，才能停止代理池

powerState?: PowerState

属性值

PowerState

继承自ManagedClusterAgentPoolProfileProperties.powerState

provisioningState

当前部署或预配状态。 注意：此属性不会序列化。 它只能由服务器填充。

provisioningState?: string

属性值

string

继承自ManagedClusterAgentPoolProfileProperties.provisioningState

proximityPlacementGroupID

邻近放置组的 ID。

proximityPlacementGroupID?: string

属性值

string

继承自ManagedClusterAgentPoolProfileProperties.proximityPlacementGroupID

scaleDownMode

这也会影响群集自动缩放程序的行为。 如果未指定，则默认为 Delete。

scaleDownMode?: string

属性值

string

继承自ManagedClusterAgentPoolProfileProperties.scaleDownMode

scaleSetEvictionPolicy

除非 scaleSetPriority 为“Spot”，否则无法指定此项。 如果未指定，则默认值为“Delete”。

scaleSetEvictionPolicy?: string

属性值

string

继承自ManagedClusterAgentPoolProfileProperties.scaleSetEvictionPolicy

scaleSetPriority

虚拟机规模集优先级。 如果未指定，则默认值为“Regular”。

scaleSetPriority?: string

属性值

string

继承自ManagedClusterAgentPoolProfileProperties.scaleSetPriority

securityProfile

代理池的安全设置。

securityProfile?: AgentPoolSecurityProfile

属性值

AgentPoolSecurityProfile

继承自ManagedClusterAgentPoolProfileProperties.securityProfile

spotMaxPrice

可能的值是大于零或 -1 的任何小数值，表示愿意支付任何按需价格。 有关现成定价的更多详细信息，请参阅 现成 VM 定价

spotMaxPrice?: number

属性值

number

继承自ManagedClusterAgentPoolProfileProperties.spotMaxPrice

tags

要保留在代理池虚拟机规模集上的标记。

tags?: {[propertyName: string]: string}

属性值

{[propertyName: string]: string}

继承自ManagedClusterAgentPoolProfileProperties.tags

type

代理池的类型。

type?: string

属性值

string

继承自ManagedClusterAgentPoolProfileProperties.type

upgradeSettings

用于升级代理池的设置

upgradeSettings?: AgentPoolUpgradeSettings

属性值

AgentPoolUpgradeSettings

继承自ManagedClusterAgentPoolProfileProperties.upgradeSettings

vmSize

VM 大小可用性因区域而异。 如果节点包含的计算资源（内存、cpu 等）Pod 不足，可能无法正常运行。 有关受限 VM 大小的更多详细信息，请参阅：https://docs.microsoft.com/azure/aks/quotas-skus-regions

vmSize?: string

属性值

string

继承自ManagedClusterAgentPoolProfileProperties.vmSize

vnetSubnetID

如果未指定，将生成和使用 VNET 和子网。 如果未指定 podSubnetID，则这适用于节点和 Pod，否则它仅适用于节点。 此格式为：/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}

vnetSubnetID?: string

属性值

string

继承自ManagedClusterAgentPoolProfileProperties.vnetSubnetID

windowsProfile

Windows 代理池的特定配置文件。

windowsProfile?: AgentPoolWindowsProfile

属性值

AgentPoolWindowsProfile

继承自ManagedClusterAgentPoolProfileProperties.windowsProfile

workloadRuntime

确定节点可以运行的工作负荷的类型。

workloadRuntime?: string

属性值

string

继承自ManagedClusterAgentPoolProfileProperties.workloadRuntime