Releases - Update Release Resource

Reference

Service:: Release

API Version:: 5.0

Update few properties of a release.

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

URI Parameters

Name	In	Required	Type	Description
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 to update.
api-version	query	True	string	Version of the API to use. This should be set to '5.0' to use this version of the api.

Request Body

Name	Type	Description
comment	string	Sets comment for release.
keepForever	boolean	Set 'true' to exclude the release from retention policies.
manualEnvironments	string[]	Sets list of manual environments.
status	ReleaseStatus	Sets status of the release.

Responses

Name	Type	Description
200 OK	Release	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.

Examples

Abandoning an active release

Sample request

HTTP

PATCH https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/releases/{releaseId}?api-version=5.0

{
  "status": "abandoned",
  "manualEnvironments": null,
  "comment": "Abandon the release"
}

Sample response

Status code:: 200

{
  "id": 21,
  "name": "Release-21",
  "status": "abandoned",
  "createdOn": "2017-06-16T01:53:35.667Z",
  "modifiedOn": "2017-06-16T01:53:36.37Z",
  "modifiedBy": {
    "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "displayName": "Chuck Reinhart",
    "uniqueName": "fabfiber@outlook.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
  },
  "createdBy": {
    "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "displayName": "Chuck Reinhart",
    "uniqueName": "fabfiber@outlook.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
  },
  "environments": [
    {
      "id": 81,
      "releaseId": 21,
      "name": "Dev",
      "status": "notStarted",
      "variables": {},
      "preDeployApprovals": [],
      "postDeployApprovals": [],
      "preApprovalsSnapshot": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": false,
            "isNotificationOn": false,
            "approver": {
              "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
              "displayName": "Chuck Reinhart",
              "uniqueName": "fabfiber@outlook.com",
              "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
              "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
            },
            "id": 0
          }
        ],
        "approvalOptions": {
          "requiredApproverCount": 0,
          "releaseCreatorCanBeApprover": true,
          "autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
          "enforceIdentityRevalidation": false,
          "timeoutInMintues": 43200
        }
      },
      "postApprovalsSnapshot": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 0
          }
        ]
      },
      "deploySteps": [],
      "rank": 1,
      "definitionEnvironmentId": 1,
      "environmentOptions": {
        "emailNotificationType": "OnlyOnFailure",
        "emailRecipients": "release.environment.owner;release.creator",
        "skipArtifactsDownload": false,
        "timeoutInMinutes": 0,
        "enableAccessToken": false,
        "publishDeploymentStatus": false
      },
      "demands": [],
      "conditions": [],
      "workflowTasks": [],
      "deployPhasesSnapshot": [
        {
          "deploymentInput": {
            "parallelExecution": {
              "parallelExecutionType": "none"
            },
            "skipArtifactsDownload": false,
            "timeoutInMinutes": 0,
            "queueId": 2,
            "demands": [],
            "enableAccessToken": false
          },
          "rank": 1,
          "phaseType": "agentBasedDeployment",
          "name": "Run on agent",
          "workflowTasks": [
            {
              "taskId": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
              "version": "1.*",
              "name": "PowerShell Script",
              "enabled": true,
              "alwaysRun": false,
              "continueOnError": false,
              "timeoutInMinutes": 0,
              "definitionType": "task",
              "inputs": {
                "scriptType": "inlineScript",
                "scriptName": "",
                "arguments": "",
                "inlineScript": "# You can write your powershell scripts inline here. \n# You can also pass predefined and custom variables to this scripts using arguments\n\n Write-Host \"Hello World\"",
                "workingFolder": "",
                "failOnStandardError": "true"
              }
            }
          ]
        }
      ],
      "owner": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabfiber@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      },
      "schedules": [],
      "release": {
        "id": 21,
        "name": "Release-21",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/21",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=21&_a=release-summary"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/21"
          }
        }
      },
      "releaseDefinition": {
        "id": 1,
        "name": "MyShuttle.CD",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
          }
        }
      },
      "releaseCreatedBy": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart"
      },
      "triggerReason": "Manual"
    },
    {
      "id": 82,
      "releaseId": 21,
      "name": "QA",
      "status": "notStarted",
      "variables": {},
      "preDeployApprovals": [],
      "postDeployApprovals": [],
      "preApprovalsSnapshot": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 0
          }
        ]
      },
      "postApprovalsSnapshot": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 0
          }
        ]
      },
      "deploySteps": [],
      "rank": 2,
      "definitionEnvironmentId": 2,
      "environmentOptions": {
        "emailNotificationType": "OnlyOnFailure",
        "emailRecipients": "release.environment.owner;release.creator",
        "skipArtifactsDownload": false,
        "timeoutInMinutes": 0,
        "enableAccessToken": false,
        "publishDeploymentStatus": false
      },
      "demands": [],
      "conditions": [
        {
          "result": false,
          "name": "Dev",
          "conditionType": "environmentState",
          "value": "4"
        }
      ],
      "workflowTasks": [],
      "deployPhasesSnapshot": [
        {
          "deploymentInput": {
            "parallelExecution": {
              "parallelExecutionType": "none"
            },
            "skipArtifactsDownload": false,
            "timeoutInMinutes": 0,
            "queueId": 2,
            "demands": [],
            "enableAccessToken": false
          },
          "rank": 1,
          "phaseType": "agentBasedDeployment",
          "name": "Run on agent",
          "workflowTasks": [
            {
              "taskId": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
              "version": "1.*",
              "name": "PowerShell Script",
              "enabled": true,
              "alwaysRun": false,
              "continueOnError": false,
              "timeoutInMinutes": 0,
              "definitionType": "task",
              "inputs": {
                "scriptType": "inlineScript",
                "scriptName": "",
                "arguments": "",
                "inlineScript": "# You can write your powershell scripts inline here. \n# You can also pass predefined and custom variables to this scripts using arguments\n\n Write-Host \"Hello World\"",
                "workingFolder": "",
                "failOnStandardError": "true"
              }
            }
          ]
        }
      ],
      "owner": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabfiber@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      },
      "schedules": [],
      "release": {
        "id": 21,
        "name": "Release-21",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/21",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=21&_a=release-summary"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/21"
          }
        }
      },
      "releaseDefinition": {
        "id": 1,
        "name": "MyShuttle.CD",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
          }
        }
      },
      "releaseCreatedBy": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart"
      },
      "triggerReason": "After successful deployment of Dev"
    },
    {
      "id": 83,
      "releaseId": 21,
      "name": "PPE",
      "status": "notStarted",
      "variables": {},
      "preDeployApprovals": [],
      "postDeployApprovals": [],
      "preApprovalsSnapshot": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 0
          }
        ]
      },
      "postApprovalsSnapshot": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 0
          }
        ]
      },
      "deploySteps": [],
      "rank": 3,
      "definitionEnvironmentId": 3,
      "environmentOptions": {
        "emailNotificationType": "OnlyOnFailure",
        "emailRecipients": "release.environment.owner;release.creator",
        "skipArtifactsDownload": false,
        "timeoutInMinutes": 0,
        "enableAccessToken": false,
        "publishDeploymentStatus": false
      },
      "demands": [],
      "conditions": [
        {
          "result": false,
          "name": "QA",
          "conditionType": "environmentState",
          "value": "4"
        }
      ],
      "workflowTasks": [],
      "deployPhasesSnapshot": [
        {
          "deploymentInput": {
            "parallelExecution": {
              "parallelExecutionType": "none"
            },
            "skipArtifactsDownload": false,
            "timeoutInMinutes": 0,
            "queueId": 2,
            "demands": [],
            "enableAccessToken": false
          },
          "rank": 1,
          "phaseType": "agentBasedDeployment",
          "name": "Run on agent",
          "workflowTasks": [
            {
              "taskId": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
              "version": "1.*",
              "name": "PowerShell Script",
              "enabled": true,
              "alwaysRun": false,
              "continueOnError": false,
              "timeoutInMinutes": 0,
              "definitionType": "task",
              "inputs": {
                "scriptType": "inlineScript",
                "scriptName": "",
                "arguments": "",
                "inlineScript": "# You can write your powershell scripts inline here. \n# You can also pass predefined and custom variables to this scripts using arguments\n\n Write-Host \"Hello World\"",
                "workingFolder": "",
                "failOnStandardError": "true"
              }
            }
          ]
        }
      ],
      "owner": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabfiber@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      },
      "schedules": [],
      "release": {
        "id": 21,
        "name": "Release-21",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/21",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=21&_a=release-summary"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/21"
          }
        }
      },
      "releaseDefinition": {
        "id": 1,
        "name": "MyShuttle.CD",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
          }
        }
      },
      "releaseCreatedBy": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart"
      },
      "triggerReason": "After successful deployment of QA"
    },
    {
      "id": 84,
      "releaseId": 21,
      "name": "PROD",
      "status": "notStarted",
      "variables": {},
      "preDeployApprovals": [],
      "postDeployApprovals": [],
      "preApprovalsSnapshot": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 0
          }
        ]
      },
      "postApprovalsSnapshot": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 0
          }
        ]
      },
      "deploySteps": [],
      "rank": 4,
      "definitionEnvironmentId": 4,
      "environmentOptions": {
        "emailNotificationType": "OnlyOnFailure",
        "emailRecipients": "release.environment.owner;release.creator",
        "skipArtifactsDownload": false,
        "timeoutInMinutes": 0,
        "enableAccessToken": false,
        "publishDeploymentStatus": false
      },
      "demands": [],
      "conditions": [
        {
          "result": false,
          "name": "PPE",
          "conditionType": "environmentState",
          "value": "4"
        }
      ],
      "workflowTasks": [],
      "deployPhasesSnapshot": [
        {
          "deploymentInput": {
            "parallelExecution": {
              "parallelExecutionType": "none"
            },
            "skipArtifactsDownload": false,
            "timeoutInMinutes": 0,
            "queueId": 2,
            "demands": [],
            "enableAccessToken": false
          },
          "rank": 1,
          "phaseType": "agentBasedDeployment",
          "name": "Run on agent",
          "workflowTasks": [
            {
              "taskId": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
              "version": "1.*",
              "name": "PowerShell Script",
              "enabled": true,
              "alwaysRun": false,
              "continueOnError": false,
              "timeoutInMinutes": 0,
              "definitionType": "task",
              "inputs": {
                "scriptType": "inlineScript",
                "scriptName": "",
                "arguments": "",
                "inlineScript": "# You can write your powershell scripts inline here. \n# You can also pass predefined and custom variables to this scripts using arguments\n\n Write-Host \"Hello World\"",
                "workingFolder": "",
                "failOnStandardError": "true"
              }
            }
          ]
        }
      ],
      "owner": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabfiber@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      },
      "schedules": [],
      "release": {
        "id": 21,
        "name": "Release-21",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/21",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=21&_a=release-summary"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/21"
          }
        }
      },
      "releaseDefinition": {
        "id": 1,
        "name": "MyShuttle.CD",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
          }
        }
      },
      "releaseCreatedBy": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart"
      },
      "triggerReason": "After successful deployment of PPE"
    }
  ],
  "variables": {},
  "variableGroups": [],
  "artifacts": [
    {
      "sourceId": "d07908bc-118f-47d2-8a13-ff75601a6b1a:1",
      "type": "Build",
      "alias": "Fabrikam.CI",
      "definitionReference": {
        "artifactSourceDefinitionUrl": {
          "id": "https://dev.azure.com/fabrikam/_permalink/_build/index?collectionId=13d3daac-03b8-4a23-9cc4-2c3de65dab63&projectId=d07908bc-118f-47d2-8a13-ff75601a6b1a&definitionId=1",
          "name": ""
        },
        "defaultVersionBranch": {
          "id": "",
          "name": ""
        },
        "defaultVersionSpecific": {
          "id": "",
          "name": ""
        },
        "defaultVersionTags": {
          "id": "",
          "name": ""
        },
        "defaultVersionType": {
          "id": "latestType",
          "name": "Latest"
        },
        "definition": {
          "id": "1",
          "name": "Fabrikam.CI"
        },
        "project": {
          "id": "d07908bc-118f-47d2-8a13-ff75601a6b1a",
          "name": "MyFirstProject"
        },
        "version": {
          "id": "2",
          "name": "2"
        },
        "artifactSourceVersionUrl": {
          "id": "https://dev.azure.com/fabrikam/_permalink/_build/index?collectionId=13d3daac-03b8-4a23-9cc4-2c3de65dab63&projectId=d07908bc-118f-47d2-8a13-ff75601a6b1a&buildId=2",
          "name": ""
        },
        "branch": {
          "id": "refs/heads/master",
          "name": "refs/heads/master"
        }
      },
      "isPrimary": true
    }
  ],
  "releaseDefinition": {
    "id": 1,
    "name": "MyShuttle.CD",
    "url": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
    "_links": {
      "self": {
        "href": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
      },
      "web": {
        "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
      }
    }
  },
  "description": "Creating Sample release",
  "reason": "manual",
  "releaseNameFormat": "Release-$(rev:r)",
  "keepForever": false,
  "definitionSnapshotRevision": 1,
  "logsContainerUrl": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/21/logs",
  "url": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/21",
  "_links": {
    "self": {
      "href": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/21"
    },
    "web": {
      "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=21&_a=release-summary"
    }
  },
  "tags": [],
  "projectReference": {
    "id": "d07908bc-118f-47d2-8a13-ff75601a6b1a",
    "name": null
  },
  "properties": {}
}

Definitions

Name	Description
ApprovalExecutionOrder
ApprovalOptions
ApprovalStatus	Gets or sets the status of the approval.
ApprovalType	Gets or sets the type of approval.
Artifact
ArtifactSourceReference
AuthorizationHeader
ConditionType	Gets or sets the condition type.
ConfigurationVariableValue
DataSourceBindingBase	Represents binding of data source for the service endpoint request.
Demand
DeploymentAttempt
DeploymentJob
DeploymentOperationStatus	Gets operation status of deployment.
DeploymentReason	Gets reason of deployment.
DeploymentStatus	Gets status of the deployment.
DeployPhase
DeployPhaseStatus
DeployPhaseTypes
EnvironmentOptions
EnvironmentStatus	Gets environment status.
GateStatus
IdentityRef
IgnoredGate
Issue
ManualIntervention
ManualInterventionStatus	Gets or sets the status of the manual intervention.
ProcessParameters
ProjectReference
PropertiesCollection	The class represents a property bag as a collection of key-value pairs. Values of all primitive types (any type with a `TypeCode != TypeCode.Object`) except for `DBNull` are accepted. Values of type Byte[], Int32, Double, DateType and String preserve their type, other primitives are retuned as a String. Byte[] expected as base64 encoded string.
ReferenceLinks	The class to represent a collection of REST reference links.
Release
ReleaseApproval
ReleaseApprovalHistory
ReleaseCondition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionShallowReference
ReleaseDeployPhase
ReleaseEnvironment
ReleaseEnvironmentShallowReference
ReleaseGates
ReleaseReason	Gets reason for release.
ReleaseSchedule
ReleaseShallowReference
ReleaseStatus	Gets status.
ReleaseTask
ReleaseUpdateMetadata
ScheduleDays	Days of the week to release
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
TaskStatus
VariableGroup
VariableGroupProviderData
VariableValue
WorkflowTask
WorkflowTaskReference

ApprovalExecutionOrder

Name	Type	Description
afterGatesAlways	string
afterSuccessfulGates	string
beforeGates	string

ApprovalOptions

Name	Type	Description
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped	boolean
enforceIdentityRevalidation	boolean
executionOrder	ApprovalExecutionOrder
releaseCreatorCanBeApprover	boolean
requiredApproverCount	integer
timeoutInMinutes	integer

ApprovalStatus

Gets or sets the status of the approval.

Name	Type	Description
approved	string
canceled	string
pending	string
reassigned	string
rejected	string
skipped	string
undefined	string

ApprovalType

Gets or sets the type of approval.

Name	Type	Description
all	string
postDeploy	string
preDeploy	string
undefined	string

Artifact

Name	Type	Description
alias	string	Gets or sets alias.
definitionReference	<string, ArtifactSourceReference>	Gets or sets definition reference. e.g. {"project":{"id":"fed755ea-49c5-4399-acea-fd5b5aa90a6c","name":"myProject"},"definition":{"id":"1","name":"mybuildDefinition"},"connection":{"id":"1","name":"myConnection"}}
isPrimary	boolean	Gets or sets as artifact is primary or not.
isRetained	boolean
type	string	Gets or sets type. It can have value as 'Build', 'Jenkins', 'GitHub', 'Nuget', 'Team Build (external)', 'ExternalTFSBuild', 'Git', 'TFVC', 'ExternalTfsXamlBuild'.

ArtifactSourceReference

Name	Type	Description
id	string
name	string

AuthorizationHeader

Name	Type	Description
name	string
value	string

ConditionType

Gets or sets the condition type.

Name	Type	Description
artifact	string	The condition type is artifact.
environmentState	string	The condition type is environment state.
event	string	The condition type is event.
undefined	string	The condition type is undefined.

ConfigurationVariableValue

Name	Type	Description
allowOverride	boolean	Gets or 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 or sets value of the configuration variable.

DataSourceBindingBase

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.
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.

Demand

Name	Type	Description
name	string
value	string

DeploymentAttempt

Name	Type	Description
attempt	integer
deploymentId	integer
hasStarted	boolean	Specifies whether deployment has started or not
id	integer
issues	Issue[]	All the issues related to the deployment
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

Name	Type	Description
job	ReleaseTask
tasks	ReleaseTask[]

DeploymentOperationStatus

Gets operation status of deployment.

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

DeploymentReason

Gets reason of deployment.

Name	Type	Description
automated	string	The deployment reason is automated.
manual	string	The deployment reason is manual.
none	string	The deployment reason is none.
redeployTrigger	string	The deployment reason is RedeployTrigger.
scheduled	string	The deployment reason is scheduled.

DeploymentStatus

Gets status of the deployment.

Name	Type	Description
all	string	The deployment status is all.
failed	string	The deployment status is failed.
inProgress	string	The deployment status is inprogress.
notDeployed	string	The deployment status is not deployed.
partiallySucceeded	string	The deployment status is partiallysucceeded.
succeeded	string	The deployment status is succeeded.
undefined	string	The deployment status is undefined.

DeployPhase

Name	Type	Description
name	string
phaseType	DeployPhaseTypes
rank	integer
refName	string
workflowTasks	WorkflowTask[]

DeployPhaseStatus

Name	Type	Description
canceled	string
cancelling	string
failed	string
inProgress	string
notStarted	string
partiallySucceeded	string
skipped	string
succeeded	string
undefined	string

DeployPhaseTypes

Name	Type	Description
agentBasedDeployment	string
deploymentGates	string	Phase type which contains tasks which acts as Gates for the deployment to go forward.
machineGroupBasedDeployment	string
runOnServer	string
undefined	string

EnvironmentOptions

Name	Type	Description
autoLinkWorkItems	boolean
badgeEnabled	boolean
emailNotificationType	string
emailRecipients	string
enableAccessToken	boolean
publishDeploymentStatus	boolean
pullRequestDeploymentEnabled	boolean
skipArtifactsDownload	boolean
timeoutInMinutes	integer

EnvironmentStatus

Gets environment status.

Name	Type	Description
canceled	string
inProgress	string
notStarted	string
partiallySucceeded	string
queued	string
rejected	string
scheduled	string
succeeded	string
undefined	string

GateStatus

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

IdentityRef

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
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
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	This url is the full route to the source resource of this graph subject.

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

ManualIntervention

Name	Type	Description
approver	IdentityRef	Gets or sets the identity who should approve.
comments	string	Gets or sets comments for approval.
createdOn	string	Gets date on which it got created.
id	integer	Gets the unique identifier for manual intervention.
instructions	string	Gets or sets instructions for approval.
modifiedOn	string	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	Get task instance identifier.
url	string	Gets url to access the manual intervention.

ManualInterventionStatus

Gets or sets the status of the manual intervention.

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

ProcessParameters

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

ProjectReference

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

PropertiesCollection

The class represents a property bag as a collection of key-value pairs. Values of all primitive types (any type with a TypeCode != TypeCode.Object) except for DBNull are accepted. Values of type Byte[], Int32, Double, DateType and String preserve their type, other primitives are retuned as a String. Byte[] expected as base64 encoded string.

Name	Type	Description
count	integer	The count of properties in the collection.
item	object
keys	string[]	The set of keys in the collection.
values	string[]	The set of values in the collection.

ReferenceLinks

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.

Release

Name	Type	Description
_links	ReferenceLinks	Gets links to access the release.
artifacts	Artifact[]	Gets or sets the list of artifacts.
comment	string	Gets or sets comment.
createdBy	IdentityRef	Gets or sets the identity who created.
createdOn	string	Gets date on which it got created.
definitionSnapshotRevision	integer	Gets revision number of definition snapshot.
description	string	Gets or sets description of release.
environments	ReleaseEnvironment[]	Gets list of environments.
id	integer	Gets the unique identifier of this field.
keepForever	boolean	Whether to exclude the release from retention policies.
logsContainerUrl	string	Gets logs container url.
modifiedBy	IdentityRef	Gets or sets the identity who modified.
modifiedOn	string	Gets date on which it got modified.
name	string	Gets name.
poolName	string	Gets pool name.
projectReference	ProjectReference	Gets or sets project reference.
properties	PropertiesCollection	The class represents a property bag as a collection of key-value pairs. Values of all primitive types (any type with a `TypeCode != TypeCode.Object`) except for `DBNull` are accepted. Values of type Byte[], Int32, Double, DateType and String preserve their type, other primitives are retuned as a String. Byte[] expected as base64 encoded string.
reason	ReleaseReason	Gets reason of release.
releaseDefinition	ReleaseDefinitionShallowReference	Gets releaseDefinitionReference which specifies the reference of the release definition to which this release is associated.
releaseNameFormat	string	Gets release name format.
status	ReleaseStatus	Gets status.
tags	string[]	Gets or sets list of tags.
triggeringArtifactAlias	string
variableGroups	VariableGroup[]	Gets the list of variable groups.
variables	<string, ConfigurationVariableValue>	Gets or sets the dictionary of variables.

ReleaseApproval

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	Gets or sets attempt which specifies as which deployment attempt it belongs.
comments	string	Gets or sets comments for approval.
createdOn	string	Gets date on which it got created.
history	ReleaseApprovalHistory[]	Gets history which specifies all approvals associated with this approval.
id	integer	Gets the unique identifier of this field.
isAutomated	boolean	Gets or sets as approval is automated or not.
isNotificationOn	boolean
modifiedOn	string	Gets date on which it got modified.
rank	integer	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	Gets the revision number.
status	ApprovalStatus	Gets or sets the status of the approval.
trialNumber	integer
url	string	Gets url to access the approval.

ReleaseApprovalHistory

Name	Type	Description
approver	IdentityRef
changedBy	IdentityRef
comments	string
createdOn	string
modifiedOn	string
revision	integer

ReleaseCondition

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
value	string	Gets or set value of the condition.

ReleaseDefinitionApprovals

Name	Type	Description
approvalOptions	ApprovalOptions
approvals	ReleaseDefinitionApprovalStep[]

ReleaseDefinitionApprovalStep

Name	Type	Description
approver	IdentityRef
id	integer
isAutomated	boolean
isNotificationOn	boolean
rank	integer

ReleaseDefinitionGate

Name	Type	Description
tasks	WorkflowTask[]

ReleaseDefinitionGatesOptions

Name	Type	Description
isEnabled	boolean
minimumSuccessDuration	integer
samplingInterval	integer
stabilizationTime	integer
timeout	integer

ReleaseDefinitionGatesStep

Name	Type	Description
gates	ReleaseDefinitionGate[]
gatesOptions	ReleaseDefinitionGatesOptions
id	integer

ReleaseDefinitionShallowReference

Name	Type	Description
_links	ReferenceLinks	Gets the links to related resources, APIs, and views for the release definition.
id	integer	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

Name	Type	Description
deploymentJobs	DeploymentJob[]
errorLog	string
id	integer
manualInterventions	ManualIntervention[]
name	string
phaseId	string
phaseType	DeployPhaseTypes
rank	integer
runPlanId	string
startedOn	string	Phase start time
status	DeployPhaseStatus

ReleaseEnvironment

Name	Type	Description
conditions	ReleaseCondition[]	Gets list of conditions.
createdOn	string	Gets date on which it got created.
definitionEnvironmentId	integer	Gets definition environment id.
demands	Demand[]	Gets demands.
deployPhasesSnapshot	DeployPhase[]	Gets list of deploy phases snapshot.
deploySteps	DeploymentAttempt[]	Gets deploy steps.
environmentOptions	EnvironmentOptions	Gets environment options.
id	integer	Gets the unique identifier of this field.
modifiedOn	string	Gets date on which it got modified.
name	string	Gets name.
nextScheduledUtcTime	string	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
preApprovalsSnapshot	ReleaseDefinitionApprovals	Gets list of pre deploy approvals snapshot.
preDeployApprovals	ReleaseApproval[]	Gets list of pre deploy approvals.
preDeploymentGatesSnapshot	ReleaseDefinitionGatesStep
processParameters	ProcessParameters	Gets process parameters.
queueId	integer	Gets queue id.
rank	integer	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.
releaseDescription	string	Gets release description.
releaseId	integer	Gets release id.
scheduledDeploymentTime	string	Gets schedule deployment time of release environment.
schedules	ReleaseSchedule[]	Gets list of schedules.
status	EnvironmentStatus	Gets environment status.
timeToDeploy	number	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.
workflowTasks	WorkflowTask[]	Gets list of workflow tasks.

ReleaseEnvironmentShallowReference

Name	Type	Description
_links	ReferenceLinks	Gets the links to related resources, APIs, and views for the release environment.
id	integer	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.

ReleaseGates

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

ReleaseReason

Gets reason for release.

Name	Type	Description
continuousIntegration	string
manual	string
none	string
pullRequest	string
schedule	string

ReleaseSchedule

Name	Type	Description
daysToRelease	ScheduleDays	Days of the week to release
jobId	string	Team Foundation Job Definition Job Id
startHours	integer	Local time zone hour to start
startMinutes	integer	Local time zone minute to start
timeZoneId	string	Time zone Id of release schedule, such as 'UTC'

ReleaseShallowReference

Name	Type	Description
_links	ReferenceLinks	Gets the links to related resources, APIs, and views for the release.
id	integer	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.

ReleaseStatus

Gets status.

Name	Type	Description
abandoned	string
active	string
draft	string
undefined	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

ReleaseUpdateMetadata

Name	Type	Description
comment	string	Sets comment for release.
keepForever	boolean	Set 'true' to exclude the release from retention policies.
manualEnvironments	string[]	Sets list of manual environments.
status	ReleaseStatus	Sets status of the release.

ScheduleDays

Days of the week to release

Name	Type	Description
all	string
friday	string
monday	string
none	string
saturday	string
sunday	string
thursday	string
tuesday	string
wednesday	string

TaskInputDefinitionBase

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

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

TaskSourceDefinitionBase

Name	Type	Description
authKey	string
endpoint	string
keySelector	string
selector	string
target	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

VariableGroup

Name	Type	Description
createdBy	IdentityRef	Gets or sets the identity who created.
createdOn	string	Gets date on which it got created.
description	string	Gets or sets description.
id	integer	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	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.
variables	<string, VariableValue>

VariableGroupProviderData

VariableValue

Name	Type	Description
isSecret	boolean
value	string

WorkflowTask

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

Name	Type	Description
id	string
name	string
version	string

Share via