Optionaloptions: IRequestOptionsStatic ReadonlyRESOURCE_Create an agent pool.
Details about the new agent pool
Create a new agent queue to connect a project to an agent pool.
Details about the queue to create
Optionalproject: stringProject ID or project name
OptionalauthorizePipelines: booleanAutomatically authorize this queue when using YAML
Create a deployment group.
Deployment group to create.
Project ID or project name
Project ID or project name
Project ID or project name
Register a deployment target to a deployment group. Generally this is called by agent configuration tool.
Deployment target to register.
Project ID or project name
ID of the deployment group to which the deployment target is registered.
Create an environment.
Environment to create.
Project ID or project name
Project ID or project name
Create a task group.
Task group object to create.
Project ID or project name
Add a variable group.
Project ID or project name
OptionalpromptOption: AadLoginPromptOptionOptionalcompleteCallbackPayload: stringOptionalcompleteCallbackByAuthCode: booleanOptionalapiVersion: stringOptionalapiVersion: stringCreate a new team project.
Optionalproject: stringProject ID or project name
Delete an agent. You probably don't want to call this endpoint directly. Instead, use the agent configuration script to remove an agent from your organization.
The pool ID to remove the agent from
The agent ID to remove
Delete an agent pool.
ID of the agent pool to delete
Removes an agent queue from a project.
The agent queue to remove
Optionalproject: stringProject ID or project name
Optionalresult: TaskResultOptionalagentShuttingDown: booleanDelete a deployment group.
Project ID or project name
ID of the deployment group to be deleted.
Project ID or project name
Delete a deployment target in a deployment group. This deletes the agent from associated deployment pool too.
Project ID or project name
ID of the deployment group in which deployment target is deleted.
ID of the deployment target to delete.
Delete the specified environment.
Project ID or project name
ID of the environment.
Delete a secure file
Project ID or project name
The unique secure file Id
Delete a task group.
Project ID or project name
Id of the task group to be deleted.
Optionalcomment: stringComments to delete.
Delete a variable group
Id of the variable group.
Download a secure file by Id
Project ID or project name
The unique secure file Id
A valid download ticket
Optionaldownload: booleanIf download is true, the file is sent as attachement in the response body. If download is false, the response body contains the file stream.
GET a PAT token for managing (configuring, removing, tagging) deployment targets in a deployment group.
Project ID or project name
ID of the deployment group in which deployment targets are managed.
GET a PAT token for managing (configuring, removing, tagging) deployment agents in a deployment pool.
ID of the deployment pool in which deployment agents are managed.
Get information about an agent.
The agent pool containing the agent
The agent ID to get information about
OptionalincludeCapabilities: booleanWhether to include the agent's capabilities in the response
OptionalincludeAssignedRequest: booleanWhether to include details about the agent's current work
OptionalincludeLastCompletedRequest: booleanWhether to include details about the agents' most recent completed work
OptionalpropertyFilters: string[]Filter which custom properties will be returned
Get agent cloud types.
Get information about an agent pool.
An agent pool ID
Optionalproperties: string[]Agent pool properties (comma-separated)
OptionalactionFilter: TaskAgentPoolActionFilterFilter by whether the calling user has use or manage permissions
OptionaldefinitionId: numberGet a list of agent pools.
OptionalpoolName: stringFilter by name
Optionalproperties: string[]Filter by agent pool properties (comma-separated)
OptionalpoolType: TaskAgentPoolTypeFilter by pool type
OptionalactionFilter: TaskAgentPoolActionFilterFilter by whether the calling user has use or manage permissions
Get a list of agent pools.
pool Ids to fetch
OptionalactionFilter: TaskAgentPoolActionFilterFilter by whether the calling user has use or manage permissions
Get information about an agent queue.
The agent queue to get information about
Optionalproject: stringProject ID or project name
OptionalactionFilter: TaskAgentQueueActionFilterFilter by whether the calling user has use or manage permissions
Get a list of agent queues.
Optionalproject: stringProject ID or project name
OptionalqueueName: stringFilter on the agent queue name
OptionalactionFilter: TaskAgentQueueActionFilterFilter by whether the calling user has use or manage permissions
Get a list of agent queues by their IDs
A comma-separated list of agent queue IDs to retrieve
Optionalproject: stringProject ID or project name
OptionalactionFilter: TaskAgentQueueActionFilterFilter by whether the calling user has use or manage permissions
Get a list of agent queues by their names
A comma-separated list of agent names to retrieve
Optionalproject: stringProject ID or project name
OptionalactionFilter: TaskAgentQueueActionFilterFilter by whether the calling user has use or manage permissions
Get a list of agent queues by pool ids
A comma-separated list of pool ids to get the corresponding queues for
Optionalproject: stringProject ID or project name
OptionalactionFilter: TaskAgentQueueActionFilterFilter by whether the calling user has use or manage permissions
OptionalincludeStatus: booleanOptionalcontinuationToken: stringOptionalcompletedRequestCount: numberOptionalagentIds: number[]OptionalcompletedRequestCount: numberProject ID or project name
OptionalcompletedRequestCount: numberProject ID or project name
OptionalmachineIds: number[]OptionalcompletedRequestCount: numberGet agent requests for a deployment target.
Project ID or project name
ID of the deployment group to which the target belongs.
ID of the deployment target.
OptionalcompletedRequestCount: numberMaximum number of completed requests to return. Default is 50
Get agent requests for a list deployment targets.
Project ID or project name
ID of the deployment group to which the targets belong.
OptionaltargetIds: number[]Comma separated list of IDs of the deployment targets.
OptionalownerId: numberId of owner of agent job request.
OptionalcompletedOn: DateDatetime to return request after this time.
OptionalcompletedRequestCount: numberMaximum number of completed requests to return for each target. Default is 50
OptionaljobId: stringProject ID or project name
OptionalcontinuationToken: stringGet a list of agents.
The agent pool containing the agents
OptionalagentName: stringFilter on agent name
OptionalincludeCapabilities: booleanWhether to include the agents' capabilities in the response
OptionalincludeAssignedRequest: booleanWhether to include details about the agents' current work
OptionalincludeLastCompletedRequest: booleanWhether to include details about the agents' most recent completed work
OptionalpropertyFilters: string[]Filter which custom properties will be returned
Optionaldemands: string[]Filter by demands the agents can satisfy
Returns list of azure subscriptions
Returns list of azure subscriptions
Get a deployment group by its ID.
Project ID or project name
ID of the deployment group.
OptionalactionFilter: DeploymentGroupActionFilterGet the deployment group only if this action can be performed on it.
Optionalexpand: DeploymentGroupExpandsInclude these additional details in the returned object.
Get a list of deployment groups by name or IDs.
Project ID or project name
Optionalname: stringName of the deployment group.
OptionalactionFilter: DeploymentGroupActionFilterGet only deployment groups on which this action can be performed.
Optionalexpand: DeploymentGroupExpandsInclude these additional details in the returned objects.
OptionalcontinuationToken: stringGet deployment groups with names greater than this continuationToken lexicographically.
Optionaltop: numberMaximum number of deployment groups to return. Default is 1000.
Optionalids: number[]Comma separated list of IDs of the deployment groups.
Get a list of deployment group metrics.
Project ID or project name
OptionaldeploymentGroupName: stringName of the deployment group.
OptionalcontinuationToken: stringGet metrics for deployment groups with names greater than this continuationToken lexicographically.
Optionaltop: numberMaximum number of deployment group metrics to return. Default is 50.
Project ID or project name
Optionalexpand: DeploymentMachineExpandsProject ID or project name
OptionalactionFilter: MachineGroupActionFilterProject ID or project name
OptionaltagFilters: string[]Project ID or project name
OptionalmachineGroupName: stringOptionalactionFilter: MachineGroupActionFilterProject ID or project name
Optionaltags: string[]Optionalname: stringOptionalexpand: DeploymentMachineExpandsGet a list of deployment pool summaries.
OptionalpoolName: stringName of the deployment pool.
Optionalexpands: DeploymentPoolSummaryExpandsInclude these additional details in the returned objects.
OptionalpoolIds: number[]List of deployment pool ids.
Get a deployment target by its ID in a deployment group
Project ID or project name
ID of the deployment group to which deployment target belongs.
ID of the deployment target to return.
Optionalexpand: DeploymentTargetExpandsInclude these additional details in the returned objects.
Get a list of deployment targets in a deployment group.
Project ID or project name
ID of the deployment group.
Optionaltags: string[]Get only the deployment targets that contain all these comma separted list of tags.
Optionalname: stringName pattern of the deployment targets to return.
OptionalpartialNameMatch: booleanWhen set to true, treats name as pattern. Else treats it as absolute match. Default is false.
Optionalexpand: DeploymentTargetExpandsInclude these additional details in the returned objects.
OptionalagentStatus: TaskAgentStatusFilterGet only deployment targets that have this status.
OptionalagentJobResult: TaskAgentJobResultFilterGet only deployment targets that have this last job result.
OptionalcontinuationToken: stringGet deployment targets with names greater than this continuationToken lexicographically.
Optionaltop: numberMaximum number of deployment targets to return. Default is 1000.
Optionalenabled: booleanGet only deployment targets that are enabled or disabled. Default is 'null' which returns all the targets.
OptionalpropertyFilters: string[]Get an environment by its ID.
Project ID or project name
ID of the environment.
Optionalexpands: EnvironmentExpandsInclude these additional details in the returned objects.
Get environment deployment execution history
Project ID or project name
OptionalcontinuationToken: stringOptionaltop: numberGet all environments.
Project ID or project name
Optionalname: stringOptionalcontinuationToken: stringOptionaltop: numberProject ID or project name
OptionallastMessageId: numberOptionalplatform: stringOptionaltop: numberOptionalparallelismTag: stringOptionalpoolIsHosted: booleanOptionalincludeRunningRequests: booleanGet a secure file
Project ID or project name
The unique secure file Id
OptionalincludeDownloadTicket: booleanIf includeDownloadTicket is true and the caller has permissions, a download ticket is included in the response.
OptionalactionFilter: SecureFileActionFilterGet secure files
Project ID or project name
OptionalnamePattern: stringName of the secure file to match. Can include wildcards to match multiple files.
OptionalincludeDownloadTickets: booleanIf includeDownloadTickets is true and the caller has permissions, a download ticket for each secure file is included in the response.
OptionalactionFilter: SecureFileActionFilterFilter by secure file permissions for View, Manage or Use action. Defaults to View.
Get secure files
Project ID or project name
A list of secure file Ids
OptionalincludeDownloadTickets: booleanIf includeDownloadTickets is true and the caller has permissions, a download ticket for each secure file is included in the response.
OptionalactionFilter: SecureFileActionFilterGet secure files
Project ID or project name
A list of secure file Ids
OptionalincludeDownloadTickets: booleanIf includeDownloadTickets is true and the caller has permissions, a download ticket for each secure file is included in the response.
OptionalactionFilter: SecureFileActionFilterGet task group.
Project ID or project name
Id of the task group.
version specification of the task group. examples: 1, 1.0.
Optionalexpand: TaskGroupExpandsThe properties that should be expanded. example $expand=Tasks will expand nested task groups.
Project ID or project name
List task groups.
Project ID or project name
OptionaltaskGroupId: stringId of the task group.
Optionalexpanded: boolean'true' to recursively expand task groups. Default is 'false'.
OptionaltaskIdFilter: stringGuid of the taskId to filter.
Optionaldeleted: boolean'true'to include deleted task groups. Default is 'false'.
Optionaltop: numberNumber of task groups to get.
OptionalcontinuationToken: DateGets the task groups after the continuation token provided.
OptionalqueryOrder: TaskGroupQueryOrderGets the results in the defined order. Default is 'CreatedOnDescending'.
OptionalincludeEnterpriseUsersCount: booleanOptionalincludeHostedAgentMinutesCount: booleanGet a variable group.
Project ID or project name
Id of the variable group.
Get variable groups.
Project ID or project name
OptionalgroupName: stringName of variable group.
OptionalactionFilter: VariableGroupActionFilterAction filter for the variable group. It specifies the action which can be performed on the variable groups.
Optionaltop: numberNumber of variable groups to get.
OptionalcontinuationToken: numberGets the variable groups after the continuation token provided.
OptionalqueryOrder: VariableGroupQueryOrderGets the results in the defined order. Default is 'IdDescending'.
Get variable groups by ids.
Project ID or project name
Comma separated list of Ids of variable groups.
OptionalloadSecrets: booleanProject ID or project name
Project ID or project name
OptionalcontinuationToken: stringOptionalname: stringOptionalpartialNameMatch: booleanOptionaltags: string[]Optionaltop: numberGET the Yaml schema used for Yaml file validation.
OptionalvalidateTaskNames: booleanWhether the schema should validate that tasks are actually installed (useful for offline tools where you don't want validation).
Checks if current identity has passed permissions on a pool.
Id of the pool to check
Permissions to check. Multiple permissions might be merged into single value using bitwise OR operator (e.g. AgentPoolPermissions.Manage | AgentPoolPermissions.View)
Project ID or project name
Proxy for a GET request defined by an 'endpoint'. The request is authorized using a service connection. The response is filtered using an XPath/Json based selector.
Describes the URL to fetch.
Query secure files using a name pattern and a condition on file properties.
The main condition syntax is described here. Use the property('property-name') function to access the value of the specified property of a secure file. It returns null if the property is not set. E.g. and( eq( property('devices'), '2' ), in( property('provisioning profile type'), 'ad hoc', 'development' ) )
Project ID or project name
OptionalnamePattern: stringName of the secure file to match. Can include wildcards to match multiple files.
Project ID or project name
Project ID or project name
Upgrade the deployment targets in a deployment group.
Project ID or project name
ID of the deployment group.
Replace an agent. You probably don't want to call this endpoint directly. Instead, use the agent configuration script to remove and reconfigure an agent from your organization.
Updated details about the replacing agent
The agent pool to use
The agent to replace
Project ID or project name
Replace a deployment target in a deployment group. Generally this is called by agent configuration tool.
New deployment target.
Project ID or project name
ID of the deployment group in which deployment target is replaced.
ID of the deployment target to replace.
Add a variable group.
Update properties on an agent pool
Updated agent pool details
The agent pool to update
OptionalupdateOptions: TaskAgentRequestUpdateOptionsUpdate a deployment group.
Deployment group to update.
Project ID or project name
ID of the deployment group.
Project ID or project name
Project ID or project name
Project ID or project name
Project ID or project name
Update a deployment target and its agent properties in a deployment group. Generally this is called by agent configuration tool.
Deployment target to update.
Project ID or project name
ID of the deployment group in which deployment target is updated.
ID of the deployment target to update.
Update tags of a list of deployment targets in a deployment group.
Deployment targets with tags to udpdate.
Project ID or project name
ID of the deployment group in which deployment targets are updated.
Update the specified environment.
Environment data to update.
Project ID or project name
ID of the environment.
Update the name or properties of an existing secure file
The secure file with updated name and/or properties
Project ID or project name
The unique secure file Id
Update properties and/or names of a set of secure files. Files are identified by their IDs. Properties provided override the existing one entirely, i.e. do not merge.
A list of secure file objects. Only three field must be populated Id, Name, and Properties. The rest of fields in the object are ignored.
Project ID or project name
Update a task group.
Task group to update.
Project ID or project name
OptionaltaskGroupId: stringId of the task group to update.
Project ID or project name
OptionaldisablePriorVersions: booleanUpdate a variable group.
Id of the variable group to update.
Project ID or project name
Project ID or project name
Upload a secure file, include the file stream in the request body
Content to upload
Project ID or project name
Name of the file to upload
OptionalauthorizePipelines: booleanIf authorizePipelines is true, then the secure file is authorized for use by all pipelines in the project.
Adds an agent to a pool. You probably don't want to call this endpoint directly. Instead, configure an agent using the agent download package.