AgentPool interface

套件:

@azure/arm-containerservice

代理程式集區。

Extends

SubResource

屬性

availabilityZones	要用於節點的可用性區域清單。 只有在 AgentPoolType 屬性是 'VirtualMachineScaleSets' 時，才能指定這個值。
capacityReservationGroupID	AKS 會將指定的代理程式集區與容量保留群組產生關聯。
count	裝載 Docker 容器的代理程式 （VM） 數目。 允許的值必須介於使用者集區的 0 到 1000（含）範圍內，且系統集區的範圍為 1 到 1000（含）。 預設值為 1。
creationData	如果節點集區將會使用快照集建立/升級，則用來指定來源快照集標識符的 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
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 支援，且快取磁碟大於要求的 OSDiskSizeGB，則預設值為 「暫時」。 否則，預設為 「受控」。 建立之後可能不會變更。 如需詳細資訊，請參閱 暫時作業系統。
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	鄰近放置群組的標識碼。
scaleDownMode	這也會影響叢集自動調整程序的行為。 如果未指定，則預設為 Delete。
scaleSetEvictionPolicy	除非 scaleSetPriority 為 'Spot'，否則無法指定此專案。 如果未指定，則預設值為 『Delete』。
scaleSetPriority	虛擬機擴展集優先順序。 如果未指定，則預設值為 『Regular』。
spotMaxPrice	可能的值為大於零或 -1 的任何十進位值，表示願意支付任何隨選價格。 如需現成定價的詳細資訊，請參閱 現成 VM 定價
tags	要保存在代理程式集區虛擬機擴展集上的標記。
typePropertiesType	Agent 集區的類型。
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	決定節點可執行的工作負載類型。

繼承的屬性

id	資源標識碼。 注意：這個屬性不會串行化。 它只能由伺服器填入。
name	資源群組內唯一的資源名稱。 此名稱可用來存取資源。 注意：這個屬性不會串行化。 它只能由伺服器填入。
type	資源類型注意：此屬性不會串行化。 它只能由伺服器填入。

屬性詳細資料

availabilityZones

要用於節點的可用性區域清單。 只有在 AgentPoolType 屬性是 'VirtualMachineScaleSets' 時，才能指定這個值。

availabilityZones?: string[]

屬性值

string[]

capacityReservationGroupID

AKS 會將指定的代理程式集區與容量保留群組產生關聯。

capacityReservationGroupID?: string

屬性值

string

count

裝載 Docker 容器的代理程式 （VM） 數目。 允許的值必須介於使用者集區的 0 到 1000（含）範圍內，且系統集區的範圍為 1 到 1000（含）。 預設值為 1。

count?: number

屬性值

number

creationData

如果節點集區將會使用快照集建立/升級，則用來指定來源快照集標識符的 CreationData。

creationData?: CreationData

屬性值

CreationData

currentOrchestratorVersion

如果 orchestratorVersion 是 <major.minor.patch>的完整指定版本，則此字段會完全相等。 如果 orchestratorVersion <major.minor>，則此字段會包含使用的完整 <major.minor.patch> 版本。 注意：這個屬性不會串行化。 它只能由伺服器填入。

currentOrchestratorVersion?: string

屬性值

string

enableAutoScaling

是否要啟用自動調整程式

enableAutoScaling?: 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?: string

屬性值

string

hostGroupID

這是格式：/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

maxCount

自動調整的節點數目上限

maxCount?: number

屬性值

number

maxPods

可在節點上執行的 Pod 數目上限。

maxPods?: number

屬性值

number

minCount

自動調整的節點數目下限

minCount?: number

屬性值

number

mode

叢集必須隨時至少有一個「系統」代理程式集區。 如需代理程式集區限制和最佳做法的其他資訊，請參閱：https://docs.microsoft.com/azure/aks/use-system-pools

mode?: string

屬性值

string

networkProfile

代理程式集區的網路相關設定。

networkProfile?: AgentPoolNetworkProfile

屬性值

AgentPoolNetworkProfile

nodeImageVersion

節點映像的版本注意：此屬性將不會串行化。 它只能由伺服器填入。

nodeImageVersion?: string

屬性值

string

nodeLabels

要跨代理程式集區中所有節點保存的節點標籤。

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

屬性值

{[propertyName: 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> 的修補程式版本（例如 1.20.13）和 <major.minor>（例如 1.20）。 當指定 <major.minor> 時，會自動選擇最新的支援 GA 修補程式版本。 一旦建立叢集之後，使用相同的 <major.minor> 更新叢集（例如 1.14.x -> 1.14），即使有較新的修補程式版本，也不會觸發升級。 最佳做法是，您應該將 AKS 叢集中的所有節點集區升級為相同的 Kubernetes 版本。 節點集區版本必須與控制平面具有相同的主要版本。 節點集區次要版本必須位於控制平面版本的兩個次要版本內。 節點集區版本不能大於控制平面版本。 如需詳細資訊，請參閱 升級節點集區。

orchestratorVersion?: string

屬性值

string

osDiskSizeGB

OS 磁碟大小 GB，用來指定主要/代理程式集區中每部計算機的磁碟大小。 如果您指定 0，它會根據指定的 vmSize 套用預設 osDisk 大小。

osDiskSizeGB?: number

屬性值

number

osDiskType

如果 VM 支援，且快取磁碟大於要求的 OSDiskSizeGB，則預設值為 「暫時」。 否則，預設為 「受控」。 建立之後可能不會變更。 如需詳細資訊，請參閱 暫時作業系統。

osDiskType?: string

屬性值

string

osSKU

指定代理程式集區所使用的 OS SKU。 如果OSType為Linux，則預設值為Ubuntu。 當 Kubernetes <= 1.24 或 Windows2022 時，當 Kubernetes >= 1.25 如果 OSType 為 Windows，則預設值為 Windows2019。

osSKU?: string

屬性值

string

osType

操作系統類型。 預設值為Linux。

osType?: string

屬性值

string

podSubnetID

如果省略，則會在節點子網上靜態指派 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

鄰近放置群組的標識碼。

proximityPlacementGroupID?: string

屬性值

string

scaleDownMode

這也會影響叢集自動調整程序的行為。 如果未指定，則預設為 Delete。

scaleDownMode?: string

屬性值

string

scaleSetEvictionPolicy

除非 scaleSetPriority 為 'Spot'，否則無法指定此專案。 如果未指定，則預設值為 『Delete』。

scaleSetEvictionPolicy?: string

屬性值

string

scaleSetPriority

虛擬機擴展集優先順序。 如果未指定，則預設值為 『Regular』。

scaleSetPriority?: string

屬性值

string

spotMaxPrice

可能的值為大於零或 -1 的任何十進位值，表示願意支付任何隨選價格。 如需現成定價的詳細資訊，請參閱 現成 VM 定價

spotMaxPrice?: number

屬性值

number

tags

要保存在代理程式集區虛擬機擴展集上的標記。

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

屬性值

{[propertyName: string]: string}

typePropertiesType

Agent 集區的類型。

typePropertiesType?: string

屬性值

string

upgradeSettings

升級代理程式集池的設定

upgradeSettings?: AgentPoolUpgradeSettings

屬性值

AgentPoolUpgradeSettings

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

windowsProfile

Windows 代理程式集區的特定配置檔。

windowsProfile?: AgentPoolWindowsProfile

屬性值

AgentPoolWindowsProfile

workloadRuntime

決定節點可執行的工作負載類型。

workloadRuntime?: string

屬性值

string

繼承的屬性詳細資料

id

資源標識碼。 注意：這個屬性不會串行化。 它只能由伺服器填入。

id?: string

屬性值

string

繼承自SubResource.id

name

資源群組內唯一的資源名稱。 此名稱可用來存取資源。 注意：這個屬性不會串行化。 它只能由伺服器填入。

name?: string

屬性值

string

繼承自SubResource.name

type

資源類型注意：此屬性不會串行化。 它只能由伺服器填入。

type?: string

屬性值

string

繼承自SubResource.type