Deploymentgroups - Update

参考

服务:: Task Agent

API 版本:: 5.0-preview.1

更新部署组。

PATCH https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}?api-version=5.0-preview.1

URI 参数

名称	在	必需	类型	说明
deploymentGroupId	path	True	integer int32	部署组的 ID。
organization	path	True	string	Azure DevOps 组织的名称。
project	path	True	string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。应将其设置为“5.0-preview.1”才能使用此版本的 API。

请求正文

名称	类型	说明
description	string	部署组的说明。
name	string	部署组的名称。

响应

名称	类型	说明
200 OK	DeploymentGroup	成功的操作

安全性

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.machinegroup_manage	提供管理部署组和代理池的功能

示例

Update a deployment group

示例请求

HTTP

PATCH https://dev.azure.com/fabrikam/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}?api-version=5.0-preview.1

{
  "name": "MyDeploymentGroup1-Update1",
  "description": "Description of this deployment group is updated"
}

示例响应

状态代码:: 200

{
  "machineCount": 0,
  "description": "Description of this deployment group is updated",
  "id": 11,
  "project": {
    "id": "91879ed9-819b-46f3-9e0b-52ed4b20c04c",
    "name": "DeploymentGroupRESTSample"
  },
  "name": "MyDeploymentGroup1-Update1",
  "pool": {
    "id": 6,
    "isHosted": false,
    "poolType": "deployment",
    "size": 0
  }
}

定义

名称	说明
Demand
DeploymentGroup	部署组。
DeploymentGroupUpdateParameter	部署组更新参数。
DeploymentMachine	部署目标。
IdentityRef
JObject
JToken
PackageVersion
ProjectReference
PropertiesCollection	类将属性包表示为键值对的集合。接受所有基元类型的值 (除 `TypeCode != TypeCode.Object`) 以外的 `DBNull` 任何类型。 Byte[]、Int32、Double、DateType 和 String 类型的值保留其类型，其他基元将重新优化为 String。 Byte[] 预期为 base64 编码字符串。
ReferenceLinks	表示 REST 引用链接集合的类。
TaskAgent
TaskAgentAuthorization	提供使用 OAuth 2.0 身份验证流授权代理所需的数据。
TaskAgentCloudRequest
TaskAgentDelaySource
TaskAgentJobRequest
TaskAgentPoolReference
TaskAgentPoolType	获取或设置池的类型
TaskAgentPublicKey	表示 RSA 非对称密钥的公钥部分。
TaskAgentReference
TaskAgentStatus	获取代理的当前连接状态。
TaskAgentUpdate
TaskAgentUpdateReason
TaskAgentUpdateReasonType
TaskOrchestrationOwner
TaskResult

Demand

Object

名称	类型	说明
name	string
value	string

DeploymentGroup

Object

部署组。

名称	类型	说明
description	string	部署组的说明。
id	integer	部署组标识符。
machineCount	integer	部署组中的部署目标数。
machineTags	string[]	部署组中所有部署目标的唯一标记列表。
machines	DeploymentMachine[]	部署组中的部署目标列表。
name	string	部署组的名称。
pool	TaskAgentPoolReference	在其中注册部署代理的部署池。
project	ProjectReference	部署组所属的项目。

DeploymentGroupUpdateParameter

Object

部署组更新参数。

名称	类型	说明
description	string	部署组的说明。
name	string	部署组的名称。

DeploymentMachine

Object

部署目标。

名称	类型	说明
agent	TaskAgent	部署代理。
id	integer	部署目标标识符。
tags	string[]	部署目标的标记。

IdentityRef

Object

名称	类型	说明
_links	ReferenceLinks	此字段包含有关图形主题的零个或多个相关链接。可以调用这些链接来获取有关此图主题的其他关系或更多详细信息。
descriptor	string	描述符是在系统运行时引用图形主题的主要方式。此字段将唯一标识帐户和组织中的同一图形主题。
directoryAlias	string
displayName	string	这是图形主题的非唯一显示名称。若要更改此字段，必须在源提供程序中更改其值。
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	此 URL 是此图主题的源资源的完整路由。

JObject

Object

名称	类型	说明
item	JToken
type	string

JToken

Object

名称	类型	说明
first	JToken
hasValues	boolean
item	JToken
last	JToken
next	JToken
parent	string
path	string
previous	JToken
root	JToken
type	string

PackageVersion

Object

名称	类型	说明
major	integer
minor	integer
patch	integer

ProjectReference

Object

名称	类型	说明
id	string
name	string

PropertiesCollection

Object

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

名称	类型	说明
count	integer	集合中属性的计数。
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	获取此代理的创建日期。
enabled	boolean	获取或设置一个值，该值指示是否应为作业执行启用此代理。
id	integer	获取代理的标识符。
lastCompletedRequest	TaskAgentJobRequest	获取此代理完成的最后一个请求。
maxParallelism	integer	获取或设置此主机上允许的最大作业并行度。
name	string	获取代理的名称。
oSDescription	string	获取代理的 OS。
pendingUpdate	TaskAgentUpdate	获取此代理的挂起更新。
properties	PropertiesCollection	类将属性包表示为键值对的集合。接受所有基元类型的值 (除 `TypeCode != TypeCode.Object`) 以外的 `DBNull` 任何类型。 Byte[]、Int32、Double、DateType 和 String 类型的值保留其类型，其他基元将重新优化为 String。 Byte[] 预期为 base64 编码字符串。
provisioningState	string	获取或设置此代理的当前预配状态
status	TaskAgentStatus	获取代理的当前连接状态。
statusChangedOn	string	获取上次连接状态更改发生的日期。
systemCapabilities	object
userCapabilities	object
version	string	获取代理的版本。

TaskAgentAuthorization

Object

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

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

TaskAgentCloudRequest

Object

名称	类型	说明
agent	TaskAgentReference
agentCloudId	integer
agentConnectedTime	string
agentData	JObject
agentSpecification	JObject
pool	TaskAgentPoolReference
provisionRequestTime	string
provisionedTime	string
releaseRequestTime	string
requestId	string

TaskAgentDelaySource

Object

名称	类型	说明
delays	string[]
taskAgent	TaskAgentReference

TaskAgentJobRequest

Object

名称	类型	说明
agentDelays	TaskAgentDelaySource[]
agentSpecification	JObject
assignTime	string
data	object
definition	TaskOrchestrationOwner
demands	Demand[]
expectedDuration	string
finishTime	string
hostId	string
jobId	string
jobName	string
lockedUntil	string
matchedAgents	TaskAgentReference[]
orchestrationId	string
owner	TaskOrchestrationOwner
planGroup	string
planId	string
planType	string
poolId	integer
queueId	integer
queueTime	string
receiveTime	string
requestId	integer
reservedAgent	TaskAgentReference
result	TaskResult
scopeId	string
serviceOwner	string

TaskAgentPoolReference

Object

名称	类型	说明
id	integer
isHosted	boolean	获取或设置一个值，该值指示此池是否由服务管理。
name	string
poolType	TaskAgentPoolType	获取或设置池的类型
scope	string
size	integer	获取池的当前大小。

TaskAgentPoolType

Enumeration

获取或设置池的类型

值	说明
automation
deployment

TaskAgentPublicKey

Object

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

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

TaskAgentReference

Object

名称	类型	说明
_links	ReferenceLinks	表示 REST 引用链接集合的类。
accessPoint	string	获取代理的接入点。
enabled	boolean	获取或设置一个值，该值指示是否应为作业执行启用此代理。
id	integer	获取代理的标识符。
name	string	获取代理的名称。
oSDescription	string	获取代理的 OS。
provisioningState	string	获取或设置此代理的当前预配状态
status	TaskAgentStatus	获取代理的当前连接状态。
version	string	获取代理的版本。

TaskAgentStatus

Enumeration

获取代理的当前连接状态。

值	说明
offline
online

TaskAgentUpdate

Object

名称	类型	说明
currentState	string	此代理更新的当前状态
reason	TaskAgentUpdateReason	此代理更新的原因
requestTime	string	获取请求此代理更新的日期。
requestedBy	IdentityRef	请求代理更新的标识
sourceVersion	PackageVersion	获取或设置代理更新的源代理版本
targetVersion	PackageVersion	获取或设置代理更新的目标代理版本

TaskAgentUpdateReason

Object

名称	类型	说明
code	TaskAgentUpdateReasonType

TaskAgentUpdateReasonType

Enumeration

值	说明
manual
minAgentVersionRequired

TaskOrchestrationOwner

Object

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

TaskResult

Enumeration

值	说明
abandoned
canceled
failed
skipped
succeeded
succeededWithIssues

通过

Deploymentgroups - Update

URI 参数

请求正文

响应

安全性

oauth2

作用域

示例

Update a deployment group

示例请求

示例响应

定义

Demand

DeploymentGroup

DeploymentGroupUpdateParameter

DeploymentMachine

IdentityRef

JObject

JToken

PackageVersion

ProjectReference

PropertiesCollection

ReferenceLinks

TaskAgent

TaskAgentAuthorization

TaskAgentCloudRequest

TaskAgentDelaySource

TaskAgentJobRequest

TaskAgentPoolReference

TaskAgentPoolType

TaskAgentPublicKey

TaskAgentReference

TaskAgentStatus

TaskAgentUpdate

TaskAgentUpdateReason

TaskAgentUpdateReasonType

TaskOrchestrationOwner

TaskResult