AgentPool interface

Package:

@azure/arm-networkcloud

AgentPool represents the agent pool of Kubernetes cluster.

Extends

TrackedResource

Properties

administratorConfiguration	The administrator credentials to be used for the nodes in this agent pool.
agentOptions	The configurations that will be applied to each agent in this agent pool.
attachedNetworkConfiguration	The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster.
availabilityZones	The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used.
count	The number of virtual machines that use this configuration.
detailedStatus	The current status of the agent pool. NOTE: This property will not be serialized. It can only be populated by the server.
detailedStatusMessage	The descriptive message about the current detailed status. NOTE: This property will not be serialized. It can only be populated by the server.
extendedLocation	The extended location of the cluster associated with the resource.
kubernetesVersion	The Kubernetes version running in this agent pool. NOTE: This property will not be serialized. It can only be populated by the server.
labels	The labels applied to the nodes in this agent pool.
mode	The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node.
provisioningState	The provisioning state of the agent pool. NOTE: This property will not be serialized. It can only be populated by the server.
taints	The taints applied to the nodes in this agent pool.
upgradeSettings	The configuration of the agent pool.
vmSkuName	The name of the VM SKU that determines the size of resources allocated for node VMs.

Inherited Properties

id	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
location	The geo-location where the resource lives
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
tags	Resource tags.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

administratorConfiguration

The administrator credentials to be used for the nodes in this agent pool.

administratorConfiguration?: AdministratorConfiguration

Property Value

AdministratorConfiguration

agentOptions

The configurations that will be applied to each agent in this agent pool.

agentOptions?: AgentOptions

Property Value

AgentOptions

attachedNetworkConfiguration

The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster.

attachedNetworkConfiguration?: AttachedNetworkConfiguration

Property Value

AttachedNetworkConfiguration

availabilityZones

The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used.

availabilityZones?: string[]

Property Value

string[]

count

The number of virtual machines that use this configuration.

count: number

Property Value

number

detailedStatus

The current status of the agent pool. NOTE: This property will not be serialized. It can only be populated by the server.

detailedStatus?: string

Property Value

string

detailedStatusMessage

The descriptive message about the current detailed status. NOTE: This property will not be serialized. It can only be populated by the server.

detailedStatusMessage?: string

Property Value

string

extendedLocation

The extended location of the cluster associated with the resource.

extendedLocation?: ExtendedLocation

Property Value

ExtendedLocation

kubernetesVersion

The Kubernetes version running in this agent pool. NOTE: This property will not be serialized. It can only be populated by the server.

kubernetesVersion?: string

Property Value

string

labels

The labels applied to the nodes in this agent pool.

labels?: KubernetesLabel[]

Property Value

KubernetesLabel[]

mode

The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node.

mode: string

Property Value

string

provisioningState

The provisioning state of the agent pool. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

taints

The taints applied to the nodes in this agent pool.

taints?: KubernetesLabel[]

Property Value

KubernetesLabel[]

upgradeSettings

The configuration of the agent pool.

upgradeSettings?: AgentPoolUpgradeSettings

Property Value

AgentPoolUpgradeSettings

vmSkuName

The name of the VM SKU that determines the size of resources allocated for node VMs.

vmSkuName: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

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

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type