Queues - Get

Service:

Task Agent

API Version:

6.0-preview.1

Get information about an agent queue.

GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/queues/{queueId}?api-version=6.0-preview.1

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/queues/{queueId}?actionFilter={actionFilter}&api-version=6.0-preview.1

URI Parameters

Name	In	Required	Type	Description
organization	path	True	string	The name of the Azure DevOps organization.
queueId	path	True	integer int32	The agent queue to get information about
project	path		string	Project ID or project name
api-version	query	True	string	Version of the API to use. This should be set to '6.0-preview.1' to use this version of the api.
actionFilter	query		TaskAgentQueueActionFilter	Filter by whether the calling user has use or manage permissions

Responses

Name	Type	Description
200 OK	TaskAgentQueue	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.agentpools	Grants the ability to view tasks, pools, queues, agents, and currently running or recently completed jobs for agents

Definitions

Name	Description
TaskAgentPoolOptions	Additional pool settings and details
TaskAgentPoolReference
TaskAgentPoolType	Gets or sets the type of the pool
TaskAgentQueue	An agent queue.
TaskAgentQueueActionFilter	Filter by whether the calling user has use or manage permissions

TaskAgentPoolOptions

Additional pool settings and details

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

TaskAgentPoolReference

Name	Type	Description
id	integer
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
size	integer	Gets the current size of the pool.

TaskAgentPoolType

Gets or sets the type of the pool

Name	Type	Description
automation	string	A typical pool of task agents
deployment	string	A deployment pool

TaskAgentQueue

An agent queue.

Name	Type	Description
id	integer	ID of the queue
name	string	Name of the queue
pool	TaskAgentPoolReference	Pool reference for this queue
projectId	string	Project ID

TaskAgentQueueActionFilter

Filter by whether the calling user has use or manage permissions

Name	Type	Description
manage	string
none	string
use	string