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

AgentPool interface

包:

@azure/arm-networkcloud

AgentPool 表示 Kubernetes 群集的代理池。

扩展

TrackedResource

属性

administratorConfiguration	要用于此代理池中的节点的管理员凭据。
agentOptions	将应用于此代理池中每个代理的配置。
attachedNetworkConfiguration	要附加到代理池的网络配置，供在此 Kubernetes 群集上运行的工作负荷使用。
availabilityZones	用于在此代理池中预配节点的网络云群集的可用性区域列表。 如果未指定，将使用所有可用性区域。
count	使用此配置的虚拟机数。
detailedStatus	代理池的当前状态。 注意：此属性不会序列化。 它只能由服务器填充。
detailedStatusMessage	有关当前详细状态的描述性消息。 注意：此属性不会序列化。 它只能由服务器填充。
extendedLocation	与资源关联的群集的扩展位置。
kubernetesVersion	在此代理池中运行的 Kubernetes 版本。 注意：此属性不会序列化。 它只能由服务器填充。
labels	应用于此代理池中的节点的标签。
mode	选择此代理池作为系统池或用户池的方式。 系统池运行 Kubernetes 群集的功能和关键服务，而用户池则专用于用户工作负荷。 每个 Kubernetes 群集必须至少包含一个具有至少一个节点的系统节点池。
provisioningState	代理池的预配状态。 注意：此属性不会序列化。 它只能由服务器填充。
taints	应用于此代理池中的节点的污点。
upgradeSettings	代理池的配置。
vmSkuName	确定为节点 VM 分配的资源大小的 VM SKU 的名称。

继承属性

id	资源的完全限定资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”注意：此属性不会序列化。 它只能由服务器填充。
location	资源所在的地理位置
name	资源说明的名称：此属性不会序列化。 它只能由服务器填充。
systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。 注意：此属性不会序列化。 它只能由服务器填充。
tags	资源标记。
type	资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”注意：此属性不会序列化。 它只能由服务器填充。

属性详细信息

administratorConfiguration

要用于此代理池中的节点的管理员凭据。

administratorConfiguration?: AdministratorConfiguration

属性值

AdministratorConfiguration

agentOptions

将应用于此代理池中每个代理的配置。

agentOptions?: AgentOptions

属性值

AgentOptions

attachedNetworkConfiguration

要附加到代理池的网络配置，供在此 Kubernetes 群集上运行的工作负荷使用。

attachedNetworkConfiguration?: AttachedNetworkConfiguration

属性值

AttachedNetworkConfiguration

availabilityZones

用于在此代理池中预配节点的网络云群集的可用性区域列表。 如果未指定，将使用所有可用性区域。

availabilityZones?: string[]

属性值

string[]

count

使用此配置的虚拟机数。

count: number

属性值

number

detailedStatus

代理池的当前状态。 注意：此属性不会序列化。 它只能由服务器填充。

detailedStatus?: string

属性值

string

detailedStatusMessage

有关当前详细状态的描述性消息。 注意：此属性不会序列化。 它只能由服务器填充。

detailedStatusMessage?: string

属性值

string

extendedLocation

与资源关联的群集的扩展位置。

extendedLocation?: ExtendedLocation

属性值

ExtendedLocation

kubernetesVersion

在此代理池中运行的 Kubernetes 版本。 注意：此属性不会序列化。 它只能由服务器填充。

kubernetesVersion?: string

属性值

string

labels

应用于此代理池中的节点的标签。

labels?: KubernetesLabel[]

属性值

KubernetesLabel[]

mode

选择此代理池作为系统池或用户池的方式。 系统池运行 Kubernetes 群集的功能和关键服务，而用户池则专用于用户工作负荷。 每个 Kubernetes 群集必须至少包含一个具有至少一个节点的系统节点池。

mode: string

属性值

string

provisioningState

代理池的预配状态。 注意：此属性不会序列化。 它只能由服务器填充。

provisioningState?: string

属性值

string

taints

应用于此代理池中的节点的污点。

taints?: KubernetesLabel[]

属性值

KubernetesLabel[]

upgradeSettings

代理池的配置。

upgradeSettings?: AgentPoolUpgradeSettings

属性值

AgentPoolUpgradeSettings

vmSkuName

确定为节点 VM 分配的资源大小的 VM SKU 的名称。

vmSkuName: string

属性值

string

继承属性详细信息

id

资源的完全限定资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”注意：此属性不会序列化。 它只能由服务器填充。

id?: string

属性值

string

继承自 TrackedResource.id 的

location

资源所在的地理位置

location: string

属性值

string

继承自TrackedResource.location

name

资源说明的名称：此属性不会序列化。 它只能由服务器填充。

name?: string

属性值

string

继承自 TrackedResource.name 的

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。 注意：此属性不会序列化。 它只能由服务器填充。

systemData?: SystemData

属性值

SystemData

继承自TrackedResource.systemData

tags

资源标记。

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

属性值

{[propertyName: string]: string}

继承自TrackedResource.tags

type

资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”注意：此属性不会序列化。 它只能由服务器填充。

type?: string

属性值

string

继承自TrackedResource.type