Definitions - List
Get a list of release definitions.
GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions?api-version=6.0
GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions?searchText={searchText}&$expand={$expand}&artifactType={artifactType}&artifactSourceId={artifactSourceId}&$top={$top}&continuationToken={continuationToken}&queryOrder={queryOrder}&path={path}&isExactNameMatch={isExactNameMatch}&tagFilter={tagFilter}&propertyFilters={propertyFilters}&definitionIdFilter={definitionIdFilter}&isDeleted={isDeleted}&searchTextContainsFolderName={searchTextContainsFolderName}&api-version=6.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 |
api-version
|
query | True |
string |
Version of the API to use. This should be set to '6.0' to use this version of the api. |
$expand
|
query |
The properties that should be expanded in the list of Release definitions. |
||
$top
|
query |
integer int32 |
Number of release definitions to get. |
|
artifact
|
query |
string |
Release definitions with given artifactSourceId will be returned. e.g. For build it would be {projectGuid}:{BuildDefinitionId}, for Jenkins it would be {JenkinsConnectionId}:{JenkinsDefinitionId}, for TfsOnPrem it would be {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. For third-party artifacts e.g. TeamCity, BitBucket you may refer 'uniqueSourceIdentifier' inside vss-extension.json at https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions. |
|
artifact
|
query |
string |
Release definitions with given artifactType will be returned. Values can be Build, Jenkins, GitHub, Nuget, Team Build (external), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild. |
|
continuation
|
query |
string |
Gets the release definitions after the continuation token provided. |
|
definition
|
query |
string array (string) |
A comma-delimited list of release definitions to retrieve. |
|
is
|
query |
boolean |
'true' to get release definitions that has been deleted. Default is 'false' |
|
is
|
query |
boolean |
'true'to gets the release definitions with exact match as specified in searchText. Default is 'false'. |
|
path
|
query |
string |
Gets the release definitions under the specified path. |
|
property
|
query |
string array (string) |
A comma-delimited list of extended properties to be retrieved. If set, the returned Release Definitions will contain values for the specified property Ids (if they exist). If not set, properties will not be included. Note that this will not filter out any Release Definition from results irrespective of whether it has property set or not. |
|
query
|
query |
Gets the results in the defined order. Default is 'IdAscending'. |
||
search
|
query |
string |
Get release definitions with names containing searchText. |
|
search
|
query |
boolean |
'true' to get the release definitions under the folder with name as specified in searchText. Default is 'false'. |
|
tag
|
query |
string array (string) |
A comma-delimited list of tags. Only release definitions with these tags will be returned. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
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 | Grants the ability to read release artifacts, including folders, releases, release definitions and release environment. |
Examples
With artifacts details expanded |
With environments details expanded |
Sample request
GET https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/definitions?api-version=6.0
Sample response
{
"count": 1,
"value": [
{
"source": "userInterface",
"id": 1,
"revision": 3,
"name": "MyShuttle.CD",
"description": null,
"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"
},
"createdOn": "2017-05-31T16:39:04.883Z",
"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"
},
"modifiedOn": "2017-05-31T16:39:58.06Z",
"lastRelease": {
"id": 14,
"name": "Release-14",
"artifacts": [],
"webAccessUri": null,
"_links": {},
"description": "",
"releaseDefinition": {
"id": 1,
"_links": {}
},
"createdOn": "2017-06-01T09:42:15.273Z",
"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"
},
"modifiedBy": null,
"reason": "none"
},
"path": "\\",
"variableGroups": null,
"releaseNameFormat": "Release-$(rev:r)",
"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"
}
},
"properties": {}
}
]
}
With artifacts details expanded
Sample request
GET https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/definitions?$expand=Artifacts&api-version=6.0
Sample response
{
"count": 1,
"value": [
{
"source": "userInterface",
"id": 1,
"revision": 3,
"name": "MyShuttle.CD",
"description": null,
"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"
},
"createdOn": "2017-05-31T16:39:04.883Z",
"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"
},
"modifiedOn": "2017-05-31T16:39:58.06Z",
"lastRelease": {
"id": 14,
"name": "Release-14",
"artifacts": [],
"webAccessUri": null,
"_links": {},
"description": "",
"releaseDefinition": {
"id": 1,
"_links": {}
},
"createdOn": "2017-06-01T09:42:15.273Z",
"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"
},
"modifiedBy": null,
"reason": "none"
},
"path": "\\",
"variableGroups": null,
"artifacts": [],
"releaseNameFormat": "Release-$(rev:r)",
"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"
}
},
"properties": {}
}
]
}
With environments details expanded
Sample request
GET https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/definitions?$expand=Environments&api-version=6.0
Sample response
{
"count": 1,
"value": [
{
"source": "userInterface",
"id": 1,
"revision": 3,
"name": "MyShuttle.CD",
"description": null,
"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"
},
"createdOn": "2017-05-31T16:39:04.883Z",
"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"
},
"modifiedOn": "2017-05-31T16:39:58.06Z",
"lastRelease": {
"id": 14,
"name": "Release-14",
"artifacts": [],
"webAccessUri": null,
"_links": {},
"description": "",
"releaseDefinition": {
"id": 1,
"_links": {}
},
"createdOn": "2017-06-01T09:42:15.273Z",
"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"
},
"modifiedBy": null,
"reason": "none"
},
"path": "\\",
"variableGroups": null,
"environments": [
{
"id": 1,
"name": "Dev",
"rank": 1,
"schedules": [],
"retentionPolicy": {
"daysToKeep": 30,
"releasesToKeep": 3,
"retainBuild": true
}
},
{
"id": 2,
"name": "QA",
"rank": 2,
"schedules": [],
"retentionPolicy": {
"daysToKeep": 30,
"releasesToKeep": 3,
"retainBuild": true
}
},
{
"id": 3,
"name": "PPE",
"rank": 3,
"schedules": [],
"retentionPolicy": {
"daysToKeep": 30,
"releasesToKeep": 3,
"retainBuild": true
}
},
{
"id": 4,
"name": "PROD",
"rank": 4,
"schedules": [],
"retentionPolicy": {
"daysToKeep": 30,
"releasesToKeep": 3,
"retainBuild": true
}
}
],
"releaseNameFormat": "Release-$(rev:r)",
"retentionPolicy": {
"daysToKeep": 30
},
"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"
}
},
"properties": {}
}
]
}
Definitions
Name | Description |
---|---|
Approval |
Approvals execution order. |
Approval |
|
Artifact | |
Artifact |
|
Authorization |
|
Condition | |
Condition |
Gets or sets the condition type. |
Configuration |
|
Data |
Represents binding of data source for the service endpoint request. |
Demand | |
Deploy |
|
Deploy |
Indicates the deploy phase type. |
Environment |
Defines policy on environment queuing at Release Management side queue. We will send to Environment Runner [creating pre-deploy and other steps] only when the policies mentioned are satisfied. |
Environment |
|
Environment |
|
Environment |
|
Environment |
Gets or sets the trigger type. |
Identity |
|
Process |
|
Project |
|
Properties |
The class represents a property bag as a collection of key-value pairs. Values of all primitive types (any type with a |
Reference |
The class to represent a collection of REST reference links. |
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
The properties that should be expanded in the list of Release definitions. |
Release |
|
Release |
|
Release |
|
Release |
Gets the results in the defined order. Default is 'IdAscending'. |
Release |
|
Release |
Gets or sets source of release definition. |
Release |
Gets reason for release. |
Release |
|
Release |
|
Release |
|
Release |
|
Release |
Type of release trigger. |
Schedule |
Days of the week to release. |
Task |
|
Task |
|
Task |
|
Workflow |
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 |
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. |
Artifact
Name | Type | Description |
---|---|---|
alias |
string |
Gets or sets alias. |
definitionReference |
<string,
Artifact |
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'. |
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 |
Condition
Name | Type | Description |
---|---|---|
conditionType |
Gets or sets the condition type. |
|
name |
string |
Gets or sets the name of the condition. e.g. 'ReleaseStarted'. |
value |
string |
Gets or set value of the condition. |
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 |
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. |
Demand
Name | Type | Description |
---|---|---|
name |
string |
Gets and sets the name of demand. |
value |
string |
Gets and sets the value of demand. |
DeployPhase
Name | Type | Description |
---|---|---|
name |
string |
Gets and sets the name of deploy phase. |
phaseType |
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 |
Gets and sets the workflow tasks for the deploy phase. |
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. |
EnvironmentExecutionPolicy
Defines policy on environment queuing at Release Management side queue. We will send to Environment Runner [creating pre-deploy and other steps] only when the policies mentioned are satisfied.
Name | Type | Description |
---|---|---|
concurrencyCount |
integer |
This policy decides, how many environments would be with Environment Runner. |
queueDepthCount |
integer |
Queue depth in the EnvironmentQueue table, this table keeps the environment entries till Environment Runner is free [as per it's policy] to take another environment for running. |
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. |
EnvironmentRetentionPolicy
Name | Type | Description |
---|---|---|
daysToKeep |
integer |
Gets and sets the number of days to keep environment. |
releasesToKeep |
integer |
Gets and sets the number of releases to keep. |
retainBuild |
boolean |
Gets and sets as the build to be retained or not. |
EnvironmentTrigger
Name | Type | Description |
---|---|---|
definitionEnvironmentId |
integer |
Definition environment ID on which this trigger applicable. |
releaseDefinitionId |
integer |
ReleaseDefinition ID on which this trigger applicable. |
triggerContent |
string |
Gets or sets the trigger content. |
triggerType |
Gets or sets the trigger type. |
EnvironmentTriggerType
Gets or sets the trigger type.
Name | Type | Description |
---|---|---|
deploymentGroupRedeploy |
string |
Environment trigger type is deployment group redeploy. |
rollbackRedeploy |
string |
Environment trigger type is Rollback. |
undefined |
string |
Environment trigger type undefined. |
IdentityRef
Name | Type | Description |
---|---|---|
_links |
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. |
ProcessParameters
Name | Type | Description |
---|---|---|
dataSourceBindings |
Represents binding of data source for the service endpoint request. |
|
inputs | ||
sourceDefinitions |
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. |
ReleaseDefinition
Name | Type | Description |
---|---|---|
_links |
Gets the links to related resources, APIs, and views for the release definition. |
|
artifacts |
Artifact[] |
Gets or sets the list of artifacts. |
comment |
string |
Gets or sets comment. |
createdBy |
Gets or sets the identity who created. |
|
createdOn |
string |
Gets date on which it got created. |
description |
string |
Gets or sets the description. |
environments |
Gets or sets the list of environments. |
|
id |
integer |
Gets the unique identifier of release definition. |
isDeleted |
boolean |
Whether release definition is deleted. |
lastRelease |
Gets the reference of last release. |
|
modifiedBy |
Gets or sets the identity who modified. |
|
modifiedOn |
string |
Gets date on which it got modified. |
name |
string |
Gets or sets the name of the release definition. |
path |
string |
Gets or sets the path of the release definition. |
projectReference |
Gets or sets project reference. |
|
properties |
Gets or sets properties. |
|
releaseNameFormat |
string |
Gets or sets the release name format. |
revision |
integer |
Gets the revision number. |
source |
Gets or sets source of release definition. |
|
tags |
string[] |
Gets or sets list of tags. |
triggers |
Gets or sets the list of triggers. |
|
url |
string |
Gets the REST API url to access the release definition. |
variableGroups |
integer[] |
Gets or sets the list of variable groups. |
variables |
<string,
Configuration |
Gets or sets the dictionary of variables. |
ReleaseDefinitionApprovals
Name | Type | Description |
---|---|---|
approvalOptions |
Gets or sets the approval options. |
|
approvals |
Gets or sets the approvals. |
ReleaseDefinitionApprovalStep
Name | Type | Description |
---|---|---|
approver |
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. |
ReleaseDefinitionDeployStep
Name | Type | Description |
---|---|---|
id |
integer |
ID of the approval or deploy step. |
tasks |
The list of steps for this definition. |
ReleaseDefinitionEnvironment
Name | Type | Description |
---|---|---|
badgeUrl |
string |
Gets or sets the BadgeUrl. BadgeUrl will be used when Badge will be enabled in Release Definition Environment. |
conditions |
Gets or sets the environment conditions. |
|
currentRelease |
Gets or sets the current release reference. |
|
demands |
Demand[] |
Gets or sets the demands. |
deployPhases |
Gets or sets the deploy phases of environment. |
|
deployStep |
Gets or sets the deploystep. |
|
environmentOptions |
Gets or sets the environment options. |
|
environmentTriggers |
Gets or sets the triggers on environment. |
|
executionPolicy |
Gets or sets the environment execution policy. |
|
id |
integer |
Gets and sets the ID of the ReleaseDefinitionEnvironment. |
name |
string |
Gets and sets the name of the ReleaseDefinitionEnvironment. |
owner |
Gets and sets the Owner of the ReleaseDefinitionEnvironment. |
|
postDeployApprovals |
Gets or sets the post deployment approvals. |
|
postDeploymentGates |
Gets or sets the post deployment gates. |
|
preDeployApprovals |
Gets or sets the pre deployment approvals. |
|
preDeploymentGates |
Gets or sets the pre deployment gates. |
|
processParameters |
Gets or sets the environment process parameters. |
|
properties |
Gets or sets the properties on environment. |
|
queueId |
integer |
Gets or sets the queue ID. |
rank |
integer |
Gets and sets the rank of the ReleaseDefinitionEnvironment. |
retentionPolicy |
Gets or sets the environment retention policy. |
|
schedules |
Gets or sets the schedules |
|
variableGroups |
integer[] |
Gets or sets the variable groups. |
variables |
<string,
Configuration |
Gets and sets the variables. |
ReleaseDefinitionExpands
The properties that should be expanded in the list of Release definitions.
Name | Type | Description |
---|---|---|
artifacts |
string |
Include artifacts in return object. |
environments |
string |
Include environments in return object. |
lastRelease |
string |
Include last release in return object. |
none |
string |
Returns top level properties of object. |
tags |
string |
Include tags in return object. |
triggers |
string |
Include triggers in return object. |
variables |
string |
Include variables in return object. |
ReleaseDefinitionGate
Name | Type | Description |
---|---|---|
tasks |
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 |
Gets or sets the gates. |
|
gatesOptions |
Gets or sets the gate options. |
|
id |
integer |
ID of the ReleaseDefinitionGateStep. |
ReleaseDefinitionQueryOrder
Gets the results in the defined order. Default is 'IdAscending'.
Name | Type | Description |
---|---|---|
idAscending |
string |
Return results based on release definition Id ascending order. |
idDescending |
string |
Return results based on release definition Id descending order. |
nameAscending |
string |
Return results based on release definition name ascending order. |
nameDescending |
string |
Return results based on release definition name descending order. |
ReleaseDefinitionShallowReference
Name | Type | Description |
---|---|---|
_links |
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 |
Gets or sets project reference. |
|
url |
string |
Gets the REST API url to access the release definition. |
ReleaseDefinitionSource
Gets or sets source of release definition.
Name | Type | Description |
---|---|---|
ibiza |
string |
Indicates ReleaseDefinition created from Ibiza. |
portalExtensionApi |
string |
Indicates ReleaseDefinition created from PortalExtension API. |
restApi |
string |
Indicates ReleaseDefinition created using REST API. |
undefined |
string |
Indicates ReleaseDefinition source not defined. |
userInterface |
string |
Indicates ReleaseDefinition created using UI. |
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. |
ReleaseReference
Name | Type | Description |
---|---|---|
_links |
Gets links to access the release. |
|
artifacts |
Artifact[] |
Gets list of artifacts. |
createdBy |
Gets the identity who created release. |
|
createdOn |
string |
Gets date on when this release created. |
description |
string |
Gets description. |
id |
integer |
ID of the Release. |
modifiedBy |
Gets the identity who modified release. |
|
name |
string |
Gets name of release. |
reason |
Gets reason for release. |
|
releaseDefinition |
Gets release definition shallow reference. |
ReleaseSchedule
Name | Type | Description |
---|---|---|
daysToRelease |
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 |
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. |
ReleaseTriggerBase
Name | Type | Description |
---|---|---|
triggerType |
Type of release trigger. |
ReleaseTriggerType
Type of release trigger.
Name | Type | Description |
---|---|---|
artifactSource |
string |
Artifact based release trigger. |
containerImage |
string |
Container image based release trigger. |
package |
string |
Package based release trigger. |
pullRequest |
string |
Pull request based release trigger. |
schedule |
string |
Schedule based release trigger. |
sourceRepo |
string |
Source repository based release trigger. |
undefined |
string |
Release trigger type not set. |
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. |
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 | ||
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 |
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. |
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. |