Class ReleaseApi

constructor

• new ReleaseApi(
      baseUrl: string,
      handlers: IRequestHandler[],
      options?: IRequestOptions,
  ): ReleaseApi

  Parameters

  • baseUrl: string
  • handlers: IRequestHandler[]
  • Optionaloptions: IRequestOptions

  Returns ReleaseApi

Static ReadonlyRESOURCE_AREA_ID

addDefinitionTag

• addDefinitionTag(
      project: string,
      releaseDefinitionId: number,
      tag: string,
  ): Promise<string[]>

  Adds a tag to a definition

  Parameters

  • project: string

    Project ID or project name
  • releaseDefinitionId: number
  • tag: string

  Returns Promise<string[]>

addDefinitionTags

• addDefinitionTags(
      tags: string[],
      project: string,
      releaseDefinitionId: number,
  ): Promise<string[]>

  Adds multiple tags to a definition

  Parameters

  • tags: string[]
  • project: string

    Project ID or project name
  • releaseDefinitionId: number

  Returns Promise<string[]>

addReleaseTag

• addReleaseTag(
      project: string,
      releaseId: number,
      tag: string,
  ): Promise<string[]>

  Adds a tag to a releaseId

  Parameters

  • project: string

    Project ID or project name
  • releaseId: number
  • tag: string

  Returns Promise<string[]>

addReleaseTags

• addReleaseTags(
      tags: string[],
      project: string,
      releaseId: number,
  ): Promise<string[]>

  Adds tag to a release

  Parameters

  • tags: string[]
  • project: string

    Project ID or project name
  • releaseId: number

  Returns Promise<string[]>

createDefinitionEnvironmentTemplate

• createDefinitionEnvironmentTemplate(
      template: ReleaseDefinitionEnvironmentTemplate,
      project: string,
  ): Promise<ReleaseDefinitionEnvironmentTemplate>

  Creates a definition environment template

  Parameters

  • template: ReleaseDefinitionEnvironmentTemplate

    Definition environment template to create
  • project: string

    Project ID or project name

  Returns Promise<ReleaseDefinitionEnvironmentTemplate>

createFavorites

• createFavorites(
      favoriteItems: FavoriteItem[],
      project: string,
      scope: string,
      identityId?: string,
  ): Promise<FavoriteItem[]>

  Parameters

  • favoriteItems: FavoriteItem[]
  • project: string

    Project ID or project name
  • scope: string
  • OptionalidentityId: string

  Returns Promise<FavoriteItem[]>

createFolder

• createFolder(folder: Folder, project: string, path?: string): Promise<Folder>

  Creates a new folder.

  Parameters

  • folder: Folder

    folder.
  • project: string

    Project ID or project name
  • Optionalpath: string

    Path of the folder.

  Returns Promise<Folder>

createRelease

• createRelease(
      releaseStartMetadata: ReleaseStartMetadata,
      project: string,
  ): Promise<Release>

  Create a release.

  Parameters

  • releaseStartMetadata: ReleaseStartMetadata

    Metadata to create a release.
  • project: string

    Project ID or project name

  Returns Promise<Release>

createReleaseDefinition

• createReleaseDefinition(
      releaseDefinition: ReleaseDefinition,
      project: string,
  ): Promise<ReleaseDefinition>

  Create a release definition

  Parameters

  • releaseDefinition: ReleaseDefinition

    release definition object to create.
  • project: string

    Project ID or project name

  Returns Promise<ReleaseDefinition>

deleteDefinitionEnvironmentTemplate

• deleteDefinitionEnvironmentTemplate(
      project: string,
      templateId: string,
  ): Promise<void>

  Delete a definition environment template

  Parameters

  • project: string

    Project ID or project name
  • templateId: string

    Id of the definition environment template

  Returns Promise<void>

deleteDefinitionTag

• deleteDefinitionTag(
      project: string,
      releaseDefinitionId: number,
      tag: string,
  ): Promise<string[]>

  Deletes a tag from a definition

  Parameters

  • project: string

    Project ID or project name
  • releaseDefinitionId: number
  • tag: string

  Returns Promise<string[]>

deleteFavorites

• deleteFavorites(
      project: string,
      scope: string,
      identityId?: string,
      favoriteItemIds?: string,
  ): Promise<void>

  Parameters

  • project: string

    Project ID or project name
  • scope: string
  • OptionalidentityId: string
  • OptionalfavoriteItemIds: string

  Returns Promise<void>

deleteFolder

• deleteFolder(project: string, path: string): Promise<void>

  Deletes a definition folder for given folder name and path and all it's existing definitions.

  Parameters

  • project: string

    Project ID or project name
  • path: string

    Path of the folder to delete.

  Returns Promise<void>

deleteRelease

• deleteRelease(
      project: string,
      releaseId: number,
      comment?: string,
  ): Promise<void>

  Soft delete a release

  Parameters

  • project: string

    Project ID or project name
  • releaseId: number

    Id of the release.
  • Optionalcomment: string

    Comment for deleting a release.

  Returns Promise<void>

deleteReleaseDefinition

• deleteReleaseDefinition(
      project: string,
      definitionId: number,
      comment?: string,
      forceDelete?: boolean,
  ): Promise<void>

  Delete a release definition.

  Parameters

  • project: string

    Project ID or project name
  • definitionId: number

    Id of the release definition.
  • Optionalcomment: string

    Comment for deleting a release definition.
  • OptionalforceDelete: boolean

    'true' to automatically cancel any in-progress release deployments and proceed with release definition deletion . Default is 'false'.

  Returns Promise<void>

deleteReleaseTag

• deleteReleaseTag(
      project: string,
      releaseId: number,
      tag: string,
  ): Promise<string[]>

  Deletes a tag from a release

  Parameters

  • project: string

    Project ID or project name
  • releaseId: number
  • tag: string

  Returns Promise<string[]>

getAgentArtifactDefinitions

• getAgentArtifactDefinitions(
      project: string,
      releaseId: number,
  ): Promise<AgentArtifactDefinition[]>

  Returns the artifact details that automation agent requires

  Parameters

  • project: string

    Project ID or project name
  • releaseId: number

  Returns Promise<AgentArtifactDefinition[]>

getApproval

• getApproval(
      project: string,
      approvalId: number,
      includeHistory?: boolean,
  ): Promise<ReleaseApproval>

  Get an approval.

  Parameters

  • project: string

    Project ID or project name
  • approvalId: number

    Id of the approval.
  • OptionalincludeHistory: boolean

    'true' to include history of the approval. Default is 'false'.

  Returns Promise<ReleaseApproval>

getApprovalHistory

• getApprovalHistory(
      project: string,
      approvalStepId: number,
  ): Promise<ReleaseApproval>

  Get approval history.

  Parameters

  • project: string

    Project ID or project name
  • approvalStepId: number

    Id of the approval.

  Returns Promise<ReleaseApproval>

getApprovals

• getApprovals(
      project: string,
      assignedToFilter?: string,
      statusFilter?: ApprovalStatus,
      releaseIdsFilter?: number[],
      typeFilter?: ApprovalType,
      top?: number,
      continuationToken?: number,
      queryOrder?: ReleaseQueryOrder,
      includeMyGroupApprovals?: boolean,
  ): Promise<PagedList<ReleaseApproval>>

  Get a list of approvals

  Parameters

  • project: string

    Project ID or project name
  • OptionalassignedToFilter: string

    Approvals assigned to this user.
  • OptionalstatusFilter: ApprovalStatus

    Approvals with this status. Default is 'pending'.
  • OptionalreleaseIdsFilter: number[]

    Approvals for release id(s) mentioned in the filter. Multiple releases can be mentioned by separating them with ',' e.g. releaseIdsFilter=1,2,3,4.
  • OptionaltypeFilter: ApprovalType

    Approval with this type.
  • Optionaltop: number

    Number of approvals to get. Default is 50.
  • OptionalcontinuationToken: number

    Gets the approvals after the continuation token provided.
  • OptionalqueryOrder: ReleaseQueryOrder

    Gets the results in the defined order of created approvals. Default is 'descending'.
  • OptionalincludeMyGroupApprovals: boolean

    'true' to include my group approvals. Default is 'false'.

  Returns Promise<PagedList<ReleaseApproval>>

getArtifactTypeDefinitions

• getArtifactTypeDefinitions(project: string): Promise<ArtifactTypeDefinition[]>

  Parameters

  • project: string

    Project ID or project name

  Returns Promise<ArtifactTypeDefinition[]>

getArtifactVersions

• getArtifactVersions(
      project: string,
      releaseDefinitionId: number,
  ): Promise<ArtifactVersionQueryResult>

  Parameters

  • project: string

    Project ID or project name
  • releaseDefinitionId: number

  Returns Promise<ArtifactVersionQueryResult>

getArtifactVersionsForSources

• getArtifactVersionsForSources(
      artifacts: Artifact[],
      project: string,
  ): Promise<ArtifactVersionQueryResult>

  Parameters

  • artifacts: Artifact[]
  • project: string

    Project ID or project name

  Returns Promise<ArtifactVersionQueryResult>

getAutoTriggerIssues

• getAutoTriggerIssues(
      artifactType: string,
      sourceId: string,
      artifactVersionId: string,
      project?: string,
  ): Promise<AutoTriggerIssue[]>

  Parameters

  • artifactType: string
  • sourceId: string
  • artifactVersionId: string
  • Optionalproject: string

    Project ID or project name

  Returns Promise<AutoTriggerIssue[]>

getDefinitionEnvironments

• getDefinitionEnvironments(
      project: string,
      taskGroupId?: string,
      propertyFilters?: string[],
  ): Promise<DefinitionEnvironmentReference[]>

  Parameters

  • project: string

    Project ID or project name
  • OptionaltaskGroupId: string
  • OptionalpropertyFilters: string[]

  Returns Promise<DefinitionEnvironmentReference[]>

getDefinitionEnvironmentTemplate

• getDefinitionEnvironmentTemplate(
      project: string,
      templateId: string,
  ): Promise<ReleaseDefinitionEnvironmentTemplate>

  Gets a definition environment template

  Parameters

  • project: string

    Project ID or project name
  • templateId: string

    Id of the definition environment template

  Returns Promise<ReleaseDefinitionEnvironmentTemplate>

getDefinitionRevision

• getDefinitionRevision(
      project: string,
      definitionId: number,
      revision: number,
  ): Promise<ReadableStream>

  Get release definition for a given definitionId and revision

  Parameters

  • project: string

    Project ID or project name
  • definitionId: number

    Id of the definition.
  • revision: number

    Id of the revision.

  Returns Promise<ReadableStream>

getDefinitionTags

• getDefinitionTags(
      project: string,
      releaseDefinitionId: number,
  ): Promise<string[]>

  Gets the tags for a definition

  Parameters

  • project: string

    Project ID or project name
  • releaseDefinitionId: number

  Returns Promise<string[]>

getDeploymentBadge

• getDeploymentBadge(
      projectId: string,
      releaseDefinitionId: number,
      environmentId: number,
      branchName?: string,
  ): Promise<string>

  Gets a badge that indicates the status of the most recent deployment for an environment.

  Parameters

  • projectId: string

    The ID of the Project.
  • releaseDefinitionId: number

    The ID of the Release Definition.
  • environmentId: number

    The ID of the Environment.
  • OptionalbranchName: string

    The name of the branch.

  Returns Promise<string>

getDeployments

• getDeployments(
      project: string,
      definitionId?: number,
      definitionEnvironmentId?: number,
      createdBy?: string,
      minModifiedTime?: Date,
      maxModifiedTime?: Date,
      deploymentStatus?: DeploymentStatus,
      operationStatus?: DeploymentOperationStatus,
      latestAttemptsOnly?: boolean,
      queryOrder?: ReleaseQueryOrder,
      top?: number,
      continuationToken?: number,
      createdFor?: string,
      minStartedTime?: Date,
      maxStartedTime?: Date,
      sourceBranch?: string,
  ): Promise<PagedList<Deployment>>

  Get a list of deployments

  Parameters

  • project: string

    Project ID or project name
  • OptionaldefinitionId: number

    List the deployments for a given definition id.
  • OptionaldefinitionEnvironmentId: number

    List the deployments for a given definition environment id.
  • OptionalcreatedBy: string

    List the deployments for which deployments are created as identity specified.
  • OptionalminModifiedTime: Date

    List the deployments with LastModified time >= minModifiedTime.
  • OptionalmaxModifiedTime: Date

    List the deployments with LastModified time <= maxModifiedTime.
  • OptionaldeploymentStatus: DeploymentStatus

    List the deployments with given deployment status. Defult is 'All'.
  • OptionaloperationStatus: DeploymentOperationStatus

    List the deployments with given operation status. Default is 'All'.
  • OptionallatestAttemptsOnly: boolean

    'true' to include deployments with latest attempt only. Default is 'false'.
  • OptionalqueryOrder: ReleaseQueryOrder

    List the deployments with given query order. Default is 'Descending'.
  • Optionaltop: number

    List the deployments with given top. Default top is '50' and Max top is '100'.
  • OptionalcontinuationToken: number

    List the deployments with deployment id >= continuationToken.
  • OptionalcreatedFor: string

    List the deployments for which deployments are requested as identity specified.
  • OptionalminStartedTime: Date

    List the deployments with StartedOn time >= minStartedTime.
  • OptionalmaxStartedTime: Date

    List the deployments with StartedOn time <= maxStartedTime.
  • OptionalsourceBranch: string

    List the deployments that are deployed from given branch name.

  Returns Promise<PagedList<Deployment>>

getDeploymentsForMultipleEnvironments

• getDeploymentsForMultipleEnvironments(
      queryParameters: DeploymentQueryParameters,
      project: string,
  ): Promise<Deployment[]>

  Parameters

  • queryParameters: DeploymentQueryParameters
  • project: string

    Project ID or project name

  Returns Promise<Deployment[]>

getFavorites

• getFavorites(
      project: string,
      scope: string,
      identityId?: string,
  ): Promise<FavoriteItem[]>

  Parameters

  • project: string

    Project ID or project name
  • scope: string
  • OptionalidentityId: string

  Returns Promise<FavoriteItem[]>

getFlightAssignments

• getFlightAssignments(flightName?: string): Promise<string[]>

  Parameters

  • OptionalflightName: string

  Returns Promise<string[]>

getFolders

• getFolders(
      project: string,
      path?: string,
      queryOrder?: FolderPathQueryOrder,
  ): Promise<Folder[]>

  Gets folders.

  Parameters

  • project: string

    Project ID or project name
  • Optionalpath: string

    Path of the folder.
  • OptionalqueryOrder: FolderPathQueryOrder

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

  Returns Promise<Folder[]>

getGateLog

• getGateLog(
      project: string,
      releaseId: number,
      environmentId: number,
      gateId: number,
      taskId: number,
  ): Promise<ReadableStream>

  Gets gate logs

  Parameters

  • project: string

    Project ID or project name
  • releaseId: number

    Id of the release.
  • environmentId: number

    Id of release environment.
  • gateId: number

    Id of the gate.
  • taskId: number

    ReleaseTask Id for the log.

  Returns Promise<ReadableStream>

getInputValues

• getInputValues(
      query: InputValuesQuery,
      project: string,
  ): Promise<InputValuesQuery>

  Parameters

  • query: InputValuesQuery
  • project: string

    Project ID or project name

  Returns Promise<InputValuesQuery>

getIssues

• getIssues(
      project: string,
      buildId: number,
      sourceId?: string,
  ): Promise<AutoTriggerIssue[]>

  Parameters

  • project: string

    Project ID or project name
  • buildId: number
  • OptionalsourceId: string

  Returns Promise<AutoTriggerIssue[]>

getLog

• getLog(
      project: string,
      releaseId: number,
      environmentId: number,
      taskId: number,
      attemptId?: number,
  ): Promise<ReadableStream>

  Gets logs

  Parameters

  • project: string

    Project ID or project name
  • releaseId: number

    Id of the release.
  • environmentId: number

    Id of release environment.
  • taskId: number

    ReleaseTask Id for the log.
  • OptionalattemptId: number

    Id of the attempt.

  Returns Promise<ReadableStream>

getLogs

• getLogs(project: string, releaseId: number): Promise<ReadableStream>

  Get logs for a release Id.

  Parameters

  • project: string

    Project ID or project name
  • releaseId: number

    Id of the release.

  Returns Promise<ReadableStream>

getManualIntervention

• getManualIntervention(
      project: string,
      releaseId: number,
      manualInterventionId: number,
  ): Promise<ManualIntervention>

  Get manual intervention for a given release and manual intervention id.

  Parameters

  • project: string

    Project ID or project name
  • releaseId: number

    Id of the release.
  • manualInterventionId: number

    Id of the manual intervention.

  Returns Promise<ManualIntervention>

getManualInterventions

• getManualInterventions(
      project: string,
      releaseId: number,
  ): Promise<ManualIntervention[]>

  List all manual interventions for a given release.

  Parameters

  • project: string

    Project ID or project name
  • releaseId: number

    Id of the release.

  Returns Promise<ManualIntervention[]>

getMetrics

• getMetrics(project: string, minMetricsTime?: Date): Promise<Metric[]>

  Parameters

  • project: string

    Project ID or project name
  • OptionalminMetricsTime: Date

  Returns Promise<Metric[]>

getOrgPipelineReleaseSettings

• getOrgPipelineReleaseSettings(): Promise<OrgPipelineReleaseSettings>

  Gets Org pipeline release settings

  Returns Promise<OrgPipelineReleaseSettings>

getPipelineReleaseSettings

• getPipelineReleaseSettings(
      project: string,
  ): Promise<ProjectPipelineReleaseSettings>

  Gets pipeline release settings

  Parameters

  • project: string

    Project ID or project name

  Returns Promise<ProjectPipelineReleaseSettings>

getRelease

• getRelease(
      project: string,
      releaseId: number,
      approvalFilters?: ApprovalFilters,
      propertyFilters?: string[],
      expand?: SingleReleaseExpands,
      topGateRecords?: number,
  ): Promise<Release>

  Get a Release

  Parameters

  • project: string

    Project ID or project name
  • releaseId: number

    Id of the release.
  • OptionalapprovalFilters: ApprovalFilters

    A filter which would allow fetching approval steps selectively based on whether it is automated, or manual. This would also decide whether we should fetch pre and post approval snapshots. Assumes All by default
  • OptionalpropertyFilters: string[]

    A comma-delimited list of extended properties to be retrieved. If set, the returned Release will contain values for the specified property Ids (if they exist). If not set, properties will not be included.
  • Optionalexpand: SingleReleaseExpands

    A property that should be expanded in the release.
  • OptionaltopGateRecords: number

    Number of release gate records to get. Default is 5.

  Returns Promise<Release>

getReleaseChanges

• getReleaseChanges(
      project: string,
      releaseId: number,
      baseReleaseId?: number,
      top?: number,
      artifactAlias?: string,
  ): Promise<Change[]>

  Parameters

  • project: string

    Project ID or project name
  • releaseId: number
  • OptionalbaseReleaseId: number
  • Optionaltop: number
  • OptionalartifactAlias: string

  Returns Promise<Change[]>

getReleaseDefinition

• getReleaseDefinition(
      project: string,
      definitionId: number,
      propertyFilters?: string[],
  ): Promise<ReleaseDefinition>

  Get a release definition.

  Parameters

  • project: string

    Project ID or project name
  • definitionId: number

    Id of the release definition.
  • OptionalpropertyFilters: string[]

    A comma-delimited list of extended properties to be retrieved. If set, the returned Release Definition will contain values for the specified property Ids (if they exist). If not set, properties will not be included.

  Returns Promise<ReleaseDefinition>

getReleaseDefinitionHistory

• getReleaseDefinitionHistory(
      project: string,
      definitionId: number,
  ): Promise<ReleaseDefinitionRevision[]>

  Get revision history for a release definition

  Parameters

  • project: string

    Project ID or project name
  • definitionId: number

    Id of the definition.

  Returns Promise<ReleaseDefinitionRevision[]>

getReleaseDefinitionRevision

• getReleaseDefinitionRevision(
      project: string,
      definitionId: number,
      revision: number,
  ): Promise<ReadableStream>

  Get release definition of a given revision.

  Parameters

  • project: string

    Project ID or project name
  • definitionId: number

    Id of the release definition.
  • revision: number

    Revision number of the release definition.

  Returns Promise<ReadableStream>

getReleaseDefinitions

• getReleaseDefinitions(
      project: string,
      searchText?: string,
      expand?: ReleaseDefinitionExpands,
      artifactType?: string,
      artifactSourceId?: string,
      top?: number,
      continuationToken?: string,
      queryOrder?: ReleaseDefinitionQueryOrder,
      path?: string,
      isExactNameMatch?: boolean,
      tagFilter?: string[],
      propertyFilters?: string[],
      definitionIdFilter?: string[],
      isDeleted?: boolean,
      searchTextContainsFolderName?: boolean,
  ): Promise<PagedList<ReleaseDefinition>>

  Get a list of release definitions.

  Parameters

  • project: string

    Project ID or project name
  • OptionalsearchText: string

    Get release definitions with names containing searchText.
  • Optionalexpand: ReleaseDefinitionExpands

    The properties that should be expanded in the list of Release definitions.
  • OptionalartifactType: string

    Release definitions with given artifactType will be returned. Values can be Build, Jenkins, GitHub, Nuget, Team Build (external), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.
  • OptionalartifactSourceId: 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.
  • Optionaltop: number

    Number of release definitions to get.
  • OptionalcontinuationToken: string

    Gets the release definitions after the continuation token provided.
  • OptionalqueryOrder: ReleaseDefinitionQueryOrder

    Gets the results in the defined order. Default is 'IdAscending'.
  • Optionalpath: string

    Gets the release definitions under the specified path.
  • OptionalisExactNameMatch: boolean

    'true'to gets the release definitions with exact match as specified in searchText. Default is 'false'.
  • OptionaltagFilter: string[]

    A comma-delimited list of tags. Only release definitions with these tags will be returned.
  • OptionalpropertyFilters: 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.
  • OptionaldefinitionIdFilter: string[]

    A comma-delimited list of release definitions to retrieve.
  • OptionalisDeleted: boolean

    'true' to get release definitions that has been deleted. Default is 'false'
  • OptionalsearchTextContainsFolderName: boolean

    'true' to get the release definitions under the folder with name as specified in searchText. Default is 'false'.

  Returns Promise<PagedList<ReleaseDefinition>>

getReleaseDefinitionSummary

• getReleaseDefinitionSummary(
      project: string,
      definitionId: number,
      releaseCount: number,
      includeArtifact?: boolean,
      definitionEnvironmentIdsFilter?: number[],
  ): Promise<ReleaseDefinitionSummary>

  Get release summary of a given definition Id.

  Parameters

  • project: string

    Project ID or project name
  • definitionId: number

    Id of the definition to get release summary.
  • releaseCount: number

    Count of releases to be included in summary.
  • OptionalincludeArtifact: boolean

    Include artifact details.Default is 'false'.
  • OptionaldefinitionEnvironmentIdsFilter: number[]

  Returns Promise<ReleaseDefinitionSummary>

getReleaseEnvironment

• getReleaseEnvironment(
      project: string,
      releaseId: number,
      environmentId: number,
      expand?: ReleaseEnvironmentExpands,
  ): Promise<ReleaseEnvironment>

  Get a release environment.

  Parameters

  • project: string

    Project ID or project name
  • releaseId: number

    Id of the release.
  • environmentId: number

    Id of the release environment.
  • Optionalexpand: ReleaseEnvironmentExpands

    A property that should be expanded in the environment.

  Returns Promise<ReleaseEnvironment>

getReleaseHistory

• getReleaseHistory(
      project: string,
      releaseId: number,
  ): Promise<ReleaseRevision[]>

  Parameters

  • project: string

    Project ID or project name
  • releaseId: number

  Returns Promise<ReleaseRevision[]>

getReleaseProjects

• getReleaseProjects(
      artifactType: string,
      artifactSourceId: string,
  ): Promise<ProjectReference[]>

  Parameters

  • artifactType: string
  • artifactSourceId: string

  Returns Promise<ProjectReference[]>

getReleaseRevision

• getReleaseRevision(
      project: string,
      releaseId: number,
      definitionSnapshotRevision: number,
  ): Promise<ReadableStream>

  Get release for a given revision number.

  Parameters

  • project: string

    Project ID or project name
  • releaseId: number

    Id of the release.
  • definitionSnapshotRevision: number

    Definition snapshot revision number.

  Returns Promise<ReadableStream>

getReleases

• getReleases(
      project?: string,
      definitionId?: number,
      definitionEnvironmentId?: number,
      searchText?: string,
      createdBy?: string,
      statusFilter?: ReleaseStatus,
      environmentStatusFilter?: number,
      minCreatedTime?: Date,
      maxCreatedTime?: Date,
      queryOrder?: ReleaseQueryOrder,
      top?: number,
      continuationToken?: number,
      expand?: ReleaseExpands,
      artifactTypeId?: string,
      sourceId?: string,
      artifactVersionId?: string,
      sourceBranchFilter?: string,
      isDeleted?: boolean,
      tagFilter?: string[],
      propertyFilters?: string[],
      releaseIdFilter?: number[],
      path?: string,
  ): Promise<PagedList<Release>>

  Get a list of releases

  Parameters

  • Optionalproject: string

    Project ID or project name
  • OptionaldefinitionId: number

    Releases from this release definition Id.
  • OptionaldefinitionEnvironmentId: number
  • OptionalsearchText: string

    Releases with names containing searchText.
  • OptionalcreatedBy: string

    Releases created by this user.
  • OptionalstatusFilter: ReleaseStatus

    Releases that have this status.
  • OptionalenvironmentStatusFilter: number
  • OptionalminCreatedTime: Date

    Releases that were created after this time.
  • OptionalmaxCreatedTime: Date

    Releases that were created before this time.
  • OptionalqueryOrder: ReleaseQueryOrder

    Gets the results in the defined order of created date for releases. Default is descending.
  • Optionaltop: number

    Number of releases to get. Default is 50.
  • OptionalcontinuationToken: number

    Gets the releases after the continuation token provided.
  • Optionalexpand: ReleaseExpands

    The property that should be expanded in the list of releases.
  • OptionalartifactTypeId: string

    Releases with given artifactTypeId will be returned. Values can be Build, Jenkins, GitHub, Nuget, Team Build (external), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.
  • OptionalsourceId: string

    Unique identifier of the artifact used. 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 https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.
  • OptionalartifactVersionId: string

    Releases with given artifactVersionId will be returned. E.g. in case of Build artifactType, it is buildId.
  • OptionalsourceBranchFilter: string

    Releases with given sourceBranchFilter will be returned.
  • OptionalisDeleted: boolean

    Gets the soft deleted releases, if true.
  • OptionaltagFilter: string[]

    A comma-delimited list of tags. Only releases with these tags will be returned.
  • OptionalpropertyFilters: string[]

    A comma-delimited list of extended properties to be retrieved. If set, the returned Releases 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 from results irrespective of whether it has property set or not.
  • OptionalreleaseIdFilter: number[]

    A comma-delimited list of releases Ids. Only releases with these Ids will be returned.
  • Optionalpath: string

    Releases under this folder path will be returned

  Returns Promise<PagedList<Release>>

getReleaseSettings

• getReleaseSettings(project: string): Promise<ReleaseSettings>

  Gets the release settings

  Parameters

  • project: string

    Project ID or project name

  Returns Promise<ReleaseSettings>

getReleaseTags

• getReleaseTags(project: string, releaseId: number): Promise<string[]>

  Gets the tags for a release

  Parameters

  • project: string

    Project ID or project name
  • releaseId: number

  Returns Promise<string[]>

getReleaseTaskAttachmentContent

• getReleaseTaskAttachmentContent(
      project: string,
      releaseId: number,
      environmentId: number,
      attemptId: number,
      planId: string,
      timelineId: string,
      recordId: string,
      type: string,
      name: string,
  ): Promise<ReadableStream>

  Get a release task attachment.

  Parameters

  • project: string

    Project ID or project name
  • releaseId: number

    Id of the release.
  • environmentId: number

    Id of the release environment.
  • attemptId: number

    Attempt number of deployment.
  • planId: string

    Plan Id of the deploy phase.
  • timelineId: string

    Timeline Id of the task.
  • recordId: string

    Record Id of attachment.
  • type: string

    Type of the attachment.
  • name: string

    Name of the attachment.

  Returns Promise<ReadableStream>

getReleaseTaskAttachments

• getReleaseTaskAttachments(
      project: string,
      releaseId: number,
      environmentId: number,
      attemptId: number,
      planId: string,
      type: string,
  ): Promise<ReleaseTaskAttachment[]>

  Get the release task attachments.

  Parameters

  • project: string

    Project ID or project name
  • releaseId: number

    Id of the release.
  • environmentId: number

    Id of the release environment.
  • attemptId: number

    Attempt number of deployment.
  • planId: string

    Plan Id of the deploy phase.
  • type: string

    Type of the attachment.

  Returns Promise<ReleaseTaskAttachment[]>

getReleaseWorkItemsRefs

• getReleaseWorkItemsRefs(
      project: string,
      releaseId: number,
      baseReleaseId?: number,
      top?: number,
      artifactAlias?: string,
  ): Promise<ReleaseWorkItemRef[]>

  Parameters

  • project: string

    Project ID or project name
  • releaseId: number
  • OptionalbaseReleaseId: number
  • Optionaltop: number
  • OptionalartifactAlias: string

  Returns Promise<ReleaseWorkItemRef[]>

getSourceBranches

• getSourceBranches(project: string, definitionId: number): Promise<string[]>

  Parameters

  • project: string

    Project ID or project name
  • definitionId: number

  Returns Promise<string[]>

getSummaryMailSections

• getSummaryMailSections(
      project: string,
      releaseId: number,
  ): Promise<SummaryMailSection[]>

  Parameters

  • project: string

    Project ID or project name
  • releaseId: number

  Returns Promise<SummaryMailSection[]>

getTags

• getTags(project: string): Promise<string[]>

  Parameters

  • project: string

    Project ID or project name

  Returns Promise<string[]>

getTaskAttachmentContent

• getTaskAttachmentContent(
      project: string,
      releaseId: number,
      environmentId: number,
      attemptId: number,
      timelineId: string,
      recordId: string,
      type: string,
      name: string,
  ): Promise<ReadableStream>

  Get a task attachment.

  Parameters

  • project: string

    Project ID or project name
  • releaseId: number

    Id of the release.
  • environmentId: number

    Id of the release environment.
  • attemptId: number

    Attempt number of deployment.
  • timelineId: string

    Timeline Id of the task.
  • recordId: string

    Record Id of attachment.
  • type: string

    Type of the attachment.
  • name: string

    Name of the attachment.

  Returns Promise<ReadableStream>

getTaskAttachments

• getTaskAttachments(
      project: string,
      releaseId: number,
      environmentId: number,
      attemptId: number,
      timelineId: string,
      type: string,
  ): Promise<ReleaseTaskAttachment[]>

  Get the task attachments.

  Parameters

  • project: string

    Project ID or project name
  • releaseId: number

    Id of the release.
  • environmentId: number

    Id of the release environment.
  • attemptId: number

    Attempt number of deployment.
  • timelineId: string

    Timeline Id of the task.
  • type: string

    Type of the attachment.

  Returns Promise<ReleaseTaskAttachment[]>

getTaskLog

• getTaskLog(
      project: string,
      releaseId: number,
      environmentId: number,
      releaseDeployPhaseId: number,
      taskId: number,
      startLine?: number,
      endLine?: number,
  ): Promise<ReadableStream>

  Gets the task log of a release as a plain text file.

  Parameters

  • project: string

    Project ID or project name
  • releaseId: number

    Id of the release.
  • environmentId: number

    Id of release environment.
  • releaseDeployPhaseId: number

    Release deploy phase Id.
  • taskId: number

    ReleaseTask Id for the log.
  • OptionalstartLine: number

    Starting line number for logs
  • OptionalendLine: number

    Ending line number for logs

  Returns Promise<ReadableStream>

getTaskLog2

• getTaskLog2(
      project: string,
      releaseId: number,
      environmentId: number,
      attemptId: number,
      timelineId: string,
      taskId: number,
      startLine?: number,
      endLine?: number,
  ): Promise<ReadableStream>

  Gets the task log of a release as a plain text file.

  Parameters

  • project: string

    Project ID or project name
  • releaseId: number

    Id of the release.
  • environmentId: number

    Id of release environment.
  • attemptId: number
  • timelineId: string
  • taskId: number

    ReleaseTask Id for the log.
  • OptionalstartLine: number

    Starting line number for logs
  • OptionalendLine: number

    Ending line number for logs

  Returns Promise<ReadableStream>

getTasks

• getTasks(
      project: string,
      releaseId: number,
      environmentId: number,
      attemptId?: number,
  ): Promise<ReleaseTask[]>

  Parameters

  • project: string

    Project ID or project name
  • releaseId: number
  • environmentId: number
  • OptionalattemptId: number

  Returns Promise<ReleaseTask[]>

getTasks2

• getTasks2(
      project: string,
      releaseId: number,
      environmentId: number,
      attemptId: number,
      timelineId: string,
  ): Promise<ReleaseTask[]>

  Parameters

  • project: string

    Project ID or project name
  • releaseId: number
  • environmentId: number
  • attemptId: number
  • timelineId: string

  Returns Promise<ReleaseTask[]>

getTasksForTaskGroup

• getTasksForTaskGroup(
      project: string,
      releaseId: number,
      environmentId: number,
      releaseDeployPhaseId: number,
  ): Promise<ReleaseTask[]>

  Parameters

  • project: string

    Project ID or project name
  • releaseId: number
  • environmentId: number
  • releaseDeployPhaseId: number

  Returns Promise<ReleaseTask[]>

listDefinitionEnvironmentTemplates

• listDefinitionEnvironmentTemplates(
      project: string,
      isDeleted?: boolean,
  ): Promise<ReleaseDefinitionEnvironmentTemplate[]>

  Gets a list of definition environment templates

  Parameters

  • project: string

    Project ID or project name
  • OptionalisDeleted: boolean

    'true' to get definition environment templates that have been deleted. Default is 'false'

  Returns Promise<ReleaseDefinitionEnvironmentTemplate[]>

sendSummaryMail

• sendSummaryMail(
      mailMessage: MailMessage,
      project: string,
      releaseId: number,
  ): Promise<void>

  Parameters

  • mailMessage: MailMessage
  • project: string

    Project ID or project name
  • releaseId: number

  Returns Promise<void>

undeleteRelease

• undeleteRelease(
      project: string,
      releaseId: number,
      comment: string,
  ): Promise<void>

  Undelete a soft deleted release.

  Parameters

  • project: string

    Project ID or project name
  • releaseId: number

    Id of release to be undeleted.
  • comment: string

    Any comment for undeleting.

  Returns Promise<void>

undeleteReleaseDefinition

• undeleteReleaseDefinition(
      releaseDefinitionUndeleteParameter: ReleaseDefinitionUndeleteParameter,
      project: string,
      definitionId: number,
  ): Promise<ReleaseDefinition>

  Undelete a release definition.

  Parameters

  • releaseDefinitionUndeleteParameter: ReleaseDefinitionUndeleteParameter

    Object for undelete release definition.
  • project: string

    Project ID or project name
  • definitionId: number

    Id of the release definition to be undeleted

  Returns Promise<ReleaseDefinition>

undeleteReleaseDefinitionEnvironmentTemplate

• undeleteReleaseDefinitionEnvironmentTemplate(
      project: string,
      templateId: string,
  ): Promise<ReleaseDefinitionEnvironmentTemplate>

  Undelete a release definition environment template.

  Parameters

  • project: string

    Project ID or project name
  • templateId: string

    Id of the definition environment template to be undeleted

  Returns Promise<ReleaseDefinitionEnvironmentTemplate>

updateFolder

• updateFolder(folder: Folder, project: string, path: string): Promise<Folder>

  Updates an existing folder at given existing path.

  Parameters

  • folder: Folder

    folder.
  • project: string

    Project ID or project name
  • path: string

    Path of the folder to update.

  Returns Promise<Folder>

updateGates

• updateGates(
      gateUpdateMetadata: GateUpdateMetadata,
      project: string,
      gateStepId: number,
  ): Promise<ReleaseGates>

  Updates the gate for a deployment.

  Parameters

  • gateUpdateMetadata: GateUpdateMetadata

    Metadata to patch the Release Gates.
  • project: string

    Project ID or project name
  • gateStepId: number

    Gate step Id.

  Returns Promise<ReleaseGates>

updateManualIntervention

• updateManualIntervention(
      manualInterventionUpdateMetadata: ManualInterventionUpdateMetadata,
      project: string,
      releaseId: number,
      manualInterventionId: number,
  ): Promise<ManualIntervention>

  Update manual intervention.

  Parameters

  • manualInterventionUpdateMetadata: ManualInterventionUpdateMetadata

    Meta data to update manual intervention.
  • project: string

    Project ID or project name
  • releaseId: number

    Id of the release.
  • manualInterventionId: number

    Id of the manual intervention.

  Returns Promise<ManualIntervention>

updateOrgPipelineReleaseSettings

• updateOrgPipelineReleaseSettings(
      newSettings: OrgPipelineReleaseSettingsUpdateParameters,
  ): Promise<OrgPipelineReleaseSettings>

  Updates Org pipeline release settings

  Parameters

  • newSettings: OrgPipelineReleaseSettingsUpdateParameters

  Returns Promise<OrgPipelineReleaseSettings>

updatePipelineReleaseSettings

• updatePipelineReleaseSettings(
      newSettings: ProjectPipelineReleaseSettingsUpdateParameters,
      project: string,
  ): Promise<ProjectPipelineReleaseSettings>

  Updates pipeline release settings

  Parameters

  • newSettings: ProjectPipelineReleaseSettingsUpdateParameters
  • project: string

    Project ID or project name

  Returns Promise<ProjectPipelineReleaseSettings>

updateRelease

• updateRelease(
      release: Release,
      project: string,
      releaseId: number,
  ): Promise<Release>

  Update a complete release object.

  Parameters

  • release: Release

    Release object for update.
  • project: string

    Project ID or project name
  • releaseId: number

    Id of the release to update.

  Returns Promise<Release>

updateReleaseApproval

• updateReleaseApproval(
      approval: ReleaseApproval,
      project: string,
      approvalId: number,
  ): Promise<ReleaseApproval>

  Update status of an approval

  Parameters

  • approval: ReleaseApproval

    ReleaseApproval object having status, approver and comments.
  • project: string

    Project ID or project name
  • approvalId: number

    Id of the approval.

  Returns Promise<ReleaseApproval>

updateReleaseApprovals

• updateReleaseApprovals(
      approvals: ReleaseApproval[],
      project: string,
  ): Promise<ReleaseApproval[]>

  Parameters

  • approvals: ReleaseApproval[]
  • project: string

    Project ID or project name

  Returns Promise<ReleaseApproval[]>

updateReleaseDefinition

• updateReleaseDefinition(
      releaseDefinition: ReleaseDefinition,
      project: string,
  ): Promise<ReleaseDefinition>

  Update a release definition.

  Parameters

  • releaseDefinition: ReleaseDefinition

    Release definition object to update.
  • project: string

    Project ID or project name

  Returns Promise<ReleaseDefinition>

updateReleaseEnvironment

• updateReleaseEnvironment(
      environmentUpdateData: ReleaseEnvironmentUpdateMetadata,
      project: string,
      releaseId: number,
      environmentId: number,
  ): Promise<ReleaseEnvironment>

  Update the status of a release environment

  Parameters

  • environmentUpdateData: ReleaseEnvironmentUpdateMetadata

    Environment update meta data.
  • project: string

    Project ID or project name
  • releaseId: number

    Id of the release.
  • environmentId: number

    Id of release environment.

  Returns Promise<ReleaseEnvironment>

updateReleaseResource

• updateReleaseResource(
      releaseUpdateMetadata: ReleaseUpdateMetadata,
      project: string,
      releaseId: number,
  ): Promise<Release>

  Update few properties of a release.

  Parameters

  • releaseUpdateMetadata: ReleaseUpdateMetadata

    Properties of release to update.
  • project: string

    Project ID or project name
  • releaseId: number

    Id of the release to update.

  Returns Promise<Release>

updateReleaseSettings

• updateReleaseSettings(
      releaseSettings: ReleaseSettings,
      project: string,
  ): Promise<ReleaseSettings>

  Updates the release settings

  Parameters

  • releaseSettings: ReleaseSettings
  • project: string

    Project ID or project name

  Returns Promise<ReleaseSettings>