Definitions - Update

Service:

Release

API Version:

5.0

更新发布定义。

PUT https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions?api-version=5.0

URI 参数

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

请求正文

名称	类型	说明
_links	ReferenceLinks	获取指向发布定义的相关资源、API 和视图的链接。
artifacts	Artifact[]	获取或设置项目列表。
comment	string	获取或设置注释。
createdBy	IdentityRef	获取或设置创建者的标识。
createdOn	string	获取创建日期。
description	string	获取或设置说明。
environments	ReleaseDefinitionEnvironment[]	获取或设置环境的列表。
id	integer	获取发布定义的唯一标识符。
isDeleted	boolean	是否删除发布定义。
lastRelease	ReleaseReference	获取最新版本的引用。
modifiedBy	IdentityRef	获取或设置修改的标识。
modifiedOn	string	获取修改日期。
name	string	获取或设置发布定义的名称。
path	string	获取或设置发布定义的路径。
projectReference	ProjectReference	获取或设置项目引用。
properties	PropertiesCollection	获取或设置属性。
releaseNameFormat	string	获取或设置发布名称格式。
revision	integer	获取修订号。
source	ReleaseDefinitionSource	获取或设置发布定义的源。
tags	string[]	获取或设置标记列表。
triggers	ReleaseTriggerBase[]	获取或设置触发器的列表。
url	string	获取用于访问发布定义的 REST API URL。
variableGroups	integer[]	获取或设置变量组的列表。
variables	<string,  ConfigurationVariableValue>	获取或设置变量的字典。

响应

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

安全性

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.release_execute	授予读取和更新发布项目（包括发布、发布定义和发布部署）的能力，以及将新版本排队的能力。

定义

名称	说明
ApprovalExecutionOrder
ApprovalOptions
Artifact
ArtifactSourceReference
AuthorizationHeader
Condition
ConditionType	获取或设置条件类型。
ConfigurationVariableValue
DataSourceBindingBase	表示服务终结点请求的数据源绑定。
Demand
DeployPhase
DeployPhaseTypes
EnvironmentExecutionPolicy	定义Release Management端队列的环境队列策略。 仅当满足上述策略时，才会发送到环境运行器[创建预部署和其他步骤]。
EnvironmentOptions
EnvironmentRetentionPolicy
EnvironmentTrigger
EnvironmentTriggerType
IdentityRef
ProcessParameters
ProjectReference
PropertiesCollection	类将属性包表示为键值对的集合。 接受除 之外DBNull的所有基元类型的值 (具有TypeCode != TypeCode.Object) 的任何类型。 Byte[]、Int32、Double、DateType 和 String 类型的值保留其类型，其他基元将重新调整为 String。 Byte[] 应为 base64 编码字符串。
ReferenceLinks	表示 REST 引用链接集合的类。
ReleaseDefinition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionDeployStep
ReleaseDefinitionEnvironment
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionShallowReference
ReleaseDefinitionSource	获取或设置发布定义的源。
ReleaseReason	获取发布的原因。
ReleaseReference
ReleaseSchedule
ReleaseShallowReference
ReleaseTriggerBase
ReleaseTriggerType
ScheduleDays	要发布的星期数
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
WorkflowTask

ApprovalExecutionOrder

名称	类型	说明
afterGatesAlways	string
afterSuccessfulGates	string
beforeGates	string

ApprovalOptions

名称	类型	说明
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped	boolean
enforceIdentityRevalidation	boolean
executionOrder	ApprovalExecutionOrder
releaseCreatorCanBeApprover	boolean
requiredApproverCount	integer
timeoutInMinutes	integer

Artifact

名称	类型	说明
alias	string	获取或设置别名。
definitionReference	<string,  ArtifactSourceReference>	获取或设置定义引用。 例如{“project”：{“id”：“fed755ea-49c5-4399-acea-fd5b5aa90a6c”，“name”：“myProject”}，“definition”：{“id”：“1”，“name”：“mybuildDefinition”}，“connection”：{“id”：“1”，“name”：“myConnection”}}
isPrimary	boolean	获取或设置，因为项目是主要项目还是非主要项目。
isRetained	boolean
type	string	获取或设置类型。 其值可以是“Build”、“Jenkins”、“GitHub”、“Nuget”、“Team Build (external) ”、“ExternalTFSBuild”、“Git”、“TFVC”、“ExternalTfsXamlBuild”。

ArtifactSourceReference

名称	类型	说明
id	string
name	string

AuthorizationHeader

名称	类型	说明
name	string
value	string

Condition

名称	类型	说明
conditionType	ConditionType	获取或设置条件类型。
name	string	获取或设置条件的名称。 例如“ReleaseStarted”。
value	string	获取或设置条件的值。

ConditionType

获取或设置条件类型。

名称	类型	说明
artifact	string	条件类型为项目。
environmentState	string	条件类型为环境状态。
event	string	条件类型为事件。
undefined	string	条件类型未定义。

ConfigurationVariableValue

名称	类型	说明
allowOverride	boolean	获取或设置变量是否可以在部署时重写。
isSecret	boolean	获取或设置变量是否为机密。
value	string	获取或设置配置变量的值。

DataSourceBindingBase

表示服务终结点请求的数据源绑定。

名称	类型	说明
callbackContextTemplate	string	此数据源支持的分页格式 (ContinuationToken/SkipTop) 。
callbackRequiredTemplate	string	需要后续调用？
dataSourceName	string	获取或设置数据源的名称。
endpointId	string	获取或设置终结点 ID。
endpointUrl	string	获取或设置服务终结点的 URL。
headers	AuthorizationHeader[]	获取或设置授权标头。
initialContextTemplate	string	定义查询参数的初始值
parameters	object	获取或设置数据源的参数。
resultSelector	string	获取或设置结果选择器。
resultTemplate	string	获取或设置结果模板。
target	string	获取或设置数据源的目标。

Demand

名称	类型	说明
name	string
value	string

DeployPhase

名称	类型	说明
name	string
phaseType	DeployPhaseTypes
rank	integer
refName	string
workflowTasks	WorkflowTask[]

DeployPhaseTypes

名称	类型	说明
agentBasedDeployment	string
deploymentGates	string	阶段类型，其中包含充当部署进一步的入口的任务。
machineGroupBasedDeployment	string
runOnServer	string
undefined	string

EnvironmentExecutionPolicy

定义Release Management端队列的环境队列策略。 仅当满足上述策略时，才会发送到环境运行器[创建预部署和其他步骤]。

名称	类型	说明
concurrencyCount	integer	此策略决定使用环境运行器的环境数量。
queueDepthCount	integer	在 EnvironmentQueue 表中的队列深度，此表会保留环境条目，直到环境运行器（根据策略）可用，以采用另一个环境运行。

EnvironmentOptions

名称	类型	说明
autoLinkWorkItems	boolean
badgeEnabled	boolean
emailNotificationType	string
emailRecipients	string
enableAccessToken	boolean
publishDeploymentStatus	boolean
pullRequestDeploymentEnabled	boolean
skipArtifactsDownload	boolean
timeoutInMinutes	integer

EnvironmentRetentionPolicy

名称	类型	说明
daysToKeep	integer
releasesToKeep	integer
retainBuild	boolean

EnvironmentTrigger

名称	类型	说明
definitionEnvironmentId	integer
releaseDefinitionId	integer
triggerContent	string
triggerType	EnvironmentTriggerType

EnvironmentTriggerType

名称	类型	说明
deploymentGroupRedeploy	string
rollbackRedeploy	string
undefined	string

IdentityRef

名称	类型	说明
_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 是指向此图主题的源资源的完整路由。

ProcessParameters

名称	类型	说明
dataSourceBindings	DataSourceBindingBase[]	表示服务终结点请求的数据源绑定。
inputs	TaskInputDefinitionBase[]
sourceDefinitions	TaskSourceDefinitionBase[]

ProjectReference

名称	类型	说明
id	string	获取此字段的唯一标识符。
name	string	获取项目的名称。

PropertiesCollection

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

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

ReferenceLinks

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

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

ReleaseDefinition

名称	类型	说明
_links	ReferenceLinks	获取指向发布定义的相关资源、API 和视图的链接。
artifacts	Artifact[]	获取或设置项目列表。
comment	string	获取或设置注释。
createdBy	IdentityRef	获取或设置创建者的标识。
createdOn	string	获取创建日期。
description	string	获取或设置说明。
environments	ReleaseDefinitionEnvironment[]	获取或设置环境的列表。
id	integer	获取发布定义的唯一标识符。
isDeleted	boolean	是否删除发布定义。
lastRelease	ReleaseReference	获取最新版本的引用。
modifiedBy	IdentityRef	获取或设置修改的标识。
modifiedOn	string	获取修改日期。
name	string	获取或设置发布定义的名称。
path	string	获取或设置发布定义的路径。
projectReference	ProjectReference	获取或设置项目引用。
properties	PropertiesCollection	获取或设置属性。
releaseNameFormat	string	获取或设置发布名称格式。
revision	integer	获取修订号。
source	ReleaseDefinitionSource	获取或设置发布定义的源。
tags	string[]	获取或设置标记列表。
triggers	ReleaseTriggerBase[]	获取或设置触发器的列表。
url	string	获取用于访问发布定义的 REST API URL。
variableGroups	integer[]	获取或设置变量组的列表。
variables	<string,  ConfigurationVariableValue>	获取或设置变量的字典。

ReleaseDefinitionApprovals

名称	类型	说明
approvalOptions	ApprovalOptions
approvals	ReleaseDefinitionApprovalStep[]

ReleaseDefinitionApprovalStep

名称	类型	说明
approver	IdentityRef
id	integer
isAutomated	boolean
isNotificationOn	boolean
rank	integer

ReleaseDefinitionDeployStep

名称	类型	说明
id	integer
tasks	WorkflowTask[]	此定义的步骤列表。

ReleaseDefinitionEnvironment

名称	类型	说明
badgeUrl	string
conditions	Condition[]
currentRelease	ReleaseShallowReference
demands	Demand[]
deployPhases	DeployPhase[]
deployStep	ReleaseDefinitionDeployStep
environmentOptions	EnvironmentOptions
environmentTriggers	EnvironmentTrigger[]
executionPolicy	EnvironmentExecutionPolicy	定义Release Management端队列的环境队列策略。 仅当满足上述策略时，才会发送到环境运行器[创建预部署和其他步骤]。
id	integer
name	string
owner	IdentityRef
postDeployApprovals	ReleaseDefinitionApprovals
postDeploymentGates	ReleaseDefinitionGatesStep
preDeployApprovals	ReleaseDefinitionApprovals
preDeploymentGates	ReleaseDefinitionGatesStep
processParameters	ProcessParameters
properties	PropertiesCollection	类将属性包表示为键值对的集合。 接受除 之外DBNull的所有基元类型的值 (具有TypeCode != TypeCode.Object) 的任何类型。 Byte[]、Int32、Double、DateType 和 String 类型的值保留其类型，其他基元将重新调整为 String。 Byte[] 应为 base64 编码字符串。
queueId	integer
rank	integer
retentionPolicy	EnvironmentRetentionPolicy
schedules	ReleaseSchedule[]
variableGroups	integer[]
variables	<string,  ConfigurationVariableValue>

ReleaseDefinitionGate

名称	类型	说明
tasks	WorkflowTask[]

ReleaseDefinitionGatesOptions

名称	类型	说明
isEnabled	boolean
minimumSuccessDuration	integer
samplingInterval	integer
stabilizationTime	integer
timeout	integer

ReleaseDefinitionGatesStep

名称	类型	说明
gates	ReleaseDefinitionGate[]
gatesOptions	ReleaseDefinitionGatesOptions
id	integer

ReleaseDefinitionShallowReference

名称	类型	说明
_links	ReferenceLinks	获取指向发布定义的相关资源、API 和视图的链接。
id	integer	获取发布定义的唯一标识符。
name	string	获取或设置发布定义的名称。
path	string	获取或设置发布定义的路径。
projectReference	ProjectReference	获取或设置项目引用。
url	string	获取用于访问发布定义的 REST API URL。

ReleaseDefinitionSource

获取或设置发布定义的源。

名称	类型	说明
ibiza	string
portalExtensionApi	string
restApi	string
undefined	string
userInterface	string

ReleaseReason

获取发布的原因。

名称	类型	说明
continuousIntegration	string
manual	string
none	string
pullRequest	string
schedule	string

ReleaseReference

名称	类型	说明
_links	ReferenceLinks	获取用于访问发布的链接。
artifacts	Artifact[]	获取项目列表。
createdBy	IdentityRef	获取创建者的标识。
createdOn	string	获取创建日期。
description	string	获取说明。
id	integer	获取此字段的唯一标识符。
modifiedBy	IdentityRef	获取修改的标识。
name	string	获取发布的名称。
reason	ReleaseReason	获取发布的原因。
releaseDefinition	ReleaseDefinitionShallowReference	获取发布定义浅表引用。

ReleaseSchedule

名称	类型	说明
daysToRelease	ScheduleDays	要发布的星期数
jobId	string	Team Foundation 作业定义作业 ID
startHours	integer	要开始的本地时区小时数
startMinutes	integer	要开始的本地时区分钟数
timeZoneId	string	发布计划的时区 ID，例如“UTC”

ReleaseShallowReference

名称	类型	说明
_links	ReferenceLinks	获取指向发布的相关资源、API 和视图的链接。
id	integer	获取发布的唯一标识符。
name	string	获取或设置发布的名称。
url	string	获取用于访问发布的 REST API URL。

ReleaseTriggerBase

名称	类型	说明
triggerType	ReleaseTriggerType

ReleaseTriggerType

名称	类型	说明
artifactSource	string
containerImage	string
package	string
pullRequest	string
schedule	string
sourceRepo	string
undefined	string

ScheduleDays

要发布的星期数

名称	类型	说明
all	string
friday	string
monday	string
none	string
saturday	string
sunday	string
thursday	string
tuesday	string
wednesday	string

TaskInputDefinitionBase

名称	类型	说明
aliases	string[]
defaultValue	string
groupName	string
helpMarkDown	string
label	string
name	string
options	object
properties	object
required	boolean
type	string
validation	TaskInputValidation
visibleRule	string

TaskInputValidation

名称	类型	说明
expression	string	条件表达式
message	string	说明用户在验证失败时如何更正的消息

TaskSourceDefinitionBase

名称	类型	说明
authKey	string
endpoint	string
keySelector	string
selector	string
target	string

WorkflowTask

名称	类型	说明
alwaysRun	boolean
condition	string
continueOnError	boolean
definitionType	string
enabled	boolean
environment	object
inputs	object
name	string
overrideInputs	object
refName	string
taskId	string
timeoutInMinutes	integer
version	string