Releases - Update Release Environment

Service:: Release

API Version:: 7.1

Update the status of a release environment

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

URI Parameters

Name	In	Required	Type	Description
environmentId	path	True	integer (int32)	Id of release environment.
organization	path	True	string	The name of the Azure DevOps organization.
project	path	True	string	Project ID or project name
releaseId	path	True	integer (int32)	Id of the release.
api-version	query	True	string	Version of the API to use. This should be set to '7.1' to use this version of the api.

Request Body

Name	Type	Description
comment	string	Gets or sets comment.
scheduledDeploymentTime	string (date-time)	Gets or sets scheduled deployment time.
status	EnvironmentStatus	Gets or sets status of environment.
variables	<string, ConfigurationVariableValue>	Sets list of environment variables to be overridden at deployment time.

Responses

Name	Type	Description
200 OK	ReleaseEnvironment	successful operation

Security

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

Name	Description
vso.release_execute	Grants the ability to read and update release artifacts, including folders, releases, release definitions and release environment, and the ability to queue a new release.

Examples

Start deployment on an environment

Sample request

HTTP

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

{
  "status": "inProgress",
  "scheduledDeploymentTime": null,
  "comment": null,
  "variables": {}
}

Sample response

Status code:: 200

{
  "id": 45,
  "releaseId": 45,
  "name": "PROD",
  "status": "queued",
  "variables": {},
  "variableGroups": [],
  "preDeployApprovals": [],
  "postDeployApprovals": [],
  "preApprovalsSnapshot": {
    "approvals": [
      {
        "rank": 1,
        "isAutomated": false,
        "isNotificationOn": false,
        "approver": {
          "displayName": "Chuck Reinhart",
          "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
          "_links": {
            "avatar": {
              "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
            }
          },
          "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
          "uniqueName": "fabfiber@outlook.com",
          "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
          "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
        },
        "id": 0
      }
    ],
    "approvalOptions": {
      "requiredApproverCount": 0,
      "releaseCreatorCanBeApprover": true,
      "autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
      "enforceIdentityRevalidation": false,
      "timeoutInMinutes": 0,
      "executionOrder": "beforeGates"
    }
  },
  "postApprovalsSnapshot": {
    "approvals": [
      {
        "rank": 1,
        "isAutomated": true,
        "isNotificationOn": false,
        "id": 0
      }
    ]
  },
  "deploySteps": [],
  "rank": 1,
  "definitionEnvironmentId": 23,
  "environmentOptions": {
    "emailNotificationType": "OnlyOnFailure",
    "emailRecipients": "release.environment.owner;release.creator",
    "skipArtifactsDownload": false,
    "timeoutInMinutes": 0,
    "enableAccessToken": false,
    "publishDeploymentStatus": false,
    "badgeEnabled": false,
    "autoLinkWorkItems": false,
    "pullRequestDeploymentEnabled": false
  },
  "demands": [],
  "conditions": [],
  "workflowTasks": [],
  "deployPhasesSnapshot": [
    {
      "deploymentInput": {
        "parallelExecution": {
          "parallelExecutionType": "none"
        },
        "skipArtifactsDownload": false,
        "artifactsDownloadInput": {
          "downloadInputs": []
        },
        "queueId": 0,
        "demands": [],
        "enableAccessToken": false,
        "timeoutInMinutes": 0,
        "jobCancelTimeoutInMinutes": 1,
        "condition": "succeeded()",
        "overrideInputs": {}
      },
      "rank": 1,
      "phaseType": "agentBasedDeployment",
      "name": "Run on agent",
      "refName": null,
      "workflowTasks": []
    }
  ],
  "owner": {
    "displayName": "Chuck Reinhart",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      }
    },
    "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "uniqueName": "fabfiber@outlook.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
  },
  "schedules": [],
  "release": {
    "id": 45,
    "name": "Release-2",
    "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/45",
    "_links": {
      "web": {
        "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?releaseId=45&_a=release-summary"
      },
      "self": {
        "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/45"
      }
    }
  },
  "releaseDefinition": {
    "id": 23,
    "name": "Fabrikam-web",
    "path": "\\",
    "projectReference": null,
    "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/23",
    "_links": {
      "web": {
        "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=23"
      },
      "self": {
        "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/23"
      }
    }
  },
  "releaseCreatedBy": {
    "displayName": "Chuck Reinhart",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      }
    },
    "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "uniqueName": "fabfiber@outlook.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
  },
  "triggerReason": "Manual",
  "preDeploymentGatesSnapshot": {
    "id": 0,
    "gatesOptions": null,
    "gates": []
  },
  "postDeploymentGatesSnapshot": {
    "id": 0,
    "gatesOptions": null,
    "gates": []
  }
}

Definitions

Name	Description
ApprovalExecutionOrder	Approvals execution order.
ApprovalOptions
ApprovalStatus	Gets or sets the status of the approval.
ApprovalType	Gets or sets the type of approval.
AuthorizationHeader
ConditionType	Gets or sets the condition type.
ConfigurationVariableValue
DataSourceBindingBase	Represents binding of data source for the service endpoint request.
DeploymentAttempt
DeploymentJob
DeploymentOperationStatus	Gets operation status of deployment.
DeploymentReason	Gets reason of deployment.
DeploymentStatus	Gets status of the deployment.
DeployPhase
DeployPhaseStatus	Status of the phase.
DeployPhaseTypes	Indicates the deploy phase type.
EnvironmentOptions
EnvironmentStatus	Gets environment status.
GateStatus	Status of release gates.
IdentityRef
IgnoredGate
Issue
ManualIntervention
ManualInterventionStatus	Gets or sets the status of the manual intervention.
ProcessParameters
ProjectReference
ReferenceLinks	The class to represent a collection of REST reference links.
ReleaseApproval
ReleaseApprovalHistory
ReleaseCondition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionShallowReference
ReleaseDeployPhase
ReleaseEnvironment
ReleaseEnvironmentShallowReference
ReleaseEnvironmentUpdateMetadata
ReleaseGates
ReleaseSchedule
ReleaseShallowReference
ReleaseTask
ScheduleDays	Days of the week to release.
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
TaskStatus	Status of release task.
VariableGroup
VariableGroupProjectReference	A variable group reference is a shallow reference to variable group.
VariableGroupProviderData
VariableValue
WorkflowTask
WorkflowTaskReference

ApprovalExecutionOrder

Enumeration

Approvals execution order.

Value	Description
beforeGates	Approvals shown before gates.
afterSuccessfulGates	Approvals shown after successful execution of gates.
afterGatesAlways	Approvals shown always after execution of gates.

ApprovalOptions

Object

Name	Type	Description
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped	boolean	Specify whether the approval can be skipped if the same approver approved the previous stage.
enforceIdentityRevalidation	boolean	Specify whether revalidate identity of approver before completing the approval.
executionOrder	ApprovalExecutionOrder	Approvals execution order.
releaseCreatorCanBeApprover	boolean	Specify whether the user requesting a release or deployment should allow to approver.
requiredApproverCount	integer (int32)	The number of approvals required to move release forward. '0' means all approvals required.
timeoutInMinutes	integer (int32)	Approval timeout. Approval default timeout is 30 days. Maximum allowed timeout is 365 days. '0' means default timeout i.e 30 days.

ApprovalStatus

Enumeration

Gets or sets the status of the approval.

Value	Description
undefined	Indicates the approval does not have the status set.
pending	Indicates the approval is pending.
approved	Indicates the approval is approved.
rejected	Indicates the approval is rejected.
reassigned	Indicates the approval is reassigned.
canceled	Indicates the approval is canceled.
skipped	Indicates the approval is skipped.

ApprovalType

Enumeration

Gets or sets the type of approval.

Value	Description
undefined	Indicates the approval type does not set.
preDeploy	Indicates the approvals which executed before deployment.
postDeploy	Indicates the approvals which executed after deployment.
all	Indicates all approvals.

AuthorizationHeader

Object

Name	Type	Description
name	string
value	string

ConditionType

Enumeration

Gets or sets the condition type.

Value	Description
undefined	The condition type is undefined.
event	The condition type is event.
environmentState	The condition type is environment state.
artifact	The condition type is artifact.

ConfigurationVariableValue

Object

Name	Type	Description
allowOverride	boolean	Gets and sets if a variable can be overridden at deployment time or not.
isSecret	boolean	Gets or sets as variable is secret or not.
value	string	Gets and sets value of the configuration variable.

DataSourceBindingBase

Object

Represents binding of data source for the service endpoint request.

Name	Type	Description
callbackContextTemplate	string	Pagination format supported by this data source(ContinuationToken/SkipTop).
callbackRequiredTemplate	string	Subsequent calls needed?
dataSourceName	string	Gets or sets the name of the data source.
endpointId	string	Gets or sets the endpoint Id.
endpointUrl	string	Gets or sets the url of the service endpoint.
headers	AuthorizationHeader[]	Gets or sets the authorization headers.
initialContextTemplate	string	Defines the initial value of the query params
parameters	object	Gets or sets the parameters for the data source.
requestContent	string	Gets or sets http request body
requestVerb	string	Gets or sets http request verb
resultSelector	string	Gets or sets the result selector.
resultTemplate	string	Gets or sets the result template.
target	string	Gets or sets the target of the data source.

DeploymentAttempt

Object

Name	Type	Description
attempt	integer (int32)	Deployment attempt.
deploymentId	integer (int32)	ID of the deployment.
hasStarted	boolean	Specifies whether deployment has started or not.
id	integer (int32)	ID of deployment.
issues	Issue[]	All the issues related to the deployment.
lastModifiedBy	IdentityRef	Identity who last modified this deployment.
lastModifiedOn	string (date-time)	Time when this deployment last modified.
operationStatus	DeploymentOperationStatus	Deployment operation status.
postDeploymentGates	ReleaseGates	Post deployment gates that executed in this deployment.
preDeploymentGates	ReleaseGates	Pre deployment gates that executed in this deployment.
queuedOn	string (date-time)	When this deployment queued on.
reason	DeploymentReason	Reason for the deployment.
releaseDeployPhases	ReleaseDeployPhase[]	List of release deployphases executed in this deployment.
requestedBy	IdentityRef	Identity who requested this deployment.
requestedFor	IdentityRef	Identity for this deployment requested.
status	DeploymentStatus	status of the deployment.

DeploymentJob

Object

Name	Type	Description
job	ReleaseTask	Parent task of all executed tasks.
tasks	ReleaseTask[]	List of executed tasks with in job.

DeploymentOperationStatus

Enumeration

Gets operation status of deployment.

Value	Description
undefined	The deployment operation status is undefined.
queued	The deployment operation status is queued.
scheduled	The deployment operation status is scheduled.
pending	The deployment operation status is pending.
approved	The deployment operation status is approved.
rejected	The deployment operation status is rejected.
deferred	The deployment operation status is deferred.
queuedForAgent	The deployment operation status is queued for agent.
phaseInProgress	The deployment operation status is phase in progress.
phaseSucceeded	The deployment operation status is phase succeeded.
phasePartiallySucceeded	The deployment operation status is phase partially succeeded.
phaseFailed	The deployment operation status is phase failed.
canceled	The deployment operation status is canceled.
phaseCanceled	The deployment operation status is phase canceled.
manualInterventionPending	The deployment operation status is manualintervention pending.
queuedForPipeline	The deployment operation status is queued for pipeline.
cancelling	The deployment operation status is cancelling.
evaluatingGates	The deployment operation status is EvaluatingGates.
gateFailed	The deployment operation status is GateFailed.
all	The deployment operation status is all.

DeploymentReason

Enumeration

Gets reason of deployment.

Value	Description
none	The deployment reason is none.
manual	The deployment reason is manual.
automated	The deployment reason is automated.
scheduled	The deployment reason is scheduled.
redeployTrigger	The deployment reason is RedeployTrigger.

DeploymentStatus

Enumeration

Gets status of the deployment.

Value	Description
undefined	The deployment status is undefined.
notDeployed	The deployment status is not deployed.
inProgress	The deployment status is in progress.
succeeded	The deployment status is succeeded.
partiallySucceeded	The deployment status is partiallysucceeded.
failed	The deployment status is failed.
all	The deployment status is all.

DeployPhase

Object

Name	Type	Description
name	string	Gets and sets the name of deploy phase.
phaseType	DeployPhaseTypes	Indicates the deploy phase type.
rank	integer (int32)	Gets and sets the rank of deploy phase.
refName	string	Gets and sets the reference name of deploy phase.
workflowTasks	WorkflowTask[]	Gets and sets the workflow tasks for the deploy phase.

DeployPhaseStatus

Enumeration

Status of the phase.

Value	Description
undefined	Phase status not set.
notStarted	Phase execution not started.
inProgress	Phase execution in progress.
partiallySucceeded	Phase execution partially succeeded.
succeeded	Phase execution succeeded.
failed	Phase execution failed.
canceled	Phase execution canceled.
skipped	Phase execution skipped.
cancelling	Phase is in cancelling state.

DeployPhaseTypes

Enumeration

Indicates the deploy phase type.

Value	Description
undefined	Phase type not defined. Don't use this.
agentBasedDeployment	Phase type which contains tasks executed on agent.
runOnServer	Phase type which contains tasks executed by server.
machineGroupBasedDeployment	Phase type which contains tasks executed on deployment group machines.
deploymentGates	Phase type which contains tasks which acts as Gates for the deployment to go forward.

EnvironmentOptions

Object

Name	Type	Description
autoLinkWorkItems	boolean	Gets and sets as the auto link workitems or not.
badgeEnabled	boolean	Gets and sets as the badge enabled or not.
publishDeploymentStatus	boolean	Gets and sets as the publish deployment status or not.
pullRequestDeploymentEnabled	boolean	Gets and sets as the.pull request deployment enabled or not.

EnvironmentStatus

Enumeration

Gets environment status.

Value	Description
undefined	Environment status not set.
notStarted	Environment is in not started state.
inProgress	Environment is in progress state.
succeeded	Environment is in succeeded state.
canceled	Environment is in canceled state.
rejected	Environment is in rejected state.
queued	Environment is in queued state.
scheduled	Environment is in scheduled state.
partiallySucceeded	Environment is in partially succeeded state.

GateStatus

Enumeration

Status of release gates.

Value	Description
none	The gate does not have the status set.
pending	The gate is in pending state.
inProgress	The gate is currently in progress.
succeeded	The gate completed successfully.
failed	The gate execution failed.
canceled	The gate execution cancelled.

IdentityRef

Object

Name	Type	Description
_links	ReferenceLinks	This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject.
descriptor	string	The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.
directoryAlias	string	Deprecated - Can be retrieved by querying the Graph user referenced in the "self" entry of the IdentityRef "_links" dictionary
displayName	string	This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.
id	string
imageUrl	string	Deprecated - Available in the "avatar" entry of the IdentityRef "_links" dictionary
inactive	boolean	Deprecated - Can be retrieved by querying the Graph membership state referenced in the "membershipState" entry of the GraphUser "_links" dictionary
isAadIdentity	boolean	Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Deprecated - not in use in most preexisting implementations of ToIdentityRef
uniqueName	string	Deprecated - use Domain+PrincipalName instead
url	string	This url is the full route to the source resource of this graph subject.

IgnoredGate

Object

Name	Type	Description
lastModifiedOn	string (date-time)	Gets the date on which gate is last ignored.
name	string	Name of gate ignored.

Issue

Object

Name	Type	Description
data	object	Issue data.
issueType	string	Issue type, for example error, warning or info.
message	string	Issue message.

ManualIntervention

Object

Name	Type	Description
approver	IdentityRef	Gets or sets the identity who should approve.
comments	string	Gets or sets comments for approval.
createdOn	string (date-time)	Gets date on which it got created.
id	integer (int32)	Gets the unique identifier for manual intervention.
instructions	string	Gets or sets instructions for approval.
modifiedOn	string (date-time)	Gets date on which it got modified.
name	string	Gets or sets the name.
release	ReleaseShallowReference	Gets releaseReference for manual intervention.
releaseDefinition	ReleaseDefinitionShallowReference	Gets releaseDefinitionReference for manual intervention.
releaseEnvironment	ReleaseEnvironmentShallowReference	Gets releaseEnvironmentReference for manual intervention.
status	ManualInterventionStatus	Gets or sets the status of the manual intervention.
taskInstanceId	string (uuid)	Get task instance identifier.
url	string	Gets url to access the manual intervention.

ManualInterventionStatus

Enumeration

Gets or sets the status of the manual intervention.

Value	Description
unknown	The manual intervention does not have the status set.
pending	The manual intervention is pending.
rejected	The manual intervention is rejected.
approved	The manual intervention is approved.
canceled	The manual intervention is canceled.

ProcessParameters

Object

Name	Type	Description
dataSourceBindings	DataSourceBindingBase[]	Represents binding of data source for the service endpoint request.
inputs	TaskInputDefinitionBase[]
sourceDefinitions	TaskSourceDefinitionBase[]

ProjectReference

Object

Name	Type	Description
id	string (uuid)	Gets the unique identifier of this field.
name	string	Gets name of project.

ReferenceLinks

Object

The class to represent a collection of REST reference links.

Name	Type	Description
links	object	The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.

ReleaseApproval

Object

Name	Type	Description
approvalType	ApprovalType	Gets or sets the type of approval.
approvedBy	IdentityRef	Gets the identity who approved.
approver	IdentityRef	Gets or sets the identity who should approve.
attempt	integer (int32)	Gets or sets attempt which specifies as which deployment attempt it belongs.
comments	string	Gets or sets comments for approval.
createdOn	string (date-time)	Gets date on which it got created.
history	ReleaseApprovalHistory[]	Gets history which specifies all approvals associated with this approval.
id	integer (int32)	Gets the unique identifier of this field.
isAutomated	boolean	Gets or sets as approval is automated or not.
modifiedOn	string (date-time)	Gets date on which it got modified.
rank	integer (int32)	Gets or sets rank which specifies the order of the approval. e.g. Same rank denotes parallel approval.
release	ReleaseShallowReference	Gets releaseReference which specifies the reference of the release to which this approval is associated.
releaseDefinition	ReleaseDefinitionShallowReference	Gets releaseDefinitionReference which specifies the reference of the release definition to which this approval is associated.
releaseEnvironment	ReleaseEnvironmentShallowReference	Gets releaseEnvironmentReference which specifies the reference of the release environment to which this approval is associated.
revision	integer (int32)	Gets the revision number.
status	ApprovalStatus	Gets or sets the status of the approval.
url	string	Gets url to access the approval.

ReleaseApprovalHistory

Object

Name	Type	Description
approver	IdentityRef	Identity of the approver.
changedBy	IdentityRef	Identity of the object who changed approval.
comments	string	Approval history comments.
createdOn	string (date-time)	Time when this approval created.
modifiedOn	string (date-time)	Time when this approval modified.
revision	integer (int32)	Approval history revision.

ReleaseCondition

Object

Name	Type	Description
conditionType	ConditionType	Gets or sets the condition type.
name	string	Gets or sets the name of the condition. e.g. 'ReleaseStarted'.
result	boolean	The release condition result.
value	string	Gets or set value of the condition.

ReleaseDefinitionApprovals

Object

Name	Type	Description
approvalOptions	ApprovalOptions	Gets or sets the approval options.
approvals	ReleaseDefinitionApprovalStep[]	Gets or sets the approvals.

ReleaseDefinitionApprovalStep

Object

Name	Type	Description
approver	IdentityRef	Gets and sets the approver.
id	integer (int32)	ID of the approval or deploy step.
isAutomated	boolean	Indicates whether the approval automated.
isNotificationOn	boolean	Indicates whether the approval notification set.
rank	integer (int32)	Gets or sets the rank of approval step.

ReleaseDefinitionGate

Object

Name	Type	Description
tasks	WorkflowTask[]	Gets or sets the gates workflow.

ReleaseDefinitionGatesOptions

Object

Name	Type	Description
isEnabled	boolean	Gets or sets as the gates enabled or not.
minimumSuccessDuration	integer (int32)	Gets or sets the minimum duration for steady results after a successful gates evaluation.
samplingInterval	integer (int32)	Gets or sets the time between re-evaluation of gates.
stabilizationTime	integer (int32)	Gets or sets the delay before evaluation.
timeout	integer (int32)	Gets or sets the timeout after which gates fail.

ReleaseDefinitionGatesStep

Object

Name	Type	Description
gates	ReleaseDefinitionGate[]	Gets or sets the gates.
gatesOptions	ReleaseDefinitionGatesOptions	Gets or sets the gate options.
id	integer (int32)	ID of the ReleaseDefinitionGateStep.

ReleaseDefinitionShallowReference

Object

Name	Type	Description
_links	ReferenceLinks	Gets the links to related resources, APIs, and views for the release definition.
id	integer (int32)	Gets the unique identifier of release definition.
name	string	Gets or sets the name of the release definition.
path	string	Gets or sets the path of the release definition.
projectReference	ProjectReference	Gets or sets project reference.
url	string	Gets the REST API url to access the release definition.

ReleaseDeployPhase

Object

Name	Type	Description
deploymentJobs	DeploymentJob[]	Deployment jobs of the phase.
errorLog	string	Phase execution error logs.
manualInterventions	ManualIntervention[]	List of manual intervention tasks execution information in phase.
name	string	Name of the phase.
phaseId	string	ID of the phase.
phaseType	DeployPhaseTypes	Type of the phase.
rank	integer (int32)	Rank of the phase.
runPlanId	string (uuid)	Run Plan ID of the phase.
startedOn	string (date-time)	Phase start time.
status	DeployPhaseStatus	Status of the phase.

ReleaseEnvironment

Object

Name	Type	Description
conditions	ReleaseCondition[]	Gets list of conditions.
createdOn	string (date-time)	Gets date on which it got created.
definitionEnvironmentId	integer (int32)	Gets definition environment id.
deployPhasesSnapshot	DeployPhase[]	Gets list of deploy phases snapshot.
deploySteps	DeploymentAttempt[]	Gets deploy steps.
environmentOptions	EnvironmentOptions	Gets environment options.
id	integer (int32)	Gets the unique identifier of this field.
modifiedOn	string (date-time)	Gets date on which it got modified.
name	string	Gets name.
nextScheduledUtcTime	string (date-time)	Gets next scheduled UTC time.
owner	IdentityRef	Gets the identity who is owner for release environment.
postApprovalsSnapshot	ReleaseDefinitionApprovals	Gets list of post deploy approvals snapshot.
postDeployApprovals	ReleaseApproval[]	Gets list of post deploy approvals.
postDeploymentGatesSnapshot	ReleaseDefinitionGatesStep	Post deployment gates snapshot data.
preApprovalsSnapshot	ReleaseDefinitionApprovals	Gets list of pre deploy approvals snapshot.
preDeployApprovals	ReleaseApproval[]	Gets list of pre deploy approvals.
preDeploymentGatesSnapshot	ReleaseDefinitionGatesStep	Pre deployment gates snapshot data.
processParameters	ProcessParameters	Gets process parameters.
rank	integer (int32)	Gets rank.
release	ReleaseShallowReference	Gets release reference which specifies the reference of the release to which this release environment is associated.
releaseCreatedBy	IdentityRef	Gets the identity who created release.
releaseDefinition	ReleaseDefinitionShallowReference	Gets releaseDefinitionReference which specifies the reference of the release definition to which this release environment is associated.
releaseId	integer (int32)	Gets release id.
scheduledDeploymentTime	string (date-time)	Gets schedule deployment time of release environment.
schedules	ReleaseSchedule[]	Gets list of schedules.
status	EnvironmentStatus	Gets environment status.
timeToDeploy	number (double)	Gets time to deploy.
triggerReason	string	Gets trigger reason.
variableGroups	VariableGroup[]	Gets the list of variable groups.
variables	<string, ConfigurationVariableValue>	Gets the dictionary of variables.

ReleaseEnvironmentShallowReference

Object

Name	Type	Description
_links	ReferenceLinks	Gets the links to related resources, APIs, and views for the release environment.
id	integer (int32)	Gets the unique identifier of release environment.
name	string	Gets or sets the name of the release environment.
url	string	Gets the REST API url to access the release environment.

ReleaseEnvironmentUpdateMetadata

Object

Name	Type	Description
comment	string	Gets or sets comment.
scheduledDeploymentTime	string (date-time)	Gets or sets scheduled deployment time.
status	EnvironmentStatus	Gets or sets status of environment.
variables	<string, ConfigurationVariableValue>	Sets list of environment variables to be overridden at deployment time.

ReleaseGates

Object

Name	Type	Description
deploymentJobs	DeploymentJob[]	Contains the gates job details of each evaluation.
id	integer (int32)	ID of release gates.
ignoredGates	IgnoredGate[]	List of ignored gates.
lastModifiedOn	string (date-time)	Gates last modified time.
runPlanId	string (uuid)	Run plan ID of the gates.
stabilizationCompletedOn	string (date-time)	Gates stabilization completed date and time.
startedOn	string (date-time)	Gates evaluation started time.
status	GateStatus	Status of release gates.
succeedingSince	string (date-time)	Date and time at which all gates executed successfully.

ReleaseSchedule

Object

Name	Type	Description
daysToRelease	ScheduleDays	Days of the week to release.
jobId	string (uuid)	Team Foundation Job Definition Job Id.
scheduleOnlyWithChanges	boolean	Flag to determine if this schedule should only release if the associated artifact has been changed or release definition changed.
startHours	integer (int32)	Local time zone hour to start.
startMinutes	integer (int32)	Local time zone minute to start.
timeZoneId	string	Time zone Id of release schedule, such as 'UTC'.

ReleaseShallowReference

Object

Name	Type	Description
_links	ReferenceLinks	Gets the links to related resources, APIs, and views for the release.
id	integer (int32)	Gets the unique identifier of release.
name	string	Gets or sets the name of the release.
url	string	Gets the REST API url to access the release.

ReleaseTask

Object

Name	Type	Description
agentName	string	Agent name on which task executed.
finishTime	string (date-time)	Finish time of the release task.
id	integer (int32)	ID of the release task.
issues	Issue[]	List of issues occurred while execution of task.
lineCount	integer (int64)	Number of lines log release task has.
logUrl	string	Log URL of the task.
name	string	Name of the task.
percentComplete	integer (int32)	Task execution complete precent.
rank	integer (int32)	Rank of the release task.
resultCode	string	Result code of the task.
startTime	string (date-time)	ID of the release task.
status	TaskStatus	Status of release task.
task	WorkflowTaskReference	Workflow task reference.
timelineRecordId	string (uuid)	Timeline record ID of the release task.

ScheduleDays

Enumeration

Days of the week to release.

Value	Description
none	Scheduled day not set.
monday	Scheduled on Monday.
tuesday	Scheduled on Tuesday.
wednesday	Scheduled on Wednesday.
thursday	Scheduled on Thursday.
friday	Scheduled on Friday.
saturday	Scheduled on Saturday.
sunday	Scheduled on Sunday.
all	Scheduled on all the days in week.

TaskInputDefinitionBase

Object

Name	Type	Description
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

Object

Name	Type	Description
expression	string	Conditional expression
message	string	Message explaining how user can correct if validation fails

TaskSourceDefinitionBase

Object

Name	Type	Description
authKey	string
endpoint	string
keySelector	string
selector	string
target	string

TaskStatus

Enumeration

Status of release task.

Value	Description
unknown	The task does not have the status set.
pending	The task is in pending status.
inProgress	The task is currently in progress.
success	The task completed successfully.
failure	The task execution failed.
canceled	The task execution canceled.
skipped	The task execution skipped.
succeeded	The task completed successfully.
failed	The task execution failed.
partiallySucceeded	The task execution partially succeeded.

VariableGroup

Object

Name	Type	Description
createdBy	IdentityRef	Gets or sets the identity who created.
createdOn	string (date-time)	Gets date on which it got created.
description	string	Gets or sets description.
id	integer (int32)	Gets the unique identifier of this field.
isShared	boolean	Denotes if a variable group is shared with other project or not.
modifiedBy	IdentityRef	Gets or sets the identity who modified.
modifiedOn	string (date-time)	Gets date on which it got modified.
name	string	Gets or sets name.
providerData	VariableGroupProviderData	Gets or sets provider data.
type	string	Gets or sets type.
variableGroupProjectReferences	VariableGroupProjectReference[]	all project references where the variable group is shared with other projects.
variables	<string, VariableValue>	Gets and sets the dictionary of variables.

VariableGroupProjectReference

Object

A variable group reference is a shallow reference to variable group.

Name	Type	Description
description	string	Gets or sets description of the variable group.
name	string	Gets or sets name of the variable group.
projectReference	ProjectReference	Gets or sets project reference of the variable group.

VariableGroupProviderData

Object

VariableValue

Object

Name	Type	Description
isReadOnly	boolean	Gets or sets if the variable is read only or not.
isSecret	boolean	Gets or sets as the variable is secret or not.
value	string	Gets or sets the value.

WorkflowTask

Object

Name	Type	Description
alwaysRun	boolean	Gets or sets as the task always run or not.
condition	string	Gets or sets the task condition.
continueOnError	boolean	Gets or sets as the task continue run on error or not.
definitionType	string	Gets or sets the task definition type. Example:- 'Agent', DeploymentGroup', 'Server' or 'ServerGate'.
enabled	boolean	Gets or sets as the task enabled or not.
environment	object	Gets or sets the task environment variables.
inputs	object	Gets or sets the task inputs.
name	string	Gets or sets the name of the task.
overrideInputs	object	Gets or sets the task override inputs.
refName	string	Gets or sets the reference name of the task.
retryCountOnTaskFailure	integer (int32)	Gets or sets the task retryCount.
taskId	string (uuid)	Gets or sets the ID of the task.
timeoutInMinutes	integer (int32)	Gets or sets the task timeout.
version	string	Gets or sets the version of the task.

WorkflowTaskReference

Object

Name	Type	Description
id	string (uuid)	Task identifier.
name	string	Name of the task.
version	string	Version of the task.

Share via

Releases - Update Release Environment

URI Parameters

Request Body

Responses

Security

oauth2

Scopes

Examples

Start deployment on an environment

Sample request

Sample response

Definitions

ApprovalExecutionOrder

ApprovalOptions

ApprovalStatus

ApprovalType

AuthorizationHeader

ConditionType

ConfigurationVariableValue

DataSourceBindingBase

DeploymentAttempt

DeploymentJob

DeploymentOperationStatus

DeploymentReason

DeploymentStatus

DeployPhase

DeployPhaseStatus

DeployPhaseTypes

EnvironmentOptions

EnvironmentStatus

GateStatus

IdentityRef

IgnoredGate

Issue

ManualIntervention

ManualInterventionStatus

ProcessParameters

ProjectReference

ReferenceLinks

ReleaseApproval

ReleaseApprovalHistory

ReleaseCondition

ReleaseDefinitionApprovals

ReleaseDefinitionApprovalStep

ReleaseDefinitionGate

ReleaseDefinitionGatesOptions

ReleaseDefinitionGatesStep

ReleaseDefinitionShallowReference

ReleaseDeployPhase

ReleaseEnvironment

ReleaseEnvironmentShallowReference

ReleaseEnvironmentUpdateMetadata

ReleaseGates

ReleaseSchedule

ReleaseShallowReference

ReleaseTask

ScheduleDays

TaskInputDefinitionBase

TaskInputValidation

TaskSourceDefinitionBase

TaskStatus

VariableGroup

VariableGroupProjectReference

VariableGroupProviderData

VariableValue

WorkflowTask

WorkflowTaskReference