Deploymentgroups - Add

参考

Service:: Distributed Task

API Version:: 7.1-preview.1

创建部署组。

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

URI 参数

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

请求正文

名称	类型	说明
description	string	部署组的说明。
name	string	部署组的名称。
poolId	integer	在其中注册部署代理的部署池的标识符。

响应

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

安全性

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

名称	说明
vso.machinegroup_manage	提供管理部署组和代理池的功能

示例

Create a deployment group

Sample Request

HTTP

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

{
  "name": "MyDeploymentGroup1",
  "description": "This deployment group is created to demnostrate the client usage"
}

Sample Response

Status code:: 200

{
  "machineCount": 0,
  "description": "This deployment group is created to demnostrate the client usage",
  "id": 11,
  "project": {
    "id": "91879ed9-819b-46f3-9e0b-52ed4b20c04c",
    "name": "DeploymentGroupRESTSample"
  },
  "name": "MyDeploymentGroup1",
  "pool": {
    "id": 6,
    "scope": "86088ab1-30d8-4526-9663-3406752b8bc6",
    "name": "DeploymentGroupRESTSample-MyDeploymentGroup1",
    "isHosted": false,
    "poolType": "deployment",
    "size": 0
  }
}

定义

名称	说明
Demand
DeploymentGroup	部署组。
DeploymentGroupCreateParameter	用于创建部署组的属性。
DeploymentMachine	部署目标。
IdentityRef
JObject	表示 JSON 对象。
JToken	表示抽象 JSON 令牌。
PackageVersion
ProjectReference
PropertiesCollection	类将属性包表示为键值对的集合。接受所有基元类型的值 (除 `TypeCode != TypeCode.Object`) 以外的 `DBNull` 任何类型。 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

名称	类型	说明
name	string
value	string

DeploymentGroup

部署组。

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

DeploymentGroupCreateParameter

用于创建部署组的属性。

名称	类型	说明
description	string	部署组的说明。
name	string	部署组的名称。
poolId	integer	在其中注册部署代理的部署池的标识符。

DeploymentMachine

部署目标。

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

IdentityRef

名称	类型	说明
_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

表示 JSON 对象。

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

JToken

表示抽象 JSON 令牌。

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

PackageVersion

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

ProjectReference

名称	类型	说明
id	string
name	string

PropertiesCollection

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

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

ReferenceLinks

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

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

TaskAgent

任务代理。

名称	类型	说明
_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	此代理主机支持的系统定义功能。警告：若要使用 PUT 方法设置功能，PUT 将完全覆盖现有功能。
userCapabilities	object	此代理主机支持的用户定义功能。警告：若要使用 PUT 方法设置功能，PUT 将完全覆盖现有功能。
version	string	代理版本。

TaskAgentAuthorization

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

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

TaskAgentCloudRequest

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

TaskAgentJobRequest

代理的作业请求。

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

TaskAgentPoolOptions

其他池设置和详细信息

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

TaskAgentPoolReference

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

TaskAgentPoolType

获取或设置池的类型

名称	类型	说明
automation	string	典型的任务代理池
deployment	string	部署池

TaskAgentPublicKey

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

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

TaskAgentReference

对代理的引用。

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

TaskAgentStatus

代理是否处于联机状态。

名称	类型	说明
offline	string
online	string

TaskAgentUpdate

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

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

TaskAgentUpdateReason

名称	类型	说明
code	TaskAgentUpdateReasonType

TaskAgentUpdateReasonType

名称	类型	说明
downgrade	string
manual	string
minAgentVersionRequired	string

TaskOrchestrationOwner

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

TaskResult

此请求的结果。

名称	类型	说明
abandoned	string
canceled	string
failed	string
skipped	string
succeeded	string
succeededWithIssues	string

通过