ReleaseRestClient class

new ReleaseRestClient(options: IVssRestClientOptions)

参数

static RESOURCE_AREA_ID: string

属性值

将标记添加到定义

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

参数

返回

将多个标记添加到定义

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

参数

返回

将标记添加到 releaseId

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

参数

返回

将标记添加到发布

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

参数

返回

创建定义环境模板

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

参数

返回

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

参数

返回

创建新文件夹。

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

参数

返回

创建发布。

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

参数

返回

创建发布定义

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

参数

返回

删除定义环境模板

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

参数

返回

从定义中删除标记

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

参数

返回

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

参数

返回

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

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

参数

返回

软删除发布

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

参数

返回

删除发布定义。

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

参数

返回

从发布中删除标记

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

参数

返回

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

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

参数

返回

获取审批。

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

参数

返回

获取审批历史记录。

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

参数

返回

获取审批列表

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

参数

返回

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

参数

返回

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

参数

返回

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

参数

返回

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

参数

返回

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

参数

返回

获取定义环境模板

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

参数

返回

获取给定 definitionId 和 revision 的发布定义

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

参数

返回

获取定义的标记

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

参数

返回

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

function getDeploymentBadge(projectId: string, releaseDefinitionId: number, environmentId: number, branchName?: string): Promise<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>>

参数

返回

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

参数

返回

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

参数

返回

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

参数

返回

获取文件夹。

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

参数

返回

获取门日志

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

参数

返回

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

参数

返回

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

参数

返回

获取日志

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

参数

返回

获取发布 ID 的日志。

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

参数

返回

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

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

参数

返回

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

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

参数

返回

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

参数

返回

获取组织管道发布设置

function getOrgPipelineReleaseSettings(): Promise<OrgPipelineReleaseSettings>

返回

获取管道发布设置

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

参数

返回

获取发布

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

参数

返回

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

参数

返回

获取发布定义。

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

参数

返回

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

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

参数

返回

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

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

参数

返回

获取发布定义列表。

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

参数

返回

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

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

参数

返回

获取发布环境。

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

参数

返回

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

参数

返回

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

参数

返回

获取给定修订号的发布。

function getReleaseRevision(project: string, releaseId: number, definitionSnapshotRevision: number): Promise<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<Release[]>

参数

返回

获取发布设置

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

参数

返回

获取发布的标记

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

参数

返回

获取发布任务附件。

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

参数

返回

获取发布任务附件。

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

参数

返回

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

参数

返回

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

参数

返回

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

参数

返回

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

参数

返回

获取任务附件。

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

参数

返回

获取任务附件。

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

参数

返回

获取作为纯文本文件发布的任务日志。

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

参数

返回

获取作为纯文本文件发布的任务日志。

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

参数

返回

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

参数

返回

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

参数

返回

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

参数

返回

获取定义环境模板的列表

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

参数

返回

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

参数

返回

取消删除软删除的版本。

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

参数

返回

取消删除发布定义。

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

参数

返回

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

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

参数

返回

更新给定现有路径处的现有文件夹。

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

参数

返回

更新部署的入口。

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

参数

返回

更新手动干预。

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

参数

返回

更新组织管道发布设置

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

参数

返回

更新管道发布设置

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

参数

返回

更新完整的发布对象。

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

参数

返回

更新审批状态

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

参数

返回

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

参数

返回

更新发布定义。

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

参数

返回

更新发布环境的状态

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

参数

返回

更新发布的几个属性。

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

参数

返回

更新发布设置

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

参数

返回