Releases - Create

Create a release.

POST https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases?api-version=6.1-preview.8

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

api-version
query True

string

Version of the API to use. This should be set to '6.1-preview.8' to use this version of the api.

Request Body

Name Type Description
artifacts

ArtifactMetadata[]

Sets list of artifact to create a release.

definitionId

integer

Sets definition Id to create a release.

description

string

Sets description to create a release.

environmentsMetadata

ReleaseStartEnvironmentMetadata[]

Sets list of environments meta data.

isDraft

boolean

Sets 'true' to create release in draft mode, 'false' otherwise.

manualEnvironments

string[]

Sets list of environments to manual as condition.

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

Sets reason to create a release.

variables

<string,  ConfigurationVariableValue>

Sets list of release variables to be overridden at deployment time.

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 folders, releases, release definitions and release environment, and the ability to queue a new release.

Examples

Sample request

POST https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/releases?api-version=6.1-preview.8

{
  "definitionId": 1,
  "description": "Creating Sample release",
  "artifacts": [
    {
      "alias": "Fabrikam.CI",
      "instanceReference": {
        "id": "2",
        "name": null
      }
    }
  ],
  "isDraft": false,
  "reason": "none",
  "manualEnvironments": null
}

Sample response

{
  "id": 19,
  "name": "Release-19",
  "status": "active",
  "createdOn": "2017-06-16T01:53:32.777Z",
  "modifiedOn": "2017-06-16T01:53:32.777Z",
  "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": 73,
      "releaseId": 19,
      "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": 19,
        "name": "Release-19",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=19&_a=release-summary"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19"
          }
        }
      },
      "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": 74,
      "releaseId": 19,
      "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": 19,
        "name": "Release-19",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=19&_a=release-summary"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19"
          }
        }
      },
      "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": 75,
      "releaseId": 19,
      "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": 19,
        "name": "Release-19",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=19&_a=release-summary"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19"
          }
        }
      },
      "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": 76,
      "releaseId": 19,
      "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": 19,
        "name": "Release-19",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=19&_a=release-summary"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19"
          }
        }
      },
      "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": ""
        },
        "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": ""
        }
      },
      "isPrimary": true
    }
  ],
  "releaseDefinition": {
    "id": 1,
    "name": "MyShuttle.CD",
    "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
    "_links": {
      "self": {
        "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-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://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19/logs",
  "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19",
  "_links": {
    "self": {
      "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19"
    },
    "web": {
      "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=19&_a=release-summary"
    }
  },
  "tags": [],
  "projectReference": {
    "id": "d07908bc-118f-47d2-8a13-ff75601a6b1a",
    "name": null
  },
  "properties": {}
}

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.

Artifact
ArtifactMetadata
ArtifactSourceReference
AuthorizationHeader
BuildVersion
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
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
ReleaseStartEnvironmentMetadata
ReleaseStartMetadata
ReleaseStatus

Gets status.

ReleaseTask
ScheduleDays

Days of the week to release.

SourcePullRequestVersion
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

Approvals execution order.

Name Type Description
afterGatesAlways

string

Approvals shown always after execution of gates.

afterSuccessfulGates

string

Approvals shown after successful execution of gates.

beforeGates

string

Approvals shown before gates.

ApprovalOptions

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

The number of approvals required to move release forward. '0' means all approvals required.

timeoutInMinutes

integer

Approval timeout. Approval default timeout is 30 days. Maximum allowed timeout is 365 days. '0' means default timeout i.e 30 days.

ApprovalStatus

Gets or sets the status of the approval.

Name Type Description
approved

string

Indicates the approval is approved.

canceled

string

Indicates the approval is canceled.

pending

string

Indicates the approval is pending.

reassigned

string

Indicates the approval is reassigned.

rejected

string

Indicates the approval is rejected.

skipped

string

Indicates the approval is skipped.

undefined

string

Indicates the approval does not have the status set.

ApprovalType

Gets or sets the type of approval.

Name Type Description
all

string

Indicates all approvals.

postDeploy

string

Indicates the approvals which executed after deployment.

preDeploy

string

Indicates the approvals which executed before deployment.

undefined

string

Indicates the approval type does not set.

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

Indicates whether artifact is primary or not.

isRetained

boolean

Indicates whether artifact is retained by release or not.

type

string

Gets or sets type. It can have value as 'Build', 'Jenkins', 'GitHub', 'Nuget', 'Team Build (external)', 'ExternalTFSBuild', 'Git', 'TFVC', 'ExternalTfsXamlBuild'.

ArtifactMetadata

Name Type Description
alias

string

Sets alias of artifact.

instanceReference

BuildVersion

Sets instance reference of artifact. e.g. for build artifact it is build number.

ArtifactSourceReference

Name Type Description
id

string

ID of the artifact source.

name

string

Name of the artifact source.

AuthorizationHeader

Name Type Description
name

string

value

string

BuildVersion

Name Type Description
commitMessage

string

Gets or sets the commit message for the artifact.

definitionId

string

Gets or sets the definition id.

definitionName

string

Gets or sets the definition name.

id

string

Gets or sets the build id.

isMultiDefinitionType

boolean

Gets or sets if the artifact supports multiple definitions.

name

string

Gets or sets the build number.

sourceBranch

string

Gets or sets the source branch for the artifact.

sourcePullRequestVersion

SourcePullRequestVersion

Gets or sets the source pull request version for the artifact.

sourceRepositoryId

string

Gets or sets the repository id for the artifact.

sourceRepositoryType

string

Gets or sets the repository type for the artifact.

sourceVersion

string

Gets or sets the source version for the artifact.

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

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

Name Type Description
attempt

integer

Deployment attempt.

deploymentId

integer

ID of the deployment.

hasStarted

boolean

Specifies whether deployment has started or not.

id

integer

ID of deployment.

issues

Issue[]

All the issues related to the deployment.

lastModifiedBy

IdentityRef

Identity who last modified this deployment.

lastModifiedOn

string

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

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

Name Type Description
job

ReleaseTask

Parent task of all executed tasks.

tasks

ReleaseTask[]

List of executed tasks with in job.

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

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

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

Gets and sets the name of deploy phase.

phaseType

DeployPhaseTypes

Indicates the deploy phase type.

rank

integer

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

Status of the phase.

Name Type Description
canceled

string

Phase execution canceled.

cancelling

string

Phase is in cancelling state.

failed

string

Phase execution failed.

inProgress

string

Phase execution in progress.

notStarted

string

Phase execution not started.

partiallySucceeded

string

Phase execution partially succeeded.

skipped

string

Phase execution skipped.

succeeded

string

Phase execution succeeded.

undefined

string

Phase status not set.

DeployPhaseTypes

Indicates the deploy phase type.

Name Type Description
agentBasedDeployment

string

Phase type which contains tasks executed on agent.

deploymentGates

string

Phase type which contains tasks which acts as Gates for the deployment to go forward.

machineGroupBasedDeployment

string

Phase type which contains tasks executed on deployment group machines.

runOnServer

string

Phase type which contains tasks executed by server.

undefined

string

Phase type not defined. Don't use this.

EnvironmentOptions

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

Gets environment status.

Name Type Description
canceled

string

Environment is in canceled state.

inProgress

string

Environment is in progress state.

notStarted

string

Environment is in not started state.

partiallySucceeded

string

Environment is in partially succeeded state.

queued

string

Environment is in queued state.

rejected

string

Environment is in rejected state.

scheduled

string

Environment is in scheduled state.

succeeded

string

Environment is in succeeded state.

undefined

string

Environment status not set.

GateStatus

Status of release gates.

Name Type Description
canceled

string

The gate execution cancelled.

failed

string

The gate execution failed.

inProgress

string

The gate is currently in progress.

none

string

The gate does not have the status set.

pending

string

The gate is in pending state.

succeeded

string

The gate completed successfully.

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

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

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

Issue data.

issueType

string

Issue type, for example error, warning or info.

message

string

Issue message.

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.

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.

createdFor

IdentityRef

Gets or sets the identity for whom release was 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.

releaseDefinitionRevision

integer

Gets or sets the release definition revision.

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.

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.

url

string

Gets url to access the approval.

ReleaseApprovalHistory

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

Time when this approval created.

modifiedOn

string

Time when this approval modified.

revision

integer

Approval history revision.

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

The release condition result.

value

string

Gets or set value of the condition.

ReleaseDefinitionApprovals

Name Type Description
approvalOptions

ApprovalOptions

Gets or sets the approval options.

approvals

ReleaseDefinitionApprovalStep[]

Gets or sets the approvals.

ReleaseDefinitionApprovalStep

Name Type Description
approver

IdentityRef

Gets and sets the approver.

id

integer

ID of the approval or deploy step.

isAutomated

boolean

Indicates whether the approval automated.

isNotificationOn

boolean

Indicates whether the approval notification set.

rank

integer

Gets or sets the rank of approval step.

ReleaseDefinitionGate

Name Type Description
tasks

WorkflowTask[]

Gets or sets the gates workflow.

ReleaseDefinitionGatesOptions

Name Type Description
isEnabled

boolean

Gets or sets as the gates enabled or not.

minimumSuccessDuration

integer

Gets or sets the minimum duration for steady results after a successful gates evaluation.

samplingInterval

integer

Gets or sets the time between re-evaluation of gates.

stabilizationTime

integer

Gets or sets the delay before evaluation.

timeout

integer

Gets or sets the timeout after which gates fail.

ReleaseDefinitionGatesStep

Name Type Description
gates

ReleaseDefinitionGate[]

Gets or sets the gates.

gatesOptions

ReleaseDefinitionGatesOptions

Gets or sets the gate options.

id

integer

ID of the ReleaseDefinitionGateStep.

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[]

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

Rank of the phase.

runPlanId

string

Run Plan ID of the phase.

startedOn

string

Phase start time.

status

DeployPhaseStatus

Status of the phase.

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.

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

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

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

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.

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[]

Contains the gates job details of each evaluation.

id

integer

ID of release gates.

ignoredGates

IgnoredGate[]

List of ignored gates.

lastModifiedOn

string

Gates last modified time.

runPlanId

string

Run plan ID of the gates.

stabilizationCompletedOn

string

Gates stabilization completed date and time.

startedOn

string

Gates evaluation started time.

status

GateStatus

Status of release gates.

succeedingSince

string

Date and time at which all gates executed successfully.

ReleaseReason

Gets reason for release.

Name Type Description
continuousIntegration

string

Indicates the release triggered by continuous integration.

manual

string

Indicates the release triggered manually.

none

string

Indicates the release triggered reason not set.

pullRequest

string

Indicates the release triggered by PullRequest.

schedule

string

Indicates the release triggered by schedule.

ReleaseSchedule

Name Type Description
daysToRelease

ScheduleDays

Days of the week to release.

jobId

string

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

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.

ReleaseStartEnvironmentMetadata

Name Type Description
definitionEnvironmentId

integer

Sets release definition environment id.

variables

<string,  ConfigurationVariableValue>

Sets list of environments variables to be overridden at deployment time.

ReleaseStartMetadata

Name Type Description
artifacts

ArtifactMetadata[]

Sets list of artifact to create a release.

definitionId

integer

Sets definition Id to create a release.

description

string

Sets description to create a release.

environmentsMetadata

ReleaseStartEnvironmentMetadata[]

Sets list of environments meta data.

isDraft

boolean

Sets 'true' to create release in draft mode, 'false' otherwise.

manualEnvironments

string[]

Sets list of environments to manual as condition.

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

Sets reason to create a release.

variables

<string,  ConfigurationVariableValue>

Sets list of release variables to be overridden at deployment time.

ReleaseStatus

Gets status.

Name Type Description
abandoned

string

Release status is in abandoned.

active

string

Release status is in active.

draft

string

Release is in draft state.

undefined

string

Release status not set.

ReleaseTask

Name Type Description
agentName

string

Agent name on which task executed.

finishTime

string

Finish time of the release task.

id

integer

ID of the release task.

issues

Issue[]

List of issues occurred while execution of task.

lineCount

integer

Number of lines log release task has.

logUrl

string

Log URL of the task.

name

string

Name of the task.

percentComplete

integer

Task execution complete precent.

rank

integer

Rank of the release task.

resultCode

string

Result code of the task.

startTime

string

ID of the release task.

status

TaskStatus

Status of release task.

task

WorkflowTaskReference

Workflow task reference.

timelineRecordId

string

Timeline record ID of the release task.

ScheduleDays

Days of the week to release.

Name Type Description
all

string

Scheduled on all the days in week.

friday

string

Scheduled on Friday.

monday

string

Scheduled on Monday.

none

string

Scheduled day not set.

saturday

string

Scheduled on Saturday.

sunday

string

Scheduled on Sunday.

thursday

string

Scheduled on Thursday.

tuesday

string

Scheduled on Tuesday.

wednesday

string

Scheduled on Wednesday.

SourcePullRequestVersion

Name Type Description
iterationId

string

Pull Request Iteration Id for which the release will publish status.

pullRequestId

string

Pull Request Id for which the release will publish status.

pullRequestMergedAt

string

Date and time of the pull request merge creation. It is required to keep timeline record of Releases created by pull request.

sourceBranch

string

Source branch of the Pull Request.

sourceBranchCommitId

string

Source branch commit Id of the Pull Request for which the release will publish status.

targetBranch

string

Target branch of the Pull Request.

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

Status of release task.

Name Type Description
canceled

string

The task execution canceled.

failed

string

The task execution failed.

failure

string

The task execution failed.

inProgress

string

The task is currently in progress.

partiallySucceeded

string

The task execution partially succeeded.

pending

string

The task is in pending status.

skipped

string

The task execution skipped.

succeeded

string

The task completed successfully.

success

string

The task completed successfully.

unknown

string

The task does not have the status set.

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.

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

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

VariableValue

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

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

Gets or sets the task retryCount.

taskId

string

Gets or sets the ID of the task.

timeoutInMinutes

integer

Gets or sets the task timeout.

version

string

Gets or sets the version of the task.

WorkflowTaskReference

Name Type Description
id

string

Task identifier.

name

string

Name of the task.

version

string

Version of the task.