Releases - Update Release Environment

Service:

Release

API Version:

5.0-preview.6

更新发布环境的状态

PATCH https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/releases/{releaseId}/environments/{environmentId}?api-version=5.0-preview.6

URI 参数

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

请求正文

名称	类型	说明
comment	string	获取或设置注释。
scheduledDeploymentTime	string	获取或设置计划的部署时间。
status	EnvironmentStatus	获取或设置环境的状态。
variables	<string,  ConfigurationVariableValue>	设置在部署时要重写的环境变量的列表。

响应

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

安全性

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
ApprovalStatus	获取或设置审批的状态。
ApprovalType	获取或设置审批类型。
AuthorizationHeader
ConditionType	获取或设置条件类型。
ConfigurationVariableValue
DataSourceBindingBase	表示服务终结点请求的数据源绑定。
Demand
DeploymentAttempt
DeploymentJob
DeploymentOperationStatus	获取部署的操作状态。
DeploymentReason	获取部署原因。
DeploymentStatus	获取部署的状态。
DeployPhase
DeployPhaseStatus
DeployPhaseTypes
EnvironmentOptions
EnvironmentStatus	获取环境状态。
GateStatus
IdentityRef
IgnoredGate
Issue
ManualIntervention
ManualInterventionStatus	获取或设置手动干预的状态。
ProcessParameters
ProjectReference
ReferenceLinks	表示 REST 引用链接集合的类。
ReleaseApproval
ReleaseApprovalHistory
ReleaseCondition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionShallowReference
ReleaseDeployPhase
ReleaseEnvironment
ReleaseEnvironmentShallowReference
ReleaseEnvironmentUpdateMetadata
ReleaseGates
ReleaseSchedule
ReleaseShallowReference
ReleaseTask
ScheduleDays	要发布的一周中的天数
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
TaskStatus
VariableGroup
VariableGroupProviderData
VariableValue
WorkflowTask
WorkflowTaskReference

ApprovalExecutionOrder

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

ApprovalOptions

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

ApprovalStatus

获取或设置审批的状态。

名称	类型	说明
approved	string
canceled	string
pending	string
reassigned	string
rejected	string
skipped	string
undefined	string

ApprovalType

获取或设置审批类型。

名称	类型	说明
all	string
postDeploy	string
preDeploy	string
undefined	string

AuthorizationHeader

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

DeploymentAttempt

名称	类型	说明
attempt	integer
deploymentId	integer
hasStarted	boolean	指定部署是否已启动
id	integer
issues	Issue[]	与部署相关的所有问题
job	ReleaseTask
lastModifiedBy	IdentityRef
lastModifiedOn	string
operationStatus	DeploymentOperationStatus
postDeploymentGates	ReleaseGates
preDeploymentGates	ReleaseGates
queuedOn	string
reason	DeploymentReason
releaseDeployPhases	ReleaseDeployPhase[]
requestedBy	IdentityRef
requestedFor	IdentityRef
runPlanId	string
status	DeploymentStatus
tasks	ReleaseTask[]

DeploymentJob

名称	类型	说明
job	ReleaseTask
tasks	ReleaseTask[]

DeploymentOperationStatus

获取部署的操作状态。

名称	类型	说明
all	string	部署操作状态为全部。
approved	string	部署操作状态已批准。
canceled	string	部署操作状态已取消。
cancelling	string	部署操作状态正在取消。
deferred	string	部署操作状态延迟。
evaluatingGates	string	部署操作状态为 EvaluatingGates。
gateFailed	string	部署操作状态为 GateFailed。
manualInterventionPending	string	部署操作状态为手动交互挂起。
pending	string	部署操作状态为挂起。
phaseCanceled	string	部署操作状态为阶段取消。
phaseFailed	string	部署操作状态为阶段失败。
phaseInProgress	string	部署操作状态为分阶段执行。
phasePartiallySucceeded	string	部署操作状态为阶段部分成功。
phaseSucceeded	string	部署操作状态为阶段成功。
queued	string	部署操作状态已排队。
queuedForAgent	string	代理的部署操作状态已排队。
queuedForPipeline	string	部署操作状态已排队等待管道。
rejected	string	部署操作状态被拒绝。
scheduled	string	部署操作状态已计划。
undefined	string	部署操作状态未定义。

DeploymentReason

获取部署原因。

名称	类型	说明
automated	string	部署原因是自动化的。
manual	string	部署原因为手动。
none	string	部署原因无。
redeployTrigger	string	部署原因是重新部署Trigger。
scheduled	string	已计划部署原因。

DeploymentStatus

获取部署的状态。

名称	类型	说明
all	string	部署状态为全部。
failed	string	部署状态失败。
inProgress	string	部署状态为“正在进行”。
notDeployed	string	部署状态未部署。
partiallySucceeded	string	部署状态部分成功。
succeeded	string	部署状态为成功。
undefined	string	部署状态未定义。

DeployPhase

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

DeployPhaseStatus

名称	类型	说明
canceled	string
cancelling	string
failed	string
inProgress	string
notStarted	string
partiallySucceeded	string
skipped	string
succeeded	string
undefined	string

DeployPhaseTypes

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

EnvironmentOptions

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

EnvironmentStatus

获取环境状态。

名称	类型	说明
canceled	string
inProgress	string
notStarted	string
partiallySucceeded	string
queued	string
rejected	string
scheduled	string
succeeded	string
undefined	string

GateStatus

名称	类型	说明
canceled	string
failed	string
inProgress	string
none	string
pending	string
succeeded	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 是指向此图主题的源资源的完整路由。

IgnoredGate

名称	类型	说明
lastModifiedOn	string	获取上次忽略门的日期。
name	string	忽略的门的名称。

Issue

名称	类型	说明
data	object
issueType	string
message	string

ManualIntervention

名称	类型	说明
approver	IdentityRef	获取或设置应批准的标识。
comments	string	获取或设置要审批的注释。
createdOn	string	获取创建日期。
id	integer	获取手动干预的唯一标识符。
instructions	string	获取或设置审批说明。
modifiedOn	string	获取修改日期。
name	string	获取或设置名称。
release	ReleaseShallowReference	获取用于手动干预的 releaseReference。
releaseDefinition	ReleaseDefinitionShallowReference	获取用于手动干预的 releaseDefinitionReference。
releaseEnvironment	ReleaseEnvironmentShallowReference	获取用于手动干预的 releaseEnvironmentReference。
status	ManualInterventionStatus	获取或设置手动干预的状态。
taskInstanceId	string	获取任务实例标识符。
url	string	获取用于访问手动干预的 URL。

ManualInterventionStatus

获取或设置手动干预的状态。

名称	类型	说明
approved	string	手动干预已获批准。
canceled	string	取消手动干预。
pending	string	手动干预处于挂起状态。
rejected	string	手动干预被拒绝。
unknown	string	手动干预未设置状态。

ProcessParameters

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

ProjectReference

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

ReferenceLinks

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

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

ReleaseApproval

名称	类型	说明
approvalType	ApprovalType	获取或设置审批的类型。
approvedBy	IdentityRef	获取已批准的标识。
approver	IdentityRef	获取或设置应审批的标识。
attempt	integer	获取或设置尝试，该尝试指定其所属的部署尝试。
comments	string	获取或设置要审批的注释。
createdOn	string	获取创建日期。
history	ReleaseApprovalHistory[]	获取指定与此审批关联的所有审批的历史记录。
id	integer	获取此字段的唯一标识符。
isAutomated	boolean	获取或设置为是否自动审批。
isNotificationOn	boolean
modifiedOn	string	获取修改日期。
rank	integer	获取或设置指定审批顺序的排名。 例如，同一排名表示并行审批。
release	ReleaseShallowReference	获取 releaseReference，它指定此审批关联的发布的引用。
releaseDefinition	ReleaseDefinitionShallowReference	获取 releaseDefinitionReference，它指定此审批关联的发布定义的引用。
releaseEnvironment	ReleaseEnvironmentShallowReference	获取 releaseEnvironmentReference，它指定与此审批关联的发布环境的引用。
revision	integer	获取修订号。
status	ApprovalStatus	获取或设置审批的状态。
trialNumber	integer
url	string	获取用于访问审批的 URL。

ReleaseApprovalHistory

名称	类型	说明
approver	IdentityRef
changedBy	IdentityRef
comments	string
createdOn	string
modifiedOn	string
revision	integer

ReleaseCondition

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

ReleaseDefinitionApprovals

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

ReleaseDefinitionApprovalStep

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

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。

ReleaseDeployPhase

名称	类型	说明
deploymentJobs	DeploymentJob[]
errorLog	string
id	integer
manualInterventions	ManualIntervention[]
name	string
phaseId	string
phaseType	DeployPhaseTypes
rank	integer
runPlanId	string
startedOn	string	阶段开始时间
status	DeployPhaseStatus

ReleaseEnvironment

名称	类型	说明
conditions	ReleaseCondition[]	获取条件列表。
createdOn	string	获取创建日期。
definitionEnvironmentId	integer	获取定义环境 ID。
demands	Demand[]	获取要求。
deployPhasesSnapshot	DeployPhase[]	获取快照部署阶段的列表。
deploySteps	DeploymentAttempt[]	获取部署步骤。
environmentOptions	EnvironmentOptions	获取环境选项。
id	integer	获取此字段的唯一标识符。
modifiedOn	string	获取修改日期。
name	string	获取名称。
nextScheduledUtcTime	string	获取下一个计划的 UTC 时间。
owner	IdentityRef	获取发布环境所有者的标识。
postApprovalsSnapshot	ReleaseDefinitionApprovals	获取部署后审批快照列表。
postDeployApprovals	ReleaseApproval[]	获取部署后审批的列表。
postDeploymentGatesSnapshot	ReleaseDefinitionGatesStep
preApprovalsSnapshot	ReleaseDefinitionApprovals	获取快照预部署审批的列表。
preDeployApprovals	ReleaseApproval[]	获取预部署审批的列表。
preDeploymentGatesSnapshot	ReleaseDefinitionGatesStep
processParameters	ProcessParameters	获取进程参数。
queueId	integer	获取队列 ID。
rank	integer	获取排名。
release	ReleaseShallowReference	获取发布引用，该引用指定与此发布环境关联的版本的引用。
releaseCreatedBy	IdentityRef	获取创建发布的标识。
releaseDefinition	ReleaseDefinitionShallowReference	获取 releaseDefinitionReference，它指定与此发布环境关联的发布定义的引用。
releaseDescription	string	获取版本说明。
releaseId	integer	获取发布 ID。
scheduledDeploymentTime	string	获取发布环境的计划部署时间。
schedules	ReleaseSchedule[]	获取计划列表。
status	EnvironmentStatus	获取环境状态。
timeToDeploy	number	获取部署时间。
triggerReason	string	获取触发器原因。
variableGroups	VariableGroup[]	获取变量组的列表。
variables	<string,  ConfigurationVariableValue>	获取变量的字典。
workflowTasks	WorkflowTask[]	获取工作流任务的列表。

ReleaseEnvironmentShallowReference

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

ReleaseEnvironmentUpdateMetadata

名称	类型	说明
comment	string	获取或设置注释。
scheduledDeploymentTime	string	获取或设置计划的部署时间。
status	EnvironmentStatus	获取或设置环境的状态。
variables	<string,  ConfigurationVariableValue>	设置在部署时要重写的环境变量的列表。

ReleaseGates

名称	类型	说明
deploymentJobs	DeploymentJob[]
id	integer
ignoredGates	IgnoredGate[]
lastModifiedOn	string
runPlanId	string
stabilizationCompletedOn	string
startedOn	string
status	GateStatus
succeedingSince	string

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。

ReleaseTask

名称	类型	说明
agentName	string
finishTime	string
id	integer
issues	Issue[]
lineCount	integer
logUrl	string
name	string
percentComplete	integer
rank	integer
resultCode	string
startTime	string
status	TaskStatus
task	WorkflowTaskReference
timelineRecordId	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

TaskStatus

名称	类型	说明
canceled	string
failed	string
failure	string
inProgress	string
partiallySucceeded	string
pending	string
skipped	string
succeeded	string
success	string
unknown	string

VariableGroup

名称	类型	说明
createdBy	IdentityRef	获取或设置创建者的标识。
createdOn	string	获取创建日期。
description	string	获取或设置说明。
id	integer	获取此字段的唯一标识符。
isShared	boolean	表示变量组是否与其他项目共享。
modifiedBy	IdentityRef	获取或设置修改的标识。
modifiedOn	string	获取修改日期。
name	string	获取或设置名称。
providerData	VariableGroupProviderData	获取或设置提供程序数据。
type	string	获取或设置类型。
variables	<string,  VariableValue>

VariableGroupProviderData

VariableValue

名称	类型	说明
isSecret	boolean
value	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

WorkflowTaskReference

名称	类型	说明
id	string
name	string
version	string