AgentPool interface

包:

@azure/arm-containerservice

代理池。

扩展

SubResource

属性

artifactStreamingProfile	用于在 AKS 上使用项目流式传输的配置。
availabilityZones	要用于节点的可用性区域列表。 仅当 AgentPoolType 属性为“VirtualMachineScaleSets”时，才能指定此值。
capacityReservationGroupID	AKS 会将指定的代理池与容量预留组相关联。
count	用于托管 docker 容器的代理数（VM）。 允许的值必须在用户池的 0 到 1000（含）范围内，系统池的范围为 1 到 1000（含）。 默认值为 1。
creationData	如果使用快照创建/升级节点池，则用于指定源快照 ID 的 CreationData。
currentOrchestratorVersion	在代理池上运行的 Kubernetes 版本。 如果 orchestratorVersion 是完全指定的 major.minor.patch< 版本>，则此字段将完全等于它。 如果 orchestratorVersion 是 <major.minor>，则此字段将包含正在使用的完整 <major.minor.patch> 版本。 注意：此属性不会序列化。 它只能由服务器填充。
enableAutoScaling	是否启用自动缩放程序
enableEncryptionAtHost	是否启用基于主机的 OS 和数据驱动器加密。 这仅在某些 VM 大小和某些 Azure 区域中受支持。 有关详细信息，请参阅： https://docs.microsoft.com/azure/aks/enable-host-encryption
enableFips	是否使用已启用 FIPS 的 OS。 有关更多详细信息 ，请参阅添加已启用 FIPS 的节点池 。
enableNodePublicIP	是否为每个节点分配自己的公共 IP。 某些方案可能需要节点池中的节点接收其自己的专用公共 IP 地址。 一种常见方案适用于游戏工作负载，其中主机需要与云虚拟机建立直接连接，以最大程度地减少跃点。 有关详细信息，请参阅 为每个节点分配公共 IP。 默认值为 false。
enableUltraSSD	是否启用 UltraSSD
eTag	用于实现乐观并发的唯一只读字符串。 更新资源时，eTag 值将更改。 为后续请求指定带有 eTag 值的 if-match 或 if-none-match 标头，以根据正常的 eTag 约定启用乐观并发。 注意：此属性不会序列化。 它只能由服务器填充。
gatewayProfile	特定于网关模式下托管代理池的配置文件。 如果代理池模式不是网关，则无法设置此字段。
gpuInstanceProfile	用于为支持的 GPU VM SKU 指定 GPU MIG 实例配置文件的 GPUInstanceProfile。
gpuProfile	代理池的 GPU 设置。
hostGroupID	专用主机组的完全限定资源 ID，用于预配虚拟机，仅在创建方案中使用，不允许在设置后更改。 此格式为：/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}。 有关详细信息，请参阅 Azure 专用主机。
kubeletConfig	代理池节点上的 Kubelet 配置。
kubeletDiskType	确定 emptyDir 卷、容器运行时数据根目录和 Kubelet 临时存储的位置。
linuxOSConfig	Linux 代理节点的 OS 配置。
localDNSProfile	使用 VnetDNS 和 KubeDNS 覆盖配置每个节点的本地 DNS。 LocalDNS 有助于提高 AKS 群集中 DNS 解析的性能和可靠性。 有关更多详细信息，请参阅 aka.ms/aks/localdns。
maxCount	自动缩放的最大节点数
maxPods	可在节点上运行的 Pod 的最大数目。
messageOfTheDay	Linux 节点的当天消息（base64 编码）。 一个 base64 编码的字符串，将在解码后写入 /etc/motd。 这允许自定义 Linux 节点当天的消息。 它不得为 Windows 节点指定。 它必须是静态字符串（即，将打印为原始字符串，而不是作为脚本执行）。
minCount	自动缩放的最小节点数
mode	代理池的模式。 群集必须随时至少有一个“系统”代理池。 有关代理池限制和最佳做法的其他信息，请参阅：https://docs.microsoft.com/azure/aks/use-system-pools
networkProfile	代理池的网络相关设置。
nodeCustomizationProfile	用于确定用于在池中预配节点的节点自定义的设置。
nodeImageVersion	节点映像的版本
nodeInitializationTaints	创建期间在节点上添加的污点，AKS 不会协调。 这些污点不会被 AKS 协调，并且可以通过 kubectl 调用删除。 创建节点池后，可以修改此字段，但在需要重新执行的其他操作（例如节点映像升级）之前，不会使用新的污点重新创建节点。 这些污点允许在节点准备好接受工作负载之前运行所需的配置，例如“key1=value1：NoSchedule”，然后可以使用 kubectl taint nodes node1 key1=value1:NoSchedule-
nodeLabels	要跨代理池中的所有节点保留的节点标签。
nodePublicIPPrefixID	VM 节点应使用 IP 的公共 IP 前缀 ID。 此格式为：/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}
nodeTaints	在节点池创建和缩放期间添加到新节点的污点。 例如，key=value：NoSchedule。
orchestratorVersion	用户指定的 Kubernetes 版本。 支持修补程序版本 <major.minor.patch> 和 <major.minor> 。 指定 major.minor< 后>，会自动选择最新支持的修补程序版本。 创建代理池后，使用相同的 major.minor< 更新代理池>不会触发升级，即使有较新的修补程序版本可用也是如此。 最佳做法是，应将 AKS 群集中的所有节点池升级到同一 Kubernetes 版本。 节点池版本必须与控制平面具有相同的主版本。 节点池次要版本必须位于控制平面版本的两个次要版本中。 节点池版本不能大于控制平面版本。 有关详细信息，请参阅 升级节点池。
osDiskSizeGB	OS 磁盘大小（以 GB 为单位）用于为主/代理池中的每个计算机指定磁盘大小。 如果指定 0，它将根据指定的 vmSize 应用默认 osDisk 大小。
osDiskType	要用于代理池中的计算机的 OS 磁盘类型。 如果 VM 支持该 VM 并且缓存磁盘大于请求的 OSDiskSizeGB，则默认值为“临时”。 否则，默认为“Managed”。 创建后可能不会更改。 有关详细信息，请参阅 临时 OS。
osSKU	指定代理池使用的 OS SKU。 如果未指定，则默认值为 Ubuntu（如果 OSType=Linux）或 Windows2019（如果 OSType=Windows）。 在 Windows2019 弃用后，默认的 Windows OSSKU 将更改为 Windows2022。
osType	操作系统类型。 默认值为 Linux。
podIPAllocationMode	Pod IP 分配模式。 代理池中 Pod 的 IP 分配模式。 必须与 podSubnetId 一起使用。 默认值为“DynamicIndividual”。
podSubnetID	启动时 Pod 将加入的子网的 ID。 如果省略，则会在节点子网上静态分配 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 的任何小数值，指示要按需 up-to 的默认价格。 可能的值是大于零或 -1 的任何小数值，表示愿意支付任何按需价格。 有关现成定价的更多详细信息，请参阅 现成 VM 定价
status	包含有关代理池的只读信息。
tags	要保留在代理池虚拟机规模集上的标记。
typePropertiesType	代理池的类型。
upgradeSettings	用于升级代理池的设置。 当升级策略设置为滚动时适用。
upgradeSettingsBlueGreen	代理池上 Blue-Green 升级的设置。 当升级策略设置为 BlueGreen 时适用。
upgradeStrategy	定义代理池的升级策略。 默认值为滚动。
virtualMachineNodesStatus	VirtualMachines 代理池中的节点的状态。
virtualMachinesProfile	VirtualMachines 代理池上的规范。
vmSize	代理池 VM 的大小。 VM 大小可用性因区域而异。 如果节点包含的计算资源（内存、cpu 等）Pod 不足，可能无法正常运行。 有关受限 VM 大小的更多详细信息，请参阅：https://docs.microsoft.com/azure/aks/quotas-skus-regions
vnetSubnetID	代理池节点和（可选）Pod 将在启动时加入的子网的 ID。 如果未指定，将生成和使用 VNET 和子网。 如果未指定 podSubnetID，则这适用于节点和 Pod，否则它仅适用于节点。 此格式为：/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
windowsProfile	Windows 代理池的特定配置文件。
workloadRuntime	确定节点可以运行的工作负荷的类型。

继承属性

id	资源 ID。 注意：此属性不会序列化。 它只能由服务器填充。
name	资源组中唯一的资源的名称。 此名称可用于访问资源。 注意：此属性不会序列化。 它只能由服务器填充。
type	资源类型注意：此属性不会序列化。 它只能由服务器填充。

属性详细信息

artifactStreamingProfile

用于在 AKS 上使用项目流式传输的配置。

artifactStreamingProfile?: AgentPoolArtifactStreamingProfile

属性值

AgentPoolArtifactStreamingProfile

availabilityZones

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

availabilityZones?: string[]

属性值

string[]

capacityReservationGroupID

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

capacityReservationGroupID?: string

属性值

string

count

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

count?: number

属性值

number

creationData

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

creationData?: CreationData

属性值

CreationData

currentOrchestratorVersion

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

currentOrchestratorVersion?: string

属性值

string

enableAutoScaling

是否启用自动缩放程序

enableAutoScaling?: boolean

属性值

boolean

enableEncryptionAtHost

是否启用基于主机的 OS 和数据驱动器加密。 这仅在某些 VM 大小和某些 Azure 区域中受支持。 有关详细信息，请参阅： https://docs.microsoft.com/azure/aks/enable-host-encryption

enableEncryptionAtHost?: boolean

属性值

boolean

enableFips

是否使用已启用 FIPS 的 OS。 有关更多详细信息 ，请参阅添加已启用 FIPS 的节点池 。

enableFips?: boolean

属性值

boolean

enableNodePublicIP

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

enableNodePublicIP?: boolean

属性值

boolean

enableUltraSSD

是否启用 UltraSSD

enableUltraSSD?: boolean

属性值

boolean

eTag

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

eTag?: string

属性值

string

gatewayProfile

特定于网关模式下托管代理池的配置文件。 如果代理池模式不是网关，则无法设置此字段。

gatewayProfile?: AgentPoolGatewayProfile

属性值

AgentPoolGatewayProfile

gpuInstanceProfile

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

gpuInstanceProfile?: string

属性值

string

gpuProfile

代理池的 GPU 设置。

gpuProfile?: GPUProfile

属性值

GPUProfile

hostGroupID

专用主机组的完全限定资源 ID，用于预配虚拟机，仅在创建方案中使用，不允许在设置后更改。 此格式为：/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}。 有关详细信息，请参阅 Azure 专用主机。

hostGroupID?: string

属性值

string

kubeletConfig

代理池节点上的 Kubelet 配置。

kubeletConfig?: KubeletConfig

属性值

KubeletConfig

kubeletDiskType

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

kubeletDiskType?: string

属性值

string

linuxOSConfig

Linux 代理节点的 OS 配置。

linuxOSConfig?: LinuxOSConfig

属性值

LinuxOSConfig

localDNSProfile

使用 VnetDNS 和 KubeDNS 覆盖配置每个节点的本地 DNS。 LocalDNS 有助于提高 AKS 群集中 DNS 解析的性能和可靠性。 有关更多详细信息，请参阅 aka.ms/aks/localdns。

localDNSProfile?: LocalDNSProfile

属性值

LocalDNSProfile

maxCount

自动缩放的最大节点数

maxCount?: number

属性值

number

maxPods

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

maxPods?: number

属性值

number

messageOfTheDay

Linux 节点的当天消息（base64 编码）。 一个 base64 编码的字符串，将在解码后写入 /etc/motd。 这允许自定义 Linux 节点当天的消息。 它不得为 Windows 节点指定。 它必须是静态字符串（即，将打印为原始字符串，而不是作为脚本执行）。

messageOfTheDay?: string

属性值

string

minCount

自动缩放的最小节点数

minCount?: number

属性值

number

mode

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

mode?: string

属性值

string

networkProfile

代理池的网络相关设置。

networkProfile?: AgentPoolNetworkProfile

属性值

AgentPoolNetworkProfile

nodeCustomizationProfile

用于确定用于在池中预配节点的节点自定义的设置。

nodeCustomizationProfile?: NodeCustomizationProfile

属性值

NodeCustomizationProfile

nodeImageVersion

节点映像的版本

nodeImageVersion?: string

属性值

string

nodeInitializationTaints

创建期间在节点上添加的污点，AKS 不会协调。 这些污点不会被 AKS 协调，并且可以通过 kubectl 调用删除。 创建节点池后，可以修改此字段，但在需要重新执行的其他操作（例如节点映像升级）之前，不会使用新的污点重新创建节点。 这些污点允许在节点准备好接受工作负载之前运行所需的配置，例如“key1=value1：NoSchedule”，然后可以使用 kubectl taint nodes node1 key1=value1:NoSchedule-

nodeInitializationTaints?: string[]

属性值

string[]

nodeLabels

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

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

属性值

{[propertyName: string]: string}

nodePublicIPPrefixID

VM 节点应使用 IP 的公共 IP 前缀 ID。 此格式为：/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}

nodePublicIPPrefixID?: string

属性值

string

nodeTaints

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

nodeTaints?: string[]

属性值

string[]

orchestratorVersion

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

orchestratorVersion?: string

属性值

string

osDiskSizeGB

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

osDiskSizeGB?: number

属性值

number

osDiskType

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

osDiskType?: string

属性值

string

osSKU

指定代理池使用的 OS SKU。 如果未指定，则默认值为 Ubuntu（如果 OSType=Linux）或 Windows2019（如果 OSType=Windows）。 在 Windows2019 弃用后，默认的 Windows OSSKU 将更改为 Windows2022。

osSKU?: string

属性值

string

osType

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

osType?: string

属性值

string

podIPAllocationMode

Pod IP 分配模式。 代理池中 Pod 的 IP 分配模式。 必须与 podSubnetId 一起使用。 默认值为“DynamicIndividual”。

podIPAllocationMode?: string

属性值

string

podSubnetID

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

podSubnetID?: string

属性值

string

powerState

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

powerState?: PowerState

属性值

PowerState

provisioningState

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

provisioningState?: string

属性值

string

proximityPlacementGroupID

邻近放置组的 ID。

proximityPlacementGroupID?: string

属性值

string

scaleDownMode

缩放代理池时要使用的缩减模式。 这也会影响群集自动缩放程序的行为。 如果未指定，则默认为 Delete。

scaleDownMode?: string

属性值

string

scaleSetEvictionPolicy

要使用的虚拟机规模集逐出策略。 除非 scaleSetPriority 为“Spot”，否则无法指定此项。 如果未指定，则默认值为“Delete”。

scaleSetEvictionPolicy?: string

属性值

string

scaleSetPriority

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

scaleSetPriority?: string

属性值

string

securityProfile

代理池的安全设置。

securityProfile?: AgentPoolSecurityProfile

属性值

AgentPoolSecurityProfile

spotMaxPrice

你愿意支付现成实例的最大价格（以美元为单位）。 可能的值是大于零或 -1 的任何小数值，指示要按需 up-to 的默认价格。 可能的值是大于零或 -1 的任何小数值，表示愿意支付任何按需价格。 有关现成定价的更多详细信息，请参阅 现成 VM 定价

spotMaxPrice?: number

属性值

number

status

包含有关代理池的只读信息。

status?: AgentPoolStatus

属性值

AgentPoolStatus

tags

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

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

属性值

{[propertyName: string]: string}

typePropertiesType

代理池的类型。

typePropertiesType?: string

属性值

string

upgradeSettings

用于升级代理池的设置。 当升级策略设置为滚动时适用。

upgradeSettings?: AgentPoolUpgradeSettings

属性值

AgentPoolUpgradeSettings

upgradeSettingsBlueGreen

代理池上 Blue-Green 升级的设置。 当升级策略设置为 BlueGreen 时适用。

upgradeSettingsBlueGreen?: AgentPoolBlueGreenUpgradeSettings

属性值

AgentPoolBlueGreenUpgradeSettings

upgradeStrategy

定义代理池的升级策略。 默认值为滚动。

upgradeStrategy?: string

属性值

string

virtualMachineNodesStatus

VirtualMachines 代理池中的节点的状态。

virtualMachineNodesStatus?: VirtualMachineNodes[]

属性值

VirtualMachineNodes[]

virtualMachinesProfile

VirtualMachines 代理池上的规范。

virtualMachinesProfile?: VirtualMachinesProfile

属性值

VirtualMachinesProfile

vmSize

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

vmSize?: string

属性值

string

vnetSubnetID

代理池节点和（可选）Pod 将在启动时加入的子网的 ID。 如果未指定，将生成和使用 VNET 和子网。 如果未指定 podSubnetID，则这适用于节点和 Pod，否则它仅适用于节点。 此格式为：/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}

vnetSubnetID?: string

属性值

string

windowsProfile

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

windowsProfile?: AgentPoolWindowsProfile

属性值

AgentPoolWindowsProfile

workloadRuntime

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

workloadRuntime?: string

属性值

string

继承属性详细信息

id

资源 ID。 注意：此属性不会序列化。 它只能由服务器填充。

id?: string

属性值

string

继承自 SubResource.id 的

name

资源组中唯一的资源的名称。 此名称可用于访问资源。 注意：此属性不会序列化。 它只能由服务器填充。

name?: string

属性值

string

继承自 SubResource.name 的

type

资源类型注意：此属性不会序列化。 它只能由服务器填充。

type?: string

属性值

string

继承自SubResource.type