Release interface

Package:

azure-devops-extension-api

Properties

artifacts	Gets or sets the list of artifacts.
comment	Gets or sets comment.
createdBy	Gets or sets the identity who created.
createdFor	Gets or sets the identity for whom release was created.
createdOn	Gets date on which it got created.
definitionSnapshotRevision	Gets revision number of definition snapshot.
description	Gets or sets description of release.
environments	Gets list of environments.
id	Gets the unique identifier of this field.
keepForever	Whether to exclude the release from retention policies.
logsContainerUrl	Gets logs container url.
modifiedBy	Gets or sets the identity who modified.
modifiedOn	Gets date on which it got modified.
name	Gets name.
poolName	Gets pool name.
projectReference	Gets or sets project reference.
properties
reason	Gets reason of release.
releaseDefinition	Gets releaseDefinitionReference which specifies the reference of the release definition to which this release is associated.
releaseDefinitionRevision	Gets or sets the release definition revision.
releaseNameFormat	Gets release name format.
status	Gets status.
tags	Gets or sets list of tags.
triggeringArtifactAlias
url
variableGroups	Gets the list of variable groups.
variables	Gets or sets the dictionary of variables.

Property Details

artifacts

Gets or sets the list of artifacts.

artifacts: Artifact[]

Property Value

Artifact[]

comment

Gets or sets comment.

comment: string

Property Value

string

createdBy

Gets or sets the identity who created.

createdBy: IdentityRef

Property Value

IdentityRef

createdFor

Gets or sets the identity for whom release was created.

createdFor: IdentityRef

Property Value

IdentityRef

createdOn

Gets date on which it got created.

createdOn: Date

Property Value

Date

definitionSnapshotRevision

Gets revision number of definition snapshot.

definitionSnapshotRevision: number

Property Value

number

description

Gets or sets description of release.

description: string

Property Value

string

environments

Gets list of environments.

environments: ReleaseEnvironment[]

Property Value

ReleaseEnvironment[]

id

Gets the unique identifier of this field.

id: number

Property Value

number

keepForever

Whether to exclude the release from retention policies.

keepForever: boolean

Property Value

boolean

logsContainerUrl

Gets logs container url.

logsContainerUrl: string

Property Value

string

modifiedBy

Gets or sets the identity who modified.

modifiedBy: IdentityRef

Property Value

IdentityRef

modifiedOn

Gets date on which it got modified.

modifiedOn: Date

Property Value

Date

name

Gets name.

name: string

Property Value

string

poolName

Gets pool name.

poolName: string

Property Value

string

projectReference

Gets or sets project reference.

projectReference: ProjectReference

Property Value

ProjectReference

properties

properties: any

Property Value

any

reason

Gets reason of release.

reason: ReleaseReason

Property Value

ReleaseReason

releaseDefinition

Gets releaseDefinitionReference which specifies the reference of the release definition to which this release is associated.

releaseDefinition: ReleaseDefinitionShallowReference

Property Value

ReleaseDefinitionShallowReference

releaseDefinitionRevision

Gets or sets the release definition revision.

releaseDefinitionRevision: number

Property Value

number

releaseNameFormat

Gets release name format.

releaseNameFormat: string

Property Value

string

status

Gets status.

status: ReleaseStatus

Property Value

ReleaseStatus

tags

Gets or sets list of tags.

tags: string[]

Property Value

string[]

triggeringArtifactAlias

triggeringArtifactAlias: string

Property Value

string

url

url: string

Property Value

string

variableGroups

Gets the list of variable groups.

variableGroups: VariableGroup[]

Property Value

VariableGroup[]

variables

Gets or sets the dictionary of variables.

variables: {[key: string]: ConfigurationVariableValue}

Property Value

{[key: string]: ConfigurationVariableValue}