AgentPoolProperties interface

Package:

@azure/arm-hybridcontainerservice

Properties of the agent pool resource

Extends

AgentPoolProfile,AgentPoolUpdateProfile,AgentPoolProvisioningStatus

Inherited Properties

count	Number of nodes in the agent pool. The default value is 1.
enableAutoScaling	Whether to enable auto-scaler. Default value is false
kubernetesVersion	Version of Kubernetes in use by the agent pool. This is inherited from the kubernetesVersion of the provisioned cluster. NOTE: This property will not be serialized. It can only be populated by the server.
maxCount	The maximum number of nodes for auto-scaling
maxPods	The maximum number of pods that can run on a node.
minCount	The minimum number of nodes for auto-scaling
nodeLabels	The node labels to be persisted across all nodes in agent pool.
nodeTaints	Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.
osSKU	Specifies the OS SKU used by the agent pool. The default is CBLMariner if OSType is Linux. The default is Windows2019 when OSType is Windows.
osType	The particular KubernetesVersion Image OS Type (Linux, Windows)
provisioningState	The status of the latest long running operation for the agent pool. NOTE: This property will not be serialized. It can only be populated by the server.
status	The observed status of the agent pool.
vmSize	The VM sku size of the agent pool node VMs.

Inherited Property Details

count

Number of nodes in the agent pool. The default value is 1.

count?: number

Property Value

number

Inherited From AgentPoolUpdateProfile.count

enableAutoScaling

Whether to enable auto-scaler. Default value is false

enableAutoScaling?: boolean

Property Value

boolean

Inherited From AgentPoolProfile.enableAutoScaling

kubernetesVersion

Version of Kubernetes in use by the agent pool. This is inherited from the kubernetesVersion of the provisioned cluster. NOTE: This property will not be serialized. It can only be populated by the server.

kubernetesVersion?: string

Property Value

string

Inherited From AgentPoolUpdateProfile.kubernetesVersion

maxCount

The maximum number of nodes for auto-scaling

maxCount?: number

Property Value

number

Inherited From AgentPoolProfile.maxCount

maxPods

The maximum number of pods that can run on a node.

maxPods?: number

Property Value

number

Inherited From AgentPoolProfile.maxPods

minCount

The minimum number of nodes for auto-scaling

minCount?: number

Property Value

number

Inherited From AgentPoolProfile.minCount

nodeLabels

The node labels to be persisted across all nodes in agent pool.

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

Property Value

{[propertyName: string]: string}

Inherited From AgentPoolProfile.nodeLabels

nodeTaints

Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.

nodeTaints?: string[]

Property Value

string[]

Inherited From AgentPoolProfile.nodeTaints

osSKU

Specifies the OS SKU used by the agent pool. The default is CBLMariner if OSType is Linux. The default is Windows2019 when OSType is Windows.

osSKU?: string

Property Value

string

Inherited From AgentPoolProfile.osSKU

osType

The particular KubernetesVersion Image OS Type (Linux, Windows)

osType?: string

Property Value

string

Inherited From AgentPoolProfile.osType

provisioningState

The status of the latest long running operation for the agent pool. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

Inherited From AgentPoolProvisioningStatus.provisioningState

status

The observed status of the agent pool.

status?: AgentPoolProvisioningStatusStatus

Property Value

AgentPoolProvisioningStatusStatus

Inherited From AgentPoolProvisioningStatus.status

vmSize

The VM sku size of the agent pool node VMs.

vmSize?: string

Property Value

string

Inherited From AgentPoolUpdateProfile.vmSize