Elasticpools - Update
Update settings on a specified Elastic Pool.
PATCH https://dev.azure.com/{organization}/_apis/distributedtask/elasticpools/{poolId}?api-version=7.0URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
organization
|
path | True |
string |
The name of the Azure DevOps organization. |
|
pool
|
path | True |
integer (int32) |
|
|
api-version
|
query | True |
string |
Version of the API to use. This should be set to '7.0' to use this version of the api. |
Request Body
| Name | Type | Description |
|---|---|---|
| agentInteractiveUI |
boolean |
Set whether agents should be configured to run with interactive UI |
| azureId |
string |
Azure string representing to location of the resource |
| desiredIdle |
integer (int32) |
Number of machines to have ready waiting for jobs |
| maxCapacity |
integer (int32) |
Maximum number of machines that will exist in the elastic pool |
| maxSavedNodeCount |
integer (int32) |
Keep machines in the pool on failure for investigation |
| osType |
Operating system type of the machines in the pool |
|
| recycleAfterEachUse |
boolean |
Discard machines after each job completes |
| serviceEndpointId |
string (uuid) |
Id of the Service Endpoint used to connect to Azure |
| serviceEndpointScope |
string (uuid) |
Scope the Service Endpoint belongs to |
| timeToLiveMinutes |
integer (int32) |
The minimum time in minutes to keep idle agents alive |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
successful operation |
Security
accessToken
Personal access token. Use any value for the user name and the token as the password.
Type:
basic
Definitions
| Name | Description |
|---|---|
|
Elastic |
Data and settings for an elastic pool |
|
Elastic |
Class used for updating an elastic pool where only certain members are populated |
|
Elastic |
State of the pool |
|
Operating |
Operating system type of the nodes in the pool |
ElasticPool
Data and settings for an elastic pool
| Name | Type | Description |
|---|---|---|
| agentInteractiveUI |
boolean |
Set whether agents should be configured to run with interactive UI |
| azureId |
string |
Azure string representing to location of the resource |
| desiredIdle |
integer (int32) |
Number of agents to have ready waiting for jobs |
| desiredSize |
integer (int32) |
The desired size of the pool |
| maxCapacity |
integer (int32) |
Maximum number of nodes that will exist in the elastic pool |
| maxSavedNodeCount |
integer (int32) |
Keep nodes in the pool on failure for investigation |
| offlineSince |
string (date-time) |
Timestamp the pool was first detected to be offline |
| osType |
Operating system type of the nodes in the pool |
|
| poolId |
integer (int32) |
Id of the associated TaskAgentPool |
| recycleAfterEachUse |
boolean |
Discard node after each job completes |
| serviceEndpointId |
string (uuid) |
Id of the Service Endpoint used to connect to Azure |
| serviceEndpointScope |
string (uuid) |
Scope the Service Endpoint belongs to |
| sizingAttempts |
integer (int32) |
The number of sizing attempts executed while trying to achieve a desired size |
| state |
State of the pool |
|
| timeToLiveMinutes |
integer (int32) |
The minimum time in minutes to keep idle agents alive |
ElasticPoolSettings
Class used for updating an elastic pool where only certain members are populated
| Name | Type | Description |
|---|---|---|
| agentInteractiveUI |
boolean |
Set whether agents should be configured to run with interactive UI |
| azureId |
string |
Azure string representing to location of the resource |
| desiredIdle |
integer (int32) |
Number of machines to have ready waiting for jobs |
| maxCapacity |
integer (int32) |
Maximum number of machines that will exist in the elastic pool |
| maxSavedNodeCount |
integer (int32) |
Keep machines in the pool on failure for investigation |
| osType |
Operating system type of the machines in the pool |
|
| recycleAfterEachUse |
boolean |
Discard machines after each job completes |
| serviceEndpointId |
string (uuid) |
Id of the Service Endpoint used to connect to Azure |
| serviceEndpointScope |
string (uuid) |
Scope the Service Endpoint belongs to |
| timeToLiveMinutes |
integer (int32) |
The minimum time in minutes to keep idle agents alive |
ElasticPoolState
State of the pool
| Value | Description |
|---|---|
| new | |
| offline | |
| online |
Online and healthy |
| unhealthy |
OperatingSystemType
Operating system type of the nodes in the pool
| Value | Description |
|---|---|
| linux | |
| windows |