Interface TaskAgentPool

An organization-level grouping of agents.

interface TaskAgentPool {
    agentCloudId?: number;
    autoProvision?: boolean;
    autoSize?: boolean;
    autoUpdate?: boolean;
    createdBy?: IdentityRef;
    createdOn?: Date;
    id?: number;
    isHosted?: boolean;
    isLegacy?: boolean;
    name?: string;
    options?: TaskAgentPoolOptions;
    owner?: IdentityRef;
    poolType?: TaskAgentPoolType;
    properties?: any;
    scope?: string;
    size?: number;
    targetSize?: number;
}

Hierarchy (View Summary)

Properties

agentCloudId? autoProvision? autoSize? autoUpdate? createdBy? createdOn? id? isHosted? isLegacy? name? options? owner? poolType? properties? scope? size? targetSize?

Properties

OptionalagentCloudId

agentCloudId?: number

The ID of the associated agent cloud.

OptionalautoProvision

autoProvision?: boolean

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

OptionalautoSize

autoSize?: boolean

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

OptionalautoUpdate

autoUpdate?: boolean

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

OptionalcreatedBy

createdBy?: IdentityRef

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

OptionalcreatedOn

createdOn?: Date

The date/time of the pool creation.

Optionalid

id?: number

OptionalisHosted

isHosted?: boolean

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

OptionalisLegacy

isLegacy?: boolean

Determines whether the pool is legacy.

Optionalname

name?: string

Optionaloptions

options?: TaskAgentPoolOptions

Additional pool settings and details

Optionalowner

owner?: IdentityRef

Owner or administrator of the pool.

OptionalpoolType

poolType?: TaskAgentPoolType

Gets or sets the type of the pool

Optionalproperties

properties?: any

Optionalscope

scope?: string

Optionalsize

size?: number

Gets the current size of the pool.

OptionaltargetSize

targetSize?: number

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

Settings

Member Visibility

On This Page

Properties