ElasticPool interface
Data and settings for an elastic pool
Properties
| agent |
Set whether agents should be configured to run with interactive UI |
| azure |
Azure string representing to location of the resource |
| desired |
Number of agents to have ready waiting for jobs |
| desired |
The desired size of the pool |
| max |
Maximum number of nodes that will exist in the elastic pool |
| max |
Keep nodes in the pool on failure for investigation |
| offline |
Timestamp the pool was first detected to be offline |
| orchestration |
Operating system type of the nodes in the pool |
| os |
Operating system type of the nodes in the pool |
| pool |
Id of the associated TaskAgentPool |
| recycle |
Discard node after each job completes |
| service |
Id of the Service Endpoint used to connect to Azure |
| service |
Scope the Service Endpoint belongs to |
| sizing |
The number of sizing attempts executed while trying to achieve a desired size |
| state | State of the pool |
| time |
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: booleanProperty Value
boolean
azureId
Azure string representing to location of the resource
azureId: stringProperty Value
string
desiredIdle
Number of agents to have ready waiting for jobs
desiredIdle: numberProperty Value
number
desiredSize
The desired size of the pool
desiredSize: numberProperty Value
number
maxCapacity
Maximum number of nodes that will exist in the elastic pool
maxCapacity: numberProperty Value
number
maxSavedNodeCount
Keep nodes in the pool on failure for investigation
maxSavedNodeCount: numberProperty Value
number
offlineSince
Timestamp the pool was first detected to be offline
offlineSince: DateProperty Value
Date
orchestrationType
Operating system type of the nodes in the pool
orchestrationType: OrchestrationTypeProperty Value
osType
Operating system type of the nodes in the pool
osType: OperatingSystemTypeProperty Value
poolId
Id of the associated TaskAgentPool
poolId: numberProperty Value
number
recycleAfterEachUse
Discard node after each job completes
recycleAfterEachUse: booleanProperty Value
boolean
serviceEndpointId
Id of the Service Endpoint used to connect to Azure
serviceEndpointId: stringProperty Value
string
serviceEndpointScope
Scope the Service Endpoint belongs to
serviceEndpointScope: stringProperty Value
string
sizingAttempts
The number of sizing attempts executed while trying to achieve a desired size
sizingAttempts: numberProperty Value
number
state
timeToLiveMinutes
The minimum time in minutes to keep idle agents alive
timeToLiveMinutes: numberProperty Value
number