Gates - Update

Service:

Release

API Version:

5.0-preview.1

Updates the gate for a deployment.

PATCH https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/gates/{gateStepId}?api-version=5.0-preview.1

URI Parameters

Name	In	Required	Type	Description
gateStepId	path	True	integer int32	Gate step Id.
organization	path	True	string	The name of the Azure DevOps organization.
project	path	True	string	Project ID or project name
api-version	query	True	string	Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.

Request Body

Name	Type	Description
comment	string	Comment
gatesToIgnore	string[]	Name of gate to be ignored.

Responses

Name	Type	Description
200 OK	ReleaseGates	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 releases, release definitions and release envrionment, and the ability to queue a new release.

Definitions

Name	Description
DeploymentJob
GateStatus
GateUpdateMetadata
IgnoredGate
Issue
ReleaseGates
ReleaseTask
TaskStatus
WorkflowTaskReference

DeploymentJob

Name	Type	Description
job	ReleaseTask
tasks	ReleaseTask[]

GateStatus

Name	Type	Description
canceled	string
failed	string
inProgress	string
none	string
pending	string
succeeded	string

GateUpdateMetadata

Name	Type	Description
comment	string	Comment
gatesToIgnore	string[]	Name of gate to be ignored.

IgnoredGate

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

Issue

Name	Type	Description
data	object
issueType	string
message	string

ReleaseGates

Name	Type	Description
deploymentJobs	DeploymentJob[]
id	integer
ignoredGates	IgnoredGate[]
lastModifiedOn	string
runPlanId	string
stabilizationCompletedOn	string
startedOn	string
status	GateStatus
succeedingSince	string

ReleaseTask

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

TaskStatus

Name	Type	Description
canceled	string
failed	string
failure	string
inProgress	string
partiallySucceeded	string
pending	string
skipped	string
succeeded	string
success	string
unknown	string

WorkflowTaskReference

Name	Type	Description
id	string
name	string
version	string