TaskAgent interface

Package:

azure-devops-extension-api

A task agent.

Extends

TaskAgentReference

Properties

assignedAgentCloudRequest	The agent cloud request that's currently associated with this agent.
assignedRequest	The request which is currently assigned to this agent.
authorization	Authorization information for this agent.
createdOn	Date on which this agent was created.
lastCompletedRequest	The last request which was completed by this agent.
maxParallelism	Maximum job parallelism allowed for this agent.
pendingUpdate	Pending update for this agent.
properties
statusChangedOn	Date on which the last connectivity status change occurred.
systemCapabilities	System-defined capabilities supported by this agent's host. Warning: To set capabilities use the PUT method, PUT will completely overwrite existing capabilities.
userCapabilities	User-defined capabilities supported by this agent's host. Warning: To set capabilities use the PUT method, PUT will completely overwrite existing capabilities.

Inherited Properties

accessPoint	This agent's access point.
enabled	Whether or not this agent should run jobs.
id	Identifier of the agent.
name	Name of the agent.
osDescription	Agent OS.
provisioningState	Provisioning state of this agent.
status	Whether or not the agent is online.
version	Agent version.

Property Details

assignedAgentCloudRequest

The agent cloud request that's currently associated with this agent.

assignedAgentCloudRequest: TaskAgentCloudRequest

Property Value

TaskAgentCloudRequest

assignedRequest

The request which is currently assigned to this agent.

assignedRequest: TaskAgentJobRequest

Property Value

TaskAgentJobRequest

authorization

Authorization information for this agent.

authorization: TaskAgentAuthorization

Property Value

TaskAgentAuthorization

createdOn

Date on which this agent was created.

createdOn: Date

Property Value

Date

lastCompletedRequest

The last request which was completed by this agent.

lastCompletedRequest: TaskAgentJobRequest

Property Value

TaskAgentJobRequest

maxParallelism

Maximum job parallelism allowed for this agent.

maxParallelism: number

Property Value

number

pendingUpdate

Pending update for this agent.

pendingUpdate: TaskAgentUpdate

Property Value

TaskAgentUpdate

properties

properties: any

Property Value

any

statusChangedOn

Date on which the last connectivity status change occurred.

statusChangedOn: Date

Property Value

Date

systemCapabilities

System-defined capabilities supported by this agent's host. Warning: To set capabilities use the PUT method, PUT will completely overwrite existing capabilities.

systemCapabilities: {[key: string]: string}

Property Value

{[key: string]: string}

userCapabilities

User-defined capabilities supported by this agent's host. Warning: To set capabilities use the PUT method, PUT will completely overwrite existing capabilities.

userCapabilities: {[key: string]: string}

Property Value

{[key: string]: string}

Inherited Property Details

accessPoint

This agent's access point.

accessPoint: string

Property Value

string

Inherited From TaskAgentReference.accessPoint

enabled

Whether or not this agent should run jobs.

enabled: boolean

Property Value

boolean

Inherited From TaskAgentReference.enabled

id

Identifier of the agent.

id: number

Property Value

number

Inherited From TaskAgentReference.id

name

Name of the agent.

name: string

Property Value

string

Inherited From TaskAgentReference.name

osDescription

Agent OS.

osDescription: string

Property Value

string

Inherited From TaskAgentReference.osDescription

provisioningState

Provisioning state of this agent.

provisioningState: string

Property Value

string

Inherited From TaskAgentReference.provisioningState

status

Whether or not the agent is online.

status: TaskAgentStatus

Property Value

TaskAgentStatus

Inherited From TaskAgentReference.status

version

Agent version.

version: string

Property Value

string

Inherited From TaskAgentReference.version