ReleaseRestClient class

参考

包:: azure-devops-extension-api

应使用的基类 (派生自) 以向 VSS REST API 发出请求

Extends: RestClientBase

构造函数

ReleaseRestClient(IVssRestClientOptions)

属性

RESOURCE_AREA_ID

方法

addDefinitionTag(string, number, string)	将标记添加到定义
addDefinitionTags(string[], string, number)	向定义添加多个标记
addReleaseTag(string, number, string)	将标记添加到 releaseId
addReleaseTags(string[], string, number)	将标记添加到发布
createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)	创建定义环境模板
createFavorites(FavoriteItem[], string, string, string)
createFolder(Folder, string, string)	创建新文件夹。
createRelease(ReleaseStartMetadata, string)	创建发布。
createReleaseDefinition(ReleaseDefinition, string)	创建发布定义
deleteDefinitionEnvironmentTemplate(string, string)	删除定义环境模板
deleteDefinitionTag(string, number, string)	从定义中删除标记
deleteFavorites(string, string, string, string)
deleteFolder(string, string)	删除给定文件夹名称和路径的定义文件夹及其所有现有定义。
deleteRelease(string, number, string)	软删除发布
deleteReleaseDefinition(string, number, string, boolean)	删除发布定义。
deleteReleaseTag(string, number, string)	从发布中删除标记
getAgentArtifactDefinitions(string, number)	返回自动化代理所需的项目详细信息
getApproval(string, number, boolean)	获取批准。
getApprovalHistory(string, number)	获取审批历史记录。
getApprovals(string, string, ApprovalStatus, number[], ApprovalType, number, number, ReleaseQueryOrder, boolean)	获取审批列表
getArtifactTypeDefinitions(string)
getArtifactVersions(string, number)
getArtifactVersionsForSources(Artifact[], string)
getAutoTriggerIssues(string, string, string, string)
getDefinitionEnvironments(string, string, string[])
getDefinitionEnvironmentTemplate(string, string)	获取定义环境模板
getDefinitionRevision(string, number, number)	获取给定 definitionId 和修订版本的发布定义
getDefinitionTags(string, number)	获取定义的标记
getDeploymentBadge(string, number, number, string)	获取一个锁屏提醒，该锁屏提醒指示环境的最新部署的状态。
getDeployments(string, number, number, string, Date, Date, DeploymentStatus, DeploymentOperationStatus, boolean, ReleaseQueryOrder, number, number, string, Date, Date, string)	获取部署列表
getDeploymentsForMultipleEnvironments(DeploymentQueryParameters, string)
getFavorites(string, string, string)
getFlightAssignments(string)
getFolders(string, string, FolderPathQueryOrder)	获取文件夹。
getGateLog(string, number, number, number, number)	获取门日志
getInputValues(InputValuesQuery, string)
getIssues(string, number, string)
getLog(string, number, number, number, number)	获取日志
getLogs(string, number)	获取发布 ID 的日志。
getManualIntervention(string, number, number)	获取给定版本的手动干预和手动干预 ID。
getManualInterventions(string, number)	列出给定版本的所有手动干预。
getMetrics(string, Date)
getOrgPipelineReleaseSettings()	获取组织管道发布设置
getPipelineReleaseSettings(string)	获取管道发布设置
getRelease(string, number, ApprovalFilters, string[], SingleReleaseExpands, number)	获取发布
getReleaseChanges(string, number, number, number, string)
getReleaseDefinition(string, number, string[])	获取发布定义。
getReleaseDefinitionHistory(string, number)	获取发布定义的修订历史记录
getReleaseDefinitionRevision(string, number, number)	获取给定修订版的发布定义。
getReleaseDefinitions(string, string, ReleaseDefinitionExpands, string, string, number, string, ReleaseDefinitionQueryOrder, string, boolean, string[], string[], string[], boolean, boolean)	获取发布定义列表。
getReleaseDefinitionSummary(string, number, number, boolean, number[])	获取给定定义 ID 的发布摘要。
getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)	获取发布环境。
getReleaseHistory(string, number)
getReleaseProjects(string, string)
getReleaseRevision(string, number, number)	获取给定修订号的发布。
getReleases(string, number, number, string, string, ReleaseStatus, number, Date, Date, ReleaseQueryOrder, number, number, ReleaseExpands, string, string, string, string, boolean, string[], string[], number[], string)	获取发布列表
getReleaseSettings(string)	获取发布设置
getReleaseTags(string, number)	获取发布的标记
getReleaseTaskAttachmentContent(string, number, number, number, string, string, string, string, string)	获取发布任务附件。
getReleaseTaskAttachments(string, number, number, number, string, string)	获取发布任务附件。
getReleaseWorkItemsRefs(string, number, number, number, string)
getSourceBranches(string, number)
getSummaryMailSections(string, number)
getTags(string)
getTaskAttachmentContent(string, number, number, number, string, string, string, string)	获取任务附件。
getTaskAttachments(string, number, number, number, string, string)	获取任务附件。
getTaskLog(string, number, number, number, number, number, number)	获取以纯文本文件形式发布的任务日志。
getTaskLog2(string, number, number, number, string, number, number, number)	获取以纯文本文件形式发布的任务日志。
getTasks(string, number, number, number)
getTasks2(string, number, number, number, string)
getTasksForTaskGroup(string, number, number, number)
listDefinitionEnvironmentTemplates(string, boolean)	获取定义环境模板的列表
sendSummaryMail(MailMessage, string, number)
undeleteRelease(string, number, string)	取消删除软删除的版本。
undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)	取消删除发布定义。
undeleteReleaseDefinitionEnvironmentTemplate(string, string)	取消删除发布定义环境模板。
updateFolder(Folder, string, string)	汇报给定现有路径中的现有文件夹。
updateGates(GateUpdateMetadata, string, number)	汇报部署的入口。
updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)	更新手动干预。
updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)	汇报组织管道发布设置
updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)	汇报管道发布设置
updateRelease(Release, string, number)	更新完整的发布对象。
updateReleaseApproval(ReleaseApproval, string, number)	更新审批状态
updateReleaseApprovals(ReleaseApproval[], string)
updateReleaseDefinition(ReleaseDefinition, string)	更新发布定义。
updateReleaseEnvironment(ReleaseEnvironmentUpdateMetadata, string, number, number)	更新发布环境的状态
updateReleaseResource(ReleaseUpdateMetadata, string, number)	更新版本的一些属性。
updateReleaseSettings(ReleaseSettings, string)	汇报发布设置

构造函数详细信息

ReleaseRestClient(IVssRestClientOptions)

new ReleaseRestClient(options: IVssRestClientOptions)

参数

options: IVssRestClientOptions

属性详细信息

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

属性值

string

方法详细信息

addDefinitionTag(string, number, string)

将标记添加到定义

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

参数

project: string

项目 ID 或项目名称

releaseDefinitionId: number

tag: string

Promise<string[]>

addDefinitionTags(string[], string, number)

向定义添加多个标记

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

参数

tags: string[]

project: string

项目 ID 或项目名称

releaseDefinitionId: number

Promise<string[]>

addReleaseTag(string, number, string)

将标记添加到 releaseId

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

参数

project: string

项目 ID 或项目名称

releaseId: number

tag: string

Promise<string[]>

addReleaseTags(string[], string, number)

将标记添加到发布

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

参数

tags: string[]

project: string

项目 ID 或项目名称

releaseId: number

Promise<string[]>

createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)

创建定义环境模板

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

参数

template: ReleaseDefinitionEnvironmentTemplate

定义要创建的环境模板

project: string

项目 ID 或项目名称

Promise<ReleaseDefinitionEnvironmentTemplate>

createFavorites(FavoriteItem[], string, string, string)

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

参数

favoriteItems: FavoriteItem[]

project: string

项目 ID 或项目名称

scope: string

identityId: string

Promise<FavoriteItem[]>

createFolder(Folder, string, string)

创建新文件夹。

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

参数

folder: Folder

文件夹。

project: string

项目 ID 或项目名称

path: string

文件夹的路径。

Promise<Folder>

createRelease(ReleaseStartMetadata, string)

创建发布。

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

参数

releaseStartMetadata: ReleaseStartMetadata

用于创建发布的元数据。

project: string

项目 ID 或项目名称

Promise<Release>

createReleaseDefinition(ReleaseDefinition, string)

创建发布定义

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

参数

releaseDefinition: ReleaseDefinition

要创建的发布定义对象。

project: string

项目 ID 或项目名称

Promise<ReleaseDefinition>

deleteDefinitionEnvironmentTemplate(string, string)

删除定义环境模板

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

参数

project: string

项目 ID 或项目名称

templateId: string

定义环境模板的 ID

Promise<void>

deleteDefinitionTag(string, number, string)

从定义中删除标记

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

参数

project: string

项目 ID 或项目名称

releaseDefinitionId: number

tag: string

Promise<string[]>

deleteFavorites(string, string, string, string)

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

参数

project: string

项目 ID 或项目名称

scope: string

identityId: string

favoriteItemIds: string

Promise<void>

deleteFolder(string, string)

删除给定文件夹名称和路径的定义文件夹及其所有现有定义。

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

参数

project: string

项目 ID 或项目名称

path: string

要删除的文件夹的路径。

Promise<void>

deleteRelease(string, number, string)

软删除发布

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

参数

project: string

项目 ID 或项目名称

releaseId: number

版本的 ID。

comment: string

有关删除发布的注释。

Promise<void>

deleteReleaseDefinition(string, number, string, boolean)

删除发布定义。

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

参数

project: string

项目 ID 或项目名称

definitionId: number

发布定义的 ID。

comment: string

有关删除发布定义的注释。

forceDelete: boolean

“true”自动取消任何正在进行的发布部署，并继续删除发布定义。默认值为“false”。

Promise<void>

deleteReleaseTag(string, number, string)

从发布中删除标记

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

参数

project: string

项目 ID 或项目名称

releaseId: number

tag: string

Promise<string[]>

getAgentArtifactDefinitions(string, number)

返回自动化代理所需的项目详细信息

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

参数

project: string

项目 ID 或项目名称

releaseId: number

Promise<AgentArtifactDefinition[]>

getApproval(string, number, boolean)

获取批准。

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

参数

project: string

项目 ID 或项目名称

approvalId: number

审批的 ID。

includeHistory: boolean

“true”包含审批历史记录。默认值为“false”。

Promise<ReleaseApproval>

getApprovalHistory(string, number)

获取审批历史记录。

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

参数

project: string

项目 ID 或项目名称

approvalStepId: number

审批的 ID。

Promise<ReleaseApproval>

getApprovals(string, string, ApprovalStatus, number[], ApprovalType, number, number, ReleaseQueryOrder, boolean)

获取审批列表

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

参数

project: string

项目 ID 或项目名称

assignedToFilter: string

分配给此用户的审批。

statusFilter: ApprovalStatus

具有此状态的审批。默认值为“pending”。

releaseIdsFilter: number[]

批准发布 ID (筛选器中提到的) 。可以通过用“releaseIdsFilter=1,2,3,4”分隔多个版本来提及多个版本。

typeFilter: ApprovalType

此类型的审批。

top: number

要获取的批准数。默认值为 50。

continuationToken: number

获取提供的继续标记之后的审批。

queryOrder: ReleaseQueryOrder

获取已创建审批的已定义顺序的结果。默认值为“降序”。

includeMyGroupApprovals: boolean

“true”包含我的组审批。默认值为“false”。

Promise<PagedList<ReleaseApproval>>

getArtifactTypeDefinitions(string)

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

参数

project: string

项目 ID 或项目名称

Promise<ArtifactTypeDefinition[]>

getArtifactVersions(string, number)

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

参数

project: string

项目 ID 或项目名称

releaseDefinitionId: number

Promise<ArtifactVersionQueryResult>

getArtifactVersionsForSources(Artifact[], string)

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

参数

artifacts: Artifact[]

project: string

项目 ID 或项目名称

Promise<ArtifactVersionQueryResult>

getAutoTriggerIssues(string, string, string, string)

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

参数

artifactType: string

sourceId: string

artifactVersionId: string

project: string

项目 ID 或项目名称

Promise<AutoTriggerIssue[]>

getDefinitionEnvironments(string, string, string[])

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

参数

project: string

项目 ID 或项目名称

taskGroupId: string

propertyFilters: string[]

Promise<DefinitionEnvironmentReference[]>

getDefinitionEnvironmentTemplate(string, string)

获取定义环境模板

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

参数

project: string

项目 ID 或项目名称

templateId: string

定义环境模板的 ID

Promise<ReleaseDefinitionEnvironmentTemplate>

getDefinitionRevision(string, number, number)

获取给定 definitionId 和修订版本的发布定义

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

参数

project: string

项目 ID 或项目名称

definitionId: number

定义的 ID。

revision: number

修订的 ID。

Promise<string>

getDefinitionTags(string, number)

获取定义的标记

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

参数

project: string

项目 ID 或项目名称

releaseDefinitionId: number

Promise<string[]>

getDeploymentBadge(string, number, number, string)

获取一个锁屏提醒，该锁屏提醒指示环境的最新部署的状态。

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

参数

projectId: string

项目的 ID。

releaseDefinitionId: number

发布定义的 ID。

environmentId: number

环境的 ID。

branchName: string

分支的名称。

Promise<string>

getDeployments(string, number, number, string, Date, Date, DeploymentStatus, DeploymentOperationStatus, boolean, ReleaseQueryOrder, number, number, string, Date, Date, string)

获取部署列表

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

参数

project: string

项目 ID 或项目名称

definitionId: number

列出给定定义 ID 的部署。

definitionEnvironmentId: number

列出给定定义环境 ID 的部署。

createdBy: string

列出为其创建部署的部署（指定标识）。

minModifiedTime: Date

列出 LastModified time >= minModifiedTime 的部署。

maxModifiedTime: Date

列出 LastModified time <= maxModifiedTime 的部署。

deploymentStatus: DeploymentStatus

列出具有给定部署状态的部署。默认值为“All”。

operationStatus: DeploymentOperationStatus

列出具有给定操作状态的部署。默认值为“All”。

latestAttemptsOnly: boolean

“true”，仅包含最新尝试的部署。默认值为“false”。

queryOrder: ReleaseQueryOrder

列出具有给定查询顺序的部署。默认值为“Descending”。

top: number

列出具有给定顶部的部署。默认顶部为“50”，最大顶部为“100”。

continuationToken: number

列出部署 ID >= continuationToken 的部署。

createdFor: string

列出为其请求部署的部署，以指定的标识。

minStartedTime: Date

列出 StartedOn time >= minStartedTime 的部署。

maxStartedTime: Date

列出 StartedOn time <= maxStartedTime 的部署。

sourceBranch: string

列出从给定分支名称部署的部署。

Promise<PagedList<Deployment>>

getDeploymentsForMultipleEnvironments(DeploymentQueryParameters, string)

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

参数

queryParameters: DeploymentQueryParameters

project: string

项目 ID 或项目名称

Promise<Deployment[]>

getFavorites(string, string, string)

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

参数

project: string

项目 ID 或项目名称

scope: string

identityId: string

Promise<FavoriteItem[]>

getFlightAssignments(string)

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

参数

flightName: string

Promise<string[]>

getFolders(string, string, FolderPathQueryOrder)

获取文件夹。

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

参数

project: string

项目 ID 或项目名称

path: string

文件夹的路径。

queryOrder: FolderPathQueryOrder

按定义的顺序获取结果。默认值为“None”。

Promise<Folder[]>

getGateLog(string, number, number, number, number)

获取门日志

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

参数

project: string

项目 ID 或项目名称

releaseId: number

版本的 ID。

environmentId: number

发布环境的 ID。

gateId: number

门的 ID。

taskId: number

日志的 ReleaseTask ID。

Promise<string>

getInputValues(InputValuesQuery, string)

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

参数

query: InputValuesQuery

project: string

项目 ID 或项目名称

Promise<InputValuesQuery>

getIssues(string, number, string)

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

参数

project: string

项目 ID 或项目名称

buildId: number

sourceId: string

Promise<AutoTriggerIssue[]>

getLog(string, number, number, number, number)

获取日志

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

参数

project: string

项目 ID 或项目名称

releaseId: number

版本的 ID。

environmentId: number

发布环境的 ID。

taskId: number

日志的 ReleaseTask ID。

attemptId: number

尝试的 ID。

Promise<string>

getLogs(string, number)

获取发布 ID 的日志。

function getLogs(project: string, releaseId: number): Promise<ArrayBuffer>

参数

project: string

项目 ID 或项目名称

releaseId: number

版本的 ID。

Promise<ArrayBuffer>

getManualIntervention(string, number, number)

获取给定版本的手动干预和手动干预 ID。

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

参数

project: string

项目 ID 或项目名称

releaseId: number

版本的 ID。

manualInterventionId: number

手动干预的 ID。

Promise<ManualIntervention>

getManualInterventions(string, number)

列出给定版本的所有手动干预。

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

参数

project: string

项目 ID 或项目名称

releaseId: number

版本的 ID。

Promise<ManualIntervention[]>

getMetrics(string, Date)

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

参数

project: string

项目 ID 或项目名称

minMetricsTime: Date

Promise<Metric[]>

getOrgPipelineReleaseSettings()

获取组织管道发布设置

function getOrgPipelineReleaseSettings(): Promise<OrgPipelineReleaseSettings>

Promise<OrgPipelineReleaseSettings>

getPipelineReleaseSettings(string)

获取管道发布设置

function getPipelineReleaseSettings(project: string): Promise<ProjectPipelineReleaseSettings>

参数

project: string

项目 ID 或项目名称

Promise<ProjectPipelineReleaseSettings>

getRelease(string, number, ApprovalFilters, string[], SingleReleaseExpands, number)

获取发布

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

参数

project: string

项目 ID 或项目名称

releaseId: number

版本的 ID。

approvalFilters: ApprovalFilters

一个筛选器，允许根据审批步骤是自动还是手动进行选择性地提取审批步骤。这也将决定是否应提取审批前和审批后快照。假定默认为 All

propertyFilters: string[]

要检索的扩展属性的逗号分隔列表。如果设置，则返回的 Release 将包含指定属性 ID 的值 (（如果它们存在于) ）。如果未设置，则不包括属性。

expand: SingleReleaseExpands

应在版本中扩展的属性。

topGateRecords: number

要获取的发布入口记录数。默认值为 5。

Promise<Release>

getReleaseChanges(string, number, number, number, string)

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

参数

project: string

项目 ID 或项目名称

releaseId: number

baseReleaseId: number

top: number

artifactAlias: string

Promise<Change[]>

getReleaseDefinition(string, number, string[])

获取发布定义。

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

参数

project: string

项目 ID 或项目名称

definitionId: number

发布定义的 ID。

propertyFilters: string[]

要检索的扩展属性的逗号分隔列表。如果设置，则返回的发布定义将包含指定属性 ID 的值 (（如果它们存在于) ）。如果未设置，则不包括属性。

Promise<ReleaseDefinition>

getReleaseDefinitionHistory(string, number)

获取发布定义的修订历史记录

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

参数

project: string

项目 ID 或项目名称

definitionId: number

定义的 ID。

Promise<ReleaseDefinitionRevision[]>

getReleaseDefinitionRevision(string, number, number)

获取给定修订版的发布定义。

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

参数

project: string

项目 ID 或项目名称

definitionId: number

发布定义的 ID。

revision: number

发布定义的修订号。

Promise<string>

getReleaseDefinitions(string, string, ReleaseDefinitionExpands, string, string, number, string, ReleaseDefinitionQueryOrder, string, boolean, string[], string[], string[], boolean, boolean)

获取发布定义列表。

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

参数

project: string

项目 ID 或项目名称

searchText: string

获取名称包含 searchText 的发布定义。

expand: ReleaseDefinitionExpands

应在发布定义列表中展开的属性。

artifactType: string

将返回具有给定 artifactType 的发布定义。值可以是 Build、Jenkins、GitHub、Nuget、Team Build (external) 、ExternalTFSBuild、Git、TFVC、ExternalTfsXamlBuild。

artifactSourceId: string

将返回具有给定 artifactSourceId 的发布定义。例如，对于生成，它将是 {projectGuid}：{BuildDefinitionId}，对于 Jenkins，它将是 {JenkinsConnectionId}：{JenkinsDefinitionId}，对于 TfsOnPrem，它将是 {TfsOnPremConnectionId}：{ProjectName}：{TfsOnPremDefinitionId}。对于第三方项目，例如 TeamCity、BitBucket，可以在 vss-extension.json 引用 https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions“uniqueSourceIdentifier”。

top: number

要获取的发布定义数。

continuationToken: string

获取提供延续标记后的发布定义。

queryOrder: ReleaseDefinitionQueryOrder

按定义的顺序获取结果。默认值为“IdAscending”。

path: string

获取指定路径下的发布定义。

isExactNameMatch: boolean

“true”获取与 searchText 中指定的完全匹配的发布定义。默认值为“false”。

tagFilter: string[]

以逗号分隔的标记列表。仅返回具有这些标记的版本定义。

propertyFilters: string[]

要检索的扩展属性的逗号分隔列表。如果设置，则返回的发布定义将包含指定属性 ID 的值 (（如果它们存在于) ）。如果未设置，则不包含属性。请注意，这不会从结果中筛选出任何发布定义，无论它是否设置了属性。

definitionIdFilter: string[]

要检索的以逗号分隔的发布定义列表。

isDeleted: boolean

“true”用于获取已删除的发布定义。默认值为“false”

searchTextContainsFolderName: boolean

“true”用于获取名称为 searchText 中指定的文件夹下的发布定义。默认值为“false”。

Promise<PagedList<ReleaseDefinition>>

getReleaseDefinitionSummary(string, number, number, boolean, number[])

获取给定定义 ID 的发布摘要。

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

参数

project: string

项目 ID 或项目名称

definitionId: number

要获取发布摘要的定义 ID。

releaseCount: number

要包含在摘要中的版本计数。

includeArtifact: boolean

包括项目详细信息。默认值为“false”。

definitionEnvironmentIdsFilter: number[]

Promise<ReleaseDefinitionSummary>

getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)

获取发布环境。

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

参数

project: string

项目 ID 或项目名称

releaseId: number

版本的 ID。

environmentId: number

发布环境的 ID。

expand: ReleaseEnvironmentExpands

应在环境中展开的属性。

Promise<ReleaseEnvironment>

getReleaseHistory(string, number)

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

参数

project: string

项目 ID 或项目名称

releaseId: number

Promise<ReleaseRevision[]>

getReleaseProjects(string, string)

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

参数

artifactType: string

artifactSourceId: string

Promise<ProjectReference[]>

getReleaseRevision(string, number, number)

获取给定修订号的发布。

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

参数

project: string

项目 ID 或项目名称

releaseId: number

版本的 ID。

definitionSnapshotRevision: number

定义快照修订号。

Promise<string>

getReleases(string, number, number, string, string, ReleaseStatus, number, Date, Date, ReleaseQueryOrder, number, number, ReleaseExpands, string, string, string, string, boolean, string[], string[], number[], string)

获取发布列表

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

参数

project: string

项目 ID 或项目名称

definitionId: number

此发布定义 ID 中的版本。

definitionEnvironmentId: number

searchText: string

名称包含 searchText 的版本。

createdBy: string

此用户创建的版本。

statusFilter: ReleaseStatus

具有此状态的版本。

environmentStatusFilter: number

minCreatedTime: Date

在此时间之后创建的版本。

maxCreatedTime: Date

在此时间之前创建的发布。

queryOrder: ReleaseQueryOrder

获取版本创建日期的已定义顺序的结果。默认值为降序。

top: number

要获取的版本数。默认值为 50。

continuationToken: number

获取提供的继续标记之后的版本。

expand: ReleaseExpands

应在发布列表中展开的属性。

artifactTypeId: string

将返回具有给定 artifactTypeId 的版本。值可以是 Build、Jenkins、GitHub、Nuget、Team Build (external) 、ExternalTFSBuild、Git、TFVC、ExternalTfsXamlBuild。

sourceId: string

所用项目的唯一标识符。例如，对于生成，它将是 {projectGuid}：{BuildDefinitionId}，对于 Jenkins，它将是 {JenkinsConnectionId}：{JenkinsDefinitionId}，对于 TfsOnPrem，它将是 {TfsOnPremConnectionId}：{ProjectName}：{TfsOnPremDefinitionId}。对于第三方项目，例如 TeamCity、BitBucket，可以引用vss-extension.json https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions中的“uniqueSourceIdentifier”。

artifactVersionId: string

将返回具有给定 artifactVersionId 的版本。例如，在生成 artifactType 的情况下，它是 buildId。

sourceBranchFilter: string

将返回具有给定 sourceBranchFilter 的版本。

isDeleted: boolean

获取软删除的版本（如果为 true）。

tagFilter: string[]

以逗号分隔的标记列表。仅返回具有这些标记的版本。

propertyFilters: string[]

要检索的扩展属性的逗号分隔列表。如果设置，则返回的 Releases 将包含指定属性 ID 的值 (（如果它们存在) ）。如果未设置，则不包含属性。请注意，这不会从结果中筛选出任何 Release，无论它是否设置了属性。

releaseIdFilter: number[]

以逗号分隔的版本 ID 列表。仅返回具有这些 ID 的版本。

path: string

将返回此文件夹路径下的版本

Promise<PagedList<Release>>

getReleaseSettings(string)

获取发布设置

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

参数

project: string

项目 ID 或项目名称

Promise<ReleaseSettings>

getReleaseTags(string, number)

获取发布的标记

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

参数

project: string

项目 ID 或项目名称

releaseId: number

Promise<string[]>

getReleaseTaskAttachmentContent(string, number, number, number, string, string, string, string, string)

获取发布任务附件。

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

参数

project: string

项目 ID 或项目名称

releaseId: number

版本的 ID。

environmentId: number

发布环境的 ID。

attemptId: number

部署尝试次数。

planId: string

部署阶段的计划 ID。

timelineId: string

任务的时间线 ID。

recordId: string

附件的记录 ID。

type: string

附件的类型。

name: string

附件的名称。

Promise<ArrayBuffer>

getReleaseTaskAttachments(string, number, number, number, string, string)

获取发布任务附件。

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

参数

project: string

项目 ID 或项目名称

releaseId: number

版本的 ID。

environmentId: number

发布环境的 ID。

attemptId: number

部署尝试次数。

planId: string

部署阶段的计划 ID。

type: string

附件的类型。

Promise<ReleaseTaskAttachment[]>

getReleaseWorkItemsRefs(string, number, number, number, string)

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

参数

project: string

项目 ID 或项目名称

releaseId: number

baseReleaseId: number

top: number

artifactAlias: string

Promise<ReleaseWorkItemRef[]>

getSourceBranches(string, number)

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

参数

project: string

项目 ID 或项目名称

definitionId: number

Promise<string[]>

getSummaryMailSections(string, number)

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

参数

project: string

项目 ID 或项目名称

releaseId: number

Promise<SummaryMailSection[]>

getTags(string)

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

参数

project: string

项目 ID 或项目名称

Promise<string[]>

getTaskAttachmentContent(string, number, number, number, string, string, string, string)

获取任务附件。

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

参数

project: string

项目 ID 或项目名称

releaseId: number

版本的 ID。

environmentId: number

发布环境的 ID。

attemptId: number

部署尝试次数。

timelineId: string

任务的时间线 ID。

recordId: string

附件的记录 ID。

type: string

附件的类型。

name: string

附件的名称。

Promise<ArrayBuffer>

getTaskAttachments(string, number, number, number, string, string)

获取任务附件。

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

参数

project: string

项目 ID 或项目名称

releaseId: number

版本的 ID。

environmentId: number

发布环境的 ID。

attemptId: number

部署尝试次数。

timelineId: string

任务的时间线 ID。

type: string

附件的类型。

Promise<ReleaseTaskAttachment[]>

getTaskLog(string, number, number, number, number, number, number)

获取以纯文本文件形式发布的任务日志。

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

参数

project: string

项目 ID 或项目名称

releaseId: number

版本的 ID。

environmentId: number

发布环境的 ID。

releaseDeployPhaseId: number

发布部署阶段 ID。

taskId: number

发布日志的Task ID。

startLine: number

日志的起始行号

endLine: number

日志的结束行号

Promise<string>

getTaskLog2(string, number, number, number, string, number, number, number)

获取以纯文本文件形式发布的任务日志。

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

参数

project: string

项目 ID 或项目名称

releaseId: number

版本的 ID。

environmentId: number

发布环境的 ID。

attemptId: number

timelineId: string

taskId: number

发布日志的Task ID。

startLine: number

日志的起始行号

endLine: number

日志的结束行号

Promise<string>

getTasks(string, number, number, number)

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

参数

project: string

项目 ID 或项目名称

releaseId: number

environmentId: number

attemptId: number

Promise<ReleaseTask[]>

getTasks2(string, number, number, number, string)

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

参数

project: string

项目 ID 或项目名称

releaseId: number

environmentId: number

attemptId: number

timelineId: string

Promise<ReleaseTask[]>

getTasksForTaskGroup(string, number, number, number)

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

参数

project: string

项目 ID 或项目名称

releaseId: number

environmentId: number

releaseDeployPhaseId: number

Promise<ReleaseTask[]>

listDefinitionEnvironmentTemplates(string, boolean)

获取定义环境模板的列表

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

参数

project: string

项目 ID 或项目名称

isDeleted: boolean

“true”用于获取已删除的定义环境模板。默认值为“false”

Promise<ReleaseDefinitionEnvironmentTemplate[]>

sendSummaryMail(MailMessage, string, number)

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

参数

mailMessage: MailMessage

project: string

项目 ID 或项目名称

releaseId: number

Promise<void>

undeleteRelease(string, number, string)

取消删除软删除的版本。

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

参数

project: string

项目 ID 或项目名称

releaseId: number

要取消删除的版本 ID。

comment: string

取消删除的任何注释。

Promise<void>

undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)

取消删除发布定义。

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

参数

releaseDefinitionUndeleteParameter: ReleaseDefinitionUndeleteParameter

取消删除发布定义的对象。

project: string

项目 ID 或项目名称

definitionId: number

要取消删除的发布定义的 ID

Promise<ReleaseDefinition>

undeleteReleaseDefinitionEnvironmentTemplate(string, string)

取消删除发布定义环境模板。

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

参数

project: string

项目 ID 或项目名称

templateId: string

要取消删除的定义环境模板的 ID

Promise<ReleaseDefinitionEnvironmentTemplate>

updateFolder(Folder, string, string)

汇报给定现有路径中的现有文件夹。

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

参数

folder: Folder

文件夹。

project: string

项目 ID 或项目名称

path: string

要更新的文件夹的路径。

Promise<Folder>

updateGates(GateUpdateMetadata, string, number)

汇报部署的入口。

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

参数

gateUpdateMetadata: GateUpdateMetadata

用于修补发布入口的元数据。

project: string

项目 ID 或项目名称

gateStepId: number

门步骤 ID。

Promise<ReleaseGates>

updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)

更新手动干预。

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

参数

manualInterventionUpdateMetadata: ManualInterventionUpdateMetadata

用于更新手动干预的元数据。

project: string

项目 ID 或项目名称

releaseId: number

版本的 ID。

manualInterventionId: number

手动干预的 ID。

Promise<ManualIntervention>

updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)

汇报组织管道发布设置

function updateOrgPipelineReleaseSettings(newSettings: OrgPipelineReleaseSettingsUpdateParameters): Promise<OrgPipelineReleaseSettings>

参数

newSettings: OrgPipelineReleaseSettingsUpdateParameters

Promise<OrgPipelineReleaseSettings>

updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)

汇报管道发布设置

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

参数

newSettings: ProjectPipelineReleaseSettingsUpdateParameters

project: string

项目 ID 或项目名称

Promise<ProjectPipelineReleaseSettings>

updateRelease(Release, string, number)

更新完整的发布对象。

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

参数

release: Release

要更新的 Release 对象。

project: string

项目 ID 或项目名称

releaseId: number

要更新的版本 ID。

Promise<Release>

updateReleaseApproval(ReleaseApproval, string, number)

更新审批状态

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

参数

approval: ReleaseApproval

具有状态、审批者和注释的 ReleaseApproval 对象。

project: string

项目 ID 或项目名称

approvalId: number

审批的 ID。

Promise<ReleaseApproval>

updateReleaseApprovals(ReleaseApproval[], string)

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

参数

approvals: ReleaseApproval[]

project: string

项目 ID 或项目名称

Promise<ReleaseApproval[]>

updateReleaseDefinition(ReleaseDefinition, string)

更新发布定义。

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

参数

releaseDefinition: ReleaseDefinition

要更新的发布定义对象。

project: string

项目 ID 或项目名称

Promise<ReleaseDefinition>

updateReleaseEnvironment(ReleaseEnvironmentUpdateMetadata, string, number, number)

更新发布环境的状态

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

参数

environmentUpdateData: ReleaseEnvironmentUpdateMetadata

环境更新元数据。

project: string

项目 ID 或项目名称

releaseId: number

版本的 ID。

environmentId: number

发布环境的 ID。

Promise<ReleaseEnvironment>

updateReleaseResource(ReleaseUpdateMetadata, string, number)

更新版本的一些属性。

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

参数

releaseUpdateMetadata: ReleaseUpdateMetadata

要更新的版本的属性。

project: string

项目 ID 或项目名称

releaseId: number

要更新的版本 ID。

Promise<Release>

updateReleaseSettings(ReleaseSettings, string)

汇报发布设置

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

参数

releaseSettings: ReleaseSettings

project: string

项目 ID 或项目名称

Promise<ReleaseSettings>