Pool - Get

Service:: Environments

API Version:: 7.2-preview.1

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/environments/{environmentId}/providers/virtualmachines/pool?api-version=7.2-preview.1

URI Parameters

Name	In	Required	Type	Description
environmentId	path	True	integer (int32)
organization	path	True	string	The name of the Azure DevOps organization.
project	path	True	string	Project ID or project name
api-version	query	True	string	Version of the API to use. This should be set to '7.2-preview.1' to use this version of the api.

Responses

Name	Type	Description
200 OK	TaskAgentPoolReference	successful operation

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name	Description
vso.environment_manage	Provides ability to manage environment
vso.build	Grants the ability to access build artifacts, including build results, definitions, and requests, and the ability to receive notifications about build events via service hooks.

Definitions

Name	Description
TaskAgentPoolOptions	Additional pool settings and details
TaskAgentPoolReference
TaskAgentPoolType	Gets or sets the type of the pool

TaskAgentPoolOptions

Enumeration

Additional pool settings and details

Value	Description
none
elasticPool	TaskAgentPool backed by the Elastic pool service
singleUseAgents	Set to true if agents are re-imaged after each TaskAgentJobRequest
preserveAgentOnJobFailure	Set to true if agents are held for investigation after a TaskAgentJobRequest failure

TaskAgentPoolReference

Object

Name	Type	Description
id	integer (int32)
isHosted	boolean	Gets or sets a value indicating whether or not this pool is managed by the service.
isLegacy	boolean	Determines whether the pool is legacy.
name	string
options	TaskAgentPoolOptions	Additional pool settings and details
poolType	TaskAgentPoolType	Gets or sets the type of the pool
scope	string (uuid)
size	integer (int32)	Gets the current size of the pool.

TaskAgentPoolType