ManagedClusterAgentPoolProfilePropertiesOutput interface

包:

@azure-rest/arm-containerservice

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

属性

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	是否启用自动缩放程序
enableCustomCATrust	设置为 true 时，AKS 会部署守护程序集和托管服务，以将用户提供的配置映射中的自定义证书颁发机构同步到节点信任存储中。 默认值为 false。
enableEncryptionAtHost	这仅在某些 VM 大小和某些 Azure 区域中受支持。 有关详细信息，请参阅：https://docs.microsoft.com/azure/aks/enable-host-encryption
enableFIPS	有关详细信息，请参阅 添加启用了 FIPS 的节点池。
enableNodePublicIP	某些方案可能需要节点池中的节点接收其自己的专用公共 IP 地址。 一种常见方案适用于游戏工作负载，其中主机需要与云虚拟机建立直接连接，以最大程度地减少跃点。 有关详细信息，请参阅 为每个节点分配公共 IP。 默认值为 false。
enableUltraSSD	是否启用 UltraSSD
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 的最大数目。
messageOfTheDay	一个 base64 编码的字符串，将在解码后写入 /etc/motd。 这允许自定义 Linux 节点当天的消息。 它不得为 Windows 节点指定。 它必须是静态字符串（即，将打印为原始字符串，而不是作为脚本执行）。
minCount	自动缩放的最小节点数
mode	群集必须随时至少有一个“系统”代理池。 有关代理池限制和最佳做法的其他信息，请参阅：https://docs.microsoft.com/azure/aks/use-system-pools
nodeImageVersion	节点映像的版本
nodeLabels	要跨代理池中的所有节点保留的节点标签。
nodePublicIPPrefixID	此格式为：/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}
nodeTaints	在节点池创建和缩放期间添加到新节点的污点。 例如，key=value：NoSchedule。
orchestratorVersion	支持 <major.minor.patch> 和 <major.minor> 的修补程序版本。 指定 <major.minor> 时，会自动选择最新的受支持的修补程序版本。 创建代理池后，使用相同的 <major.minor> 更新代理池不会触发升级，即使更新的修补程序版本可用也是如此。 最佳做法是，应将 AKS 群集中的所有节点池升级到同一 Kubernetes 版本。 节点池版本必须与控制平面具有相同的主版本。 节点池次要版本必须位于控制平面版本的两个次要版本中。 节点池版本不能大于控制平面版本。 有关详细信息，请参阅 升级节点池。
osDiskSizeGB	OS 磁盘大小（以 GB 为单位）用于为主/代理池中的每个计算机指定磁盘大小。 如果指定 0，它将根据指定的 vmSize 应用默认 osDisk 大小。
osDiskType	如果 VM 支持该 VM 并且缓存磁盘大于请求的 OSDiskSizeGB，则默认值为“临时”。 否则，默认为“Managed”。 创建后可能不会更改。 有关详细信息，请参阅 临时 OS。
osSKU	指定代理池使用的 OS SKU。 如果未指定，则默认值为 Ubuntu（如果 OSType=Linux）或 Windows2019（如果 OSType=Windows）。 在 Windows2019 弃用后，默认的 Windows OSSKU 将更改为 Windows2022。
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”。
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}
workloadRuntime	确定节点可以运行的工作负荷的类型。

属性详细信息

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?: CreationDataOutput

属性值

CreationDataOutput

currentOrchestratorVersion

如果 orchestratorVersion 是一个完全指定的版本 <major.minor.patch>，则此字段将完全等于它。 如果 orchestratorVersion <major.minor>，此字段将包含正在使用的完整 <major.minor.patch> 版本。

currentOrchestratorVersion?: string

属性值

string

enableAutoScaling

是否启用自动缩放程序

enableAutoScaling?: boolean

属性值

boolean

enableCustomCATrust

设置为 true 时，AKS 会部署守护程序集和托管服务，以将用户提供的配置映射中的自定义证书颁发机构同步到节点信任存储中。 默认值为 false。

enableCustomCATrust?: boolean

属性值

boolean

enableEncryptionAtHost

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

enableEncryptionAtHost?: boolean

属性值

boolean

enableFIPS

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

enableFIPS?: boolean

属性值

boolean

enableNodePublicIP

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

enableNodePublicIP?: boolean

属性值

boolean

enableUltraSSD

是否启用 UltraSSD

enableUltraSSD?: boolean

属性值

boolean

gpuInstanceProfile

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

gpuInstanceProfile?: "MIG1g" | "MIG2g" | "MIG3g" | "MIG4g" | "MIG7g"

属性值

"MIG1g" | "MIG2g" | "MIG3g" | "MIG4g" | "MIG7g"

hostGroupID

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

hostGroupID?: string

属性值

string

kubeletConfig

代理池节点上的 Kubelet 配置。

kubeletConfig?: KubeletConfigOutput

属性值

KubeletConfigOutput

kubeletDiskType

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

kubeletDiskType?: "OS" | "Temporary"

属性值

"OS" | "Temporary"

linuxOSConfig

Linux 代理节点的 OS 配置。

linuxOSConfig?: LinuxOSConfigOutput

属性值

LinuxOSConfigOutput

maxCount

自动缩放的最大节点数

maxCount?: number

属性值

number

maxPods

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

maxPods?: number

属性值

number

messageOfTheDay

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

messageOfTheDay?: string

属性值

string

minCount

自动缩放的最小节点数

minCount?: number

属性值

number

mode

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

mode?: "System" | "User"

属性值

"System" | "User"

nodeImageVersion

节点映像的版本

nodeImageVersion?: string

属性值

string

nodeLabels

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

nodeLabels?: Record<string, string>

属性值

Record<string, string>

nodePublicIPPrefixID

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

nodePublicIPPrefixID?: string

属性值

string

nodeTaints

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

nodeTaints?: string[]

属性值

string[]

orchestratorVersion

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

orchestratorVersion?: string

属性值

string

osDiskSizeGB

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

osDiskSizeGB?: number

属性值

number

osDiskType

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

osDiskType?: "Managed" | "Ephemeral"

属性值

"Managed" | "Ephemeral"

osSKU

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

osSKU?: "Ubuntu" | "CBLMariner" | "Windows2019" | "Windows2022"

属性值

"Ubuntu" | "CBLMariner" | "Windows2019" | "Windows2022"

osType

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

osType?: "Linux" | "Windows"

属性值

"Linux" | "Windows"

podSubnetID

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

podSubnetID?: string

属性值

string

powerState

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

powerState?: PowerStateOutput

属性值

PowerStateOutput

provisioningState

当前部署或预配状态。

provisioningState?: string

属性值

string

proximityPlacementGroupID

邻近放置组的 ID。

proximityPlacementGroupID?: string

属性值

string

scaleDownMode

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

scaleDownMode?: "Delete" | "Deallocate"

属性值

"Delete" | "Deallocate"

scaleSetEvictionPolicy

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

scaleSetEvictionPolicy?: "Delete" | "Deallocate"

属性值

"Delete" | "Deallocate"

scaleSetPriority

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

scaleSetPriority?: "Spot" | "Regular"

属性值

"Spot" | "Regular"

spotMaxPrice

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

spotMaxPrice?: number

属性值

number

tags

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

tags?: Record<string, string>

属性值

Record<string, string>

type

代理池的类型。

type?: "VirtualMachineScaleSets" | "AvailabilitySet"

属性值

"VirtualMachineScaleSets" | "AvailabilitySet"

upgradeSettings

用于升级代理池的设置

upgradeSettings?: AgentPoolUpgradeSettingsOutput

属性值

AgentPoolUpgradeSettingsOutput

vmSize

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

vmSize?: string

属性值

string

vnetSubnetID

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

vnetSubnetID?: string

属性值

string

workloadRuntime

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

workloadRuntime?: "OCIContainer" | "WasmWasi"

属性值

"OCIContainer" | "WasmWasi"