ElasticPool interface

Package:

azure-devops-extension-api

Data and settings for an elastic pool

Properties

agentInteractiveUI	Set whether agents should be configured to run with interactive UI
azureId	Azure string representing to location of the resource
desiredIdle	Number of agents to have ready waiting for jobs
desiredSize	The desired size of the pool
maxCapacity	Maximum number of nodes that will exist in the elastic pool
maxSavedNodeCount	Keep nodes in the pool on failure for investigation
offlineSince	Timestamp the pool was first detected to be offline
orchestrationType	Operating system type of the nodes in the pool
osType	Operating system type of the nodes in the pool
poolId	Id of the associated TaskAgentPool
recycleAfterEachUse	Discard node after each job completes
serviceEndpointId	Id of the Service Endpoint used to connect to Azure
serviceEndpointScope	Scope the Service Endpoint belongs to
sizingAttempts	The number of sizing attempts executed while trying to achieve a desired size
state	State of the pool
timeToLiveMinutes	The minimum time in minutes to keep idle agents alive

Property Details

agentInteractiveUI

Set whether agents should be configured to run with interactive UI

agentInteractiveUI: boolean

Property Value

boolean

azureId

Azure string representing to location of the resource

azureId: string

Property Value

string

desiredIdle

Number of agents to have ready waiting for jobs

desiredIdle: number

Property Value

number

desiredSize

The desired size of the pool

desiredSize: number

Property Value

number

maxCapacity

Maximum number of nodes that will exist in the elastic pool

maxCapacity: number

Property Value

number

maxSavedNodeCount

Keep nodes in the pool on failure for investigation

maxSavedNodeCount: number

Property Value

number

offlineSince

Timestamp the pool was first detected to be offline

offlineSince: Date

Property Value

Date

orchestrationType

Operating system type of the nodes in the pool

orchestrationType: OrchestrationType

Property Value

OrchestrationType

osType

Operating system type of the nodes in the pool

osType: OperatingSystemType

Property Value

OperatingSystemType

poolId

Id of the associated TaskAgentPool

poolId: number

Property Value

number

recycleAfterEachUse

Discard node after each job completes

recycleAfterEachUse: boolean

Property Value

boolean

serviceEndpointId

Id of the Service Endpoint used to connect to Azure

serviceEndpointId: string

Property Value

string

serviceEndpointScope

Scope the Service Endpoint belongs to

serviceEndpointScope: string

Property Value

string

sizingAttempts

The number of sizing attempts executed while trying to achieve a desired size

sizingAttempts: number

Property Value

number

state

State of the pool

state: ElasticPoolState

Property Value

ElasticPoolState

timeToLiveMinutes

The minimum time in minutes to keep idle agents alive

timeToLiveMinutes: number

Property Value

number