AgentPool interface

Package:

@azure/arm-hybridcontainerservice

The agentPool resource definition

Properties

availabilityZones	AvailabilityZones - The list of Availability zones to use for nodes. Datacenter racks modelled as zones
count	Count - Number of agents to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.
extendedLocation	Extended Location definition
id	Resource Id NOTE: This property will not be serialized. It can only be populated by the server.
location	The resource location
name	Resource Name NOTE: This property will not be serialized. It can only be populated by the server.
nodeImageVersion	The version of node image
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's Image's OS Type (Linux, Windows)
provisioningState	Provisioning state of the resource NOTE: This property will not be serialized. It can only be populated by the server.
status	Defines the observed state of the agent pool
systemData	Metadata pertaining to creation and last modification of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
tags	Resource tags
type	Resource Type NOTE: This property will not be serialized. It can only be populated by the server.
vmSize	VmSize - The size of the agent pool VMs.

Property Details

availabilityZones

AvailabilityZones - The list of Availability zones to use for nodes. Datacenter racks modelled as zones

availabilityZones?: string[]

Property Value

string[]

count

Count - Number of agents to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.

count?: number

Property Value

number

extendedLocation

Extended Location definition

extendedLocation?: ExtendedLocation

Property Value

ExtendedLocation

id

Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

location

The resource location

location?: string

Property Value

string

name

Resource Name NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

nodeImageVersion

The version of node image

nodeImageVersion?: string

Property Value

string

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

osType

The particular KubernetesVersion's Image's OS Type (Linux, Windows)

osType?: string

Property Value

string

provisioningState

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

provisioningState?: string

Property Value

string

status

Defines the observed state of the agent pool

status?: AgentPoolProvisioningStatusStatus

Property Value

AgentPoolProvisioningStatusStatus

systemData

Metadata pertaining to creation and last modification of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

tags

Resource tags

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

Property Value

{[propertyName: string]: string}

type

Resource Type NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

vmSize

VmSize - The size of the agent pool VMs.

vmSize?: string

Property Value

string