TaskAgentPool interface

Package:

azure-devops-extension-api

An organization-level grouping of agents.

Extends

TaskAgentPoolReference

Properties

agentCloudId	The ID of the associated agent cloud.
autoProvision	Whether or not a queue should be automatically provisioned for each project collection.
autoSize	Whether or not the pool should autosize itself based on the Agent Cloud Provider settings.
autoUpdate	Whether or not agents in this pool are allowed to automatically update
createdBy	Creator of the pool. The creator of the pool is automatically added into the administrators group for the pool on creation.
createdOn	The date/time of the pool creation.
owner	Owner or administrator of the pool.
properties
targetSize	Target parallelism - Only applies to agent pools that are backed by pool providers. It will be null for regular pools.

Inherited Properties

id
isHosted	Gets or sets a value indicating whether or not this pool is managed by the service.
isLegacy	Determines whether the pool is legacy.
name
options	Additional pool settings and details
poolType	Gets or sets the type of the pool
scope
size	Gets the current size of the pool.

Property Details

agentCloudId

The ID of the associated agent cloud.

agentCloudId: number

Property Value

number

autoProvision

Whether or not a queue should be automatically provisioned for each project collection.

autoProvision: boolean

Property Value

boolean

autoSize

Whether or not the pool should autosize itself based on the Agent Cloud Provider settings.

autoSize: boolean

Property Value

boolean

autoUpdate

Whether or not agents in this pool are allowed to automatically update

autoUpdate: boolean

Property Value

boolean

createdBy

Creator of the pool. The creator of the pool is automatically added into the administrators group for the pool on creation.

createdBy: IdentityRef

Property Value

IdentityRef

createdOn

The date/time of the pool creation.

createdOn: Date

Property Value

Date

owner

Owner or administrator of the pool.

owner: IdentityRef

Property Value

IdentityRef

properties

properties: any

Property Value

any

targetSize

Target parallelism - Only applies to agent pools that are backed by pool providers. It will be null for regular pools.

targetSize: number

Property Value

number

Inherited Property Details

id

id: number

Property Value

number

Inherited From TaskAgentPoolReference.id

isHosted

Gets or sets a value indicating whether or not this pool is managed by the service.

isHosted: boolean

Property Value

boolean

Inherited From TaskAgentPoolReference.isHosted

isLegacy

Determines whether the pool is legacy.

isLegacy: boolean

Property Value

boolean

Inherited From TaskAgentPoolReference.isLegacy

name

name: string

Property Value

string

Inherited From TaskAgentPoolReference.name

options

Additional pool settings and details

options: TaskAgentPoolOptions

Property Value

TaskAgentPoolOptions

Inherited From TaskAgentPoolReference.options

poolType

Gets or sets the type of the pool

poolType: TaskAgentPoolType

Property Value

TaskAgentPoolType

Inherited From TaskAgentPoolReference.poolType

scope

scope: string

Property Value

string

Inherited From TaskAgentPoolReference.scope

size

Gets the current size of the pool.

size: number

Property Value

number

Inherited From TaskAgentPoolReference.size