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)	建立 ref 我的最愛
createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)	要求將另一個存放庫的 ref 擷取到此存放庫。它會同步處理兩個現有的分叉。若要建立分叉，請參閱 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)	在反覆專案上建立提取要求狀態。此作業的結果與在要求本文中具有指定反覆專案標識碼的提取要求建立狀態相同。
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 刪除啟用狀態和 BillableCommitters 數據。刪除啟用數據將會有效地停用受影響的存放庫。
deleteLike(string, number, number, number, string)	移除註出的類似。
deletePullRequestIterationStatus(string, number, number, number, string)	刪除提取要求反覆項目狀態。
deletePullRequestLabels(string, number, string, string, string)	從指派給提取要求的標籤集合中移除標籤（tag）。標記本身將不會刪除。
deletePullRequestReviewer(string, number, string, string)	從提取要求中移除檢閱者。
deletePullRequestStatus(string, number, number, string)	刪除提取要求狀態。
deleteRefFavorite(string, number)	刪除指定的 refs 我的最愛
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)	依櫻桃挑選標識符擷取櫻桃挑選作業的相關信息。
getCherryPickConflict(string, number, number, string)	依標識符擷取櫻桃挑選的一個衝突
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)	取得單一專案的專案元數據和/或內容。下載參數是指出內容是否應該以下載的形式提供，或只是以響應中的數據流的形式傳送。不適用於壓縮的內容，該內容一律會以下載的形式傳回。
getHfsItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	取得單一專案的專案元數據和/或內容。下載參數是指出內容是否應該以下載的形式提供，或只是以響應中的數據流的形式傳送。不適用於壓縮的內容，該內容一律會以下載的形式傳回。
getHfsItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)	取得專案集合的專案元數據和/或內容。下載參數是指出內容是否應該以下載的形式提供，或只是以響應中的數據流的形式傳送。不適用於一律以下載方式傳回的壓縮內容。
getHfsItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	取得單一專案的專案元數據和/或內容。下載參數是指出內容是否應該以下載的形式提供，或只是以響應中的數據流的形式傳送。不適用於壓縮的內容，該內容一律會以下載的形式傳回。
getHfsItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	取得單一專案的專案元數據和/或內容。下載參數是指出內容是否應該以下載的形式提供，或只是以響應中的數據流的形式傳送。不適用於壓縮的內容，該內容一律會以下載的形式傳回。
getImportRequest(string, string, number)	擷取特定的匯入要求。
getItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	取得單一專案的專案元數據和/或內容。下載參數是指出內容是否應該以下載的形式提供，或只是以響應中的數據流的形式傳送。不適用於壓縮的內容，該內容一律會以下載的形式傳回。
getItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	取得單一專案的專案元數據和/或內容。下載參數是指出內容是否應該以下載的形式提供，或只是以響應中的數據流的形式傳送。不適用於壓縮的內容，該內容一律會以下載的形式傳回。
getItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)	取得專案集合的專案元數據和/或內容。下載參數是指出內容是否應該以下載的形式提供，或只是以響應中的數據流的形式傳送。不適用於一律以下載方式傳回的壓縮內容。
getItemsBatch(GitItemRequestData, string, string)	張貼以擷取從存放庫/專案中的一組專案中擷取批次，並指定路徑清單或長路徑
getItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	取得單一專案的專案元數據和/或內容。下載參數是指出內容是否應該以下載的形式提供，或只是以響應中的數據流的形式傳送。不適用於壓縮的內容，該內容一律會以下載的形式傳回。
getItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	取得單一專案的專案元數據和/或內容。下載參數是指出內容是否應該以下載的形式提供，或只是以響應中的數據流的形式傳送。不適用於壓縮的內容，該內容一律會以下載的形式傳回。
getLikes(string, number, number, number, string)	取得批注的讚。
getMergeBases(string, string, string, string, string, string)	尋找兩個認可的合併基底，選擇性地跨分支。如果未指定 otherRepositoryId，合併基底只會在本機 repositoryNameOrId 的內容中計算。
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)	依標識符擷取提取要求的一個衝突
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)	依標識元取得特定的提取要求反覆項目狀態。所有反覆專案的提取要求內的狀態標識碼是唯一的。
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)	依標識碼取得特定的提取要求狀態。所有反覆專案的提取要求內的狀態標識碼是唯一的。
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)	取得我的最愛標識碼的 refs favorites。
getRefFavorites(string, string, string)	取得存放庫和身分識別的 refs 我的最愛。
getRefFavoritesForProject(string, string)
getRefs(string, string, string, boolean, boolean, boolean, boolean, boolean, string)	查詢提供的存放庫，以取得其 refs 並傳回它們。
getRepositories(string, boolean, boolean, boolean)	擷取 Git 存放庫。
getRepositoriesPaged(string, boolean, boolean, boolean, string, number, string)	依名稱和分頁篩選來擷取 Git 存放庫。
getRepository(string, string)	擷取 Git 存放庫。
getRepositoryWithParent(string, boolean, string)	擷取 Git 存放庫。
getRevert(string, number, string)	依還原標識符擷取還原作業的相關信息。
getRevertConflict(string, number, number, string)	依標識符擷取還原的一個衝突
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)	Tree 端點會傳回指定樹狀結構底下物件的集合。樹狀結構是 Git 存放庫中的資料夾。
getTreeZip(string, string, string, string, boolean, string)	Tree 端點會傳回指定樹狀結構底下物件的集合。樹狀結構是 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)	建立、更新或刪除 refs（branch）。
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

項目識別碼或項目名稱

repositoryId: string

存放庫的標識碼或名稱。

傳回

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

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

project: string

項目識別碼或項目名稱

傳回

Promise<Attachment>

createCherryPick(GitAsyncRefOperationParameters, string, string)

櫻桃挑選與提取要求相關聯的特定認可或認可到新的分支。

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

參數

cherryPickToCreate: GitAsyncRefOperationParameters

project: string

項目識別碼或項目名稱

repositoryId: string

存放庫的標識碼。

傳回

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

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

threadId: number

所需批注位於的線程標識碼。

project: string

項目識別碼或項目名稱

傳回

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 認可的標識碼。

repositoryId: string

存放庫的標識碼。

project: string

項目識別碼或項目名稱

傳回

Promise<GitStatus>

createFavorite(GitRefFavorite, string)

建立 ref 我的最愛

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

參數

favorite: GitRefFavorite

要建立的 ref 我的最愛。

project: string

項目識別碼或項目名稱

傳回

Promise<GitRefFavorite>

createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)

要求將另一個存放庫的 ref 擷取到此存放庫。它會同步處理兩個現有的分叉。若要建立分叉，請參閱 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

來源存放庫和 ref 對應。

repositoryNameOrId: string

存放庫的名稱或標識碼。

project: string

項目識別碼或項目名稱

includeLinks: boolean

True 表示包含連結

傳回

Promise<GitForkSyncRequest>

createImportRequest(GitImportRequest, string, string)

建立匯入要求。

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

參數

importRequest: GitImportRequest

要建立的匯入要求。

project: string

項目識別碼或項目名稱

repositoryId: string

存放庫的名稱或標識碼。

傳回

Promise<GitImportRequest>

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

在批注上新增讚。

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

參數

repositoryId: string

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

threadId: number

包含批注之線程的識別碼。

commentId: number

批注的標識碼。

project: string

項目識別碼或項目名稱

傳回

Promise<void>

createMergeRequest(GitMergeParameters, string, string, boolean)

要求 Git 合併作業。目前我們僅支持合併 2 個認可。

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

參數

mergeParameters: GitMergeParameters

父代 commitId 和合併認可混亂。

project: string

項目識別碼或項目名稱

repositoryNameOrId: string

存放庫的名稱或標識碼。

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

提取要求目標分支的存放庫標識碼。

project: string

項目識別碼或項目名稱

supportsIterations: boolean

如果為 true，後續推送至提取要求將會個別檢閱。如果不需要這項功能，則針對大型提取要求將此值設定為 false。

傳回

Promise<GitPullRequest>

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

在反覆專案上建立提取要求狀態。此作業的結果與在要求本文中具有指定反覆專案標識碼的提取要求建立狀態相同。

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

參數

status: GitPullRequestStatus

要建立的提取要求狀態。

repositoryId: string

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

iterationId: number

提取要求反覆項目的標識碼。

project: string

項目識別碼或項目名稱

傳回

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

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

project: string

項目識別碼或項目名稱

projectId: string

項目識別碼或項目名稱。

傳回

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 />如果此處包含檢閱者的標識碼，它必須符合 reviewerID 參數。<br />Reviewers 可以使用此方法設定自己的投票。新增其他檢閱者時，投票必須設定為零。

repositoryId: string

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

reviewerId: string

檢閱者的標識碼。

project: string

項目識別碼或項目名稱

傳回

Promise<IdentityRefWithVote>

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

將檢閱者新增至提取要求。

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

參數

reviewers: IdentityRef[]

要新增至提取要求的檢閱者。

repositoryId: string

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

project: string

項目識別碼或項目名稱

傳回

Promise<IdentityRefWithVote[]>

createPullRequestStatus(GitPullRequestStatus, string, number, string)

建立提取要求狀態。

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

參數

status: GitPullRequestStatus

要建立的提取要求狀態。

repositoryId: string

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

project: string

項目識別碼或項目名稱

傳回

Promise<GitPullRequestStatus>

createPush(GitPush, string, string)

將變更推送至存放庫。

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

參數

push: GitPush

repositoryId: string

存放庫的名稱或標識碼。

project: string

項目識別碼或項目名稱

傳回

Promise<GitPush>

createRepository(GitRepositoryCreateOptions, string, string)

在小組專案中建立 Git 存放庫。

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

參數

gitRepositoryToCreate: GitRepositoryCreateOptions

指定存放庫名稱、小組專案和/或父存放庫。如果要求是專案範圍（亦即包含專案標識符），則可以從 gitRepositoryToCreate 省略 Team 項目資訊。

project: string

項目識別碼或項目名稱

sourceRef: string

[選擇性]指定建立分支存放庫時要使用的來源 refs

傳回

Promise<GitRepository>

createRevert(GitAsyncRefOperationParameters, string, string)

啟動作業以建立新的分支，以還原與提取要求相關聯的特定認可或認可所引進的變更。

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

參數

revertToCreate: GitAsyncRefOperationParameters

project: string

項目識別碼或項目名稱

repositoryId: string

存放庫的標識碼。

傳回

Promise<GitRevert>

createThread(GitPullRequestCommentThread, string, number, string)

在提取要求中建立線程。

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

參數

commentThread: GitPullRequestCommentThread

要建立的線程。線程必須至少包含一個批注。

repositoryId: string

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

project: string

項目識別碼或項目名稱

傳回

Promise<GitPullRequestCommentThread>

createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)

將未材料化的身分識別新增至提取要求的檢閱者。

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

參數

reviewer: IdentityRefWithVote

要新增至提取要求的檢閱者。

repositoryId: string

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

project: string

項目識別碼或項目名稱

傳回

Promise<IdentityRefWithVote>

deleteAttachment(string, string, number, string)

刪除提取要求附件。

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

參數

fileName: string

要刪除的附件名稱。

repositoryId: string

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

project: string

項目識別碼或項目名稱

傳回

Promise<void>

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

刪除提取要求中與特定線程相關聯的批注。

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

參數

repositoryId: string

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

threadId: number

所需批注位於的線程標識碼。

commentId: number

批注的標識碼。

project: string

項目識別碼或項目名稱

傳回

Promise<void>

deleteEnablementStatus(boolean, boolean, string[])

DELETE 從 DB 刪除啟用狀態和 BillableCommitters 數據。刪除啟用數據將會有效地停用受影響的存放庫。

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

參數

allProjects: boolean

includeBillableCommitters: boolean

projectIds: string[]

傳回

Promise<void>

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

移除註出的類似。

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

參數

repositoryId: string

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

threadId: number

包含批注之線程的識別碼。

commentId: number

批注的標識碼。

project: string

項目識別碼或項目名稱

傳回

Promise<void>

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

刪除提取要求反覆項目狀態。

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

參數

repositoryId: string

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

iterationId: number

提取要求反覆項目的標識碼。

statusId: number

提取要求狀態的識別碼。

project: string

項目識別碼或項目名稱

傳回

Promise<void>

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

從指派給提取要求的標籤集合中移除標籤（tag）。標記本身將不會刪除。

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

參數

repositoryId: string

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

labelIdOrName: string

所要求的標籤名稱或識別碼。

project: string

項目識別碼或項目名稱

projectId: string

項目識別碼或項目名稱。

傳回

Promise<void>

deletePullRequestReviewer(string, number, string, string)

從提取要求中移除檢閱者。

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

參數

repositoryId: string

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

reviewerId: string

要移除的檢閱者標識碼。

project: string

項目識別碼或項目名稱

傳回

Promise<void>

deletePullRequestStatus(string, number, number, string)

刪除提取要求狀態。

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

參數

repositoryId: string

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

statusId: number

提取要求狀態的識別碼。

project: string

項目識別碼或項目名稱

傳回

Promise<void>

deleteRefFavorite(string, number)

刪除指定的 refs 我的最愛

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

參數

project: string

項目識別碼或項目名稱

favoriteId: number

要刪除之 ref 我的最愛標識碼。

傳回

Promise<void>

deleteRepository(string, string)

刪除 Git 存放庫

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

參數

repositoryId: string

存放庫的標識碼。

project: string

項目識別碼或項目名稱

傳回

Promise<void>

deleteRepositoryFromRecycleBin(string, string)

終結（硬式刪除）虛刪除的 Git 存放庫。

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

參數

project: string

項目識別碼或項目名稱

repositoryId: string

存放庫的標識碼。

傳回

Promise<void>

getAnnotatedTag(string, string, string)

取得批註標記。

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

參數

project: string

項目識別碼或項目名稱

repositoryId: string

存放庫的標識碼或名稱。

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

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

project: string

項目識別碼或項目名稱

傳回

Promise<ArrayBuffer>

getAttachments(string, number, string)

取得附加至指定提取要求的檔案清單。

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

參數

repositoryId: string

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

project: string

項目識別碼或項目名稱

傳回

Promise<Attachment[]>

getAttachmentZip(string, string, number, string)

取得提取要求附件的檔案內容。

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

參數

fileName: string

附件的名稱。

repositoryId: string

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

project: string

項目識別碼或項目名稱

傳回

Promise<ArrayBuffer>

getBillableCommitters(string, Date, number, number)

擷取指定日期之進階安全性服務的實際可計費認可者。

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

參數

project: string

項目識別碼或項目名稱

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

項目識別碼或項目名稱

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

存放庫的名稱或標識碼。

sha1: string

檔案的SHA1哈希。您可以使用「Git/Items/Get Item」端點取得檔案的 SHA1。

project: string

項目識別碼或項目名稱

download: boolean

如果為 true，請提示下載，而不是在瀏覽器中轉譯。注意：如果$format為 zip，則此值預設為 true

fileName: string

提供要用於下載的 fileName。

resolveLfs: boolean

如果為 true，請嘗試將 Blob 解析為其 LFS 內容，如果是 LFS 指標檔案。只與八位數據流接受標頭或$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

存放庫的名稱或標識碼。

sha1: string

檔案的SHA1哈希。您可以使用「Git/Items/Get Item」端點取得檔案的 SHA1。

project: string

項目識別碼或項目名稱

download: boolean

如果為 true，請提示下載，而不是在瀏覽器中轉譯。注意：如果$format為 zip，則此值預設為 true

fileName: string

提供要用於下載的 fileName。

resolveLfs: boolean

如果為 true，請嘗試將 Blob 解析為其 LFS 內容，如果是 LFS 指標檔案。只與八位數據流接受標頭或$format類型相容

傳回

Promise<ArrayBuffer>

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

取得 zip 檔案下載中的一或多個 Blob。

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

參數

blobIds: string[]

要傳回 zip 檔案中的 Blob 識別碼（SHA1 哈希）。

repositoryId: string

存放庫的名稱或標識碼。

project: string

項目識別碼或項目名稱

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

存放庫的名稱或標識碼。

sha1: string

檔案的SHA1哈希。您可以使用「Git/Items/Get Item」端點取得檔案的 SHA1。

project: string

項目識別碼或項目名稱

download: boolean

如果為 true，請提示下載，而不是在瀏覽器中轉譯。注意：如果$format為 zip，則此值預設為 true

fileName: string

提供要用於下載的 fileName。

resolveLfs: boolean

如果為 true，請嘗試將 Blob 解析為其 LFS 內容，如果是 LFS 指標檔案。只與八位數據流接受標頭或$format類型相容

傳回

Promise<ArrayBuffer>

getBranch(string, string, string, GitVersionDescriptor)

擷取單一分支的相關統計數據。

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

參數

repositoryId: string

存放庫的名稱或標識碼。

name: string

分支的名稱。

project: string

項目識別碼或項目名稱

baseVersionDescriptor: GitVersionDescriptor

識別要做為基底的認可或分支。

傳回

Promise<GitBranchStats>

getBranches(string, string, GitVersionDescriptor)

擷取存放庫內所有分支的相關統計數據。

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

參數

repositoryId: string

存放庫的名稱或標識碼。

project: string

項目識別碼或項目名稱

baseVersionDescriptor: GitVersionDescriptor

識別要做為基底的認可或分支。

傳回

Promise<GitBranchStats[]>

getBranchStatsBatch(GitQueryBranchStatsCriteria, string, string)

擷取多個認可的統計數據

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

參數

searchCriteria: GitQueryBranchStatsCriteria

要比較的基底認可和目標認可清單。

repositoryId: string

存放庫的名稱或標識碼。

project: string

項目識別碼或項目名稱

傳回

Promise<GitBranchStats[]>

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

擷取特定認可的變更。

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

參數

commitId: string

認可的標識碼。

repositoryId: string

存放庫的標識碼或易記名稱。若要使用易記名稱，也必須指定 projectId。

project: string

項目識別碼或項目名稱

top: number

要傳回的變更數目上限。

skip: number

要略過的變更數目。

傳回

Promise<GitCommitChanges>

getCherryPick(string, number, string)

依櫻桃挑選標識符擷取櫻桃挑選作業的相關信息。

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

參數

project: string

項目識別碼或項目名稱

cherryPickId: number

櫻桃挑選的標識碼。

repositoryId: string

存放庫的標識碼。

傳回

Promise<GitCherryPick>

getCherryPickConflict(string, number, number, string)

依標識符擷取櫻桃挑選的一個衝突

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

參數

repositoryId: string

cherryPickId: number

conflictId: number

project: string

項目識別碼或項目名稱

傳回

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

項目識別碼或項目名稱

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

項目識別碼或項目名稱

repositoryId: string

存放庫的標識碼。

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

項目識別碼或項目名稱

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

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

threadId: number

所需批注位於的線程標識碼。

commentId: number

批注的標識碼。

project: string

項目識別碼或項目名稱

傳回

Promise<Comment>

getComments(string, number, number, string)

擷取提取要求中與特定線程相關聯的所有批注。

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

參數

repositoryId: string

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

threadId: number

線程的標識碼。

project: string

項目識別碼或項目名稱

傳回

Promise<Comment[]>

getCommit(string, string, string, number)

擷取特定的認可。

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

參數

commitId: string

認可的標識碼。

repositoryId: string

存放庫的標識碼或易記名稱。若要使用易記名稱，也必須指定 projectId。

project: string

項目識別碼或項目名稱

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

存放庫的名稱或標識碼。

project: string

項目識別碼或項目名稱

diffCommonCommit: boolean

如果為 true，則為 common 和 target commit 之間的差異。如果為 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

存放庫的標識碼或易記名稱。若要使用易記名稱，也必須指定 projectId。

searchCriteria: GitQueryCommitsCriteria

project: string

項目識別碼或項目名稱

傳回

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

存放庫的名稱或標識碼。

project: string

項目識別碼或項目名稱

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

項目識別碼或項目名稱

傳回

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

項目識別碼或項目名稱

repositoryId: string

傳回

Promise<BillableCommitter[]>

getEstimatedBillablePushersOrg()

取得組織過去90天的預估計費推播器。

function getEstimatedBillablePushersOrg(): Promise<BillablePusher[]>

傳回

Promise<BillablePusher[]>

getEstimatedBillablePushersProject(string)

取得項目過去90天的預估計費推播器。

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

參數

project: string

項目識別碼或項目名稱

傳回

Promise<BillablePusher[]>

getFileDiffs(FileDiffsCriteria, string, string)

取得每個指定檔案的檔案差異

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

參數

fileDiffsCriteria: FileDiffsCriteria

檔案參數物件清單

project: string

項目識別碼或項目名稱

repositoryId: string

存放庫的名稱或標識碼

傳回

Promise<FileDiff[]>

getForks(string, string, string, boolean)

擷取集合中存放庫的所有分支。

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

參數

repositoryNameOrId: string

存放庫的名稱或標識碼。

collectionId: string

Team 專案集合標識碼。

project: string

項目識別碼或項目名稱

includeLinks: boolean

True 是表示包含連結。

傳回

Promise<GitRepositoryRef[]>

getForkSyncRequest(string, number, string, boolean)

取得特定分支同步作業的詳細數據。

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

參數

repositoryNameOrId: string

存放庫的名稱或標識碼。

forkSyncOperationId: number

同步要求的 OperationId。

project: string

項目識別碼或項目名稱

includeLinks: boolean

True 是表示包含連結。

傳回

Promise<GitForkSyncRequest>

getForkSyncRequests(string, string, boolean, boolean)

擷取此存放庫上所有要求的分支同步作業。

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

參數

repositoryNameOrId: string

存放庫的名稱或標識碼。

project: string

項目識別碼或項目名稱

includeAbandoned: boolean

True 是表示包含已放棄的要求。

includeLinks: boolean

True 是表示包含連結。

傳回

Promise<GitForkSyncRequest[]>

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

取得單一專案的專案元數據和/或內容。下載參數是指出內容是否應該以下載的形式提供，或只是以響應中的數據流的形式傳送。不適用於壓縮的內容，該內容一律會以下載的形式傳回。

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

存放庫的名稱或標識碼。

path: string

項目路徑。

project: string

項目識別碼或項目名稱

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

存放庫的名稱或標識碼。

path: string

項目路徑。

project: string

項目識別碼或項目名稱

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)

取得專案集合的專案元數據和/或內容。下載參數是指出內容是否應該以下載的形式提供，或只是以響應中的數據流的形式傳送。不適用於一律以下載方式傳回的壓縮內容。

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

存放庫的名稱或標識碼。

project: string

項目識別碼或項目名稱

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

存放庫的名稱或標識碼。

path: string

項目路徑。

project: string

項目識別碼或項目名稱

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

存放庫的名稱或標識碼。

path: string

項目路徑。

project: string

項目識別碼或項目名稱

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

項目識別碼或項目名稱

repositoryId: string

存放庫的名稱或標識碼。

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

存放庫的名稱或標識碼。

path: string

項目路徑。

project: string

項目識別碼或項目名稱

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

存放庫的名稱或標識碼。

path: string

項目路徑。

project: string

項目識別碼或項目名稱

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

存放庫的名稱或標識碼。

project: string

項目識別碼或項目名稱

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)

張貼以擷取從存放庫/專案中的一組專案中擷取批次，並指定路徑清單或長路徑

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

參數

requestData: GitItemRequestData

要求數據屬性：ItemDescriptors、IncludeContentMetadata、LatestProcessedChange、IncludeLinks。 ItemDescriptors：要擷取的專案集合，包括路徑、版本和遞歸層級。 IncludeContentMetadata：是否要包含所有專案的元數據 LatestProcessedChange：是否要包含淺層 ref，以認可上次變更每個專案。 IncludeLinks：是否要在淺層參考中包含_links字段。

repositoryId: string

存放庫的名稱或標識碼

project: string

項目識別碼或項目名稱

傳回

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

存放庫的名稱或標識碼。

path: string

項目路徑。

project: string

項目識別碼或項目名稱

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

存放庫的名稱或標識碼。

path: string

項目路徑。

project: string

項目識別碼或項目名稱

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

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

threadId: number

包含批注之線程的識別碼。

commentId: number

批注的標識碼。

project: string

項目識別碼或項目名稱

傳回

Promise<IdentityRef[]>

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

尋找兩個認可的合併基底，選擇性地跨分支。如果未指定 otherRepositoryId，合併基底只會在本機 repositoryNameOrId 的內容中計算。

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

參數

repositoryNameOrId: string

本機存放庫的標識碼或名稱。

commitId: string

第一次認可，通常是潛在合併的目標分支提示。

otherCommitId: string

其他認可，通常是潛在合併的來源分支提示。

project: string

項目識別碼或項目名稱

otherCollectionId: string

otherCommitId 所在的集合標識符。

otherRepositoryId: string

otherCommitId 所在的存放庫標識符。

傳回

Promise<GitCommitRef[]>

getMergeRequest(string, string, number, boolean)

取得特定合併作業的詳細數據。

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

參數

project: string

項目識別碼或項目名稱

repositoryNameOrId: string

存放庫的名稱或標識碼。

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

提取要求目標分支的存放庫標識碼。

pullRequestId: number

要擷取之提取要求的標識碼。

project: string

項目識別碼或項目名稱

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

要擷取之提取要求的標識碼。

project: string

項目識別碼或項目名稱

傳回

Promise<GitPullRequest>

getPullRequestCommits(string, number, string)

取得指定提取要求的認可。

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

參數

repositoryId: string

存放庫的標識碼或名稱。

pullRequestId: number

提取要求的標識碼。

project: string

項目識別碼或項目名稱

傳回

Promise<PagedList<GitCommitRef>>

getPullRequestConflict(string, number, number, string)

依標識符擷取提取要求的一個衝突

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

參數

repositoryId: string

pullRequestId: number

conflictId: number

project: string

項目識別碼或項目名稱

傳回

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

提取要求標識碼。

project: string

項目識別碼或項目名稱

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

存放庫的標識碼或名稱。

pullRequestId: number

提取要求的標識碼。

iterationId: number

要傳回之提取要求反覆項目的標識碼。

project: string

項目識別碼或項目名稱

傳回

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

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

iterationId: number

提取要求反覆項目的標識碼。 <br /> 反覆專案一是建立提取要求時的來源分支前端，並在有推送至來源分支時建立後續反覆專案。允許的值介於 1 到此提取要求的最大反覆項目之間。

project: string

項目識別碼或項目名稱

top: number

自選。要擷取的變更數目。默認值為 100，最大值為 2000。

skip: number

自選。要忽略的變更數目。例如，若要擷取變更 101-150，請將前 50 個設定為 100。

compareTo: number

要比較之提取要求反覆項目的標識碼。默認值為零，表示針對來源和目標分支之間的一般認可進行比較

傳回

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

存放庫的標識碼或名稱。

pullRequestId: number

提取要求的標識碼。

iterationId: number

要從中取得認可之反覆項目的標識符。

project: string

項目識別碼或項目名稱

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

存放庫的標識碼或名稱。

pullRequestId: number

提取要求的標識碼。

project: string

項目識別碼或項目名稱

includeCommits: boolean

如果為 true，請在回應中包含與每個反覆專案相關聯的認可。

傳回

Promise<GitPullRequestIteration[]>

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

依標識元取得特定的提取要求反覆項目狀態。所有反覆專案的提取要求內的狀態標識碼是唯一的。

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

參數

repositoryId: string

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

iterationId: number

提取要求反覆項目的標識碼。

statusId: number

提取要求狀態的識別碼。

project: string

項目識別碼或項目名稱

傳回

Promise<GitPullRequestStatus>

getPullRequestIterationStatuses(string, number, number, string)

取得與提取要求反覆項目相關聯的所有狀態。

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

參數

repositoryId: string

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

iterationId: number

提取要求反覆項目的標識碼。

project: string

項目識別碼或項目名稱

傳回

Promise<GitPullRequestStatus[]>

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

擷取已指派給提取要求的單一標籤（標籤）。

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

參數

repositoryId: string

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

labelIdOrName: string

所要求的標籤名稱或識別碼。

project: string

項目識別碼或項目名稱

projectId: string

項目識別碼或項目名稱。

傳回

Promise<WebApiTagDefinition>

getPullRequestLabels(string, number, string, string)

取得指派給提取要求的所有標籤（標籤）。

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

參數

repositoryId: string

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

project: string

項目識別碼或項目名稱

projectId: string

項目識別碼或項目名稱。

傳回

Promise<WebApiTagDefinition[]>

getPullRequestProperties(string, number, string)

取得提取要求的外部屬性。

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

參數

repositoryId: string

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

project: string

項目識別碼或項目名稱

傳回

Promise<any>

getPullRequestQuery(GitPullRequestQuery, string, string)

此 API 可用來尋找與指定認可相關的提取要求。它可用來尋找建立特定合併認可之提取要求，或可用來尋找已合併特定認可的所有提取要求。輸入是查詢清單，每個查詢都包含認可清單。針對您搜尋的每個認可，您將取得認可字典 -> 提取要求。

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

參數

queries: GitPullRequestQuery

要執行的查詢清單。

repositoryId: string

存放庫的標識碼。

project: string

項目識別碼或項目名稱

傳回

Promise<GitPullRequestQuery>

getPullRequestReviewer(string, number, string, string)

擷取提取要求上特定檢閱者的相關信息

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

參數

repositoryId: string

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

reviewerId: string

檢閱者的標識碼。

project: string

項目識別碼或項目名稱

傳回

Promise<IdentityRefWithVote>

getPullRequestReviewers(string, number, string)

擷取提取要求的檢閱者

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

參數

repositoryId: string

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

project: string

項目識別碼或項目名稱

傳回

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

提取要求目標分支的存放庫標識碼。

searchCriteria: GitPullRequestSearchCriteria

系統會傳回符合此搜尋準則的提取要求。

project: string

項目識別碼或項目名稱

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

項目識別碼或項目名稱

searchCriteria: GitPullRequestSearchCriteria

系統會傳回符合此搜尋準則的提取要求。

maxCommentLength: number

未使用。

skip: number

要忽略的提取要求數目。例如，若要擷取結果 101-150，請將 top 設定為 50，然後跳至 100。

top: number

要擷取的提取要求數目。

傳回

Promise<GitPullRequest[]>

getPullRequestStatus(string, number, number, string)

依標識碼取得特定的提取要求狀態。所有反覆專案的提取要求內的狀態標識碼是唯一的。

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

參數

repositoryId: string

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

statusId: number

提取要求狀態的識別碼。

project: string

項目識別碼或項目名稱

傳回

Promise<GitPullRequestStatus>

getPullRequestStatuses(string, number, string)

取得與提取要求相關聯的所有狀態。

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

參數

repositoryId: string

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

project: string

項目識別碼或項目名稱

傳回

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

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

threadId: number

線程的標識碼。

project: string

項目識別碼或項目名稱

iteration: number

如果指定，則會使用此反覆專案作為差異右側的追蹤線程位置。

baseIteration: number

如果指定，則會使用這個反覆專案作為差異的左側來追蹤線程位置。

傳回

Promise<GitPullRequestCommentThread>

getPullRequestWorkItemRefs(string, number, string)

擷取與提取要求相關聯的工作項目清單。

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

參數

repositoryId: string

存放庫的標識碼或名稱。

pullRequestId: number

提取要求的標識碼。

project: string

項目識別碼或項目名稱

傳回

Promise<ResourceRef[]>

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

擷取特定的推送。

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

參數

repositoryId: string

存放庫的名稱或標識碼。

pushId: number

推送的標識碼。

project: string

項目識別碼或項目名稱

includeCommits: number

要包含在結果中的認可數目。

includeRefUpdates: boolean

如果為 true，請包含推送所更新的 ref 清單。

傳回

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

存放庫的標識碼或易記名稱。若要使用易記名稱，也必須指定 projectId。

pushId: number

推送的標識碼。

project: string

項目識別碼或項目名稱

top: number

要傳回的認可數目上限（“取得頂端 x 認可”）。

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

存放庫的名稱或標識碼。

project: string

項目識別碼或項目名稱

skip: number

要略過的推播數目。

top: number

要傳回的推播數目。

searchCriteria: GitPushSearchCriteria

搜尋準則屬性：fromDate、toDate、pusherId、refName、includeRefUpdates 或 includeLinks。 fromDate：搜尋的開始日期。 toDate：要搜尋的結束日期。pusherId：提交推送的人員身分識別。 refName：要考慮的分支名稱。 includeRefUpdates：如果為 true，請包含推送所更新的 ref 清單。 includeLinks：是否要在淺層參考中包含_links字段。

傳回

Promise<GitPush[]>

getRecycleBinRepositories(string)

從回收站擷取虛刪除的 Git 存放庫。

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

參數

project: string

項目識別碼或項目名稱

傳回

Promise<GitDeletedRepository[]>

getRefFavorite(string, number)

取得我的最愛標識碼的 refs favorites。

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

參數

project: string

項目識別碼或項目名稱

favoriteId: number

要求的 ref 我的最愛標識碼。

傳回

Promise<GitRefFavorite>

getRefFavorites(string, string, string)

取得存放庫和身分識別的 refs 我的最愛。

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

參數

project: string

項目識別碼或項目名稱

repositoryId: string

存放庫的標識碼。

identityId: string

要擷取其我的最愛的身分識別標識碼。如果為 null，則會使用要求身分識別。

傳回

Promise<GitRefFavorite[]>

getRefFavoritesForProject(string, string)

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

參數

project: string

項目識別碼或項目名稱

identityId: string

傳回

Promise<GitRefFavorite[]>

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

查詢提供的存放庫，以取得其 refs 並傳回它們。

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

存放庫的名稱或標識碼。

project: string

項目識別碼或項目名稱

filter: string

[選擇性]要套用至 refs 的篩選（開頭為）。

includeLinks: boolean

[選擇性]指定是否應該在結果中包含 referenceLinks。默認值為 false。

includeStatuses: boolean

[選擇性]每個 ref 最多包含前 1000 個認可狀態。默認值為 false。

includeMyBranches: boolean

[選擇性]只包含用戶擁有的分支、使用者最愛的分支，以及預設分支。默認值為 false。無法與篩選參數結合。

latestStatusesOnly: boolean

[選擇性]True 表示只包含每個 ref 的提示認可狀態。此選項需要 includeStatuses 為 true。默認值為 false。

peelTags: boolean

[選擇性]批註標記將會填入 PeeledObjectId 屬性。默認值為 false。

filterContains: string

[選擇性]要套用至 refs （contains）的篩選條件。

傳回

Promise<PagedList<GitRef>>

getRepositories(string, boolean, boolean, boolean)

擷取 Git 存放庫。

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

參數

project: string

項目識別碼或項目名稱

includeLinks: boolean

[選擇性]True 是表示包含參考連結。默認值為 false。

includeAllUrls: boolean

[選擇性]True 是表示包含所有遠端 URL。默認值為 false。

includeHidden: boolean

[選擇性]True 是表示包含隱藏的存放庫。默認值為 false。

傳回

Promise<GitRepository[]>

getRepositoriesPaged(string, boolean, boolean, boolean, string, number, string)

依名稱和分頁篩選來擷取 Git 存放庫。

function getRepositoriesPaged(projectId: string, includeLinks?: boolean, includeAllUrls?: boolean, includeHidden?: boolean, filterContains?: string, top?: number, continuationToken?: string): Promise<PagedList<GitRepository>>

參數

projectId: string

小組專案的標識碼或名稱。

includeLinks: boolean

[選擇性]True 是表示包含參考連結。默認值為 false。

includeAllUrls: boolean

[選擇性]True 是表示包含所有遠端 URL。默認值為 false。

includeHidden: boolean

[選擇性]True 是表示包含隱藏的存放庫。默認值為 false。

filterContains: string

[選擇性]要套用至 refs （contains）的篩選條件。

top: number

[選擇性]要傳回的存放庫數目上限。不能大於 500。如果未提供，但 continuationToken 為，top 預設為 100。

continuationToken: string

用於分頁的接續令牌。

傳回

Promise<PagedList<GitRepository>>

getRepository(string, string)

擷取 Git 存放庫。

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

參數

repositoryId: string

存放庫的名稱或標識碼。

project: string

項目識別碼或項目名稱

傳回

Promise<GitRepository>

getRepositoryWithParent(string, boolean, string)

擷取 Git 存放庫。

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

參數

repositoryId: string

存放庫的名稱或標識碼。

includeParent: boolean

True 是表示包含父存放庫。僅適用於已驗證的呼叫。

project: string

項目識別碼或項目名稱

傳回

Promise<GitRepository>

getRevert(string, number, string)

依還原標識符擷取還原作業的相關信息。

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

參數

project: string

項目識別碼或項目名稱

revertId: number

還原作業的標識碼。

repositoryId: string

存放庫的標識碼。

傳回

Promise<GitRevert>

getRevertConflict(string, number, number, string)

依標識符擷取還原的一個衝突

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

參數

repositoryId: string

revertId: number

conflictId: number

project: string

項目識別碼或項目名稱

傳回

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

項目識別碼或項目名稱

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

項目識別碼或項目名稱

repositoryId: string

存放庫的標識碼。

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 認可的標識碼。

repositoryId: string

存放庫的標識碼。

project: string

項目識別碼或項目名稱

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 存放庫的標識碼。

project: string

項目識別碼或項目名稱

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

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

project: string

項目識別碼或項目名稱

iteration: number

如果指定，則會使用這個反覆專案作為差異右側來追蹤線程位置。

baseIteration: number

如果指定，則會使用此反覆專案作為差異的左側來追蹤線程位置。

傳回

Promise<GitPullRequestCommentThread[]>

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

Tree 端點會傳回指定樹狀結構底下物件的集合。樹狀結構是 Git 存放庫中的資料夾。

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

參數

repositoryId: string

存放庫標識碼。

sha1: string

樹狀結構的SHA1哈希。

project: string

項目識別碼或項目名稱

projectId: string

項目標識碼。

recursive: boolean

以遞歸方式搜尋。包含此樹狀結構底下的樹狀結構。默認值為 false。

fileName: string

傳回 .zip 檔案時要使用的名稱。預設值為物件識別碼。

傳回

Promise<GitTreeRef>

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

Tree 端點會傳回指定樹狀結構底下物件的集合。樹狀結構是 Git 存放庫中的資料夾。

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

參數

repositoryId: string

存放庫標識碼。

sha1: string

樹狀結構的SHA1哈希。

project: string

項目識別碼或項目名稱

projectId: string

項目標識碼。

recursive: boolean

以遞歸方式搜尋。包含此樹狀結構底下的樹狀結構。默認值為 false。

fileName: string

傳回 .zip 檔案時要使用的名稱。預設值為物件識別碼。

傳回

Promise<ArrayBuffer>

queryImportRequests(string, string, boolean)

擷取存放庫的匯入要求。

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

參數

project: string

項目識別碼或項目名稱

repositoryId: string

存放庫的名稱或標識碼。

includeAbandoned: boolean

True 是表示在結果中包含已放棄的匯入要求。

傳回

Promise<GitImportRequest[]>

restoreRepositoryFromRecycleBin(GitRecycleBinRepositoryDetails, string, string)

復原虛刪除的 Git 存放庫。最近刪除的存放庫會進入虛刪除狀態一段時間，再進行硬式刪除並無法復原。

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

參數

repositoryDetails: GitRecycleBinRepositoryDetails

project: string

項目識別碼或項目名稱

repositoryId: string

存放庫的標識碼。

傳回

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 存放庫的標識碼。

pullRequestId: number

提取要求的標識碼。

project: string

項目識別碼或項目名稱

傳回

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

項目識別碼或項目名稱

傳回

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

項目識別碼或項目名稱

傳回

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

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

threadId: number

所需批注位於的線程標識碼。

commentId: number

要更新之批注的標識碼。

project: string

項目識別碼或項目名稱

傳回

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

項目識別碼或項目名稱

repositoryId: string

存放庫的名稱或標識碼。

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

提取要求目標分支的存放庫標識碼。

pullRequestId: number

要更新之提取要求的標識碼。

project: string

項目識別碼或項目名稱

傳回

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

項目識別碼或項目名稱

傳回

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

項目識別碼或項目名稱

傳回

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

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

iterationId: number

提取要求反覆項目的標識碼。

project: string

項目識別碼或項目名稱

傳回

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

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

project: string

項目識別碼或項目名稱

傳回

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 />如果此處包含檢閱者的標識碼，它必須符合 reviewerID 參數。

repositoryId: string

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

reviewerId: string

檢閱者的標識碼。

project: string

項目識別碼或項目名稱

傳回

Promise<IdentityRefWithVote>

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

重設提取要求上多個檢閱者的投票。注意：此端點僅支援更新投票，但不支援更新必要的檢閱者（使用原則）或顯示名稱。

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

參數

patchVotes: IdentityRefWithVote[]

投票會重設為零的檢閱者標識符

repositoryId: string

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼

project: string

項目識別碼或項目名稱

傳回

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

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

project: string

項目識別碼或項目名稱

傳回

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

存放庫的名稱或標識碼。

filter: string

要鎖定/解除鎖定之分支的名稱

project: string

項目識別碼或項目名稱

projectId: string

小組專案的標識碼或名稱。如果指定存放庫的標識碼，則為選擇性。

傳回

Promise<GitRef>

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

建立、更新或刪除 refs（branch）。

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

參數

refUpdates: GitRefUpdate[]

要嘗試執行的 ref 更新清單

repositoryId: string

存放庫的名稱或標識碼。

project: string

項目識別碼或項目名稱

projectId: string

小組專案的標識碼或名稱。如果指定存放庫的標識碼，則為選擇性。

傳回

Promise<GitRefUpdateResult[]>

updateRepository(GitRepository, string, string)

使用新的存放庫名稱或新的預設分支來更新 Git 存放庫。

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

參數

newRepositoryInfo: GitRepository

指定新的存放庫名稱或存放庫的新預設分支

repositoryId: string

存放庫的標識碼。

project: string

項目識別碼或項目名稱

傳回

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

項目識別碼或項目名稱

傳回

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

項目識別碼或項目名稱

傳回

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

提取要求目標分支的存放庫標識碼。

pullRequestId: number

提取要求的標識碼。

threadId: number

要更新之線程的標識碼。

project: string

項目識別碼或項目名稱

傳回

Promise<GitPullRequestCommentThread>

共用方式為

GitRestClient class

建構函式

屬性

方法

建構函式詳細資料

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)

參數

傳回

createCommitStatus(GitStatus, string, string, string)

參數

傳回

createFavorite(GitRefFavorite, string)

參數

傳回

createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)

參數

傳回

createImportRequest(GitImportRequest, string, string)

參數

傳回

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

參數

傳回

createMergeRequest(GitMergeParameters, string, string, boolean)

參數

傳回

createPullRequest(GitPullRequest, string, string, boolean)

參數

傳回

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

參數

傳回

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)

參數

傳回

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)

參數