Definitions - List

Get a list of release definitions.

GET https://{accountName}.vsrm.visualstudio.com/{project}/_apis/release/definitions?api-version=4.1-preview.3
GET https://{accountName}.vsrm.visualstudio.com/{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}&api-version=4.1-preview.3

URI Parameters

Name In Required Type Description
accountName
path True
  • string

The name of the Visual Studio Team Services account.

project
path True
  • string

Project ID or project name

searchText
query
  • string

Get release definitions with names starting with searchText.

$expand
query

The properties that should be expanded in the list of Release definitions.

artifactType
query
  • string

Release definitions with given artifactType will be returned. Values can be Build, Jenkins, GitHub, Nuget, Team Build (external), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.

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

$top
query
  • integer
int32

Number of release definitions to get.

continuationToken
query
  • string

Gets the release definitions after the continuation token provided.

queryOrder
query

Gets the results in the defined order. Default is 'IdAscending'.

path
query
  • string

Gets the release definitions under the specified path.

isExactNameMatch
query
  • boolean

'true'to gets the release definitions with exact match as specified in searchText. Default is 'false'.

tagFilter
query
  • string
array (string)

A comma-delimited list of tags. Only release definitions with these tags will be returned.

propertyFilters
query
  • string
array (string)

A comma-delimited list of extended properties to retrieve.

definitionIdFilter
query
  • string
array (string)

A comma-delimited list of release definitions to retrieve.

isDeleted
query
  • boolean

'true' to get release definitions that has been deleted. Default is 'false'

api-version
query True
  • string

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

Responses

Name Type Description
200 OK

successful operation

Examples

With artifacts details expanded
With environments details expanded

Sample Request

GET https://fabrikam.vsrm.visualstudio.com/MyFirstProject/_apis/release/definitions?api-version=4.1-preview.3

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://app.vssps.visualstudio.com/A168224e4-29ff-4081-9954-c8780ce81117/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://fabfiber-inc.visualstudio.com/_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://app.vssps.visualstudio.com/A168224e4-29ff-4081-9954-c8780ce81117/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://fabfiber-inc.visualstudio.com/_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://app.vssps.visualstudio.com/A168224e4-29ff-4081-9954-c8780ce81117/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
          "imageUrl": "https://fabfiber-inc.visualstudio.com/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
        },
        "modifiedBy": null,
        "reason": "none"
      },
      "path": "\\",
      "variableGroups": null,
      "releaseNameFormat": "Release-$(rev:r)",
      "url": "https://fabfiber-inc.vsrm.visualstudio.com/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
      "_links": {
        "self": {
          "href": "https://fabfiber-inc.vsrm.visualstudio.com/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
        },
        "web": {
          "href": "https://fabfiber-inc.visualstudio.com/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
        }
      },
      "properties": {}
    }
  ]
}

With artifacts details expanded

Sample Request

GET https://fabrikam.vsrm.visualstudio.com/MyFirstProject/_apis/release/definitions?$expand=Artifacts&api-version=4.1-preview.3

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://app.vssps.visualstudio.com/A168224e4-29ff-4081-9954-c8780ce81117/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://fabfiber-inc.visualstudio.com/_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://app.vssps.visualstudio.com/A168224e4-29ff-4081-9954-c8780ce81117/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://fabfiber-inc.visualstudio.com/_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://app.vssps.visualstudio.com/A168224e4-29ff-4081-9954-c8780ce81117/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
          "imageUrl": "https://fabfiber-inc.visualstudio.com/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
        },
        "modifiedBy": null,
        "reason": "none"
      },
      "path": "\\",
      "variableGroups": null,
      "artifacts": [],
      "releaseNameFormat": "Release-$(rev:r)",
      "url": "https://fabfiber-inc.vsrm.visualstudio.com/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
      "_links": {
        "self": {
          "href": "https://fabfiber-inc.vsrm.visualstudio.com/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
        },
        "web": {
          "href": "https://fabfiber-inc.visualstudio.com/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
        }
      },
      "properties": {}
    }
  ]
}

With environments details expanded

Sample Request

GET https://fabrikam.vsrm.visualstudio.com/MyFirstProject/_apis/release/definitions?$expand=Environments&api-version=4.1-preview.3

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://app.vssps.visualstudio.com/A168224e4-29ff-4081-9954-c8780ce81117/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://fabfiber-inc.visualstudio.com/_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://app.vssps.visualstudio.com/A168224e4-29ff-4081-9954-c8780ce81117/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://fabfiber-inc.visualstudio.com/_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://app.vssps.visualstudio.com/A168224e4-29ff-4081-9954-c8780ce81117/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
          "imageUrl": "https://fabfiber-inc.visualstudio.com/_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://fabfiber-inc.vsrm.visualstudio.com/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
      "_links": {
        "self": {
          "href": "https://fabfiber-inc.vsrm.visualstudio.com/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
        },
        "web": {
          "href": "https://fabfiber-inc.visualstudio.com/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
        }
      },
      "properties": {}
    }
  ]
}

Definitions

AgentBasedDeployPhase
AgentDeploymentInput
ApprovalExecutionOrder
ApprovalOptions
Artifact
ArtifactFilter
ArtifactsDownloadInput
ArtifactSourceReference
ArtifactSourceTrigger
AuthorizationHeader
AzureKeyVaultVariableValue
BuildArtifactDownloadInput
ConditionType

Gets or sets the condition type.

ContainerImageTrigger
CustomArtifactDownloadInput
DataSourceBindingBase

Represents binding of data source for the service endpoint request.

DefinitionReference

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

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

EnvironmentOptions
EnvironmentRetentionPolicy
GitArtifactDownloadInput
GitHubArtifactDownloadInput
IdentityRef
JenkinsArtifactDownloadInput
MachineGroupBasedDeployPhase
MachineGroupDeploymentInput
MultiConfigInput
MultiMachineInput
PackageTrigger
ParallelExecutionTypes
PipelineProcess
PipelineProcessTypes
ProcessParameters
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.

ReleaseCondition
ReleaseDefinition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionDeployStep
ReleaseDefinitionEnvironment
ReleaseDefinitionExpands

The properties that should be expanded in the list of Release definitions.

ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionQueryOrder

Gets the results in the defined order. Default is 'IdAscending'.

ReleaseDefinitionShallowReference
ReleaseDefinitionSource

Gets or sets source of release definition.

ReleaseReason

Gets reason for release.

ReleaseReference
ReleaseSchedule
ReleaseTriggerType
RunOnServerDeployPhase
ScheduleDays

Days of the week to release

ScheduledReleaseTrigger
ServerDeploymentInput
SourceRepoTrigger
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
TfvcArtifactDownloadInput
Variables
WorkflowTask

AgentBasedDeployPhase

Name Type Description
deploymentInput
name
  • string
phaseType
rank
  • integer
workflowTasks

AgentDeploymentInput

Name Type Description
artifactsDownloadInput
condition
  • string
demands
enableAccessToken
  • boolean
imageId
  • integer
jobCancelTimeoutInMinutes
  • integer

Gets or sets the job cancel timeout in minutes for deployment which are cancelled by user for this release environment

overrideInputs
  • <string, string>
parallelExecution ExecutionInput:
  • ParallelExecutionInputBase
queueId
  • integer
skipArtifactsDownload
  • boolean
timeoutInMinutes
  • integer

Gets or sets the job execution timeout in minutes for deployment which are queued against this release environment

ApprovalExecutionOrder

Name Type Description
afterGatesAlways
  • string
afterSuccessfulGates
  • string
beforeGates
  • string

ApprovalOptions

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

Artifact

Name Type Description
alias
  • string

Gets or sets alias.

definitionReference
  • <string, ArtifactSourceReference>

Gets or sets definition reference. e.g. {"project":{"id":"fed755ea-49c5-4399-acea-fd5b5aa90a6c","name":"myProject"},"definition":{"id":"1","name":"mybuildDefinition"},"connection":{"id":"1","name":"myConnection"}}

isPrimary
  • boolean

Gets or sets as artifact is primary or not.

type
  • string

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

ArtifactFilter

Name Type Description
sourceBranch
  • string
tags
  • string[]
useBuildDefinitionBranch
  • boolean

ArtifactsDownloadInput

Name Type Description
downloadInputs ArtifactDownloadInputBase[]:

ArtifactSourceReference

Name Type Description
id
  • string
name
  • string

ArtifactSourceTrigger

Name Type Description
artifactAlias
  • string

Artifact source alias for Artifact Source trigger type

triggerConditions
triggerType

AuthorizationHeader

Name Type Description
name
  • string
value
  • string

AzureKeyVaultVariableValue

Name Type Description
contentType
  • string
enabled
  • boolean
expires
  • string
isSecret
  • boolean
value
  • string

BuildArtifactDownloadInput

Name Type Description
alias
  • string
artifactDownloadMode
  • string
artifactItems
  • string[]
artifactType
  • string

ConditionType

Gets or sets the condition type.

Name Type Description
artifact
  • string

The condition type is artifact.

environmentState
  • string

The condition type is environment state.

event
  • string

The condition type is event.

undefined
  • string

The condition type is undefined.

ContainerImageTrigger

Name Type Description
alias
  • string
triggerType

CustomArtifactDownloadInput

Name Type Description
alias
  • string
artifactDownloadMode
  • string
artifactType
  • string

DataSourceBindingBase

Represents binding of data source for the service endpoint request.

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

parameters
  • <string, string>

Gets or sets the parameters for the data source.

resultSelector
  • string

Gets or sets the result selector.

resultTemplate
  • string

Gets or sets the result template.

target
  • string

Gets or sets the target of the data source.

DefinitionReference

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

Name Type Description

Demand

Name Type Description
name
  • string
value
  • string

DeployPhaseTypes

Name Type Description
agentBasedDeployment
  • string
machineGroupBasedDeployment
  • string
runOnServer
  • string
undefined
  • string

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
badgeEnabled
  • boolean
emailNotificationType
  • string
emailRecipients
  • string
enableAccessToken
  • boolean
publishDeploymentStatus
  • boolean
skipArtifactsDownload
  • boolean
timeoutInMinutes
  • integer

EnvironmentRetentionPolicy

Name Type Description
daysToKeep
  • integer
releasesToKeep
  • integer
retainBuild
  • boolean

GitArtifactDownloadInput

Name Type Description
alias
  • string
artifactDownloadMode
  • string
artifactType
  • string

GitHubArtifactDownloadInput

Name Type Description
alias
  • string
artifactDownloadMode
  • string
artifactType
  • string

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
displayName
  • string

This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.

id
  • string
imageUrl
  • string
inactive
  • boolean
isAadIdentity
  • boolean
isContainer
  • boolean
profileUrl
  • string
uniqueName
  • string
url
  • string

This url is the full route to the source resource of this graph subject.

JenkinsArtifactDownloadInput

Name Type Description
alias
  • string
artifactDownloadMode
  • string
artifactItems
  • string[]
artifactType
  • string

MachineGroupBasedDeployPhase

Name Type Description
deploymentInput
name
  • string
phaseType
rank
  • integer
workflowTasks

MachineGroupDeploymentInput

Name Type Description
artifactsDownloadInput
condition
  • string
demands
deploymentHealthOption
  • string
enableAccessToken
  • boolean
healthPercent
  • integer
jobCancelTimeoutInMinutes
  • integer

Gets or sets the job cancel timeout in minutes for deployment which are cancelled by user for this release environment

overrideInputs
  • <string, string>
queueId
  • integer
skipArtifactsDownload
  • boolean
tags
  • string[]
timeoutInMinutes
  • integer

Gets or sets the job execution timeout in minutes for deployment which are queued against this release environment

MultiConfigInput

Name Type Description
continueOnError
  • boolean
maxNumberOfAgents
  • integer
multipliers
  • string
parallelExecutionType

MultiMachineInput

Name Type Description
continueOnError
  • boolean
maxNumberOfAgents
  • integer
parallelExecutionType

PackageTrigger

Name Type Description
alias
  • string
triggerType

ParallelExecutionTypes

Name Type Description
multiConfiguration
  • string
multiMachine
  • string
none
  • string

PipelineProcess

Name Type Description
type

PipelineProcessTypes

Name Type Description
designer
  • string
yaml
  • string

ProcessParameters

Name Type Description
dataSourceBindings

Represents binding of data source for the service endpoint request.

inputs
sourceDefinitions

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
  • <string, object>

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

ReleaseCondition

Name Type Description
conditionType

Gets or sets the condition type.

name
  • string

Gets or sets the name of the condition. e.g. 'ReleaseStarted'.

result
  • boolean
value
  • string

Gets or set value of the condition.

ReleaseDefinition

Name Type Description
_links

Gets links to access the release definition.

artifacts

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

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.

path
  • string

Gets or sets the path.

pipelineProcess

Gets or sets pipeline process.

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

Gets or sets the list of triggers.

url
  • string

Gets url to access the release definition.

variableGroups
  • integer[]

Gets or sets the list of variable groups.

variables
  • <string, ConfigurationVariableValue>

Gets or sets the dictionary of variables.

ReleaseDefinitionApprovals

Name Type Description
approvalOptions
approvals

ReleaseDefinitionApprovalStep

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

ReleaseDefinitionDeployStep

Name Type Description
id
  • integer
tasks

The list of steps for this definition.

ReleaseDefinitionEnvironment

Name Type Description
badgeUrl
  • string
conditions Condition[]:
demands
deployPhases DeployPhase[]:
deployStep
environmentOptions
executionPolicy

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.

id
  • integer
name
  • string
owner
postDeployApprovals
postDeploymentGates
preDeployApprovals
preDeploymentGates
processParameters
properties

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.

queueId
  • integer
rank
  • integer
retentionPolicy
schedules
variableGroups
  • integer[]
variables
  • <string, ConfigurationVariableValue>

ReleaseDefinitionExpands

The properties that should be expanded in the list of Release definitions.

Name Type Description
artifacts
  • string
environments
  • string
lastRelease
  • string
none
  • string
tags
  • string
triggers
  • string
variables
  • string

ReleaseDefinitionGate

Name Type Description
tasks

ReleaseDefinitionGatesOptions

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

ReleaseDefinitionGatesStep

Name Type Description
gates
gatesOptions
id
  • integer

ReleaseDefinitionQueryOrder

Gets the results in the defined order. Default is 'IdAscending'.

Name Type Description
idAscending
  • string
idDescending
  • string
nameAscending
  • string
nameDescending
  • string

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.

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
portalExtensionApi
  • string
restApi
  • string
undefined
  • string
userInterface
  • string

ReleaseReason

Gets reason for release.

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

ReleaseReference

Name Type Description
_links

Gets links to access the release.

artifacts

Gets list of artifacts.

createdBy

Gets the identity who created.

createdOn
  • string

Gets date on which it got created.

description
  • string

Gets description.

id
  • integer

Gets the unique identifier of this field.

modifiedBy

Gets the identity who modified.

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

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'

ReleaseTriggerType

Name Type Description
artifactSource
  • string
containerImage
  • string
package
  • string
pullRequest
  • string
schedule
  • string
sourceRepo
  • string
undefined
  • string

RunOnServerDeployPhase

Name Type Description
deploymentInput
name
  • string
phaseType
rank
  • integer
workflowTasks

ScheduleDays

Days of the week to release

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

ScheduledReleaseTrigger

Name Type Description
schedule

Release schedule for Scheduled Release trigger type

triggerType

ServerDeploymentInput

Name Type Description
condition
  • string
jobCancelTimeoutInMinutes
  • integer

Gets or sets the job cancel timeout in minutes for deployment which are cancelled by user for this release environment

overrideInputs
  • <string, string>
parallelExecution ExecutionInput:
  • ParallelExecutionInputBase
timeoutInMinutes
  • integer

Gets or sets the job execution timeout in minutes for deployment which are queued against this release environment

SourceRepoTrigger

Name Type Description
alias
  • string
branchFilters
  • string[]
triggerType

TaskInputDefinitionBase

Name Type Description
aliases
  • string[]
defaultValue
  • string
groupName
  • string
helpMarkDown
  • string
label
  • string
name
  • string
options
  • <string, string>
properties
  • <string, string>
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

TfvcArtifactDownloadInput

Name Type Description
alias
  • string
artifactDownloadMode
  • string
artifactType
  • string

Variables

Name Type Description
VariableValue:

WorkflowTask

Name Type Description
alwaysRun
  • boolean
condition
  • string
continueOnError
  • boolean
definitionType
  • string
enabled
  • boolean
inputs
  • <string, string>
name
  • string
overrideInputs
  • <string, string>
refName
  • string
taskId
  • string
timeoutInMinutes
  • integer
version
  • string