Agents - Replace Agent

服务:

Distributed Task

API 版本:

7.1

替换代理。 你可能不想直接调用此终结点。 相反，使用代理配置脚本 从组织中删除和重新配置代理。

PUT https://dev.azure.com/{organization}/_apis/distributedtask/pools/{poolId}/agents/{agentId}?api-version=7.1

URI 参数

名称	在	必需	类型	说明
agentId	path	True	integer (int32)	要替换的代理
organization	path	True	string	Azure DevOps 组织的名称。
poolId	path	True	integer (int32)	要使用的代理池
api-version	query	True	string	要使用的 API 版本。 这应设置为“7.1”才能使用此版本的 API。

请求正文

名称	类型	说明
_links	ReferenceLinks	表示 REST 引用链接集合的类。
accessPoint	string	此代理的接入点。
assignedAgentCloudRequest	TaskAgentCloudRequest	当前与此代理关联的代理云请求。
assignedRequest	TaskAgentJobRequest	当前分配给此代理的请求。
authorization	TaskAgentAuthorization	此代理的授权信息。
createdOn	string (date-time)	创建此代理的日期。
enabled	boolean	此代理是否应运行作业。
id	integer (int32)	代理的标识符。
lastCompletedRequest	TaskAgentJobRequest	此代理完成的最后一个请求。
maxParallelism	integer (int32)	此代理允许的最大作业并行度。
name	string	代理的名称。
osDescription	string	代理 OS。
pendingUpdate	TaskAgentUpdate	此代理的挂起更新。
properties	PropertiesCollection	类将属性包表示为键值对的集合。 接受除 DBNull 以外的所有基元类型（具有 TypeCode != TypeCode.Object的任何类型）的值。 Byte[]、Int32、Double、DateType 和 String 类型的值将保留其类型，其他基元将重新调整为 String。 Byte[] 应为 base64 编码字符串。
provisioningState	string	此代理的预配状态。
status	TaskAgentStatus	代理是否处于联机状态。
statusChangedOn	string (date-time)	发生上次连接状态更改的日期。
systemCapabilities	object	此代理主机支持的系统定义功能。 警告：若要设置功能，请使用 PUT 方法，PUT 将完全覆盖现有功能。
userCapabilities	object	此代理主机支持的用户定义的功能。 警告：若要设置功能，请使用 PUT 方法，PUT 将完全覆盖现有功能。
version	string	代理版本。

响应

名称	类型	说明
200 OK	TaskAgent	成功作

安全性

oauth2

类型: oauth2
流向: accessCode
授权 URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
令牌 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

作用域

名称	说明
vso.agentpools_manage	授予管理池、队列和代理的能力

定义

名称	说明
Demand
IdentityRef
JObject	表示 JSON 对象。
JToken	表示抽象 JSON 令牌。
PackageVersion
PropertiesCollection	类将属性包表示为键值对的集合。 接受除 DBNull 以外的所有基元类型（具有 TypeCode != TypeCode.Object的任何类型）的值。 Byte[]、Int32、Double、DateType 和 String 类型的值将保留其类型，其他基元将重新调整为 String。 Byte[] 应为 base64 编码字符串。
ReferenceLinks	表示 REST 引用链接集合的类。
TaskAgent	任务代理。
TaskAgentAuthorization	提供使用 OAuth 2.0 身份验证流授权代理所需的数据。
TaskAgentCloudRequest
TaskAgentJobRequest	代理的作业请求。
TaskAgentPoolOptions	其他池设置和详细信息
TaskAgentPoolReference
TaskAgentPoolType	获取或设置池的类型
TaskAgentPublicKey	表示 RSA 非对称密钥的公钥部分。
TaskAgentReference	对代理的引用。
TaskAgentStatus	代理是否处于联机状态。
TaskAgentUpdate	有关代理更新的详细信息。
TaskAgentUpdateReason
TaskAgentUpdateReasonType
TaskOrchestrationOwner
TaskResult	此请求的结果。

Demand

Object

名称	类型	说明
name	string
value	string

IdentityRef

Object

名称	类型	说明
_links	ReferenceLinks	此字段包含有关图形主题的零个或多个有趣的链接。 可以调用这些链接以获取有关此图形主题的其他关系或更详细的信息。
descriptor	string	描述符是在系统运行时引用图形主题的主要方法。 此字段将唯一标识帐户和组织中的同一图形主题。
directoryAlias	string	已弃用 - 可以通过查询 IdentityRef“_links”字典的“self”条目中引用的 Graph 用户来检索
displayName	string	这是图形主题的非唯一显示名称。 若要更改此字段，必须在源提供程序中更改其值。
id	string
imageUrl	string	已弃用 - 在 IdentityRef“_links”字典的“虚拟形象”条目中可用
inactive	boolean	已弃用 - 可以通过查询 GraphUser“_links”字典的“membershipState”条目中引用的 Graph 成员身份状态来检索
isAadIdentity	boolean	已弃用 - 可以从描述符的主题类型推断（Descriptor.IsAadUserType/Descriptor.IsAadGroupType）
isContainer	boolean	已弃用 - 可以从描述符的主题类型推断（描述符.IsGroupType）
isDeletedInOrigin	boolean
profileUrl	string	已弃用 - 不在 ToIdentityRef 的大多数预先存在的实现中使用
uniqueName	string	已弃用 - 请改用 Domain+PrincipalName
url	string	此 URL 是指向此图形主题的源资源的完整路由。

JObject

Object

表示 JSON 对象。

名称	类型	说明
item	JToken	表示抽象 JSON 令牌。
type	string (JTokenType)	获取此 JToken 的节点类型。

JToken

Object

表示抽象 JSON 令牌。

名称	类型	说明
first	JToken	获取此令牌的第一个子令牌。
hasValues	boolean	获取一个值，该值指示此令牌是否具有子令牌。
item	JToken	表示抽象 JSON 令牌。
last	JToken	获取此令牌的最后一个子令牌。
next	JToken	获取此节点的下一个同级标记。
parent	string (JContainer)	获取或设置父级。
path	string	获取 JSON 令牌的路径。
previous	JToken	获取此节点的上一个同级标记。
root	JToken	获取此 JToken 的根 JToken。
type	string (JTokenType)	获取此 JToken 的节点类型。

PackageVersion

Object

名称	类型	说明
major	integer (int32)
minor	integer (int32)
patch	integer (int32)

PropertiesCollection

Object

类将属性包表示为键值对的集合。 接受除 DBNull 以外的所有基元类型（具有 TypeCode != TypeCode.Object的任何类型）的值。 Byte[]、Int32、Double、DateType 和 String 类型的值将保留其类型，其他基元将重新调整为 String。 Byte[] 应为 base64 编码字符串。

名称	类型	说明
count	integer (int32)	集合中的属性计数。
item	object
keys	string[]	集合中的键集。
values	string[]	集合中的值集。

ReferenceLinks

Object

表示 REST 引用链接集合的类。

名称	类型	说明
links	object	链接的只读视图。 由于引用链接是只读的，因此我们只想将其公开为只读链接。

TaskAgent

Object

任务代理。

名称	类型	说明
_links	ReferenceLinks	表示 REST 引用链接集合的类。
accessPoint	string	此代理的接入点。
assignedAgentCloudRequest	TaskAgentCloudRequest	当前与此代理关联的代理云请求。
assignedRequest	TaskAgentJobRequest	当前分配给此代理的请求。
authorization	TaskAgentAuthorization	此代理的授权信息。
createdOn	string (date-time)	创建此代理的日期。
enabled	boolean	此代理是否应运行作业。
id	integer (int32)	代理的标识符。
lastCompletedRequest	TaskAgentJobRequest	此代理完成的最后一个请求。
maxParallelism	integer (int32)	此代理允许的最大作业并行度。
name	string	代理的名称。
osDescription	string	代理 OS。
pendingUpdate	TaskAgentUpdate	此代理的挂起更新。
properties	PropertiesCollection	类将属性包表示为键值对的集合。 接受除 DBNull 以外的所有基元类型（具有 TypeCode != TypeCode.Object的任何类型）的值。 Byte[]、Int32、Double、DateType 和 String 类型的值将保留其类型，其他基元将重新调整为 String。 Byte[] 应为 base64 编码字符串。
provisioningState	string	此代理的预配状态。
status	TaskAgentStatus	代理是否处于联机状态。
statusChangedOn	string (date-time)	发生上次连接状态更改的日期。
systemCapabilities	object	此代理主机支持的系统定义功能。 警告：若要设置功能，请使用 PUT 方法，PUT 将完全覆盖现有功能。
userCapabilities	object	此代理主机支持的用户定义的功能。 警告：若要设置功能，请使用 PUT 方法，PUT 将完全覆盖现有功能。
version	string	代理版本。

TaskAgentAuthorization

Object

提供使用 OAuth 2.0 身份验证流授权代理所需的数据。

名称	类型	说明
authorizationUrl	string	用于从配置的令牌服务获取访问令牌的终结点。
clientId	string (uuid)	此代理的客户端标识符。
publicKey	TaskAgentPublicKey	用于验证此代理的标识的公钥。

TaskAgentCloudRequest

Object

名称	类型	说明
agent	TaskAgentReference	对代理的引用。
agentCloudId	integer (int32)
agentConnectedTime	string (date-time)
agentData	JObject	表示 JSON 对象。
agentSpecification	JObject	表示 JSON 对象。
pool	TaskAgentPoolReference
provisionRequestTime	string (date-time)
provisionedTime	string (date-time)
releaseRequestTime	string (date-time)
requestId	string (uuid)

TaskAgentJobRequest

Object

代理的作业请求。

名称	类型	说明
agentSpecification	JObject	表示 JSON 对象。
assignTime	string (date-time)	分配此请求的日期/时间。
data	object	有关请求的其他数据。
definition	TaskOrchestrationOwner	与此请求关联的管道定义
demands	Demand[]	满足此请求所需的要求列表。
finishTime	string (date-time)	完成此请求的日期/时间。
hostId	string (uuid)	触发此请求的主机。
jobId	string (uuid)	由此请求生成的作业的 ID。
jobName	string	由此请求生成的作业的名称。
lockedUntil	string (date-time)	代理续订锁定的最后期限。
matchedAgents	TaskAgentReference[]	对代理的引用。
matchesAllAgentsInPool	boolean
orchestrationId	string
owner	TaskOrchestrationOwner	与此请求关联的管道
planGroup	string
planId	string (uuid)	连接到此请求的业务流程计划的内部 ID。
planType	string	表示业务流程计划类型的内部详细信息。
poolId	integer (int32)	此请求面向的池的 ID
priority	integer (int32)
queueId	integer (int32)	此请求面向的队列的 ID
queueTime	string (date-time)	此请求已排队的日期/时间。
receiveTime	string (date-time)	代理收回此请求的日期/时间。
requestId	integer (int64)	请求的 ID。
reservedAgent	TaskAgentReference	为此请求分配的代理。
result	TaskResult	此请求的结果。
scopeId	string (uuid)	管道的范围;匹配项目 ID。
serviceOwner	string (uuid)	拥有此请求的服务。
statusMessage	string
userDelayed	boolean

TaskAgentPoolOptions

枚举

其他池设置和详细信息

值	说明
elasticPool	由弹性池服务支持的 TaskAgentPool
none
preserveAgentOnJobFailure	如果在 TaskAgentJobRequest 失败后保留代理进行调查，则设置为 true
singleUseAgents	如果代理在每个 TaskAgentJobRequest 之后重新映像，则设置为 true

TaskAgentPoolReference

Object

名称	类型	说明
id	integer (int32)
isHosted	boolean	获取或设置一个值，该值指示此池是否由服务管理。
isLegacy	boolean	确定池是否为旧池。
name	string
options	TaskAgentPoolOptions	其他池设置和详细信息
poolType	TaskAgentPoolType	获取或设置池的类型
scope	string (uuid)
size	integer (int32)	获取池的当前大小。

TaskAgentPoolType

枚举

获取或设置池的类型

值	说明
automation	任务代理的典型池
deployment	部署池

TaskAgentPublicKey

Object

表示 RSA 非对称密钥的公钥部分。

名称	类型	说明
exponent	string[] (byte)	获取或设置公钥的指数。
modulus	string[] (byte)	获取或设置公钥的模数。

TaskAgentReference

Object

对代理的引用。

名称	类型	说明
_links	ReferenceLinks	表示 REST 引用链接集合的类。
accessPoint	string	此代理的接入点。
enabled	boolean	此代理是否应运行作业。
id	integer (int32)	代理的标识符。
name	string	代理的名称。
osDescription	string	代理 OS。
provisioningState	string	此代理的预配状态。
status	TaskAgentStatus	代理是否处于联机状态。
version	string	代理版本。

TaskAgentStatus

枚举

代理是否处于联机状态。

值	说明
offline
online

TaskAgentUpdate

Object

有关代理更新的详细信息。

名称	类型	说明
currentState	string	此代理更新的当前状态。
reason	TaskAgentUpdateReason	此更新的原因。
requestTime	string (date-time)	请求此更新的日期。
requestedBy	IdentityRef	请求此更新的标识。
sourceVersion	PackageVersion	更新的源代理版本。
targetVersion	PackageVersion	更新的目标代理版本。

TaskAgentUpdateReason

Object

名称	类型	说明
code	TaskAgentUpdateReasonType

TaskAgentUpdateReasonType

枚举

值	说明
downgrade
manual
minAgentVersionRequired

TaskOrchestrationOwner

Object

名称	类型	说明
_links	ReferenceLinks	表示 REST 引用链接集合的类。
id	integer (int32)
name	string

TaskResult

枚举

此请求的结果。

值	说明
abandoned
canceled
failed
skipped
succeeded
succeededWithIssues