GitRestClient class

参考

包:: azure-devops-extension-api

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

Extends: RestClientBase

构造函数

GitRestClient(IVssRestClientOptions)

属性

RESOURCE_AREA_ID

方法

createAnnotatedTag(GitAnnotatedTag, string, string)	创建带批注的标记。
createAttachment(any, string, string, number, string)	将新文件附加到拉取请求。
createCherryPick(GitAsyncRefOperationParameters, string, string)	将一个或多个与拉取请求关联的特定提交选取到新分支。
createComment(Comment, string, number, number, string)	在拉取请求中对特定线程创建注释 (每个线程最多可以创建 500 个注释) 。
createCommitStatus(GitStatus, string, string, string)	创建 Git 提交状态。
createFavorite(GitRefFavorite, string)	创建引用收藏夹
createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)	请求将另一个存储库的引用提取到此存储库中。它同步两个现有分支。若要创建分叉，请参阅 <href=“https://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1"> 存储库终结点</a>
createImportRequest(GitImportRequest, string, string)	创建导入请求。
createLike(string, number, number, number, string)	在批注中添加赞。
createMergeRequest(GitMergeParameters, string, string, boolean)	请求 git 合并操作。目前，我们仅支持合并 2 个提交。
createPullRequest(GitPullRequest, string, string, boolean)	创建拉取请求。
createPullRequestIterationStatus(GitPullRequestStatus, string, number, number, string)	在迭代中创建拉取请求状态。此操作的结果与请求正文中具有指定的迭代 ID 的拉取请求创建状态相同。
createPullRequestLabel(WebApiCreateTagRequestData, string, number, string, string)	如果) 尚不存在，则创建标记 (，并将其添加为指定拉取请求的标签 (标记) 。唯一必需的字段是新标签的名称 (标记) 。
createPullRequestReviewer(IdentityRefWithVote, string, number, string, string)	将审阅者添加到拉取请求或投票。
createPullRequestReviewers(IdentityRef[], string, number, string)	将审阅者添加到拉取请求。
createPullRequestStatus(GitPullRequestStatus, string, number, string)	创建拉取请求状态。
createPush(GitPush, string, string)	将更改推送到存储库。
createRepository(GitRepositoryCreateOptions, string, string)	在团队项目中创建 git 存储库。
createRevert(GitAsyncRefOperationParameters, string, string)	启动操作以创建新分支，该分支将还原由特定提交或与拉取请求关联的提交引入的更改。
createThread(GitPullRequestCommentThread, string, number, string)	在拉取请求中创建线程。
createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)	向拉取请求的审阅者添加非物质化标识。
deleteAttachment(string, string, number, string)	删除拉取请求附件。
deleteComment(string, number, number, number, string)	删除与拉取请求中的特定线程关联的注释。
deleteEnablementStatus(boolean, boolean, string[])	DELETE 从 DB 中删除启用状态和计费通信数据。删除启用数据将有效地禁用受影响的存储库。
deleteLike(string, number, number, number, string)	删除批注上的 like 。
deletePullRequestIterationStatus(string, number, number, number, string)	删除拉取请求迭代状态。
deletePullRequestLabels(string, number, string, string, string)	从分配给拉取请求的标签集中删除标签 (标记) 。不会删除标记本身。
deletePullRequestReviewer(string, number, string, string)	从拉取请求中删除审阅者。
deletePullRequestStatus(string, number, number, string)	删除拉取请求状态。
deleteRefFavorite(string, number)	删除指定的引用收藏夹
deleteRepository(string, string)	删除 git 存储库
deleteRepositoryFromRecycleBin(string, string)	销毁 (软删除的 Git 存储库) 硬删除。
getAnnotatedTag(string, string, string)	获取带批注的标记。
getAttachmentContent(string, string, number, string)	获取拉取请求附件的文件内容。
getAttachments(string, number, string)	获取附加到给定拉取请求的文件列表。
getAttachmentZip(string, string, number, string)	获取拉取请求附件的文件内容。
getBillableCommitters(string, Date, number, number)	在给定日期检索高级安全服务的实际可计费提交者。
getBillableCommittersDetail(string, string, Date)	检索给定日期高级安全服务的详细实际计费提交者。详细结果有意不会筛选掉软删除的项目和存储库，以帮助诊断计费问题。
getBlob(string, string, string, boolean, string, boolean)	获取单个 Blob。
getBlobContent(string, string, string, boolean, string, boolean)	获取单个 Blob。
getBlobsZip(string[], string, string, string)	获取 zip 文件下载中的一个或多个 Blob。
getBlobZip(string, string, string, boolean, string, boolean)	获取单个 Blob。
getBranch(string, string, string, GitVersionDescriptor)	检索有关单个分支的统计信息。
getBranches(string, string, GitVersionDescriptor)	检索有关存储库中所有分支的统计信息。
getBranchStatsBatch(GitQueryBranchStatsCriteria, string, string)	检索多个提交的统计信息
getChanges(string, string, string, number, number)	检索特定提交的更改。
getCherryPick(string, number, string)	按樱桃选取 ID 检索有关樱桃选取操作的信息。
getCherryPickConflict(string, number, number, string)	按 ID 检索樱桃选取的一个冲突
getCherryPickConflicts(string, number, string, string, number, boolean, boolean, boolean)	检索樱桃选取的所有冲突
getCherryPickForRefName(string, string, string)	检索有关特定分支的选取操作的信息。由于基础对象结构，此操作成本高昂，因此此 API 仅查看 1000 个最新的选取操作。
getCherryPickRelationships(string, string, string, boolean)	给定 commitId，将返回位于同一个挑选系列中的提交列表。
getComment(string, number, number, number, string)	检索与拉取请求中特定线程关联的注释。
getComments(string, number, number, string)	检索拉取请求中与特定线程关联的所有注释。
getCommit(string, string, string, number)	检索特定提交。
getCommitDiffs(string, string, boolean, number, number, GitBaseVersionDescriptor, GitTargetVersionDescriptor)	在基本提交和目标提交之间查找最接近 (合并基) ，并获取基提交和目标提交或通用和目标提交之间的差异。
getCommits(string, GitQueryCommitsCriteria, string)	检索项目的 git 提交
getCommitsBatch(GitQueryCommitsCriteria, string, string, number, number, boolean)	检索符合搜索条件的项目的 git 提交
getDeletedRepositories(string)	检索已删除的 Git 存储库。
getEnablementStatus(string[], Date, number, number)	项目的存储库的 GET 启用状态。
getEnableOnCreateHost(boolean)
getEnableOnCreateProject(string)
getEstimatedBillableCommittersRepo(string, string)	获取过去 90 天内存储库的估计可计费提交者。
getEstimatedBillablePushersOrg()	获取过去 90 天内组织的估计可计费推送器。
getEstimatedBillablePushersProject(string)	获取过去 90 天内项目的估计可计费推送器。
getFileDiffs(FileDiffsCriteria, string, string)	获取每个指定文件的文件差异
getForks(string, string, string, boolean)	检索集合中存储库的所有分支。
getForkSyncRequest(string, number, string, boolean)	获取特定分支同步操作的详细信息。
getForkSyncRequests(string, string, boolean, boolean)	检索此存储库上请求的所有分叉同步操作。
getHfsItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	获取单个项的项元数据和/或内容。 download 参数用于指示内容是应作为下载内容提供，还是仅作为响应中的流发送。不适用于始终作为下载返回的压缩内容。
getHfsItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	获取单个项的项元数据和/或内容。 download 参数用于指示内容是应作为下载内容提供，还是仅作为响应中的流发送。不适用于始终作为下载返回的压缩内容。
getHfsItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)	获取项集合的项元数据和/或内容。 download 参数用于指示内容是应作为下载内容提供，还是仅作为响应中的流发送。不适用于始终作为下载返回的压缩内容。
getHfsItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	获取单个项的项元数据和/或内容。 download 参数用于指示内容是应作为下载内容提供，还是仅作为响应中的流发送。不适用于始终作为下载返回的压缩内容。
getHfsItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	获取单个项的项元数据和/或内容。 download 参数用于指示内容是应作为下载内容提供，还是仅作为响应中的流发送。不适用于始终作为下载返回的压缩内容。
getImportRequest(string, string, number)	检索特定的导入请求。
getItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	获取单个项的项元数据和/或内容。 download 参数用于指示内容是应作为下载内容提供，还是仅作为响应中的流发送。不适用于始终作为下载返回的压缩内容。
getItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	获取单个项的项元数据和/或内容。 download 参数用于指示内容是应作为下载内容提供，还是仅作为响应中的流发送。不适用于始终作为下载返回的压缩内容。
getItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)	获取项集合的项元数据和/或内容。 download 参数用于指示内容是应作为下载内容提供，还是仅作为响应中的流发送。不适用于始终作为下载返回的压缩内容。
getItemsBatch(GitItemRequestData, string, string)	在给定路径列表或长路径的情况下，检索从存储库/项目中的一组项中创建批的 Post
getItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	获取单个项的项元数据和/或内容。 download 参数用于指示内容是应作为下载内容提供，还是仅作为响应中的流发送。不适用于始终作为下载返回的压缩内容。
getItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	获取单个项的项元数据和/或内容。 download 参数用于指示内容是应作为下载内容提供，还是仅作为响应中的流发送。不适用于始终作为下载返回的压缩内容。
getLikes(string, number, number, number, string)	获取评论的点赞。
getMergeBases(string, string, string, string, string, string)	查找两个提交的合并基数，可以选择跨分支查找。如果未指定 otherRepositoryId，则只会在本地存储库NameOrId 的上下文中计算合并基数。
getMergeRequest(string, string, number, boolean)	获取特定合并操作的详细信息。
getPermission(string, string, string)	GET 高级安全权限状态。
getPullRequest(string, number, string, number, number, number, boolean, boolean)	检索拉取请求。
getPullRequestById(number, string)	检索拉取请求。
getPullRequestCommits(string, number, string)	获取指定拉取请求的提交。
getPullRequestConflict(string, number, number, string)	按 ID 检索拉取请求的一个冲突
getPullRequestConflicts(string, number, string, number, number, boolean, boolean, boolean)	检索拉取请求的所有冲突
getPullRequestIteration(string, number, number, string)	获取拉取请求的指定迭代。
getPullRequestIterationChanges(string, number, number, string, number, number, number)	检索在两次迭代之间的拉取请求中所做的更改。
getPullRequestIterationCommits(string, number, number, string, number, number)	获取拉取请求的指定迭代的提交。
getPullRequestIterations(string, number, string, boolean)	获取指定拉取请求的迭代列表。
getPullRequestIterationStatus(string, number, number, number, string)	按 ID 获取特定的拉取请求迭代状态。状态 ID 在所有迭代的拉取请求中是唯一的。
getPullRequestIterationStatuses(string, number, number, string)	获取与拉取请求迭代关联的所有状态。
getPullRequestLabel(string, number, string, string, string)	检索已分配给拉取请求的单个标签 (标记) 。
getPullRequestLabels(string, number, string, string)	获取) 分配给拉取请求的所有标签 (标记。
getPullRequestProperties(string, number, string)	获取拉取请求的外部属性。
getPullRequestQuery(GitPullRequestQuery, string, string)	此 API 用于查找与给定提交相关的拉取请求。它可用于查找创建特定合并提交的拉取请求，也可以用于查找曾经合并过特定提交的所有拉取请求。输入是查询列表，每个查询都包含一个提交列表。对于搜索的每个提交，你将返回一个提交 -> 拉取请求字典。
getPullRequestReviewer(string, number, string, string)	检索有关拉取请求的特定审阅者的信息
getPullRequestReviewers(string, number, string)	检索拉取请求的审阅者
getPullRequests(string, GitPullRequestSearchCriteria, string, number, number, number)	检索与指定条件匹配的所有拉取请求。
getPullRequestsByProject(string, GitPullRequestSearchCriteria, number, number, number)	检索与指定条件匹配的所有拉取请求。
getPullRequestStatus(string, number, number, string)	按 ID 获取特定的拉取请求状态。在所有迭代中，状态 ID 在拉取请求中是唯一的。
getPullRequestStatuses(string, number, string)	获取与拉取请求关联的所有状态。
getPullRequestThread(string, number, number, string, number, number)	检索拉取请求中的线程。
getPullRequestWorkItemRefs(string, number, string)	检索与拉取请求关联的工作项的列表。
getPush(string, number, string, number, boolean)	检索特定推送。
getPushCommits(string, number, string, number, number, boolean)	检索与特定推送关联的提交列表。
getPushes(string, string, number, number, GitPushSearchCriteria)	检索与指定存储库关联的推送。
getRecycleBinRepositories(string)	从回收站检索软删除的 git 存储库。
getRefFavorite(string, number)	获取收藏夹 ID 的引用收藏夹。
getRefFavorites(string, string, string)	获取存储库和标识的引用收藏夹。
getRefFavoritesForProject(string, string)
getRefs(string, string, string, boolean, boolean, boolean, boolean, boolean, string)	查询提供的存储库以获取其引用并返回它们。
getRepositories(string, boolean, boolean, boolean)	检索 git 存储库。
getRepository(string, string)	检索 git 存储库。
getRepositoryWithParent(string, boolean, string)	检索 git 存储库。
getRevert(string, number, string)	按还原 ID 检索有关还原操作的信息。
getRevertConflict(string, number, number, string)	按 ID 检索还原的一个冲突
getRevertConflicts(string, number, string, string, number, boolean, boolean, boolean)	检索还原的所有冲突
getRevertForRefName(string, string, string)	检索有关特定分支的还原操作的信息。
getStatuses(string, string, string, number, number, boolean)	获取与 Git 提交关联的状态。
getSuggestions(string, string, boolean)	检索特定存储库或团队项目的拉取请求建议。
getThreads(string, number, string, number, number)	检索拉取请求中的所有线程。
getTree(string, string, string, string, boolean, string)	树终结点返回指定树下的对象集合。树是 Git 存储库中的文件夹。
getTreeZip(string, string, string, string, boolean, string)	树终结点返回指定树下的对象集合。树是 Git 存储库中的文件夹。
queryImportRequests(string, string, boolean)	检索存储库的导入请求。
restoreRepositoryFromRecycleBin(GitRecycleBinRepositoryDetails, string, string)	恢复软删除的 Git 存储库。最近删除的存储库先以软删除状态保留一段时间，然后才被硬删除且不可恢复。
setEnableOnCreateHost(boolean)
setEnableOnCreateProject(string, boolean)
sharePullRequest(ShareNotificationContext, string, number, string)	向一组收件人发送有关特定拉取请求的电子邮件通知
updateCherryPickConflict(GitConflict, string, number, number, string)	更新合并冲突解决
updateCherryPickConflicts(GitConflict[], string, number, string)	更新多个合并冲突解决方法
updateComment(Comment, string, number, number, number, string)	更新与拉取请求中的特定线程关联的注释。
updateEnablementStatus(AdvSecEnablementUpdate[])	存储库的 POST 启用状态。
updateImportRequest(GitImportRequest, string, string, number)	重试或放弃失败的导入请求。
updatePullRequest(GitPullRequest, string, number, string)	更新拉取请求
updatePullRequestConflict(GitConflict, string, number, number, string)	更新合并冲突解决
updatePullRequestConflicts(GitConflict[], string, number, string)	更新多个合并冲突解决方法
updatePullRequestIterationStatuses(JsonPatchDocument, string, number, number, string)	更新拉取请求迭代状态集合。唯一受支持的操作类型是 `remove`。
updatePullRequestProperties(JsonPatchDocument, string, number, string)	创建或更新拉取请求外部属性。修补操作可以是 `add`、 `replace` 或 `remove`。对于 `add` 操作，路径可以为空。如果路径为空，则该值必须是键值对的列表。对于 `replace` 操作，路径不能为空。如果该路径不存在，则会将属性添加到集合中。对于 `remove` 操作，路径不能为空。如果路径不存在，则不会执行任何操作。
updatePullRequestReviewer(IdentityRefWithVote, string, number, string, string)	编辑审阅者条目。这些字段可修补：isFlagged、hasDeclined
updatePullRequestReviewers(IdentityRefWithVote[], string, number, string)	重置多个审阅者对拉取请求的投票。注意：此终结点仅支持更新投票，但不支持更新所需的审阅者 (使用策略) 或显示名称。
updatePullRequestStatuses(JsonPatchDocument, string, number, string)	更新拉取请求状态集合。唯一受支持的操作类型是 `remove`。
updateRef(GitRefUpdate, string, string, string, string)	锁定或解锁分支。
updateRefs(GitRefUpdate[], string, string, string)	创建、更新或删除引用 (分支) 。
updateRepository(GitRepository, string, string)	使用新的存储库名称或新的默认分支更新 Git 存储库。
updateRevertConflict(GitConflict, string, number, number, string)	更新合并冲突解决
updateRevertConflicts(GitConflict[], string, number, string)	更新多个合并冲突解决方法
updateThread(GitPullRequestCommentThread, string, number, number, string)	更新拉取请求中的线程。

构造函数详细信息

GitRestClient(IVssRestClientOptions)

new GitRestClient(options: IVssRestClientOptions)

参数

options: IVssRestClientOptions

属性详细信息

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

属性值

string

方法详细信息

createAnnotatedTag(GitAnnotatedTag, string, string)

创建带批注的标记。

function createAnnotatedTag(tagObject: GitAnnotatedTag, project: string, repositoryId: string): Promise<GitAnnotatedTag>

参数

tagObject: GitAnnotatedTag

包含要创建的标记的详细信息的对象。

project: string

项目 ID 或项目名称

repositoryId: string

存储库的 ID 或名称。

Promise<GitAnnotatedTag>

createAttachment(any, string, string, number, string)

将新文件附加到拉取请求。

function createAttachment(content: any, fileName: string, repositoryId: string, pullRequestId: number, project?: string): Promise<Attachment>

参数

content: any

要上传的内容

fileName: string

文件的名称。

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

project: string

项目 ID 或项目名称

Promise<Attachment>

createCherryPick(GitAsyncRefOperationParameters, string, string)

将一个或多个与拉取请求关联的特定提交选取到新分支。

function createCherryPick(cherryPickToCreate: GitAsyncRefOperationParameters, project: string, repositoryId: string): Promise<GitCherryPick>

参数

cherryPickToCreate: GitAsyncRefOperationParameters

project: string

项目 ID 或项目名称

repositoryId: string

存储库的 ID。

Promise<GitCherryPick>

createComment(Comment, string, number, number, string)

在拉取请求中对特定线程创建注释 (每个线程最多可以创建 500 个注释) 。

function createComment(comment: Comment, repositoryId: string, pullRequestId: number, threadId: number, project?: string): Promise<Comment>

参数

comment: Comment

要创建的注释。批注最多可以包含 150,000 个字符。

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

threadId: number

所需注释位于的线程的 ID。

project: string

项目 ID 或项目名称

Promise<Comment>

createCommitStatus(GitStatus, string, string, string)

创建 Git 提交状态。

function createCommitStatus(gitCommitStatusToCreate: GitStatus, commitId: string, repositoryId: string, project?: string): Promise<GitStatus>

参数

gitCommitStatusToCreate: GitStatus

要创建的 Git 提交状态对象。

commitId: string

Git 提交的 ID。

repositoryId: string

存储库的 ID。

project: string

项目 ID 或项目名称

Promise<GitStatus>

createFavorite(GitRefFavorite, string)

创建引用收藏夹

function createFavorite(favorite: GitRefFavorite, project: string): Promise<GitRefFavorite>

参数

favorite: GitRefFavorite

要创建的引用收藏夹。

project: string

项目 ID 或项目名称

Promise<GitRefFavorite>

createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)

请求将另一个存储库的引用提取到此存储库中。它同步两个现有分支。若要创建分叉，请参阅 <href=“https://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1"> 存储库终结点</a>

function createForkSyncRequest(syncParams: GitForkSyncRequestParameters, repositoryNameOrId: string, project?: string, includeLinks?: boolean): Promise<GitForkSyncRequest>

参数

syncParams: GitForkSyncRequestParameters

源存储库和引用映射。

repositoryNameOrId: string

存储库的名称或 ID。

project: string

项目 ID 或项目名称

includeLinks: boolean

如果为 True，则包含链接

Promise<GitForkSyncRequest>

createImportRequest(GitImportRequest, string, string)

创建导入请求。

function createImportRequest(importRequest: GitImportRequest, project: string, repositoryId: string): Promise<GitImportRequest>

参数

importRequest: GitImportRequest

要创建的导入请求。

project: string

项目 ID 或项目名称

repositoryId: string

存储库的名称或 ID。

Promise<GitImportRequest>

createLike(string, number, number, number, string)

在批注中添加赞。

function createLike(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<void>

参数

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

threadId: number

包含注释的线程的 ID。

commentId: number

注释的 ID。

project: string

项目 ID 或项目名称

Promise<void>

createMergeRequest(GitMergeParameters, string, string, boolean)

请求 git 合并操作。目前，我们仅支持合并 2 个提交。

function createMergeRequest(mergeParameters: GitMergeParameters, project: string, repositoryNameOrId: string, includeLinks?: boolean): Promise<GitMerge>

参数

mergeParameters: GitMergeParameters

父级 commitIds 和合并提交混乱。

project: string

项目 ID 或项目名称

repositoryNameOrId: string

存储库的名称或 ID。

includeLinks: boolean

如果为 True，则包含链接

Promise<GitMerge>

createPullRequest(GitPullRequest, string, string, boolean)

创建拉取请求。

function createPullRequest(gitPullRequestToCreate: GitPullRequest, repositoryId: string, project?: string, supportsIterations?: boolean): Promise<GitPullRequest>

参数

gitPullRequestToCreate: GitPullRequest

要创建的拉取请求。

repositoryId: string

拉取请求的目标分支的存储库 ID。

project: string

项目 ID 或项目名称

supportsIterations: boolean

如果为 true，则后续推送到拉取请求将可以单独查看。对于出于性能原因的大型拉取请求，如果不需要此功能，则将其设置为 false。

Promise<GitPullRequest>

createPullRequestIterationStatus(GitPullRequestStatus, string, number, number, string)

在迭代中创建拉取请求状态。此操作的结果与请求正文中具有指定的迭代 ID 的拉取请求创建状态相同。

function createPullRequestIterationStatus(status: GitPullRequestStatus, repositoryId: string, pullRequestId: number, iterationId: number, project?: string): Promise<GitPullRequestStatus>

参数

status: GitPullRequestStatus

要创建的拉取请求状态。

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

iterationId: number

拉取请求迭代的 ID。

project: string

项目 ID 或项目名称

Promise<GitPullRequestStatus>

createPullRequestLabel(WebApiCreateTagRequestData, string, number, string, string)

如果) 尚不存在，则创建标记 (，并将其添加为指定拉取请求的标签 (标记) 。唯一必需的字段是新标签的名称 (标记) 。

function createPullRequestLabel(label: WebApiCreateTagRequestData, repositoryId: string, pullRequestId: number, project?: string, projectId?: string): Promise<WebApiTagDefinition>

参数

label: WebApiCreateTagRequestData

要分配给拉取请求的标签。

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

project: string

项目 ID 或项目名称

projectId: string

项目 ID 或项目名称。

Promise<WebApiTagDefinition>

createPullRequestReviewer(IdentityRefWithVote, string, number, string, string)

将审阅者添加到拉取请求或投票。

function createPullRequestReviewer(reviewer: IdentityRefWithVote, repositoryId: string, pullRequestId: number, reviewerId: string, project?: string): Promise<IdentityRefWithVote>

参数

reviewer: IdentityRefWithVote

审阅者的投票。<br />如果此处包含审阅者的 ID，则它必须与 reviewerID 参数匹配。<br />Reviewers 可以使用此方法设置自己的投票。添加其他审阅者时，投票必须设置为零。

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

reviewerId: string

审阅者的 ID。

project: string

项目 ID 或项目名称

Promise<IdentityRefWithVote>

createPullRequestReviewers(IdentityRef[], string, number, string)

将审阅者添加到拉取请求。

function createPullRequestReviewers(reviewers: IdentityRef[], repositoryId: string, pullRequestId: number, project?: string): Promise<IdentityRefWithVote[]>

参数

reviewers: IdentityRef[]

要添加到拉取请求的审阅者。

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

project: string

项目 ID 或项目名称

Promise<IdentityRefWithVote[]>

createPullRequestStatus(GitPullRequestStatus, string, number, string)

创建拉取请求状态。

function createPullRequestStatus(status: GitPullRequestStatus, repositoryId: string, pullRequestId: number, project?: string): Promise<GitPullRequestStatus>

参数

status: GitPullRequestStatus

要创建的拉取请求状态。

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

project: string

项目 ID 或项目名称

Promise<GitPullRequestStatus>

createPush(GitPush, string, string)

将更改推送到存储库。

function createPush(push: GitPush, repositoryId: string, project?: string): Promise<GitPush>

参数

push: GitPush

repositoryId: string

存储库的名称或 ID。

project: string

项目 ID 或项目名称

Promise<GitPush>

createRepository(GitRepositoryCreateOptions, string, string)

在团队项目中创建 git 存储库。

function createRepository(gitRepositoryToCreate: GitRepositoryCreateOptions, project?: string, sourceRef?: string): Promise<GitRepository>

参数

gitRepositoryToCreate: GitRepositoryCreateOptions

指定存储库名称、团队项目和/或父存储库。如果请求是项目范围的 (即包含项目 ID) ，则可以从 gitRepositoryToCreate 中省略团队项目信息。

project: string

项目 ID 或项目名称

sourceRef: string

[可选]指定创建复刻存储库时要使用的源引用

Promise<GitRepository>

createRevert(GitAsyncRefOperationParameters, string, string)

启动操作以创建新分支，该分支将还原由特定提交或与拉取请求关联的提交引入的更改。

function createRevert(revertToCreate: GitAsyncRefOperationParameters, project: string, repositoryId: string): Promise<GitRevert>

参数

revertToCreate: GitAsyncRefOperationParameters

project: string

项目 ID 或项目名称

repositoryId: string

存储库的 ID。

Promise<GitRevert>

createThread(GitPullRequestCommentThread, string, number, string)

在拉取请求中创建线程。

function createThread(commentThread: GitPullRequestCommentThread, repositoryId: string, pullRequestId: number, project?: string): Promise<GitPullRequestCommentThread>

参数

commentThread: GitPullRequestCommentThread

要创建的线程。线程必须至少包含一个注释。

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

project: string

项目 ID 或项目名称

Promise<GitPullRequestCommentThread>

createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)

向拉取请求的审阅者添加非物质化标识。

function createUnmaterializedPullRequestReviewer(reviewer: IdentityRefWithVote, repositoryId: string, pullRequestId: number, project?: string): Promise<IdentityRefWithVote>

参数

reviewer: IdentityRefWithVote

要添加到拉取请求的审阅者。

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

project: string

项目 ID 或项目名称

Promise<IdentityRefWithVote>

deleteAttachment(string, string, number, string)

删除拉取请求附件。

function deleteAttachment(fileName: string, repositoryId: string, pullRequestId: number, project?: string): Promise<void>

参数

fileName: string

要删除的附件的名称。

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

project: string

项目 ID 或项目名称

Promise<void>

deleteComment(string, number, number, number, string)

删除与拉取请求中的特定线程关联的注释。

function deleteComment(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<void>

参数

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

threadId: number

所需注释位于的线程的 ID。

commentId: number

注释的 ID。

project: string

项目 ID 或项目名称

Promise<void>

deleteEnablementStatus(boolean, boolean, string[])

DELETE 从 DB 中删除启用状态和计费通信数据。删除启用数据将有效地禁用受影响的存储库。

function deleteEnablementStatus(allProjects: boolean, includeBillableCommitters?: boolean, projectIds?: string[]): Promise<void>

参数

allProjects: boolean

includeBillableCommitters: boolean

projectIds: string[]

Promise<void>

deleteLike(string, number, number, number, string)

删除批注上的 like 。

function deleteLike(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<void>

参数

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

threadId: number

包含注释的线程的 ID。

commentId: number

注释的 ID。

project: string

项目 ID 或项目名称

Promise<void>

deletePullRequestIterationStatus(string, number, number, number, string)

删除拉取请求迭代状态。

function deletePullRequestIterationStatus(repositoryId: string, pullRequestId: number, iterationId: number, statusId: number, project?: string): Promise<void>

参数

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

iterationId: number

拉取请求迭代的 ID。

statusId: number

拉取请求状态的 ID。

project: string

项目 ID 或项目名称

Promise<void>

deletePullRequestLabels(string, number, string, string, string)

从分配给拉取请求的标签集中删除标签 (标记) 。不会删除标记本身。

function deletePullRequestLabels(repositoryId: string, pullRequestId: number, labelIdOrName: string, project?: string, projectId?: string): Promise<void>

参数

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

labelIdOrName: string

请求的标签的名称或 ID。

project: string

项目 ID 或项目名称

projectId: string

项目 ID 或项目名称。

Promise<void>

deletePullRequestReviewer(string, number, string, string)

从拉取请求中删除审阅者。

function deletePullRequestReviewer(repositoryId: string, pullRequestId: number, reviewerId: string, project?: string): Promise<void>

参数

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

reviewerId: string

要删除的审阅者的 ID。

project: string

项目 ID 或项目名称

Promise<void>

deletePullRequestStatus(string, number, number, string)

删除拉取请求状态。

function deletePullRequestStatus(repositoryId: string, pullRequestId: number, statusId: number, project?: string): Promise<void>

参数

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

statusId: number

拉取请求状态的 ID。

project: string

项目 ID 或项目名称

Promise<void>

deleteRefFavorite(string, number)

删除指定的引用收藏夹

function deleteRefFavorite(project: string, favoriteId: number): Promise<void>

参数

project: string

项目 ID 或项目名称

favoriteId: number

要删除的引用收藏夹的 ID。

Promise<void>

deleteRepository(string, string)

删除 git 存储库

function deleteRepository(repositoryId: string, project?: string): Promise<void>

参数

repositoryId: string

存储库的 ID。

project: string

项目 ID 或项目名称

Promise<void>

deleteRepositoryFromRecycleBin(string, string)

销毁 (软删除的 Git 存储库) 硬删除。

function deleteRepositoryFromRecycleBin(project: string, repositoryId: string): Promise<void>

参数

project: string

项目 ID 或项目名称

repositoryId: string

存储库的 ID。

Promise<void>

getAnnotatedTag(string, string, string)

获取带批注的标记。

function getAnnotatedTag(project: string, repositoryId: string, objectId: string): Promise<GitAnnotatedTag>

参数

project: string

项目 ID 或项目名称

repositoryId: string

存储库的 ID 或名称。

objectId: string

要获取的标记的 ObjectId (Sha1Id) 。

Promise<GitAnnotatedTag>

getAttachmentContent(string, string, number, string)

获取拉取请求附件的文件内容。

function getAttachmentContent(fileName: string, repositoryId: string, pullRequestId: number, project?: string): Promise<ArrayBuffer>

参数

fileName: string

附件的名称。

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

project: string

项目 ID 或项目名称

Promise<ArrayBuffer>

getAttachments(string, number, string)

获取附加到给定拉取请求的文件列表。

function getAttachments(repositoryId: string, pullRequestId: number, project?: string): Promise<Attachment[]>

参数

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

project: string

项目 ID 或项目名称

Promise<Attachment[]>

getAttachmentZip(string, string, number, string)

获取拉取请求附件的文件内容。

function getAttachmentZip(fileName: string, repositoryId: string, pullRequestId: number, project?: string): Promise<ArrayBuffer>

参数

fileName: string

附件的名称。

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

project: string

项目 ID 或项目名称

Promise<ArrayBuffer>

getBillableCommitters(string, Date, number, number)

在给定日期检索高级安全服务的实际可计费提交者。

function getBillableCommitters(project: string, billingDate?: Date, skip?: number, take?: number): Promise<BillableCommitter[]>

参数

project: string

项目 ID 或项目名称

billingDate: Date

应为 UTC。如果未指定，则默认为上一个计费日期。

skip: number

跳过 X 行结果集以模拟分页。

take: number

返回结果集的 Y 行以模拟分页。

Promise<BillableCommitter[]>

getBillableCommittersDetail(string, string, Date)

检索给定日期高级安全服务的详细实际计费提交者。详细结果有意不会筛选掉软删除的项目和存储库，以帮助诊断计费问题。

function getBillableCommittersDetail(project: string, includeDetails: string, billingDate?: Date): Promise<BillableCommitterDetail[]>

参数

project: string

项目 ID 或项目名称

includeDetails: string

返回可计费提交者的所有详细信息。

billingDate: Date

应为 UTC。如果未指定，则默认为上一个计费日期。

Promise<BillableCommitterDetail[]>

getBlob(string, string, string, boolean, string, boolean)

获取单个 Blob。

function getBlob(repositoryId: string, sha1: string, project?: string, download?: boolean, fileName?: string, resolveLfs?: boolean): Promise<GitBlobRef>

参数

repositoryId: string

存储库的名称或 ID。

sha1: string

文件的 SHA1 哈希。可以使用“Git/Items/Get Item”终结点获取文件的 SHA1。

project: string

项目 ID 或项目名称

download: boolean

如果为 true，则提示进行下载，而不是在浏览器中呈现。注意：如果$format为 zip，则此值默认为 true

fileName: string

提供用于下载的 fileName。

resolveLfs: boolean

如果为 true，请尝试将 Blob 解析为其 LFS 内容（如果它是 LFS 指针文件）。仅与八进制流 Accept 标头或$format类型兼容

Promise<GitBlobRef>

getBlobContent(string, string, string, boolean, string, boolean)

获取单个 Blob。

function getBlobContent(repositoryId: string, sha1: string, project?: string, download?: boolean, fileName?: string, resolveLfs?: boolean): Promise<ArrayBuffer>

参数

repositoryId: string

存储库的名称或 ID。

sha1: string

文件的 SHA1 哈希。可以使用“Git/Items/Get Item”终结点获取文件的 SHA1。

project: string

项目 ID 或项目名称

download: boolean

如果为 true，则提示进行下载，而不是在浏览器中呈现。注意：如果$format为 zip，则此值默认为 true

fileName: string

提供用于下载的 fileName。

resolveLfs: boolean

如果为 true，请尝试将 Blob 解析为其 LFS 内容（如果它是 LFS 指针文件）。仅与八进制流 Accept 标头或$format类型兼容

Promise<ArrayBuffer>

getBlobsZip(string[], string, string, string)

获取 zip 文件下载中的一个或多个 Blob。

function getBlobsZip(blobIds: string[], repositoryId: string, project?: string, filename?: string): Promise<ArrayBuffer>

参数

blobIds: string[]

blob ID (SHA1 哈希) 在 zip 文件中返回。

repositoryId: string

存储库的名称或 ID。

project: string

项目 ID 或项目名称

filename: string

Promise<ArrayBuffer>

getBlobZip(string, string, string, boolean, string, boolean)

获取单个 Blob。

function getBlobZip(repositoryId: string, sha1: string, project?: string, download?: boolean, fileName?: string, resolveLfs?: boolean): Promise<ArrayBuffer>

参数

repositoryId: string

存储库的名称或 ID。

sha1: string

文件的 SHA1 哈希。可以使用“Git/Items/Get Item”终结点获取文件的 SHA1。

project: string

项目 ID 或项目名称

download: boolean

如果为 true，则提示进行下载，而不是在浏览器中呈现。注意：如果$format为 zip，则此值默认为 true

fileName: string

提供用于下载的 fileName。

resolveLfs: boolean

如果为 true，请尝试将 Blob 解析为其 LFS 内容（如果它是 LFS 指针文件）。仅与八进制流 Accept 标头或$format类型兼容

Promise<ArrayBuffer>

getBranch(string, string, string, GitVersionDescriptor)

检索有关单个分支的统计信息。

function getBranch(repositoryId: string, name: string, project?: string, baseVersionDescriptor?: GitVersionDescriptor): Promise<GitBranchStats>

参数

repositoryId: string

存储库的名称或 ID。

name: string

分支的名称。

project: string

项目 ID 或项目名称

baseVersionDescriptor: GitVersionDescriptor

标识要用作基的提交或分支。

Promise<GitBranchStats>

getBranches(string, string, GitVersionDescriptor)

检索有关存储库中所有分支的统计信息。

function getBranches(repositoryId: string, project?: string, baseVersionDescriptor?: GitVersionDescriptor): Promise<GitBranchStats[]>

参数

repositoryId: string

存储库的名称或 ID。

project: string

项目 ID 或项目名称

baseVersionDescriptor: GitVersionDescriptor

标识要用作基的提交或分支。

Promise<GitBranchStats[]>

getBranchStatsBatch(GitQueryBranchStatsCriteria, string, string)

检索多个提交的统计信息

function getBranchStatsBatch(searchCriteria: GitQueryBranchStatsCriteria, repositoryId: string, project?: string): Promise<GitBranchStats[]>

参数

searchCriteria: GitQueryBranchStatsCriteria

要比较的基本提交和目标提交列表。

repositoryId: string

存储库的名称或 ID。

project: string

项目 ID 或项目名称

Promise<GitBranchStats[]>

getChanges(string, string, string, number, number)

检索特定提交的更改。

function getChanges(commitId: string, repositoryId: string, project?: string, top?: number, skip?: number): Promise<GitCommitChanges>

参数

commitId: string

提交的 ID。

repositoryId: string

存储库的 ID 或友好名称。若要使用友好名称，还必须指定 projectId。

project: string

项目 ID 或项目名称

top: number

要返回的最大更改数。

skip: number

要跳过的更改数。

Promise<GitCommitChanges>

getCherryPick(string, number, string)

按樱桃选取 ID 检索有关樱桃选取操作的信息。

function getCherryPick(project: string, cherryPickId: number, repositoryId: string): Promise<GitCherryPick>

参数

project: string

项目 ID 或项目名称

cherryPickId: number

樱桃选取的 ID。

repositoryId: string

存储库的 ID。

Promise<GitCherryPick>

getCherryPickConflict(string, number, number, string)

按 ID 检索樱桃选取的一个冲突

function getCherryPickConflict(repositoryId: string, cherryPickId: number, conflictId: number, project?: string): Promise<GitConflict>

参数

repositoryId: string

cherryPickId: number

conflictId: number

project: string

项目 ID 或项目名称

Promise<GitConflict>

getCherryPickConflicts(string, number, string, string, number, boolean, boolean, boolean)

检索樱桃选取的所有冲突

function getCherryPickConflicts(repositoryId: string, cherryPickId: number, project?: string, continuationToken?: string, top?: number, excludeResolved?: boolean, onlyResolved?: boolean, includeObsolete?: boolean): Promise<PagedList<GitConflict>>

参数

repositoryId: string

cherryPickId: number

project: string

项目 ID 或项目名称

continuationToken: string

top: number

excludeResolved: boolean

onlyResolved: boolean

includeObsolete: boolean

Promise<PagedList<GitConflict>>

getCherryPickForRefName(string, string, string)

检索有关特定分支的选取操作的信息。由于基础对象结构，此操作成本高昂，因此此 API 仅查看 1000 个最新的选取操作。

function getCherryPickForRefName(project: string, repositoryId: string, refName: string): Promise<GitCherryPick>

参数

project: string

项目 ID 或项目名称

repositoryId: string

存储库的 ID。

refName: string

用于樱桃选取操作的 GitAsyncRefOperationParameters generatedRefName。

Promise<GitCherryPick>

getCherryPickRelationships(string, string, string, boolean)

给定 commitId，将返回位于同一个挑选系列中的提交列表。

function getCherryPickRelationships(repositoryNameOrId: string, commitId: string, project?: string, includeLinks?: boolean): Promise<GitCommitRef[]>

参数

repositoryNameOrId: string

commitId: string

project: string

项目 ID 或项目名称

includeLinks: boolean

Promise<GitCommitRef[]>

getComment(string, number, number, number, string)

检索与拉取请求中特定线程关联的注释。

function getComment(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<Comment>

参数

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

threadId: number

所需注释位于的线程的 ID。

commentId: number

批注的 ID。

project: string

项目 ID 或项目名称

Promise<Comment>

getComments(string, number, number, string)

检索拉取请求中与特定线程关联的所有注释。

function getComments(repositoryId: string, pullRequestId: number, threadId: number, project?: string): Promise<Comment[]>

参数

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

threadId: number

线程的 ID。

project: string

项目 ID 或项目名称

Promise<Comment[]>

getCommit(string, string, string, number)

检索特定提交。

function getCommit(commitId: string, repositoryId: string, project?: string, changeCount?: number): Promise<GitCommit>

参数

commitId: string

提交的 ID。

repositoryId: string

存储库的 ID 或友好名称。若要使用友好名称，还必须指定 projectId。

project: string

项目 ID 或项目名称

changeCount: number

要包含在结果中的更改数。

Promise<GitCommit>

getCommitDiffs(string, string, boolean, number, number, GitBaseVersionDescriptor, GitTargetVersionDescriptor)

在基本提交和目标提交之间查找最接近 (合并基) ，并获取基提交和目标提交或通用和目标提交之间的差异。

function getCommitDiffs(repositoryId: string, project?: string, diffCommonCommit?: boolean, top?: number, skip?: number, baseVersionDescriptor?: GitBaseVersionDescriptor, targetVersionDescriptor?: GitTargetVersionDescriptor): Promise<GitCommitDiffs>

参数

repositoryId: string

存储库的名称或 ID。

project: string

项目 ID 或项目名称

diffCommonCommit: boolean

如果为 true，则公共提交和目标提交之间存在差异。如果为 false，则基本提交和目标提交之间存在差异。

top: number

要返回的最大更改数。默认为 100。

skip: number

要跳过的更改数

baseVersionDescriptor: GitBaseVersionDescriptor

基本提交的描述符。

targetVersionDescriptor: GitTargetVersionDescriptor

目标提交的描述符。

Promise<GitCommitDiffs>

getCommits(string, GitQueryCommitsCriteria, string)

检索项目的 git 提交

function getCommits(repositoryId: string, searchCriteria: GitQueryCommitsCriteria, project?: string): Promise<GitCommitRef[]>

参数

repositoryId: string

存储库的 ID 或友好名称。若要使用友好名称，还必须指定 projectId。

searchCriteria: GitQueryCommitsCriteria

project: string

项目 ID 或项目名称

Promise<GitCommitRef[]>

getCommitsBatch(GitQueryCommitsCriteria, string, string, number, number, boolean)

检索符合搜索条件的项目的 git 提交

function getCommitsBatch(searchCriteria: GitQueryCommitsCriteria, repositoryId: string, project?: string, skip?: number, top?: number, includeStatuses?: boolean): Promise<GitCommitRef[]>

参数

searchCriteria: GitQueryCommitsCriteria

搜索选项

repositoryId: string

存储库的名称或 ID。

project: string

项目 ID 或项目名称

skip: number

要跳过的提交数。该值不能超过 3,000,000。

top: number

要返回的最大提交数。该值不能超过 50,000。

includeStatuses: boolean

如果为 True，则包含其他提交状态信息。

Promise<GitCommitRef[]>

getDeletedRepositories(string)

检索已删除的 Git 存储库。

function getDeletedRepositories(project: string): Promise<GitDeletedRepository[]>

参数

project: string

项目 ID 或项目名称

Promise<GitDeletedRepository[]>

getEnablementStatus(string[], Date, number, number)

项目的存储库的 GET 启用状态。

function getEnablementStatus(projectIds?: string[], billingDate?: Date, skip?: number, take?: number): Promise<AdvSecEnablementStatus[]>

参数

projectIds: string[]

主机中的所有项目默认为 Null，要返回的项目存储库状态列表

billingDate: Date

UTC 预期，Null 默认为 UtcNow () ，可为时间点状态提供

skip: number

跳过结果集的 X 行以模拟分页。

take: number

返回结果集的 Y 行以模拟分页。

Promise<AdvSecEnablementStatus[]>

getEnableOnCreateHost(boolean)

function getEnableOnCreateHost(enableOnCreateHost: boolean): Promise<boolean>

参数

enableOnCreateHost: boolean

Promise<boolean>

getEnableOnCreateProject(string)

function getEnableOnCreateProject(enableOnCreateProjectId: string): Promise<boolean>

参数

enableOnCreateProjectId: string

Promise<boolean>

getEstimatedBillableCommittersRepo(string, string)

获取过去 90 天内存储库的估计可计费提交者。

function getEstimatedBillableCommittersRepo(project: string, repositoryId: string): Promise<BillableCommitter[]>

参数

project: string

项目 ID 或项目名称

repositoryId: string

Promise<BillableCommitter[]>

getEstimatedBillablePushersOrg()

获取过去 90 天内组织的估计可计费推送器。

function getEstimatedBillablePushersOrg(): Promise<BillablePusher[]>

Promise<BillablePusher[]>

getEstimatedBillablePushersProject(string)

获取过去 90 天内项目的估计可计费推送器。

function getEstimatedBillablePushersProject(project: string): Promise<BillablePusher[]>

参数

project: string

项目 ID 或项目名称

Promise<BillablePusher[]>

getFileDiffs(FileDiffsCriteria, string, string)

获取每个指定文件的文件差异

function getFileDiffs(fileDiffsCriteria: FileDiffsCriteria, project: string, repositoryId: string): Promise<FileDiff[]>

参数

fileDiffsCriteria: FileDiffsCriteria

文件参数对象列表

project: string

项目 ID 或项目名称

repositoryId: string

存储库的名称或 ID

Promise<FileDiff[]>

getForks(string, string, string, boolean)

检索集合中存储库的所有分支。

function getForks(repositoryNameOrId: string, collectionId: string, project?: string, includeLinks?: boolean): Promise<GitRepositoryRef[]>

参数

repositoryNameOrId: string

存储库的名称或 ID。

collectionId: string

团队项目集合 ID。

project: string

项目 ID 或项目名称

includeLinks: boolean

如果为 True，则包含链接。

Promise<GitRepositoryRef[]>

getForkSyncRequest(string, number, string, boolean)

获取特定分支同步操作的详细信息。

function getForkSyncRequest(repositoryNameOrId: string, forkSyncOperationId: number, project?: string, includeLinks?: boolean): Promise<GitForkSyncRequest>

参数

repositoryNameOrId: string

存储库的名称或 ID。

forkSyncOperationId: number

同步请求的 OperationId。

project: string

项目 ID 或项目名称

includeLinks: boolean

如果为 True，则包含链接。

Promise<GitForkSyncRequest>

getForkSyncRequests(string, string, boolean, boolean)

检索此存储库上请求的所有分叉同步操作。

function getForkSyncRequests(repositoryNameOrId: string, project?: string, includeAbandoned?: boolean, includeLinks?: boolean): Promise<GitForkSyncRequest[]>

参数

repositoryNameOrId: string

存储库的名称或 ID。

project: string

项目 ID 或项目名称

includeAbandoned: boolean

如果为 True，则包含已放弃的请求。

includeLinks: boolean

如果为 True，则包含链接。

Promise<GitForkSyncRequest[]>

getHfsItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

获取单个项的项元数据和/或内容。 download 参数用于指示内容是应作为下载内容提供，还是仅作为响应中的流发送。不适用于始终作为下载返回的压缩内容。

function getHfsItem(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveHfs?: boolean, sanitize?: boolean): Promise<GitItem>

参数

repositoryId: string

存储库的名称或 ID。

path: string

项路径。

project: string

项目 ID 或项目名称

scopePath: string

路径范围。默认值为 NULL。

recursionLevel: VersionControlRecursionType

此请求的递归级别。默认值为“none”，无递归。

includeContentMetadata: boolean

设置为 true 以包含内容元数据。默认值为 false。

latestProcessedChange: boolean

设置为 true 以包含最新更改。默认值为 false。

download: boolean

设置为 true 以文件的形式下载响应。默认值为 false。

versionDescriptor: GitVersionDescriptor

版本描述符。默认值是存储库的默认分支。

includeContent: boolean

设置为 true 以在请求 json 时包含项内容。默认值为 false。

resolveHfs: boolean

设置为 true 可解析 Git HFS 指针文件以从 Git HFS 返回实际内容。默认为 true。

sanitize: boolean

设置为 true 可清理 svg 文件并将其作为图像返回。仅当请求 svg 文件时有用。默认值为 false。

Promise<GitItem>

getHfsItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getHfsItemContent(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveHfs?: boolean, sanitize?: boolean): Promise<ArrayBuffer>

参数

repositoryId: string

存储库的名称或 ID。

path: string

项路径。

project: string

项目 ID 或项目名称

scopePath: string

路径范围。默认值为 NULL。

recursionLevel: VersionControlRecursionType

此请求的递归级别。默认值为“none”，无递归。

includeContentMetadata: boolean

设置为 true 以包含内容元数据。默认值为 false。

latestProcessedChange: boolean

设置为 true 以包含最新更改。默认值为 false。

download: boolean

设置为 true 以文件的形式下载响应。默认值为 false。

versionDescriptor: GitVersionDescriptor

版本描述符。默认值是存储库的默认分支。

includeContent: boolean

设置为 true 以在请求 json 时包含项内容。默认值为 false。

resolveHfs: boolean

设置为 true 可解析 Git HFS 指针文件以从 Git HFS 返回实际内容。默认为 true。

sanitize: boolean

设置为 true 可清理 svg 文件并将其作为图像返回。仅当请求 svg 文件时有用。默认值为 false。

Promise<ArrayBuffer>

getHfsItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)

获取项集合的项元数据和/或内容。 download 参数用于指示内容是应作为下载内容提供，还是仅作为响应中的流发送。不适用于始终作为下载返回的压缩内容。

function getHfsItems(repositoryId: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, includeLinks?: boolean, versionDescriptor?: GitVersionDescriptor, zipForUnix?: boolean): Promise<GitItem[]>

参数

repositoryId: string

存储库的名称或 ID。

project: string

项目 ID 或项目名称

scopePath: string

路径范围。默认值为 NULL。

recursionLevel: VersionControlRecursionType

此请求的递归级别。默认值为“none”，无递归。

includeContentMetadata: boolean

设置为 true 以包含内容元数据。默认值为 false。

latestProcessedChange: boolean

设置为 true 以包含最新更改。默认值为 false。

download: boolean

设置为 true 以文件的形式下载响应。默认值为 false。

includeLinks: boolean

设置为 true 以包含指向项的链接。默认值为 false。

versionDescriptor: GitVersionDescriptor

版本描述符。默认值是存储库的默认分支。

zipForUnix: boolean

设置为 true 以保留 unix (和 POSIX) 系统（如可执行文件和符号链接）的文件权限

Promise<GitItem[]>

getHfsItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getHfsItemText(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveHfs?: boolean, sanitize?: boolean): Promise<string>

参数

repositoryId: string

存储库的名称或 ID。

path: string

项路径。

project: string

项目 ID 或项目名称

scopePath: string

路径范围。默认值为 NULL。

recursionLevel: VersionControlRecursionType

此请求的递归级别。默认值为“none”，无递归。

includeContentMetadata: boolean

设置为 true 以包含内容元数据。默认值为 false。

latestProcessedChange: boolean

设置为 true 以包含最新更改。默认值为 false。

download: boolean

设置为 true 以文件的形式下载响应。默认值为 false。

versionDescriptor: GitVersionDescriptor

版本描述符。默认值是存储库的默认分支。

includeContent: boolean

设置为 true 以在请求 json 时包含项内容。默认值为 false。

resolveHfs: boolean

设置为 true 可解析 Git HFS 指针文件以从 Git HFS 返回实际内容。默认为 true。

sanitize: boolean

设置为 true 可清理 svg 文件并将其作为图像返回。仅当请求 svg 文件时有用。默认值为 false。

Promise<string>

getHfsItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getHfsItemZip(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveHfs?: boolean, sanitize?: boolean): Promise<ArrayBuffer>

参数

repositoryId: string

存储库的名称或 ID。

path: string

项路径。

project: string

项目 ID 或项目名称

scopePath: string

路径范围。默认值为 NULL。

recursionLevel: VersionControlRecursionType

此请求的递归级别。默认值为“none”，无递归。

includeContentMetadata: boolean

设置为 true 以包含内容元数据。默认值为 false。

latestProcessedChange: boolean

设置为 true 以包含最新更改。默认值为 false。

download: boolean

设置为 true 以文件的形式下载响应。默认值为 false。

versionDescriptor: GitVersionDescriptor

版本描述符。默认值是存储库的默认分支。

includeContent: boolean

设置为 true 以在请求 json 时包含项内容。默认值为 false。

resolveHfs: boolean

设置为 true 可解析 Git HFS 指针文件以从 Git HFS 返回实际内容。默认为 true。

sanitize: boolean

设置为 true 可清理 svg 文件并将其作为图像返回。仅当请求 svg 文件时有用。默认值为 false。

Promise<ArrayBuffer>

getImportRequest(string, string, number)

检索特定的导入请求。

function getImportRequest(project: string, repositoryId: string, importRequestId: number): Promise<GitImportRequest>

参数

project: string

项目 ID 或项目名称

repositoryId: string

存储库的名称或 ID。

importRequestId: number

导入请求的唯一标识符。

Promise<GitImportRequest>

getItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getItem(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveLfs?: boolean, sanitize?: boolean): Promise<GitItem>

参数

repositoryId: string

存储库的名称或 ID。

path: string

项路径。

project: string

项目 ID 或项目名称

scopePath: string

路径范围。默认值为 NULL。

recursionLevel: VersionControlRecursionType

此请求的递归级别。默认值为“none”，无递归。

includeContentMetadata: boolean

设置为 true 以包含内容元数据。默认值为 false。

latestProcessedChange: boolean

设置为 true 以包含最新更改。默认值为 false。

download: boolean

设置为 true 以文件的形式下载响应。默认值为 false。

versionDescriptor: GitVersionDescriptor

版本描述符。默认值是存储库的默认分支。

includeContent: boolean

设置为 true 以在请求 json 时包含项内容。默认值为 false。

resolveLfs: boolean

设置为 true 可解析 Git LFS 指针文件以从 Git LFS 返回实际内容。默认值为 false。

sanitize: boolean

设置为 true 可清理 svg 文件并将其作为图像返回。仅当请求 svg 文件时有用。默认值为 false。

Promise<GitItem>

getItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getItemContent(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveLfs?: boolean, sanitize?: boolean): Promise<ArrayBuffer>

参数

repositoryId: string

存储库的名称或 ID。

path: string

项路径。

project: string

项目 ID 或项目名称

scopePath: string

路径范围。默认值为 NULL。

recursionLevel: VersionControlRecursionType

此请求的递归级别。默认值为“none”，无递归。

includeContentMetadata: boolean

设置为 true 以包含内容元数据。默认值为 false。

latestProcessedChange: boolean

设置为 true 以包含最新更改。默认值为 false。

download: boolean

设置为 true 以文件的形式下载响应。默认值为 false。

versionDescriptor: GitVersionDescriptor

版本描述符。默认值是存储库的默认分支。

includeContent: boolean

设置为 true 以在请求 json 时包含项内容。默认值为 false。

resolveLfs: boolean

设置为 true 可解析 Git LFS 指针文件以从 Git LFS 返回实际内容。默认值为 false。

sanitize: boolean

设置为 true 可清理 svg 文件并将其作为图像返回。仅当请求 svg 文件时有用。默认值为 false。

Promise<ArrayBuffer>

getItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)

function getItems(repositoryId: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, includeLinks?: boolean, versionDescriptor?: GitVersionDescriptor, zipForUnix?: boolean): Promise<GitItem[]>

参数

repositoryId: string

存储库的名称或 ID。

project: string

项目 ID 或项目名称

scopePath: string

路径范围。默认值为 NULL。

recursionLevel: VersionControlRecursionType

此请求的递归级别。默认值为“none”，无递归。

includeContentMetadata: boolean

设置为 true 以包含内容元数据。默认值为 false。

latestProcessedChange: boolean

设置为 true 以包含最新更改。默认值为 false。

download: boolean

设置为 true 以文件的形式下载响应。默认值为 false。

includeLinks: boolean

设置为 true 以包含指向项的链接。默认值为 false。

versionDescriptor: GitVersionDescriptor

版本描述符。默认值是存储库的默认分支。

zipForUnix: boolean

设置为 true 以保留 unix (和 POSIX) 系统（如可执行文件和符号链接）的文件权限

Promise<GitItem[]>

getItemsBatch(GitItemRequestData, string, string)

在给定路径列表或长路径的情况下，检索从存储库/项目中的一组项中创建批的 Post

function getItemsBatch(requestData: GitItemRequestData, repositoryId: string, project?: string): Promise<GitItem[][]>

参数

requestData: GitItemRequestData

请求数据属性：ItemDescriptors、IncludeContentMetadata、LatestProcessedChange、IncludeLinks。 ItemDescriptors：要提取的项的集合，包括路径、版本和递归级别。 IncludeContentMetadata：是否包括所有项的元数据 LatestProcessedChange：是否包含浅层 ref 以提交上次更改的每个项。 IncludeLinks：是否在浅层引用中包含 _links 字段。

repositoryId: string

存储库的名称或 ID

project: string

项目 ID 或项目名称

Promise<GitItem[][]>

getItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getItemText(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveLfs?: boolean, sanitize?: boolean): Promise<string>

参数

repositoryId: string

存储库的名称或 ID。

path: string

项路径。

project: string

项目 ID 或项目名称

scopePath: string

路径范围。默认值为 NULL。

recursionLevel: VersionControlRecursionType

此请求的递归级别。默认值为“none”，无递归。

includeContentMetadata: boolean

设置为 true 以包含内容元数据。默认值为 false。

latestProcessedChange: boolean

设置为 true 以包含最新更改。默认值为 false。

download: boolean

设置为 true 以文件的形式下载响应。默认值为 false。

versionDescriptor: GitVersionDescriptor

版本描述符。默认值是存储库的默认分支。

includeContent: boolean

设置为 true 以在请求 json 时包含项内容。默认值为 false。

resolveLfs: boolean

设置为 true 可解析 Git LFS 指针文件以从 Git LFS 返回实际内容。默认值为 false。

sanitize: boolean

设置为 true 可清理 svg 文件并将其作为图像返回。仅当请求 svg 文件时有用。默认值为 false。

Promise<string>

getItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getItemZip(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveLfs?: boolean, sanitize?: boolean): Promise<ArrayBuffer>

参数

repositoryId: string

存储库的名称或 ID。

path: string

项路径。

project: string

项目 ID 或项目名称

scopePath: string

路径范围。默认值为 NULL。

recursionLevel: VersionControlRecursionType

此请求的递归级别。默认值为“none”，无递归。

includeContentMetadata: boolean

设置为 true 以包含内容元数据。默认值为 false。

latestProcessedChange: boolean

设置为 true 以包含最新更改。默认值为 false。

download: boolean

设置为 true 以文件的形式下载响应。默认值为 false。

versionDescriptor: GitVersionDescriptor

版本描述符。默认值是存储库的默认分支。

includeContent: boolean

设置为 true 以在请求 json 时包含项内容。默认值为 false。

resolveLfs: boolean

设置为 true 可解析 Git LFS 指针文件以从 Git LFS 返回实际内容。默认值为 false。

sanitize: boolean

设置为 true 可清理 svg 文件并将其作为图像返回。仅当请求 svg 文件时有用。默认值为 false。

Promise<ArrayBuffer>

getLikes(string, number, number, number, string)

获取评论的点赞。

function getLikes(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<IdentityRef[]>

参数

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

threadId: number

包含注释的线程的 ID。

commentId: number

注释的 ID。

project: string

项目 ID 或项目名称

Promise<IdentityRef[]>

getMergeBases(string, string, string, string, string, string)

查找两个提交的合并基数，可以选择跨分支查找。如果未指定 otherRepositoryId，则只会在本地存储库NameOrId 的上下文中计算合并基数。

function getMergeBases(repositoryNameOrId: string, commitId: string, otherCommitId: string, project?: string, otherCollectionId?: string, otherRepositoryId?: string): Promise<GitCommitRef[]>

参数

repositoryNameOrId: string

本地存储库的 ID 或名称。

commitId: string

第一次提交，通常是潜在合并的目标分支的提示。

otherCommitId: string

其他提交，通常是潜在合并的源分支的提示。

project: string

项目 ID 或项目名称

otherCollectionId: string

otherCommitId 所在的集合 ID。

otherRepositoryId: string

otherCommitId 所在的存储库 ID。

Promise<GitCommitRef[]>

getMergeRequest(string, string, number, boolean)

获取特定合并操作的详细信息。

function getMergeRequest(project: string, repositoryNameOrId: string, mergeOperationId: number, includeLinks?: boolean): Promise<GitMerge>

参数

project: string

项目 ID 或项目名称

repositoryNameOrId: string

存储库的名称或 ID。

mergeOperationId: number

合并请求的 OperationId。

includeLinks: boolean

如果为 True，则包含链接

Promise<GitMerge>

getPermission(string, string, string)

GET 高级安全权限状态。

function getPermission(projectName?: string, repositoryId?: string, permission?: string): Promise<boolean>

参数

projectName: string

repositoryId: string

存储库用户正在尝试访问

permission: string

请求的权限必须为“viewAlert”、“dismissAlert”、“manage”、“viewEnablement”或“repoRead”

Promise<boolean>

getPullRequest(string, number, string, number, number, number, boolean, boolean)

检索拉取请求。

function getPullRequest(repositoryId: string, pullRequestId: number, project?: string, maxCommentLength?: number, skip?: number, top?: number, includeCommits?: boolean, includeWorkItemRefs?: boolean): Promise<GitPullRequest>

参数

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

要检索的拉取请求的 ID。

project: string

项目 ID 或项目名称

maxCommentLength: number

未使用。

skip: number

未使用。

top: number

未使用。

includeCommits: boolean

如果为 true，将返回拉取请求以及关联的提交。

includeWorkItemRefs: boolean

如果为 true，将返回拉取请求以及关联的工作项引用。

Promise<GitPullRequest>

getPullRequestById(number, string)

检索拉取请求。

function getPullRequestById(pullRequestId: number, project?: string): Promise<GitPullRequest>

参数

pullRequestId: number

要检索的拉取请求的 ID。

project: string

项目 ID 或项目名称

Promise<GitPullRequest>

getPullRequestCommits(string, number, string)

获取指定拉取请求的提交。

function getPullRequestCommits(repositoryId: string, pullRequestId: number, project?: string): Promise<PagedList<GitCommitRef>>

参数

repositoryId: string

存储库的 ID 或名称。

pullRequestId: number

拉取请求的 ID。

project: string

项目 ID 或项目名称

Promise<PagedList<GitCommitRef>>

getPullRequestConflict(string, number, number, string)

按 ID 检索拉取请求的一个冲突

function getPullRequestConflict(repositoryId: string, pullRequestId: number, conflictId: number, project?: string): Promise<GitConflict>

参数

repositoryId: string

pullRequestId: number

conflictId: number

project: string

项目 ID 或项目名称

Promise<GitConflict>

getPullRequestConflicts(string, number, string, number, number, boolean, boolean, boolean)

检索拉取请求的所有冲突

function getPullRequestConflicts(repositoryId: string, pullRequestId: number, project?: string, skip?: number, top?: number, includeObsolete?: boolean, excludeResolved?: boolean, onlyResolved?: boolean): Promise<GitConflict[]>

参数

repositoryId: string

拉取请求的存储库。

pullRequestId: number

拉取请求 ID。

project: string

项目 ID 或项目名称

skip: number

要跳过的冲突。

top: number

跳过后返回的冲突。

includeObsolete: boolean

包括过时的冲突。

excludeResolved: boolean

排除已解决的冲突。

onlyResolved: boolean

仅返回已解决的冲突。

Promise<GitConflict[]>

getPullRequestIteration(string, number, number, string)

获取拉取请求的指定迭代。

function getPullRequestIteration(repositoryId: string, pullRequestId: number, iterationId: number, project?: string): Promise<GitPullRequestIteration>

参数

repositoryId: string

存储库的 ID 或名称。

pullRequestId: number

拉取请求的 ID。

iterationId: number

要返回的拉取请求迭代的 ID。

project: string

项目 ID 或项目名称

Promise<GitPullRequestIteration>

getPullRequestIterationChanges(string, number, number, string, number, number, number)

检索在两次迭代之间的拉取请求中所做的更改。

function getPullRequestIterationChanges(repositoryId: string, pullRequestId: number, iterationId: number, project?: string, top?: number, skip?: number, compareTo?: number): Promise<GitPullRequestIterationChanges>

参数

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

iterationId: number

拉取请求迭代的 ID。 <br /> 迭代 1 是创建拉取请求时源分支的头，当有推送到源分支时，将创建后续迭代。允许的值介于 1 和此拉取请求的最大迭代之间。

project: string

项目 ID 或项目名称

top: number

可选。要检索的更改数。默认值为 100，最大值为 2000。

skip: number

可选。要忽略的更改数。例如，若要检索更改 101-150，请将前 50 设置为 100。

compareTo: number

要与之进行比较的拉取请求迭代的 ID。默认值为零，表示与源分支和目标分支之间的常见提交进行比较

Promise<GitPullRequestIterationChanges>

getPullRequestIterationCommits(string, number, number, string, number, number)

获取拉取请求的指定迭代的提交。

function getPullRequestIterationCommits(repositoryId: string, pullRequestId: number, iterationId: number, project?: string, top?: number, skip?: number): Promise<GitCommitRef[]>

参数

repositoryId: string

存储库的 ID 或名称。

pullRequestId: number

拉取请求的 ID。

iterationId: number

要从中获取提交的迭代的 ID。

project: string

项目 ID 或项目名称

top: number

要返回的最大提交数。每批可返回的最大提交数为 500。

skip: number

要跳过的提交数。

Promise<GitCommitRef[]>

getPullRequestIterations(string, number, string, boolean)

获取指定拉取请求的迭代列表。

function getPullRequestIterations(repositoryId: string, pullRequestId: number, project?: string, includeCommits?: boolean): Promise<GitPullRequestIteration[]>

参数

repositoryId: string

存储库的 ID 或名称。

pullRequestId: number

拉取请求的 ID。

project: string

项目 ID 或项目名称

includeCommits: boolean

如果为 true，请在响应中包含与每个迭代关联的提交。

Promise<GitPullRequestIteration[]>

getPullRequestIterationStatus(string, number, number, number, string)

按 ID 获取特定的拉取请求迭代状态。状态 ID 在所有迭代的拉取请求中是唯一的。

function getPullRequestIterationStatus(repositoryId: string, pullRequestId: number, iterationId: number, statusId: number, project?: string): Promise<GitPullRequestStatus>

参数

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

iterationId: number

拉取请求迭代的 ID。

statusId: number

拉取请求状态的 ID。

project: string

项目 ID 或项目名称

Promise<GitPullRequestStatus>

getPullRequestIterationStatuses(string, number, number, string)

获取与拉取请求迭代关联的所有状态。

function getPullRequestIterationStatuses(repositoryId: string, pullRequestId: number, iterationId: number, project?: string): Promise<GitPullRequestStatus[]>

参数

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

iterationId: number

拉取请求迭代的 ID。

project: string

项目 ID 或项目名称

Promise<GitPullRequestStatus[]>

getPullRequestLabel(string, number, string, string, string)

检索已分配给拉取请求的单个标签 (标记) 。

function getPullRequestLabel(repositoryId: string, pullRequestId: number, labelIdOrName: string, project?: string, projectId?: string): Promise<WebApiTagDefinition>

参数

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

labelIdOrName: string

请求的标签的名称或 ID。

project: string

项目 ID 或项目名称

projectId: string

项目 ID 或项目名称。

Promise<WebApiTagDefinition>

getPullRequestLabels(string, number, string, string)

获取) 分配给拉取请求的所有标签 (标记。

function getPullRequestLabels(repositoryId: string, pullRequestId: number, project?: string, projectId?: string): Promise<WebApiTagDefinition[]>

参数

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

project: string

项目 ID 或项目名称

projectId: string

项目 ID 或项目名称。

Promise<WebApiTagDefinition[]>

getPullRequestProperties(string, number, string)

获取拉取请求的外部属性。

function getPullRequestProperties(repositoryId: string, pullRequestId: number, project?: string): Promise<any>

参数

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

project: string

项目 ID 或项目名称

Promise<any>

getPullRequestQuery(GitPullRequestQuery, string, string)

此 API 用于查找与给定提交相关的拉取请求。它可用于查找创建特定合并提交的拉取请求，也可以用于查找曾经合并过特定提交的所有拉取请求。输入是查询列表，每个查询都包含一个提交列表。对于搜索的每个提交，你将返回一个提交 -> 拉取请求字典。

function getPullRequestQuery(queries: GitPullRequestQuery, repositoryId: string, project?: string): Promise<GitPullRequestQuery>

参数

queries: GitPullRequestQuery

要执行的查询列表。

repositoryId: string

存储库的 ID。

project: string

项目 ID 或项目名称

Promise<GitPullRequestQuery>

getPullRequestReviewer(string, number, string, string)

检索有关拉取请求的特定审阅者的信息

function getPullRequestReviewer(repositoryId: string, pullRequestId: number, reviewerId: string, project?: string): Promise<IdentityRefWithVote>

参数

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

reviewerId: string

审阅者的 ID。

project: string

项目 ID 或项目名称

Promise<IdentityRefWithVote>

getPullRequestReviewers(string, number, string)

检索拉取请求的审阅者

function getPullRequestReviewers(repositoryId: string, pullRequestId: number, project?: string): Promise<IdentityRefWithVote[]>

参数

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

project: string

项目 ID 或项目名称

Promise<IdentityRefWithVote[]>

getPullRequests(string, GitPullRequestSearchCriteria, string, number, number, number)

检索与指定条件匹配的所有拉取请求。

function getPullRequests(repositoryId: string, searchCriteria: GitPullRequestSearchCriteria, project?: string, maxCommentLength?: number, skip?: number, top?: number): Promise<GitPullRequest[]>

参数

repositoryId: string

拉取请求的目标分支的存储库 ID。

searchCriteria: GitPullRequestSearchCriteria

将返回与此搜索条件匹配的拉取请求。

project: string

项目 ID 或项目名称

maxCommentLength: number

未使用。

skip: number

要忽略的拉取请求数。例如，若要检索结果 101-150，请将 top 设置为 50，然后跳到 100。

top: number

要检索的拉取请求数。

Promise<GitPullRequest[]>

getPullRequestsByProject(string, GitPullRequestSearchCriteria, number, number, number)

检索与指定条件匹配的所有拉取请求。

function getPullRequestsByProject(project: string, searchCriteria: GitPullRequestSearchCriteria, maxCommentLength?: number, skip?: number, top?: number): Promise<GitPullRequest[]>

参数

project: string

项目 ID 或项目名称

searchCriteria: GitPullRequestSearchCriteria

将返回与此搜索条件匹配的拉取请求。

maxCommentLength: number

未使用。

skip: number

要忽略的拉取请求数。例如，若要检索结果 101-150，请将 top 设置为 50，然后跳到 100。

top: number

要检索的拉取请求数。

Promise<GitPullRequest[]>

getPullRequestStatus(string, number, number, string)

按 ID 获取特定的拉取请求状态。在所有迭代中，状态 ID 在拉取请求中是唯一的。

function getPullRequestStatus(repositoryId: string, pullRequestId: number, statusId: number, project?: string): Promise<GitPullRequestStatus>

参数

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

statusId: number

拉取请求状态的 ID。

project: string

项目 ID 或项目名称

Promise<GitPullRequestStatus>

getPullRequestStatuses(string, number, string)

获取与拉取请求关联的所有状态。

function getPullRequestStatuses(repositoryId: string, pullRequestId: number, project?: string): Promise<GitPullRequestStatus[]>

参数

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

project: string

项目 ID 或项目名称

Promise<GitPullRequestStatus[]>

getPullRequestThread(string, number, number, string, number, number)

检索拉取请求中的线程。

function getPullRequestThread(repositoryId: string, pullRequestId: number, threadId: number, project?: string, iteration?: number, baseIteration?: number): Promise<GitPullRequestCommentThread>

参数

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

threadId: number

线程的 ID。

project: string

项目 ID 或项目名称

iteration: number

如果指定，则将使用此迭代作为差异的右侧来跟踪线程位置。

baseIteration: number

如果指定，则将使用此迭代作为差异的左侧跟踪线程位置。

Promise<GitPullRequestCommentThread>

getPullRequestWorkItemRefs(string, number, string)

检索与拉取请求关联的工作项的列表。

function getPullRequestWorkItemRefs(repositoryId: string, pullRequestId: number, project?: string): Promise<ResourceRef[]>

参数

repositoryId: string

存储库的 ID 或名称。

pullRequestId: number

拉取请求的 ID。

project: string

项目 ID 或项目名称

Promise<ResourceRef[]>

getPush(string, number, string, number, boolean)

检索特定推送。

function getPush(repositoryId: string, pushId: number, project?: string, includeCommits?: number, includeRefUpdates?: boolean): Promise<GitPush>

参数

repositoryId: string

存储库的名称或 ID。

pushId: number

推送的 ID。

project: string

项目 ID 或项目名称

includeCommits: number

要包含在结果中的提交数。

includeRefUpdates: boolean

如果为 true，则包括通过推送更新的引用列表。

Promise<GitPush>

getPushCommits(string, number, string, number, number, boolean)

检索与特定推送关联的提交列表。

function getPushCommits(repositoryId: string, pushId: number, project?: string, top?: number, skip?: number, includeLinks?: boolean): Promise<GitCommitRef[]>

参数

repositoryId: string

存储库的 ID 或友好名称。若要使用友好名称，还必须指定 projectId。

pushId: number

推送的 ID。

project: string

项目 ID 或项目名称

top: number

要返回的最大提交数 (“get the top x commits”) 。

skip: number

要跳过的提交数。

includeLinks: boolean

设置为 false 可避免包含资源的 REST URL 链接。默认为 true。

Promise<GitCommitRef[]>

getPushes(string, string, number, number, GitPushSearchCriteria)

检索与指定存储库关联的推送。

function getPushes(repositoryId: string, project?: string, skip?: number, top?: number, searchCriteria?: GitPushSearchCriteria): Promise<GitPush[]>

参数

repositoryId: string

存储库的名称或 ID。

project: string

项目 ID 或项目名称

skip: number

要跳过的推送数。

top: number

要返回的推送数。

searchCriteria: GitPushSearchCriteria

搜索条件属性：fromDate、toDate、pusherId、refName、includeRefUpdates 或 includeLinks。 fromDate：搜索的开始日期。 toDate：要搜索的结束日期。pusherId：提交推送的人员的标识。 refName：要考虑的分支名称。 includeRefUpdates：如果为 true，则包含通过推送更新的引用列表。 includeLinks：是否在浅表引用中包含_links字段。

Promise<GitPush[]>

getRecycleBinRepositories(string)

从回收站检索软删除的 git 存储库。

function getRecycleBinRepositories(project: string): Promise<GitDeletedRepository[]>

参数

project: string

项目 ID 或项目名称

Promise<GitDeletedRepository[]>

getRefFavorite(string, number)

获取收藏夹 ID 的引用收藏夹。

function getRefFavorite(project: string, favoriteId: number): Promise<GitRefFavorite>

参数

project: string

项目 ID 或项目名称

favoriteId: number

请求的引用收藏夹的 ID。

Promise<GitRefFavorite>

getRefFavorites(string, string, string)

获取存储库和标识的引用收藏夹。

function getRefFavorites(project: string, repositoryId?: string, identityId?: string): Promise<GitRefFavorite[]>

参数

project: string

项目 ID 或项目名称

repositoryId: string

存储库的 ID。

identityId: string

要检索其收藏夹的标识的 ID。如果为 null，则使用请求标识。

Promise<GitRefFavorite[]>

getRefFavoritesForProject(string, string)

function getRefFavoritesForProject(project: string, identityId?: string): Promise<GitRefFavorite[]>

参数

project: string

项目 ID 或项目名称

identityId: string

Promise<GitRefFavorite[]>

getRefs(string, string, string, boolean, boolean, boolean, boolean, boolean, string)

查询提供的存储库以获取其引用并返回它们。

function getRefs(repositoryId: string, project?: string, filter?: string, includeLinks?: boolean, includeStatuses?: boolean, includeMyBranches?: boolean, latestStatusesOnly?: boolean, peelTags?: boolean, filterContains?: string): Promise<PagedList<GitRef>>

参数

repositoryId: string

存储库的名称或 ID。

project: string

项目 ID 或项目名称

filter: string

[可选]应用于 refs (的筛选器以) 开头。

includeLinks: boolean

[可选]指定是否应在结果中包含 referenceLinks。默认值为 false。

includeStatuses: boolean

[可选]每个引用最多包含前 1000 个提交状态。默认值为 false。

includeMyBranches: boolean

[可选]仅包括用户拥有的分支、用户收藏的分支和默认分支。默认值为 false。不能与筛选器参数组合使用。

latestStatusesOnly: boolean

[可选]如果为 True，则仅包含每个引用的提示提交状态。此选项要求 includeStatuses 为 true。默认值为 false。

peelTags: boolean

[可选]带批注的标记将填充 PeeledObjectId 属性。默认值为 false。

filterContains: string

[可选]要应用于 ref 的筛选器 (包含) 。

Promise<PagedList<GitRef>>

getRepositories(string, boolean, boolean, boolean)

检索 git 存储库。

function getRepositories(project?: string, includeLinks?: boolean, includeAllUrls?: boolean, includeHidden?: boolean): Promise<GitRepository[]>

参数

project: string

项目 ID 或项目名称

includeLinks: boolean

[可选]如果为 True，则包含引用链接。默认值为 false。

includeAllUrls: boolean

[可选]如果为 True，则包含所有远程 URL。默认值为 false。

includeHidden: boolean

[可选]如果为 True，则包含隐藏的存储库。默认值为 false。

Promise<GitRepository[]>

getRepository(string, string)

检索 git 存储库。

function getRepository(repositoryId: string, project?: string): Promise<GitRepository>

参数

repositoryId: string

存储库的名称或 ID。

project: string

项目 ID 或项目名称

Promise<GitRepository>

getRepositoryWithParent(string, boolean, string)

检索 git 存储库。

function getRepositoryWithParent(repositoryId: string, includeParent: boolean, project?: string): Promise<GitRepository>

参数

repositoryId: string

存储库的名称或 ID。

includeParent: boolean

如果为 True，则包含父存储库。仅在经过身份验证的调用中可用。

project: string

项目 ID 或项目名称

Promise<GitRepository>

getRevert(string, number, string)

按还原 ID 检索有关还原操作的信息。

function getRevert(project: string, revertId: number, repositoryId: string): Promise<GitRevert>

参数

project: string

项目 ID 或项目名称

revertId: number

还原操作的 ID。

repositoryId: string

存储库的 ID。

Promise<GitRevert>

getRevertConflict(string, number, number, string)

按 ID 检索还原的一个冲突

function getRevertConflict(repositoryId: string, revertId: number, conflictId: number, project?: string): Promise<GitConflict>

参数

repositoryId: string

revertId: number

conflictId: number

project: string

项目 ID 或项目名称

Promise<GitConflict>

getRevertConflicts(string, number, string, string, number, boolean, boolean, boolean)

检索还原的所有冲突

function getRevertConflicts(repositoryId: string, revertId: number, project?: string, continuationToken?: string, top?: number, excludeResolved?: boolean, onlyResolved?: boolean, includeObsolete?: boolean): Promise<PagedList<GitConflict>>

参数

repositoryId: string

revertId: number

project: string

项目 ID 或项目名称

continuationToken: string

top: number

excludeResolved: boolean

onlyResolved: boolean

includeObsolete: boolean

Promise<PagedList<GitConflict>>

getRevertForRefName(string, string, string)

检索有关特定分支的还原操作的信息。

function getRevertForRefName(project: string, repositoryId: string, refName: string): Promise<GitRevert>

参数

project: string

项目 ID 或项目名称

repositoryId: string

存储库的 ID。

refName: string

用于还原操作的 GitAsyncRefOperationParameters generatedRefName。

Promise<GitRevert>

getStatuses(string, string, string, number, number, boolean)

获取与 Git 提交关联的状态。

function getStatuses(commitId: string, repositoryId: string, project?: string, top?: number, skip?: number, latestOnly?: boolean): Promise<GitStatus[]>

参数

commitId: string

Git 提交的 ID。

repositoryId: string

存储库的 ID。

project: string

项目 ID 或项目名称

top: number

可选。要检索的状态数。默认值为 1000。

skip: number

可选。要忽略的状态数。默认为 0。例如，若要检索结果 101-150，请将 top 设置为 50，然后跳到 100。

latestOnly: boolean

标志指示是否仅获取按 Context.Name 和 Context.Genre分组的最新状态。

Promise<GitStatus[]>

getSuggestions(string, string, boolean)

检索特定存储库或团队项目的拉取请求建议。

function getSuggestions(repositoryId: string, project?: string, preferCompareBranch?: boolean): Promise<GitSuggestion[]>

参数

repositoryId: string

git 存储库的 ID。

project: string

项目 ID 或项目名称

preferCompareBranch: boolean

如果为 true，则首选比较分支而不是默认分支作为拉取请求的目标分支。

Promise<GitSuggestion[]>

getThreads(string, number, string, number, number)

检索拉取请求中的所有线程。

function getThreads(repositoryId: string, pullRequestId: number, project?: string, iteration?: number, baseIteration?: number): Promise<GitPullRequestCommentThread[]>

参数

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

project: string

项目 ID 或项目名称

iteration: number

如果指定，则将使用此迭代作为差异的右侧跟踪线程位置。

baseIteration: number

如果指定，则将使用此迭代作为差异的左侧来跟踪线程位置。

Promise<GitPullRequestCommentThread[]>

getTree(string, string, string, string, boolean, string)

树终结点返回指定树下的对象集合。树是 Git 存储库中的文件夹。

function getTree(repositoryId: string, sha1: string, project?: string, projectId?: string, recursive?: boolean, fileName?: string): Promise<GitTreeRef>

参数

repositoryId: string

存储库 ID。

sha1: string

树对象的 SHA1 哈希。

project: string

项目 ID 或项目名称

projectId: string

项目 ID。

recursive: boolean

以递归方式搜索。在此树下包括树。默认值为 false。

fileName: string

返回 .zip 文件时要使用的名称。默认值为对象 ID。

Promise<GitTreeRef>

getTreeZip(string, string, string, string, boolean, string)

树终结点返回指定树下的对象集合。树是 Git 存储库中的文件夹。

function getTreeZip(repositoryId: string, sha1: string, project?: string, projectId?: string, recursive?: boolean, fileName?: string): Promise<ArrayBuffer>

参数

repositoryId: string

存储库 ID。

sha1: string

树对象的 SHA1 哈希。

project: string

项目 ID 或项目名称

projectId: string

项目 ID。

recursive: boolean

以递归方式搜索。在此树下包括树。默认值为 false。

fileName: string

返回 .zip 文件时要使用的名称。默认值为对象 ID。

Promise<ArrayBuffer>

queryImportRequests(string, string, boolean)

检索存储库的导入请求。

function queryImportRequests(project: string, repositoryId: string, includeAbandoned?: boolean): Promise<GitImportRequest[]>

参数

project: string

项目 ID 或项目名称

repositoryId: string

存储库的名称或 ID。

includeAbandoned: boolean

如果为 True，则结果中包含放弃的导入请求。

Promise<GitImportRequest[]>

restoreRepositoryFromRecycleBin(GitRecycleBinRepositoryDetails, string, string)

恢复软删除的 Git 存储库。最近删除的存储库先以软删除状态保留一段时间，然后才被硬删除且不可恢复。

function restoreRepositoryFromRecycleBin(repositoryDetails: GitRecycleBinRepositoryDetails, project: string, repositoryId: string): Promise<GitRepository>

参数

repositoryDetails: GitRecycleBinRepositoryDetails

project: string

项目 ID 或项目名称

repositoryId: string

存储库的 ID。

Promise<GitRepository>

setEnableOnCreateHost(boolean)

function setEnableOnCreateHost(enableOnCreateHost: boolean): Promise<void>

参数

enableOnCreateHost: boolean

Promise<void>

setEnableOnCreateProject(string, boolean)

function setEnableOnCreateProject(enableOnCreateProjectId: string, enableOnStatus: boolean): Promise<void>

参数

enableOnCreateProjectId: string

enableOnStatus: boolean

Promise<void>

sharePullRequest(ShareNotificationContext, string, number, string)

向一组收件人发送有关特定拉取请求的电子邮件通知

function sharePullRequest(userMessage: ShareNotificationContext, repositoryId: string, pullRequestId: number, project?: string): Promise<void>

参数

userMessage: ShareNotificationContext

repositoryId: string

git 存储库的 ID。

pullRequestId: number

拉取请求的 ID。

project: string

项目 ID 或项目名称

Promise<void>

updateCherryPickConflict(GitConflict, string, number, number, string)

更新合并冲突解决

function updateCherryPickConflict(conflict: GitConflict, repositoryId: string, cherryPickId: number, conflictId: number, project?: string): Promise<GitConflict>

参数

conflict: GitConflict

repositoryId: string

cherryPickId: number

conflictId: number

project: string

项目 ID 或项目名称

Promise<GitConflict>

updateCherryPickConflicts(GitConflict[], string, number, string)

更新多个合并冲突解决方法

function updateCherryPickConflicts(conflictUpdates: GitConflict[], repositoryId: string, cherryPickId: number, project?: string): Promise<GitConflictUpdateResult[]>

参数

conflictUpdates: GitConflict[]

repositoryId: string

cherryPickId: number

project: string

项目 ID 或项目名称

Promise<GitConflictUpdateResult[]>

updateComment(Comment, string, number, number, number, string)

更新与拉取请求中的特定线程关联的注释。

function updateComment(comment: Comment, repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<Comment>

参数

comment: Comment

应更新的注释内容。批注最多可以包含 150,000 个字符。

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

threadId: number

所需注释位于的线程的 ID。

commentId: number

要更新的注释的 ID。

project: string

项目 ID 或项目名称

Promise<Comment>

updateEnablementStatus(AdvSecEnablementUpdate[])

存储库的 POST 启用状态。

function updateEnablementStatus(enablementUpdates: AdvSecEnablementUpdate[]): Promise<void>

参数

enablementUpdates: AdvSecEnablementUpdate[]

Promise<void>

updateImportRequest(GitImportRequest, string, string, number)

重试或放弃失败的导入请求。

function updateImportRequest(importRequestToUpdate: GitImportRequest, project: string, repositoryId: string, importRequestId: number): Promise<GitImportRequest>

参数

importRequestToUpdate: GitImportRequest

导入请求的更新版本。目前，允许的唯一更改是将“状态”设置为“已排队”或“已放弃”。

project: string

项目 ID 或项目名称

repositoryId: string

存储库的名称或 ID。

importRequestId: number

要更新的导入请求的唯一标识符。

Promise<GitImportRequest>

updatePullRequest(GitPullRequest, string, number, string)

更新拉取请求

function updatePullRequest(gitPullRequestToUpdate: GitPullRequest, repositoryId: string, pullRequestId: number, project?: string): Promise<GitPullRequest>

参数

gitPullRequestToUpdate: GitPullRequest

应更新的拉取请求内容。

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

要更新的拉取请求的 ID。

project: string

项目 ID 或项目名称

Promise<GitPullRequest>

updatePullRequestConflict(GitConflict, string, number, number, string)

更新合并冲突解决

function updatePullRequestConflict(conflict: GitConflict, repositoryId: string, pullRequestId: number, conflictId: number, project?: string): Promise<GitConflict>

参数

conflict: GitConflict

repositoryId: string

pullRequestId: number

conflictId: number

project: string

项目 ID 或项目名称

Promise<GitConflict>

updatePullRequestConflicts(GitConflict[], string, number, string)

更新多个合并冲突解决方法

function updatePullRequestConflicts(conflictUpdates: GitConflict[], repositoryId: string, pullRequestId: number, project?: string): Promise<GitConflictUpdateResult[]>

参数

conflictUpdates: GitConflict[]

repositoryId: string

pullRequestId: number

project: string

项目 ID 或项目名称

Promise<GitConflictUpdateResult[]>

updatePullRequestIterationStatuses(JsonPatchDocument, string, number, number, string)

更新拉取请求迭代状态集合。唯一受支持的操作类型是 remove。

function updatePullRequestIterationStatuses(patchDocument: JsonPatchDocument, repositoryId: string, pullRequestId: number, iterationId: number, project?: string): Promise<void>

参数

patchDocument: JsonPatchDocument

以 JSON 修补程序格式应用于拉取请求状态的操作。

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

iterationId: number

拉取请求迭代的 ID。

project: string

项目 ID 或项目名称

Promise<void>

updatePullRequestProperties(JsonPatchDocument, string, number, string)

创建或更新拉取请求外部属性。修补操作可以是 add、 replace 或 remove。对于 add 操作，路径可以为空。如果路径为空，则该值必须是键值对的列表。对于 replace 操作，路径不能为空。如果该路径不存在，则会将属性添加到集合中。对于 remove 操作，路径不能为空。如果路径不存在，则不会执行任何操作。

function updatePullRequestProperties(patchDocument: JsonPatchDocument, repositoryId: string, pullRequestId: number, project?: string): Promise<any>

参数

patchDocument: JsonPatchDocument

用于以 JSON 修补程序格式添加、替换或删除的属性。

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

project: string

项目 ID 或项目名称

Promise<any>

updatePullRequestReviewer(IdentityRefWithVote, string, number, string, string)

编辑审阅者条目。这些字段可修补：isFlagged、hasDeclined

function updatePullRequestReviewer(reviewer: IdentityRefWithVote, repositoryId: string, pullRequestId: number, reviewerId: string, project?: string): Promise<IdentityRefWithVote>

参数

reviewer: IdentityRefWithVote

审阅者数据。<br />如果此处包含审阅者的 ID，则它必须与 reviewerID 参数匹配。

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

reviewerId: string

审阅者的 ID。

project: string

项目 ID 或项目名称

Promise<IdentityRefWithVote>

updatePullRequestReviewers(IdentityRefWithVote[], string, number, string)

重置多个审阅者对拉取请求的投票。注意：此终结点仅支持更新投票，但不支持更新所需的审阅者 (使用策略) 或显示名称。

function updatePullRequestReviewers(patchVotes: IdentityRefWithVote[], repositoryId: string, pullRequestId: number, project?: string): Promise<void>

参数

patchVotes: IdentityRefWithVote[]

其投票将重置为零的审阅者的 ID

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID

project: string

项目 ID 或项目名称

Promise<void>

updatePullRequestStatuses(JsonPatchDocument, string, number, string)

更新拉取请求状态集合。唯一受支持的操作类型是 remove。

function updatePullRequestStatuses(patchDocument: JsonPatchDocument, repositoryId: string, pullRequestId: number, project?: string): Promise<void>

参数

patchDocument: JsonPatchDocument

以 JSON 修补程序格式应用于拉取请求状态的操作。

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

project: string

项目 ID 或项目名称

Promise<void>

updateRef(GitRefUpdate, string, string, string, string)

锁定或解锁分支。

function updateRef(newRefInfo: GitRefUpdate, repositoryId: string, filter: string, project?: string, projectId?: string): Promise<GitRef>

参数

newRefInfo: GitRefUpdate

(锁定/解锁) 执行的 ref 更新操作

repositoryId: string

存储库的名称或 ID。

filter: string

要锁定/解锁的分支的名称

project: string

项目 ID 或项目名称

projectId: string

团队项目的 ID 或名称。如果指定存储库的 ID，则为可选。

Promise<GitRef>

updateRefs(GitRefUpdate[], string, string, string)

创建、更新或删除引用 (分支) 。

function updateRefs(refUpdates: GitRefUpdate[], repositoryId: string, project?: string, projectId?: string): Promise<GitRefUpdateResult[]>

参数

refUpdates: GitRefUpdate[]

要尝试执行的引用更新列表

repositoryId: string

存储库的名称或 ID。

project: string

项目 ID 或项目名称

projectId: string

团队项目的 ID 或名称。如果指定存储库的 ID，则为可选。

Promise<GitRefUpdateResult[]>

updateRepository(GitRepository, string, string)

使用新的存储库名称或新的默认分支更新 Git 存储库。

function updateRepository(newRepositoryInfo: GitRepository, repositoryId: string, project?: string): Promise<GitRepository>

参数

newRepositoryInfo: GitRepository

指定存储库的新存储库名称或新的默认分支

repositoryId: string

存储库的 ID。

project: string

项目 ID 或项目名称

Promise<GitRepository>

updateRevertConflict(GitConflict, string, number, number, string)

更新合并冲突解决

function updateRevertConflict(conflict: GitConflict, repositoryId: string, revertId: number, conflictId: number, project?: string): Promise<GitConflict>

参数

conflict: GitConflict

repositoryId: string

revertId: number

conflictId: number

project: string

项目 ID 或项目名称

Promise<GitConflict>

updateRevertConflicts(GitConflict[], string, number, string)

更新多个合并冲突解决方法

function updateRevertConflicts(conflictUpdates: GitConflict[], repositoryId: string, revertId: number, project?: string): Promise<GitConflictUpdateResult[]>

参数

conflictUpdates: GitConflict[]

repositoryId: string

revertId: number

project: string

项目 ID 或项目名称

Promise<GitConflictUpdateResult[]>

updateThread(GitPullRequestCommentThread, string, number, number, string)

更新拉取请求中的线程。

function updateThread(commentThread: GitPullRequestCommentThread, repositoryId: string, pullRequestId: number, threadId: number, project?: string): Promise<GitPullRequestCommentThread>

参数

commentThread: GitPullRequestCommentThread

应更新的线程内容。

repositoryId: string

拉取请求的目标分支的存储库 ID。

pullRequestId: number

拉取请求的 ID。

threadId: number

要更新的线程的 ID。

project: string

项目 ID 或项目名称

Promise<GitPullRequestCommentThread>