BuildRestClient class
应使用 (派生自) 的基类向 VSS REST API 发出请求
- Extends
构造函数
| Build |
属性
| RESOURCE_AREA_ID |
方法
构造函数详细信息
BuildRestClient(IVssRestClientOptions)
属性详细信息
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: string属性值
string
方法详细信息
addBuildTag(string, number, string)
将标记添加到生成。
function addBuildTag(project: string, buildId: number, tag: string): Promise<string[]>参数
- project
-
string
项目 ID 或项目名称
- buildId
-
number
生成的 ID。
- tag
-
string
要添加的标记。
返回
Promise<string[]>
addBuildTags(string[], string, number)
将标记添加到生成。
function addBuildTags(tags: string[], project: string, buildId: number): Promise<string[]>参数
- tags
-
string[]
要添加的标记。 请求正文直接由列出的标记组成。
- project
-
string
项目 ID 或项目名称
- buildId
-
number
生成的 ID。
返回
Promise<string[]>
addDefinitionTag(string, number, string)
将标记添加到定义
function addDefinitionTag(project: string, definitionId: number, tag: string): Promise<string[]>参数
- project
-
string
项目 ID 或项目名称
- definitionId
-
number
定义的 ID。
- tag
-
string
要添加的标记。
返回
Promise<string[]>
addDefinitionTags(string[], string, number)
向定义添加多个标记。
function addDefinitionTags(tags: string[], project: string, definitionId: number): Promise<string[]>参数
- tags
-
string[]
要添加的标记。
- project
-
string
项目 ID 或项目名称
- definitionId
-
number
定义的 ID。
返回
Promise<string[]>
addRetentionLeases(NewRetentionLease[], string)
为管道运行添加新租约。
function addRetentionLeases(newLeases: NewRetentionLease[], project: string): Promise<RetentionLease[]>参数
- newLeases
- project
-
string
项目 ID 或项目名称
返回
Promise<RetentionLease[]>
authorizeDefinitionResources(DefinitionResourceReference[], string, number)
function authorizeDefinitionResources(resources: DefinitionResourceReference[], project: string, definitionId: number): Promise<DefinitionResourceReference[]>参数
- resources
- project
-
string
项目 ID 或项目名称
- definitionId
-
number
返回
Promise<DefinitionResourceReference[]>
authorizeProjectResources(DefinitionResourceReference[], string)
function authorizeProjectResources(resources: DefinitionResourceReference[], project: string): Promise<DefinitionResourceReference[]>参数
- resources
- project
-
string
项目 ID 或项目名称
返回
Promise<DefinitionResourceReference[]>
createArtifact(BuildArtifact, string, number)
将项目与生成关联。
function createArtifact(artifact: BuildArtifact, project: string, buildId: number): Promise<BuildArtifact>参数
- artifact
- BuildArtifact
项目。
- project
-
string
项目 ID 或项目名称
- buildId
-
number
生成的 ID。
返回
Promise<BuildArtifact>
createDefinition(BuildDefinition, string, number, number)
创建新定义。
function createDefinition(definition: BuildDefinition, project: string, definitionToCloneId?: number, definitionToCloneRevision?: number): Promise<BuildDefinition>参数
- definition
- BuildDefinition
定义。
- project
-
string
项目 ID 或项目名称
- definitionToCloneId
-
number
- definitionToCloneRevision
-
number
返回
Promise<BuildDefinition>
createFolder(Folder, string, string)
创建新文件夹。
function createFolder(folder: Folder, project: string, path: string): Promise<Folder>参数
- folder
- Folder
文件夹。
- project
-
string
项目 ID 或项目名称
- path
-
string
文件夹的完整路径。
返回
Promise<Folder>
deleteBuild(string, number)
删除生成。
function deleteBuild(project: string, buildId: number): Promise<void>参数
- project
-
string
项目 ID 或项目名称
- buildId
-
number
生成的 ID。
返回
Promise<void>
deleteBuildTag(string, number, string)
从生成中删除标记。 注意：此 API 不适用于具有特殊字符的标记。 若要删除具有特殊字符的标记，请改用 PATCH 方法在 6.0+ ()
function deleteBuildTag(project: string, buildId: number, tag: string): Promise<string[]>参数
- project
-
string
项目 ID 或项目名称
- buildId
-
number
生成的 ID。
- tag
-
string
要删除的标记。
返回
Promise<string[]>
deleteDefinition(string, number)
删除定义和所有关联的生成。
function deleteDefinition(project: string, definitionId: number): Promise<void>参数
- project
-
string
项目 ID 或项目名称
- definitionId
-
number
定义的 ID。
返回
Promise<void>
deleteDefinitionTag(string, number, string)
从定义中删除标记。 注意：此 API 不适用于具有特殊字符的标记。 若要删除具有特殊字符的标记，请改用 PATCH 方法在 6.0+ ()
function deleteDefinitionTag(project: string, definitionId: number, tag: string): Promise<string[]>参数
- project
-
string
项目 ID 或项目名称
- definitionId
-
number
定义的 ID。
- tag
-
string
要删除的标记。
返回
Promise<string[]>
deleteFolder(string, string)
删除定义文件夹。 定义及其相应的生成也将被删除。
function deleteFolder(project: string, path: string): Promise<void>参数
- project
-
string
项目 ID 或项目名称
- path
-
string
文件夹的完整路径。
返回
Promise<void>
deleteRetentionLeasesById(string, number[])
删除特定的保留租约。
function deleteRetentionLeasesById(project: string, ids: number[]): Promise<void>参数
- project
-
string
项目 ID 或项目名称
- ids
-
number[]
返回
Promise<void>
deleteTag(string, string)
从生成、定义和标记存储中删除标记
function deleteTag(project: string, tag: string): Promise<string[]>参数
- project
-
string
项目 ID 或项目名称
- tag
-
string
要删除的标记。
返回
Promise<string[]>
deleteTemplate(string, string)
删除生成定义模板。
function deleteTemplate(project: string, templateId: string): Promise<void>参数
- project
-
string
项目 ID 或项目名称
- templateId
-
string
模板的 ID。
返回
Promise<void>
getArtifact(string, number, string)
获取生成的特定项目。
function getArtifact(project: string, buildId: number, artifactName: string): Promise<BuildArtifact>参数
- project
-
string
项目 ID 或项目名称
- buildId
-
number
生成的 ID。
- artifactName
-
string
项目的名称。
返回
Promise<BuildArtifact>
getArtifactContentZip(string, number, string)
获取生成的特定项目。
function getArtifactContentZip(project: string, buildId: number, artifactName: string): Promise<ArrayBuffer>参数
- project
-
string
项目 ID 或项目名称
- buildId
-
number
生成的 ID。
- artifactName
-
string
项目的名称。
返回
Promise<ArrayBuffer>
getArtifacts(string, number)
获取生成的所有项目。
function getArtifacts(project: string, buildId: number): Promise<BuildArtifact[]>参数
- project
-
string
项目 ID 或项目名称
- buildId
-
number
生成的 ID。
返回
Promise<BuildArtifact[]>
getAttachment(string, number, string, string, string, string)
获取特定的附件。
function getAttachment(project: string, buildId: number, timelineId: string, recordId: string, type: string, name: string): Promise<ArrayBuffer>参数
- project
-
string
项目 ID 或项目名称
- buildId
-
number
生成的 ID。
- timelineId
-
string
时间线的 ID。
- recordId
-
string
时间线记录的 ID。
- type
-
string
附件的类型。
- name
-
string
附件的名称。
返回
Promise<ArrayBuffer>
getAttachments(string, number, string)
获取与生成关联的特定类型的附件列表。
function getAttachments(project: string, buildId: number, type: string): Promise<Attachment[]>参数
- project
-
string
项目 ID 或项目名称
- buildId
-
number
生成的 ID。
- type
-
string
附件的类型。
返回
Promise<Attachment[]>
getBadge(string, number, string)
获取一个锁屏提醒，该锁屏提醒指示定义的最新版本的状态。 请注意，此 API 已弃用。 首选 StatusBadgeController.GetStatusBadge。
function getBadge(project: string, definitionId: number, branchName?: string): Promise<string>参数
- project
-
string
项目 ID 或名称。
- definitionId
-
number
定义的 ID。
- branchName
-
string
分支的名称。
返回
Promise<string>
getBuild(string, number, string)
获取生成
function getBuild(project: string, buildId: number, propertyFilters?: string): Promise<Build>参数
- project
-
string
项目 ID 或项目名称
- buildId
-
number
- propertyFilters
-
string
返回
Promise<Build>
getBuildBadge(string, string, string, string)
获取一个锁屏提醒，该锁屏提醒指示指定分支的最新版本的状态。
function getBuildBadge(project: string, repoType: string, repoId?: string, branchName?: string): Promise<BuildBadge>参数
- project
-
string
项目 ID 或项目名称
- repoType
-
string
存储库类型。
- repoId
-
string
存储库 ID。
- branchName
-
string
分支名称。
返回
Promise<BuildBadge>
getBuildBadgeData(string, string, string, string)
获取一个锁屏提醒，该锁屏提醒指示指定分支的最新版本的状态。
function getBuildBadgeData(project: string, repoType: string, repoId?: string, branchName?: string): Promise<string>参数
- project
-
string
项目 ID 或项目名称
- repoType
-
string
存储库类型。
- repoId
-
string
存储库 ID。
- branchName
-
string
分支名称。
返回
Promise<string>
getBuildChanges(string, number, string, number, boolean)
获取与生成关联的更改
function getBuildChanges(project: string, buildId: number, continuationToken?: string, top?: number, includeSourceChange?: boolean): Promise<PagedList<Change>>参数
- project
-
string
项目 ID 或项目名称
- buildId
-
number
- continuationToken
-
string
- top
-
number
要返回的最大更改数
- includeSourceChange
-
boolean
返回
getBuildController(number)
获取控制器
function getBuildController(controllerId: number): Promise<BuildController>参数
- controllerId
-
number
返回
Promise<BuildController>
getBuildControllers(string)
获取控制器，可以选择按名称筛选
function getBuildControllers(name?: string): Promise<BuildController[]>参数
- name
-
string
返回
Promise<BuildController[]>
getBuildGeneralSettings(string)
获取管道常规设置。
function getBuildGeneralSettings(project: string): Promise<PipelineGeneralSettings>参数
- project
-
string
项目 ID 或项目名称
返回
Promise<PipelineGeneralSettings>
getBuildLog(string, number, number, number, number)
获取生成的单个日志文件。
function getBuildLog(project: string, buildId: number, logId: number, startLine?: number, endLine?: number): Promise<string>参数
- project
-
string
项目 ID 或项目名称
- buildId
-
number
生成的 ID。
- logId
-
number
日志文件的 ID。
- startLine
-
number
起始行。
- endLine
-
number
末行。
返回
Promise<string>
getBuildLogLines(string, number, number, number, number)
获取生成的单个日志文件。
function getBuildLogLines(project: string, buildId: number, logId: number, startLine?: number, endLine?: number): Promise<string[]>参数
- project
-
string
项目 ID 或项目名称
- buildId
-
number
生成的 ID。
- logId
-
number
日志文件的 ID。
- startLine
-
number
起始行。
- endLine
-
number
末行。
返回
Promise<string[]>
getBuildLogs(string, number)
获取生成的日志。
function getBuildLogs(project: string, buildId: number): Promise<BuildLog[]>参数
- project
-
string
项目 ID 或项目名称
- buildId
-
number
生成的 ID。
返回
Promise<BuildLog[]>
getBuildLogsZip(string, number)
获取生成的日志。
function getBuildLogsZip(project: string, buildId: number): Promise<ArrayBuffer>参数
- project
-
string
项目 ID 或项目名称
- buildId
-
number
生成的 ID。
返回
Promise<ArrayBuffer>
getBuildLogZip(string, number, number, number, number)
获取生成的单个日志文件。
function getBuildLogZip(project: string, buildId: number, logId: number, startLine?: number, endLine?: number): Promise<ArrayBuffer>参数
- project
-
string
项目 ID 或项目名称
- buildId
-
number
生成的 ID。
- logId
-
number
日志文件的 ID。
- startLine
-
number
起始行。
- endLine
-
number
末行。
返回
Promise<ArrayBuffer>
getBuildOptionDefinitions(string)
获取系统支持的所有生成定义选项。
function getBuildOptionDefinitions(project?: string): Promise<BuildOptionDefinition[]>参数
- project
-
string
项目 ID 或项目名称
返回
Promise<BuildOptionDefinition[]>
getBuildProperties(string, number, string[])
获取生成的属性。
function getBuildProperties(project: string, buildId: number, filter?: string[]): Promise<any>参数
- project
-
string
项目 ID 或项目名称
- buildId
-
number
生成的 ID。
- filter
-
string[]
以逗号分隔的属性列表。 如果已指定，则筛选到这些特定属性。
返回
Promise<any>
getBuildReport(string, number, string)
获取生成报表。
function getBuildReport(project: string, buildId: number, type?: string): Promise<BuildReportMetadata>参数
- project
-
string
项目 ID 或项目名称
- buildId
-
number
生成的 ID。
- type
-
string
返回
Promise<BuildReportMetadata>
getBuildReportHtmlContent(string, number, string)
获取生成报表。
function getBuildReportHtmlContent(project: string, buildId: number, type?: string): Promise<any>参数
- project
-
string
项目 ID 或项目名称
- buildId
-
number
生成的 ID。
- type
-
string
返回
Promise<any>
getBuilds(string, number[], number[], string, Date, Date, string, BuildReason, BuildStatus, BuildResult, string[], string[], number, string, number, QueryDeletedOption, BuildQueryOrder, string, number[], string, string)
获取生成列表。
function getBuilds(project: string, definitions?: number[], queues?: number[], buildNumber?: string, minTime?: Date, maxTime?: Date, requestedFor?: string, reasonFilter?: BuildReason, statusFilter?: BuildStatus, resultFilter?: BuildResult, tagFilters?: string[], properties?: string[], top?: number, continuationToken?: string, maxBuildsPerDefinition?: number, deletedFilter?: QueryDeletedOption, queryOrder?: BuildQueryOrder, branchName?: string, buildIds?: number[], repositoryId?: string, repositoryType?: string): Promise<PagedList<Build>>参数
- project
-
string
项目 ID 或项目名称
- definitions
-
number[]
以逗号分隔的定义 ID 列表。 如果指定，则筛选这些定义的生成。
- queues
-
number[]
以逗号分隔的队列 ID 列表。 如果指定，则筛选针对这些队列运行的生成。
- buildNumber
-
string
如果指定，则筛选到与此内部版本号匹配的生成。 追加 * 以执行前缀搜索。
- minTime
-
Date
如果指定，则根据指定的 queryOrder 筛选到在此日期之后完成/启动/排队的生成。
- maxTime
-
Date
如果指定，则根据指定的 queryOrder 筛选到在此日期之前完成/启动/排队的生成。
- requestedFor
-
string
如果指定，则筛选为指定用户请求的生成。
- reasonFilter
- BuildReason
如果指定，将筛选为与此原因匹配的生成。
- statusFilter
- BuildStatus
如果指定，则筛选到与此状态匹配的生成。
- resultFilter
- BuildResult
如果指定，将筛选到与此结果匹配的生成。
- tagFilters
-
string[]
以逗号分隔的标记列表。 如果指定，将筛选为具有指定标记的生成。
- properties
-
string[]
要检索的属性的逗号分隔列表。
- top
-
number
要返回的最大生成数。
- continuationToken
-
string
上一次调用此方法返回的延续标记，可用于返回下一组生成。
- maxBuildsPerDefinition
-
number
每个定义要返回的最大生成数。
- deletedFilter
- QueryDeletedOption
指示是排除、包含还是仅返回已删除的生成。
- queryOrder
- BuildQueryOrder
应返回生成的顺序。
- branchName
-
string
如果指定，则筛选以生成生成此分支的生成分支。
- buildIds
-
number[]
一个逗号分隔的列表，指定要检索的生成的 ID。
- repositoryId
-
string
如果指定，则筛选从此存储库生成的生成。
- repositoryType
-
string
如果指定，将筛选为从此类型的存储库生成的生成。
返回
getBuildSettings(string)
获取生成设置。
function getBuildSettings(project?: string): Promise<BuildSettings>参数
- project
-
string
项目 ID 或项目名称
返回
Promise<BuildSettings>
getBuildTags(string, number)
获取生成的标记。
function getBuildTags(project: string, buildId: number): Promise<string[]>参数
- project
-
string
项目 ID 或项目名称
- buildId
-
number
生成的 ID。
返回
Promise<string[]>
getBuildTimeline(string, number, string, number, string)
获取生成的详细信息
function getBuildTimeline(project: string, buildId: number, timelineId?: string, changeId?: number, planId?: string): Promise<Timeline>参数
- project
-
string
项目 ID 或项目名称
- buildId
-
number
- timelineId
-
string
- changeId
-
number
- planId
-
string
返回
Promise<Timeline>
getBuildWorkItemsRefs(string, number, number)
获取与生成关联的工作项。 仅返回同一项目中的工作项。
function getBuildWorkItemsRefs(project: string, buildId: number, top?: number): Promise<ResourceRef[]>参数
- project
-
string
项目 ID 或项目名称
- buildId
-
number
生成的 ID。
- top
-
number
要返回的最大工作项数。
返回
Promise<ResourceRef[]>
getBuildWorkItemsRefsFromCommits(string[], string, number, number)
获取与生成关联的工作项，并筛选为特定的提交。
function getBuildWorkItemsRefsFromCommits(commitIds: string[], project: string, buildId: number, top?: number): Promise<ResourceRef[]>参数
- commitIds
-
string[]
以逗号分隔的提交 ID 列表。
- project
-
string
项目 ID 或项目名称
- buildId
-
number
生成的 ID。
- top
-
number
要返回的最大工作项数，如果未指定提交 ID，则为要考虑的提交数。
返回
Promise<ResourceRef[]>
getChangesBetweenBuilds(string, number, number, number)
获取两个给定生成之间对存储库所做的更改。
function getChangesBetweenBuilds(project: string, fromBuildId?: number, toBuildId?: number, top?: number): Promise<Change[]>参数
- project
-
string
项目 ID 或项目名称
- fromBuildId
-
number
第一个生成的 ID。
- toBuildId
-
number
上次生成的 ID。
- top
-
number
要返回的最大更改数。
返回
Promise<Change[]>
getDefinition(string, number, number, Date, string[], boolean)
获取定义（可选）在特定修订处。
function getDefinition(project: string, definitionId: number, revision?: number, minMetricsTime?: Date, propertyFilters?: string[], includeLatestBuilds?: boolean): Promise<BuildDefinition>参数
- project
-
string
项目 ID 或项目名称
- definitionId
-
number
定义的 ID。
- revision
-
number
要检索的修订号。 如果未指定此项，将返回最新版本。
- minMetricsTime
-
Date
如果指定，则指示应包含指标的日期。
- propertyFilters
-
string[]
要包含在结果中的属性的逗号分隔列表。
- includeLatestBuilds
-
boolean
返回
Promise<BuildDefinition>
getDefinitionMetrics(string, number, Date)
获取定义的生成指标。
function getDefinitionMetrics(project: string, definitionId: number, minMetricsTime?: Date): Promise<BuildMetric[]>参数
- project
-
string
项目 ID 或项目名称
- definitionId
-
number
定义的 ID。
- minMetricsTime
-
Date
计算指标的日期。
返回
Promise<BuildMetric[]>
getDefinitionProperties(string, number, string[])
获取定义的属性。
function getDefinitionProperties(project: string, definitionId: number, filter?: string[]): Promise<any>参数
- project
-
string
项目 ID 或项目名称
- definitionId
-
number
定义的 ID。
- filter
-
string[]
以逗号分隔的属性列表。 如果指定，则筛选这些特定属性。
返回
Promise<any>
getDefinitionResources(string, number)
function getDefinitionResources(project: string, definitionId: number): Promise<DefinitionResourceReference[]>参数
- project
-
string
项目 ID 或项目名称
- definitionId
-
number
返回
Promise<DefinitionResourceReference[]>
getDefinitionRevisions(string, number)
获取定义的所有修订。
function getDefinitionRevisions(project: string, definitionId: number): Promise<BuildDefinitionRevision[]>参数
- project
-
string
项目 ID 或项目名称
- definitionId
-
number
定义的 ID。
返回
Promise<BuildDefinitionRevision[]>
getDefinitions(string, string, string, string, DefinitionQueryOrder, number, string, Date, number[], string, Date, Date, boolean, boolean, string, number, string)
获取定义的列表。
function getDefinitions(project: string, name?: string, repositoryId?: string, repositoryType?: string, queryOrder?: DefinitionQueryOrder, top?: number, continuationToken?: string, minMetricsTime?: Date, definitionIds?: number[], path?: string, builtAfter?: Date, notBuiltAfter?: Date, includeAllProperties?: boolean, includeLatestBuilds?: boolean, taskIdFilter?: string, processType?: number, yamlFilename?: string): Promise<PagedList<BuildDefinitionReference>>参数
- project
-
string
项目 ID 或项目名称
- name
-
string
如果指定，则筛选名称与此模式匹配的定义。
- repositoryId
-
string
存储库 ID。 如果指定，则筛选使用此存储库的定义。
- repositoryType
-
string
如果指定，则筛选具有此类型的存储库的定义。
- queryOrder
- DefinitionQueryOrder
指示返回定义的顺序。
- top
-
number
要返回的最大定义数。
- continuationToken
-
string
上一次调用此方法返回的延续标记，可用于返回下一组定义。
- minMetricsTime
-
Date
如果指定，则指示应包含指标的日期。
- definitionIds
-
number[]
以逗号分隔的列表，指定要检索的定义 ID。
- path
-
string
如果指定，则筛选到此文件夹下的定义。
- builtAfter
-
Date
如果已指定，则筛选到在此日期之后具有生成的定义。
- notBuiltAfter
-
Date
如果指定，则筛选到在此日期之后没有生成的定义。
- includeAllProperties
-
boolean
指示是否应返回完整定义。 默认情况下，返回定义的浅表表示形式。
- includeLatestBuilds
-
boolean
指示是否返回此定义的最新和最新完成的生成。
- taskIdFilter
-
string
如果指定，则筛选到使用指定任务的定义。
- processType
-
number
如果指定，则筛选到具有给定进程类型的定义。
- yamlFilename
-
string
如果指定，则筛选到与给定文件名匹配的 YAML 定义。 若要使用此筛选器，应将 includeAllProperties 设置为 true
返回
Promise<PagedList<BuildDefinitionReference>>
getDefinitionTags(string, number, number)
获取定义的标记。
function getDefinitionTags(project: string, definitionId: number, revision?: number): Promise<string[]>参数
- project
-
string
项目 ID 或项目名称
- definitionId
-
number
定义的 ID。
- revision
-
number
定义修订号。 如果未指定，则使用定义的最新修订。
返回
Promise<string[]>
getDefinitionYaml(string, number, number, Date, string[], boolean)
将定义转换为 YAML（可选）在特定修订处。
function getDefinitionYaml(project: string, definitionId: number, revision?: number, minMetricsTime?: Date, propertyFilters?: string[], includeLatestBuilds?: boolean): Promise<YamlBuild>参数
- project
-
string
项目 ID 或项目名称
- definitionId
-
number
定义的 ID。
- revision
-
number
要检索的修订号。 如果未指定此项，将返回最新版本。
- minMetricsTime
-
Date
如果指定，则指示应包含指标的日期。
- propertyFilters
-
string[]
要包含在结果中的属性的逗号分隔列表。
- includeLatestBuilds
-
boolean
返回
Promise<YamlBuild>
getFile(string, number, string, string, string)
从生成中获取文件。
function getFile(project: string, buildId: number, artifactName: string, fileId: string, fileName: string): Promise<ArrayBuffer>参数
- project
-
string
项目 ID 或项目名称
- buildId
-
number
生成的 ID。
- artifactName
-
string
项目的名称。
- fileId
-
string
文件的主键。
- fileName
-
string
文件将设置为的名称。
返回
Promise<ArrayBuffer>
getFileContents(string, string, string, string, string, string)
获取给定源代码存储库中文件的内容。
function getFileContents(project: string, providerName: string, serviceEndpointId?: string, repository?: string, commitOrBranch?: string, path?: string): Promise<string>参数
- project
-
string
项目 ID 或项目名称
- providerName
-
string
源提供程序的名称。
- serviceEndpointId
-
string
如果指定，则为要查询的服务终结点的 ID。 只能省略不使用服务终结点的提供程序，例如 TFVC 或 TFGit。
- repository
-
string
如果指定，则为供应商特定的标识符或要获取分支的存储库的名称。 只能省略不支持多个存储库的提供程序。
- commitOrBranch
-
string
从中检索文件内容的提交或分支的标识符。
- path
-
string
要检索的文件的路径，相对于存储库的根目录。
返回
Promise<string>
getFolders(string, string, FolderQueryOrder)
获取生成定义文件夹的列表。
function getFolders(project: string, path?: string, queryOrder?: FolderQueryOrder): Promise<Folder[]>参数
- project
-
string
项目 ID 或项目名称
- path
-
string
要以 开头的路径。
- queryOrder
- FolderQueryOrder
文件夹的返回顺序。
返回
Promise<Folder[]>
getLatestBuild(string, string, string)
获取定义的最新内部版本，可以选择范围限定为特定分支。
function getLatestBuild(project: string, definition: string, branchName?: string): Promise<Build>参数
- project
-
string
项目 ID 或项目名称
- definition
-
string
具有可选前导文件夹路径的定义名称，或定义 ID
- branchName
-
string
可选参数，指示要使用的特定分支。 如果未指定，则使用默认分支。
返回
Promise<Build>
getPathContents(string, string, string, string, string, string)
获取给定源代码存储库中目录的内容。
function getPathContents(project: string, providerName: string, serviceEndpointId?: string, repository?: string, commitOrBranch?: string, path?: string): Promise<SourceRepositoryItem[]>参数
- project
-
string
项目 ID 或项目名称
- providerName
-
string
源提供程序的名称。
- serviceEndpointId
-
string
如果指定，则为要查询的服务终结点的 ID。 只能省略不使用服务终结点的提供程序，例如 TFVC 或 TFGit。
- repository
-
string
如果指定，则为供应商特定的标识符或要获取分支的存储库的名称。 只能省略不支持多个存储库的提供程序。
- commitOrBranch
-
string
从中检索文件内容的提交或分支的标识符。
- path
-
string
要列出的路径内容，相对于存储库的根目录。
返回
Promise<SourceRepositoryItem[]>
getProjectMetrics(string, string, Date)
获取项目的生成指标。
function getProjectMetrics(project: string, metricAggregationType?: string, minMetricsTime?: Date): Promise<BuildMetric[]>参数
- project
-
string
项目 ID 或项目名称
- metricAggregationType
-
string
要使用的聚合类型 (每小时、每日) 。
- minMetricsTime
-
Date
计算指标的日期。
返回
Promise<BuildMetric[]>
getProjectResources(string, string, string)
function getProjectResources(project: string, type?: string, id?: string): Promise<DefinitionResourceReference[]>参数
- project
-
string
项目 ID 或项目名称
- type
-
string
- id
-
string
返回
Promise<DefinitionResourceReference[]>
getPullRequest(string, string, string, string, string)
从源提供程序获取拉取请求 对象。
function getPullRequest(project: string, providerName: string, pullRequestId: string, repositoryId?: string, serviceEndpointId?: string): Promise<PullRequest>参数
- project
-
string
项目 ID 或项目名称
- providerName
-
string
源提供程序的名称。
- pullRequestId
-
string
拉取请求特定于供应商的 ID。
- repositoryId
-
string
特定于供应商的标识符或包含拉取请求的存储库的名称。
- serviceEndpointId
-
string
如果指定，则为要查询的服务终结点的 ID。 只能省略不使用服务终结点的提供程序，例如 TFVC 或 TFGit。
返回
Promise<PullRequest>
getResourceUsage()
获取有关系统中的生成资源的信息。
function getResourceUsage(): Promise<BuildResourceUsage>返回
Promise<BuildResourceUsage>
getRetentionHistory(number)
返回项目集合的保留历史记录。 这包括具有可能阻止保留作业清理的自定义保留规则的管道、具有保留类型的每个管道的运行、与集合拥有的具有保留类型的管道关联的文件，以及每个管道的文件数。
function getRetentionHistory(daysToLookback?: number): Promise<BuildRetentionHistory>参数
- daysToLookback
-
number
返回
Promise<BuildRetentionHistory>
getRetentionLease(string, number)
返回给定租约 ID 的保留租约的详细信息。
function getRetentionLease(project: string, leaseId: number): Promise<RetentionLease>参数
- project
-
string
项目 ID 或项目名称
- leaseId
-
number
返回
Promise<RetentionLease>
getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])
返回与指定的 MinimalRetentionLeases 匹配的任何租约
function getRetentionLeasesByMinimalRetentionLeases(project: string, leasesToFetch: MinimalRetentionLease[]): Promise<RetentionLease[]>参数
- project
-
string
项目 ID 或项目名称
- leasesToFetch
JSON 序列化的 MinimalRetentionLeases 列表（用“|”分隔）
返回
Promise<RetentionLease[]>
getRetentionLeasesByOwnerId(string, string, number, number)
返回指定实体拥有的任何租约，可以选择范围限定为单个管道定义并运行。
function getRetentionLeasesByOwnerId(project: string, ownerId?: string, definitionId?: number, runId?: number): Promise<RetentionLease[]>参数
- project
-
string
项目 ID 或项目名称
- ownerId
-
string
- definitionId
-
number
一个可选参数，用于将搜索限制为特定管道定义。
- runId
-
number
一个可选参数，用于将搜索限制为单个管道运行。 需要 definitionId。
返回
Promise<RetentionLease[]>
getRetentionLeasesByUserId(string, string, number, number)
返回指定用户拥有的任何租约，可以选择范围限定为单个管道定义并运行。
function getRetentionLeasesByUserId(project: string, userOwnerId: string, definitionId?: number, runId?: number): Promise<RetentionLease[]>参数
- project
-
string
项目 ID 或项目名称
- userOwnerId
-
string
要搜索的用户 ID。
- definitionId
-
number
一个可选参数，用于将搜索限制为特定管道定义。
- runId
-
number
一个可选参数，用于将搜索限制为单个管道运行。 需要 definitionId。
返回
Promise<RetentionLease[]>
getRetentionLeasesForBuild(string, number)
获取应用于特定生成的所有保留租约。
function getRetentionLeasesForBuild(project: string, buildId: number): Promise<RetentionLease[]>参数
- project
-
string
项目 ID 或项目名称
- buildId
-
number
生成的 ID。
返回
Promise<RetentionLease[]>
getRetentionSettings(string)
获取项目的保留设置。
function getRetentionSettings(project: string): Promise<ProjectRetentionSetting>参数
- project
-
string
项目 ID 或项目名称
返回
Promise<ProjectRetentionSetting>
getStatusBadge(string, string, string, string, string, string, string)
<p>获取定义的生成状态，可选择限定为特定的分支、阶段、作业和配置。</p><p>如果有多个，则在指定 jobName 时需要传入 stageName 值，如果传递配置参数，则相同的规则将应用于这两个值。</P>
function getStatusBadge(project: string, definition: string, branchName?: string, stageName?: string, jobName?: string, configuration?: string, label?: string): Promise<string>参数
- project
-
string
项目 ID 或项目名称
- definition
-
string
具有可选前导文件夹路径的定义名称或定义 ID。
- branchName
-
string
仅考虑此分支的最新版本。 如果未指定，则使用默认分支。
- stageName
-
string
在管道中使用此阶段来呈现状态。
- jobName
-
string
在管道的某个阶段使用此作业来呈现状态。
- configuration
-
string
使用此作业配置呈现状态
- label
-
string
替换锁屏提醒左侧的默认文本。
返回
Promise<string>
getTags(string)
获取项目中所有生成标记的列表。
function getTags(project: string): Promise<string[]>参数
- project
-
string
项目 ID 或项目名称
返回
Promise<string[]>
getTemplate(string, string)
获取特定的生成定义模板。
function getTemplate(project: string, templateId: string): Promise<BuildDefinitionTemplate>参数
- project
-
string
项目 ID 或项目名称
- templateId
-
string
请求的模板的 ID。
返回
Promise<BuildDefinitionTemplate>
getTemplates(string)
获取所有定义模板。
function getTemplates(project: string): Promise<BuildDefinitionTemplate[]>参数
- project
-
string
项目 ID 或项目名称
返回
Promise<BuildDefinitionTemplate[]>
getWorkItemsBetweenBuilds(string, number, number, number)
获取两个生成之间的所有工作项。
function getWorkItemsBetweenBuilds(project: string, fromBuildId: number, toBuildId: number, top?: number): Promise<ResourceRef[]>参数
- project
-
string
项目 ID 或项目名称
- fromBuildId
-
number
第一个生成的 ID。
- toBuildId
-
number
上次生成的 ID。
- top
-
number
要返回的最大工作项数。
返回
Promise<ResourceRef[]>
listBranches(string, string, string, string, string)
获取给定源代码存储库的分支列表。
function listBranches(project: string, providerName: string, serviceEndpointId?: string, repository?: string, branchName?: string): Promise<string[]>参数
- project
-
string
项目 ID 或项目名称
- providerName
-
string
源提供程序的名称。
- serviceEndpointId
-
string
如果指定，则为要查询的服务终结点的 ID。 只能省略不使用服务终结点的提供程序，例如 TFVC 或 TFGit。
- repository
-
string
要获取分支的特定于供应商的标识符或存储库的名称。 只能省略不支持多个存储库的提供程序。
- branchName
-
string
如果提供，则具体检查分支的名称。
返回
Promise<string[]>
listRepositories(string, string, string, string, ResultSet, boolean, string)
获取源代码存储库的列表。
function listRepositories(project: string, providerName: string, serviceEndpointId?: string, repository?: string, resultSet?: ResultSet, pageResults?: boolean, continuationToken?: string): Promise<SourceRepositories>参数
- project
-
string
项目 ID 或项目名称
- providerName
-
string
源提供程序的名称。
- serviceEndpointId
-
string
如果指定，则为要查询的服务终结点的 ID。 只能省略不使用服务终结点的提供程序，例如 TFVC 或 TFGit。
- repository
-
string
如果已指定，则获取供应商特定的标识符或要获取的单个存储库的名称。
- resultSet
- ResultSet
与终结点最相关的存储库的“top”。 如果未设置，则返回所有存储库。 如果设置了“存储库”，则忽略。
- pageResults
-
boolean
如果设置为 true，这将限制结果集，并返回继续标记以继续查询。
- continuationToken
-
string
分页结果时，这是上一次调用此方法返回的延续标记，可用于返回下一组存储库。
返回
Promise<SourceRepositories>
listSourceProviders(string)
获取源提供程序及其功能的列表。
function listSourceProviders(project: string): Promise<SourceProviderAttributes[]>参数
- project
-
string
项目 ID 或项目名称
返回
Promise<SourceProviderAttributes[]>
listWebhooks(string, string, string, string)
获取在给定源代码存储库中安装的 Webhook 列表。
function listWebhooks(project: string, providerName: string, serviceEndpointId?: string, repository?: string): Promise<RepositoryWebhook[]>参数
- project
-
string
项目 ID 或项目名称
- providerName
-
string
源提供程序的名称。
- serviceEndpointId
-
string
如果指定，则为要查询的服务终结点的 ID。 只能省略不使用服务终结点的提供程序，例如 TFVC 或 TFGit。
- repository
-
string
如果已指定，则为特定于供应商的标识符或存储库的名称以获取 Webhook。 只能省略不支持多个存储库的提供程序。
返回
Promise<RepositoryWebhook[]>
queueBuild(Build, string, boolean, string, number, number)
将生成排队
function queueBuild(build: Build, project: string, ignoreWarnings?: boolean, checkInTicket?: string, sourceBuildId?: number, definitionId?: number): Promise<Build>参数
- build
- Build
- project
-
string
项目 ID 或项目名称
- ignoreWarnings
-
boolean
- checkInTicket
-
string
- sourceBuildId
-
number
- definitionId
-
number
用于在没有正文的情况下将生成排队的可选定义 ID。 如果存在有效的正文，则忽略
返回
Promise<Build>
restoreDefinition(string, number, boolean)
还原已删除的定义
function restoreDefinition(project: string, definitionId: number, deleted: boolean): Promise<BuildDefinition>参数
- project
-
string
项目 ID 或项目名称
- definitionId
-
number
要还原的定义的标识符。
- deleted
-
boolean
如果为 false，则还原已删除的定义。
返回
Promise<BuildDefinition>
restoreWebhooks(DefinitionTriggerType[], string, string, string, string)
为给定源代码存储库中的指定触发器重新创建 Webhook。
function restoreWebhooks(triggerTypes: DefinitionTriggerType[], project: string, providerName: string, serviceEndpointId?: string, repository?: string): Promise<void>参数
- triggerTypes
要为其还原 Webhook 的触发器类型。
- project
-
string
项目 ID 或项目名称
- providerName
-
string
源提供程序的名称。
- serviceEndpointId
-
string
如果指定，则为要查询的服务终结点的 ID。 只能省略不使用服务终结点的提供程序，例如 TFVC 或 TFGit。
- repository
-
string
如果已指定，则为特定于供应商的标识符或存储库的名称以获取 Webhook。 只能省略不支持多个存储库的提供程序。
返回
Promise<void>
saveTemplate(BuildDefinitionTemplate, string, string)
汇报现有的生成定义模板。
function saveTemplate(template: BuildDefinitionTemplate, project: string, templateId: string): Promise<BuildDefinitionTemplate>参数
- template
- BuildDefinitionTemplate
模板的新版本。
- project
-
string
项目 ID 或项目名称
- templateId
-
string
模板的 ID。
返回
Promise<BuildDefinitionTemplate>
updateBuild(Build, string, number, boolean)
汇报生成。
function updateBuild(build: Build, project: string, buildId: number, retry?: boolean): Promise<Build>参数
- build
- Build
生成。
- project
-
string
项目 ID 或项目名称
- buildId
-
number
生成的 ID。
- retry
-
boolean
返回
Promise<Build>
updateBuildGeneralSettings(PipelineGeneralSettings, string)
汇报管道常规设置。
function updateBuildGeneralSettings(newSettings: PipelineGeneralSettings, project: string): Promise<PipelineGeneralSettings>参数
- newSettings
- PipelineGeneralSettings
- project
-
string
项目 ID 或项目名称
返回
Promise<PipelineGeneralSettings>
updateBuildProperties(JsonPatchDocument, string, number)
汇报生成的属性。
function updateBuildProperties(document: JsonPatchDocument, project: string, buildId: number): Promise<any>参数
- document
- JsonPatchDocument
描述要更新的属性的 json 修补程序文档。
- project
-
string
项目 ID 或项目名称
- buildId
-
number
生成的 ID。
返回
Promise<any>
updateBuilds(Build[], string)
汇报多个生成。
function updateBuilds(builds: Build[], project: string): Promise<Build[]>参数
- builds
-
Build[]
要更新的生成。
- project
-
string
项目 ID 或项目名称
返回
Promise<Build[]>
updateBuildSettings(BuildSettings, string)
汇报生成设置。
function updateBuildSettings(settings: BuildSettings, project?: string): Promise<BuildSettings>参数
- settings
- BuildSettings
新设置。
- project
-
string
项目 ID 或项目名称
返回
Promise<BuildSettings>
updateBuildTags(UpdateTagParameters, string, number)
从生成中添加/删除标记。
function updateBuildTags(updateParameters: UpdateTagParameters, project: string, buildId: number): Promise<string[]>参数
- updateParameters
- UpdateTagParameters
要添加/删除的标记。
- project
-
string
项目 ID 或项目名称
- buildId
-
number
生成的 ID。
返回
Promise<string[]>
updateDefinition(BuildDefinition, string, number, number, number)
汇报现有的生成定义。 为了使此操作成功，请求正文的“Revision”属性的值必须与现有生成定义的 匹配。 建议使用 GET 获取现有生成定义，根据需要修改生成定义，然后使用 PUT 提交修改后的定义。
function updateDefinition(definition: BuildDefinition, project: string, definitionId: number, secretsSourceDefinitionId?: number, secretsSourceDefinitionRevision?: number): Promise<BuildDefinition>参数
- definition
- BuildDefinition
定义的新版本。 其“Revision”属性必须与要接受更新的现有定义匹配。
- project
-
string
项目 ID 或项目名称
- definitionId
-
number
定义的 ID。
- secretsSourceDefinitionId
-
number
- secretsSourceDefinitionRevision
-
number
返回
Promise<BuildDefinition>
updateDefinitionProperties(JsonPatchDocument, string, number)
汇报定义的属性。
function updateDefinitionProperties(document: JsonPatchDocument, project: string, definitionId: number): Promise<any>参数
- document
- JsonPatchDocument
描述要更新的属性的 json 修补程序文档。
- project
-
string
项目 ID 或项目名称
- definitionId
-
number
定义的 ID。
返回
Promise<any>
updateDefinitionTags(UpdateTagParameters, string, number)
从定义中添加/删除标记。
function updateDefinitionTags(updateParameters: UpdateTagParameters, project: string, definitionId: number): Promise<string[]>参数
- updateParameters
- UpdateTagParameters
要添加/删除的标记。
- project
-
string
项目 ID 或项目名称
- definitionId
-
number
定义的 ID。
返回
Promise<string[]>
updateFolder(Folder, string, string)
在给定的现有路径处汇报现有文件夹
function updateFolder(folder: Folder, project: string, path: string): Promise<Folder>参数
- folder
- Folder
文件夹的新版本。
- project
-
string
项目 ID 或项目名称
- path
-
string
文件夹的完整路径。
返回
Promise<Folder>
updateRetentionLease(RetentionLeaseUpdate, string, number)
汇报保留租约的持续时间或管道保护状态。
function updateRetentionLease(leaseUpdate: RetentionLeaseUpdate, project: string, leaseId: number): Promise<RetentionLease>参数
- leaseUpdate
- RetentionLeaseUpdate
保留租约的新数据。
- project
-
string
项目 ID 或项目名称
- leaseId
-
number
要更新的租约的 ID。
返回
Promise<RetentionLease>
updateRetentionSettings(UpdateProjectRetentionSettingModel, string)
汇报项目的保留设置。
function updateRetentionSettings(updateModel: UpdateProjectRetentionSettingModel, project: string): Promise<ProjectRetentionSetting>参数
- updateModel
- UpdateProjectRetentionSettingModel
- project
-
string
项目 ID 或项目名称
返回
Promise<ProjectRetentionSetting>
updateStage(UpdateStageParameters, number, string, string)
更新生成阶段
function updateStage(updateParameters: UpdateStageParameters, buildId: number, stageRefName: string, project?: string): Promise<void>参数
- updateParameters
- UpdateStageParameters
- buildId
-
number
- stageRefName
-
string
- project
-
string
项目 ID 或项目名称
返回
Promise<void>
反馈
即将发布：在整个 2024 年，我们将逐步淘汰作为内容反馈机制的“GitHub 问题”，并将其取代为新的反馈系统。 有关详细信息，请参阅：https://aka.ms/ContentUserFeedback。
提交和查看相关反馈