GitRestClient class

Referens

Paket:: azure-devops-extension-api

Basklass som ska användas (härledd från) för att göra begäranden till VSS REST-API:er

Extends: RestClientBase

Konstruktorer

GitRestClient(IVssRestClientOptions)

Egenskaper

RESOURCE_AREA_ID

Metoder

createAnnotatedTag(GitAnnotatedTag, string, string)	Skapa en kommenterad tagg.
createAttachment(any, string, string, number, string)	Bifoga en ny fil i en pull-begäran.
createCherryPick(GitAsyncRefOperationParameters, string, string)	Cherry väljer en specifik incheckning eller incheckningar som är kopplade till en pull-begäran till en ny gren.
createComment(Comment, string, number, number, string)	Skapa en kommentar på en specifik tråd i en pull-begäran (upp till 500 kommentarer kan skapas per tråd).
createCommitStatus(GitStatus, string, string, string)	Skapa Git-incheckningsstatus.
createFavorite(GitRefFavorite, string)	Skapar en referensfavorit
createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)	Begär att en annan lagringsplatss referens hämtas till den här. Den synkroniserar två befintliga gafflar. Information om hur du skapar en förgrening finns i <en href="https://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1"> slutpunkten för lagringsplatser</a>
createImportRequest(GitImportRequest, string, string)	Skapa en importbegäran.
createLike(string, number, number, number, string)	Lägg till en liknande i en kommentar.
createMergeRequest(GitMergeParameters, string, string, boolean)	Begär en git-sammanslagningsåtgärd. För närvarande stöder vi endast sammanslagning av 2 incheckningar.
createPullRequest(GitPullRequest, string, string, boolean)	Skapa en pull-begäran.
createPullRequestIterationStatus(GitPullRequestStatus, string, number, number, string)	Skapa en pull-begärandestatus för iterationen. Den här åtgärden får samma resultat som Skapa status för pull-begäran med angivet iterations-ID i begärandetexten.
createPullRequestLabel(WebApiCreateTagRequestData, string, number, string, string)	Skapa en tagg (om det inte finns ännu) och lägg till den som en etikett (tagg) för en angiven pull-begäran. Det enda obligatoriska fältet är namnet på den nya etiketten (taggen).
createPullRequestReviewer(IdentityRefWithVote, string, number, string, string)	Lägg till en granskare i en pull-begäran eller rösta.
createPullRequestReviewers(IdentityRef[], string, number, string)	Lägg till granskare i en pull-begäran.
createPullRequestStatus(GitPullRequestStatus, string, number, string)	Skapa en status för pull-begäran.
createPush(GitPush, string, string)	Skicka ändringar till lagringsplatsen.
createRepository(GitRepositoryCreateOptions, string, string)	Skapa en git-lagringsplats i ett teamprojekt.
createRevert(GitAsyncRefOperationParameters, string, string)	Startar åtgärden för att skapa en ny gren som återställer ändringar som införts av en specifik incheckning eller incheckningar som är associerade till en pull-begäran.
createThread(GitPullRequestCommentThread, string, number, string)	Skapa en tråd i en pull-begäran.
createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)	Lägg till en omaterialiserad identitet till granskarna av en pull-begäran.
deleteAttachment(string, string, number, string)	Ta bort en bifogad pull-begäran.
deleteComment(string, number, number, number, string)	Ta bort en kommentar som är associerad med en specifik tråd i en pull-begäran.
deleteEnablementStatus(boolean, boolean, string[])	DELETE Tar bort aktiveringsstatus och BillableCommitters-data från DB. Om du tar bort aktiveringsdata inaktiveras den effektivt för de berörda lagringsplatserna.
deleteLike(string, number, number, number, string)	Ta bort en liknande i en kommentar.
deletePullRequestIterationStatus(string, number, number, number, string)	Ta bort iterationsstatus för pull-begäran.
deletePullRequestLabels(string, number, string, string, string)	Tar bort en etikett (tagg) från uppsättningen med de som tilldelats pull-begäran. Själva taggen tas inte bort.
deletePullRequestReviewer(string, number, string, string)	Ta bort en granskare från en pull-begäran.
deletePullRequestStatus(string, number, number, string)	Ta bort status för pull-begäran.
deleteRefFavorite(string, number)	Tar bort refs-favoriten som angetts
deleteRepository(string, string)	Ta bort en git-lagringsplats
deleteRepositoryFromRecycleBin(string, string)	Förstör (hård borttagning) en mjuk borttagen Git-lagringsplats.
getAnnotatedTag(string, string, string)	Hämta en kommenterad tagg.
getAttachmentContent(string, string, number, string)	Hämta filinnehållet i en bifogad pull-begäran.
getAttachments(string, number, string)	Hämta en lista över filer som är kopplade till en viss pull-begäran.
getAttachmentZip(string, string, number, string)	Hämta filinnehållet i en bifogad pull-begäran.
getBillableCommitters(string, Date, number, number)	Hämta faktiska fakturerbara incheckningar för Advanced Security Service för ett visst datum.
getBillableCommittersDetail(string, string, Date)	Hämta detaljerade faktiska fakturerbara incheckningar för Advanced Security Service för ett visst datum. Detaljerade resultat filtrerar avsiktligt inte bort mjukt borttagna projekt och lagringsplatser för att diagnostisera faktureringsproblem.
getBlob(string, string, string, boolean, string, boolean)	Hämta en enda blob.
getBlobContent(string, string, string, boolean, string, boolean)	Hämta en enda blob.
getBlobsZip(string[], string, string, string)	Hämtar en eller flera blobar i en zip-filnedladdning.
getBlobZip(string, string, string, boolean, string, boolean)	Hämta en enda blob.
getBranch(string, string, string, GitVersionDescriptor)	Hämta statistik om en enda gren.
getBranches(string, string, GitVersionDescriptor)	Hämta statistik om alla grenar på en lagringsplats.
getBranchStatsBatch(GitQueryBranchStatsCriteria, string, string)	Hämta statistik för flera incheckningar
getChanges(string, string, string, number, number)	Hämta ändringar för en viss incheckning.
getCherryPick(string, number, string)	Hämta information om en körsbärsplockningsåtgärd med körsbärsplocknings-ID.
getCherryPickConflict(string, number, number, string)	Hämta en konflikt för ett körsbärsval efter ID
getCherryPickConflicts(string, number, string, string, number, boolean, boolean, boolean)	Hämta alla konflikter för ett körsbärsval
getCherryPickForRefName(string, string, string)	Hämta information om en körsbärsplockningsåtgärd för en specifik gren. Den här åtgärden är dyr på grund av den underliggande objektstrukturen, så det här API:et tittar bara på de 1 000 senaste åtgärderna för körsbärsplockning.
getCherryPickRelationships(string, string, string, boolean)	Givet ett commitId returnerar en lista över incheckningar som finns i samma cherry-pick-familj.
getComment(string, number, number, number, string)	Hämta en kommentar som är associerad med en specifik tråd i en pull-begäran.
getComments(string, number, number, string)	Hämta alla kommentarer som är associerade med en specifik tråd i en pull-begäran.
getCommit(string, string, string, number)	Hämta en viss incheckning.
getCommitDiffs(string, string, boolean, number, number, GitBaseVersionDescriptor, GitTargetVersionDescriptor)	Hitta den närmaste gemensamma incheckningen (kopplingsbasen) mellan bas- och målincheckningar och hämta diff mellan antingen bas- och målincheckningarna eller vanliga incheckningar och målincheckningar.
getCommits(string, GitQueryCommitsCriteria, string)	Hämta git-incheckningar för ett projekt
getCommitsBatch(GitQueryCommitsCriteria, string, string, number, number, boolean)	Hämta git-incheckningar för ett projekt som matchar sökvillkoren
getDeletedRepositories(string)	Hämta borttagna git-lagringsplatser.
getEnablementStatus(string[], Date, number, number)	GET-aktiveringsstatus för projektets lagringsplatser.
getEnableOnCreateHost(boolean)
getEnableOnCreateProject(string)
getEstimatedBillableCommittersRepo(string, string)	Hämta uppskattade fakturerbara incheckningar för en lagringsplats under de senaste 90 dagarna.
getEstimatedBillablePushersOrg()	Hämta uppskattade fakturerbara push-enheter för en organisation för de senaste 90 dagarna.
getEstimatedBillablePushersProject(string)	Hämta uppskattade fakturerbara push-enheter för ett projekt för de senaste 90 dagarna.
getFileDiffs(FileDiffsCriteria, string, string)	Hämta fildiffen för var och en av de angivna filerna
getForks(string, string, string, boolean)	Hämta alla förgreningar för en lagringsplats i samlingen.
getForkSyncRequest(string, number, string, boolean)	Hämta information om en specifik förgreningssynkroniseringsåtgärd.
getForkSyncRequests(string, string, boolean, boolean)	Hämta alla begärda synkroniseringsåtgärder för förgrening på den här lagringsplatsen.
getHfsItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Hämta objektmetadata och/eller innehåll för ett enskilt objekt. Hämtningsparametern är att ange om innehållet ska vara tillgängligt som en nedladdning eller bara skickas som en ström i svaret. Gäller inte för zippat innehåll, som alltid returneras som en nedladdning.
getHfsItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Hämta objektmetadata och/eller innehåll för ett enskilt objekt. Hämtningsparametern är att ange om innehållet ska vara tillgängligt som en nedladdning eller bara skickas som en ström i svaret. Gäller inte för zippat innehåll, som alltid returneras som en nedladdning.
getHfsItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)	Hämta objektmetadata och/eller innehåll för en samling objekt. Hämtningsparametern är att ange om innehållet ska vara tillgängligt som en nedladdning eller bara skickas som en ström i svaret. Gäller inte för zippat innehåll som alltid returneras som en nedladdning.
getHfsItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Hämta objektmetadata och/eller innehåll för ett enskilt objekt. Hämtningsparametern är att ange om innehållet ska vara tillgängligt som en nedladdning eller bara skickas som en ström i svaret. Gäller inte för zippat innehåll, som alltid returneras som en nedladdning.
getHfsItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Hämta objektmetadata och/eller innehåll för ett enskilt objekt. Hämtningsparametern är att ange om innehållet ska vara tillgängligt som en nedladdning eller bara skickas som en ström i svaret. Gäller inte för zippat innehåll, som alltid returneras som en nedladdning.
getImportRequest(string, string, number)	Hämta en viss importbegäran.
getItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Hämta objektmetadata och/eller innehåll för ett enskilt objekt. Hämtningsparametern är att ange om innehållet ska vara tillgängligt som en nedladdning eller bara skickas som en ström i svaret. Gäller inte för zippat innehåll, som alltid returneras som en nedladdning.
getItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Hämta objektmetadata och/eller innehåll för ett enskilt objekt. Hämtningsparametern är att ange om innehållet ska vara tillgängligt som en nedladdning eller bara skickas som en ström i svaret. Gäller inte för zippat innehåll, som alltid returneras som en nedladdning.
getItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)	Hämta objektmetadata och/eller innehåll för en samling objekt. Hämtningsparametern är att ange om innehållet ska vara tillgängligt som en nedladdning eller bara skickas som en ström i svaret. Gäller inte för zippat innehåll som alltid returneras som en nedladdning.
getItemsBatch(GitItemRequestData, string, string)	Publicera för att hämta en skapande av en batch från en uppsättning objekt i en lagringsplats/ett projekt med en lista över sökvägar eller en lång sökväg
getItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Hämta objektmetadata och/eller innehåll för ett enskilt objekt. Hämtningsparametern är att ange om innehållet ska vara tillgängligt som en nedladdning eller bara skickas som en ström i svaret. Gäller inte för zippat innehåll, som alltid returneras som en nedladdning.
getItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Hämta objektmetadata och/eller innehåll för ett enskilt objekt. Hämtningsparametern är att ange om innehållet ska vara tillgängligt som en nedladdning eller bara skickas som en ström i svaret. Gäller inte för zippat innehåll, som alltid returneras som en nedladdning.
getLikes(string, number, number, number, string)	Få likes för en kommentar.
getMergeBases(string, string, string, string, string, string)	Hitta sammanslagningsbaserna för två incheckningar, om du vill över förgreningar. Om otherRepositoryId inte anges beräknas sammanslagningsbaserna endast inom kontexten för den lokala lagringsplatsenNameOrId.
getMergeRequest(string, string, number, boolean)	Hämta information om en specifik sammanslagningsåtgärd.
getPermission(string, string, string)	STATUS FÖR GET Advanced Security-behörighet.
getPullRequest(string, number, string, number, number, number, boolean, boolean)	Hämta en pull-begäran.
getPullRequestById(number, string)	Hämta en pull-begäran.
getPullRequestCommits(string, number, string)	Hämta incheckningarna för den angivna pull-begäran.
getPullRequestConflict(string, number, number, string)	Hämta en konflikt för en pull-begäran efter ID
getPullRequestConflicts(string, number, string, number, number, boolean, boolean, boolean)	Hämta alla konflikter för en pull-begäran
getPullRequestIteration(string, number, number, string)	Hämta den angivna iterationen för en pull-begäran.
getPullRequestIterationChanges(string, number, number, string, number, number, number)	Hämta ändringarna som gjorts i en pull-begäran mellan två iterationer.
getPullRequestIterationCommits(string, number, number, string, number, number)	Hämta incheckningarna för den angivna iterationen av en pull-begäran.
getPullRequestIterations(string, number, string, boolean)	Hämta listan över iterationer för den angivna pull-begäran.
getPullRequestIterationStatus(string, number, number, number, string)	Hämta den specifika iterationsstatusen för pull-begäran efter ID. Status-ID:t är unikt i pull-begäran för alla iterationer.
getPullRequestIterationStatuses(string, number, number, string)	Hämta alla statusar som är associerade med en iteration för pull-begäran.
getPullRequestLabel(string, number, string, string, string)	Hämtar en enskild etikett (tagg) som har tilldelats en pull-begäran.
getPullRequestLabels(string, number, string, string)	Hämta alla etiketter (taggar) som tilldelats en pull-begäran.
getPullRequestProperties(string, number, string)	Hämta externa egenskaper för pull-begäran.
getPullRequestQuery(GitPullRequestQuery, string, string)	Det här API:et används för att hitta vilka pull-begäranden som är relaterade till en viss incheckning. Den kan användas för att antingen hitta pull-begäran som skapade en viss kopplingsincheckning eller så kan den användas för att hitta alla pull-begäranden som någonsin har sammanfogat en viss incheckning. Indata är en lista över frågor som var och en innehåller en lista över incheckningar. För varje incheckning som du söker efter får du tillbaka en ordlista med incheckning –> pull-begäranden.
getPullRequestReviewer(string, number, string, string)	Hämta information om en viss granskare för en pull-begäran
getPullRequestReviewers(string, number, string)	Hämta granskarna för en pull-begäran
getPullRequests(string, GitPullRequestSearchCriteria, string, number, number, number)	Hämta alla pull-begäranden som matchar ett angivet villkor.
getPullRequestsByProject(string, GitPullRequestSearchCriteria, number, number, number)	Hämta alla pull-begäranden som matchar ett angivet villkor.
getPullRequestStatus(string, number, number, string)	Hämta den specifika pull-begärandestatusen efter ID. Status-ID:t är unikt i pull-begäran för alla iterationer.
getPullRequestStatuses(string, number, string)	Hämta alla statusar som är associerade med en pull-begäran.
getPullRequestThread(string, number, number, string, number, number)	Hämta en tråd i en pull-begäran.
getPullRequestWorkItemRefs(string, number, string)	Hämta en lista över arbetsobjekt som är associerade med en pull-begäran.
getPush(string, number, string, number, boolean)	Hämtar en viss push-överföring.
getPushCommits(string, number, string, number, number, boolean)	Hämta en lista över incheckningar som är associerade med en viss push-överföring.
getPushes(string, string, number, number, GitPushSearchCriteria)	Hämtar push-meddelanden som är associerade med den angivna lagringsplatsen.
getRecycleBinRepositories(string)	Hämta git-lagringsplatser med mjuk borttagning från papperskorgen.
getRefFavorite(string, number)	Hämtar refs-favoriten för ett favorit-ID.
getRefFavorites(string, string, string)	Hämtar refs-favoriter för en lagringsplats och en identitet.
getRefFavoritesForProject(string, string)
getRefs(string, string, string, boolean, boolean, boolean, boolean, boolean, string)	Frågar den angivna lagringsplatsen efter sina referenser och returnerar dem.
getRepositories(string, boolean, boolean, boolean)	Hämta git-lagringsplatser.
getRepositoriesPaged(string, boolean, boolean, boolean, string, number, string)	Hämta git-lagringsplatser med filter efter namn och sidnumrering.
getRepository(string, string)	Hämta en git-lagringsplats.
getRepositoryWithParent(string, boolean, string)	Hämta en git-lagringsplats.
getRevert(string, number, string)	Hämta information om en återställningsåtgärd genom att återställa ID.
getRevertConflict(string, number, number, string)	Hämta en konflikt för återställning efter ID
getRevertConflicts(string, number, string, string, number, boolean, boolean, boolean)	Hämta alla konflikter för en återställning
getRevertForRefName(string, string, string)	Hämta information om en återställningsåtgärd för en specifik gren.
getStatuses(string, string, string, number, number, boolean)	Hämta statusar som är associerade med Git-incheckningen.
getSuggestions(string, string, boolean)	Hämta ett pull-begäransförslag för en viss lagringsplats eller ett visst teamprojekt.
getThreads(string, number, string, number, number)	Hämta alla trådar i en pull-begäran.
getTree(string, string, string, string, boolean, string)	Trädslutpunkten returnerar samlingen med objekt under det angivna trädet. Träd är mappar på en Git-lagringsplats.
getTreeZip(string, string, string, string, boolean, string)	Trädslutpunkten returnerar samlingen med objekt under det angivna trädet. Träd är mappar på en Git-lagringsplats.
queryImportRequests(string, string, boolean)	Hämta importbegäranden för en lagringsplats.
restoreRepositoryFromRecycleBin(GitRecycleBinRepositoryDetails, string, string)	Återställa en mjuk borttagen Git-lagringsplats. Nyligen borttagna lagringsplatser hamnar i ett tillstånd för mjuk borttagning under en tidsperiod innan de tas bort hårt och blir oåterkalleliga.
setEnableOnCreateHost(boolean)
setEnableOnCreateProject(string, boolean)
sharePullRequest(ShareNotificationContext, string, number, string)	Skickar ett e-postmeddelande om en specifik pull-begäran till en uppsättning mottagare
updateCherryPickConflict(GitConflict, string, number, number, string)	Lösning av konflikt vid uppdatering av sammanslagning
updateCherryPickConflicts(GitConflict[], string, number, string)	Uppdatera flera sammanslagningskonflikter
updateComment(Comment, string, number, number, number, string)	Uppdatera en kommentar som är associerad med en specifik tråd i en pull-begäran.
updateEnablementStatus(AdvSecEnablementUpdate[])	POST-aktiveringsstatus för lagringsplatser.
updateImportRequest(GitImportRequest, string, string, number)	Försök igen eller avbryt en misslyckad importbegäran.
updatePullRequest(GitPullRequest, string, number, string)	Uppdatera en pull-begäran
updatePullRequestConflict(GitConflict, string, number, number, string)	Lösning av konflikt vid uppdatering av sammanslagning
updatePullRequestConflicts(GitConflict[], string, number, string)	Uppdatera flera sammanslagningskonflikter
updatePullRequestIterationStatuses(JsonPatchDocument, string, number, number, string)	Uppdatera insamling av iterationsstatusar för pull-begäranden. Den enda åtgärdstypen som stöds är `remove`.
updatePullRequestProperties(JsonPatchDocument, string, number, string)	Skapa eller uppdatera externa egenskaper för pull-begäran. Korrigeringsåtgärden kan vara `add`, `replace` eller `remove`. För `add` åtgärden kan sökvägen vara tom. Om sökvägen är tom måste värdet vara en lista med nyckelvärdepar. För `replace` åtgärden kan sökvägen inte vara tom. Om sökvägen inte finns läggs egenskapen till i samlingen. För `remove` åtgärden kan sökvägen inte vara tom. Om sökvägen inte finns utförs ingen åtgärd.
updatePullRequestReviewer(IdentityRefWithVote, string, number, string, string)	Redigera en granskarpost. Dessa fält kan korrigeras: isFlagged, hasDeclined
updatePullRequestReviewers(IdentityRefWithVote[], string, number, string)	Återställ rösterna från flera granskare på en pull-begäran. Obs! Den här slutpunkten stöder endast uppdatering av röster, men stöder inte uppdatering av nödvändiga granskare (användningsprincip) eller visningsnamn.
updatePullRequestStatuses(JsonPatchDocument, string, number, string)	Uppdatera insamling av status för pull-begäranden. Den enda åtgärdstypen som stöds är `remove`.
updateRef(GitRefUpdate, string, string, string, string)	Lås eller lås upp en gren.
updateRefs(GitRefUpdate[], string, string, string)	Skapa, uppdatera eller ta bort refs (grenar).
updateRepository(GitRepository, string, string)	Uppdaterar Git-lagringsplatsen med antingen ett nytt lagringsplatsnamn eller en ny standardgren.
updateRevertConflict(GitConflict, string, number, number, string)	Lösning av konflikt vid uppdatering av sammanslagning
updateRevertConflicts(GitConflict[], string, number, string)	Uppdatera flera sammanslagningskonflikter
updateThread(GitPullRequestCommentThread, string, number, number, string)	Uppdatera en tråd i en pull-begäran.

Konstruktorinformation

GitRestClient(IVssRestClientOptions)

new GitRestClient(options: IVssRestClientOptions)

Parametrar

options: IVssRestClientOptions

Egenskapsinformation

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Egenskapsvärde

string

Metodinformation

createAnnotatedTag(GitAnnotatedTag, string, string)

Skapa en kommenterad tagg.

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

Parametrar

tagObject: GitAnnotatedTag

Objekt som innehåller information om tagg som ska skapas.

project: string

Projekt-ID eller projektnamn

repositoryId: string

ID eller namn på lagringsplatsen.

Returer

Promise<GitAnnotatedTag>

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

Bifoga en ny fil i en pull-begäran.

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

Parametrar

content: any

Innehåll som ska laddas upp

fileName: string

Namnet på filen.

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

project: string

Projekt-ID eller projektnamn

Returer

Promise<Attachment>

createCherryPick(GitAsyncRefOperationParameters, string, string)

Cherry väljer en specifik incheckning eller incheckningar som är kopplade till en pull-begäran till en ny gren.

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

Parametrar

cherryPickToCreate: GitAsyncRefOperationParameters

project: string

Projekt-ID eller projektnamn

repositoryId: string

ID för lagringsplatsen.

Returer

Promise<GitCherryPick>

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

Skapa en kommentar på en specifik tråd i en pull-begäran (upp till 500 kommentarer kan skapas per tråd).

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

Parametrar

comment: Comment

Kommentaren som ska skapas. Kommentarer kan vara upp till 150 000 tecken.

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

threadId: number

ID för den tråd som den önskade kommentaren finns i.

project: string

Projekt-ID eller projektnamn

Returer

Promise<Comment>

createCommitStatus(GitStatus, string, string, string)

Skapa Git-incheckningsstatus.

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

Parametrar

gitCommitStatusToCreate: GitStatus

Git-incheckningsstatusobjekt som ska skapas.

commitId: string

ID för Git-incheckningen.

repositoryId: string

ID för lagringsplatsen.

project: string

Projekt-ID eller projektnamn

Returer

Promise<GitStatus>

createFavorite(GitRefFavorite, string)

Skapar en referensfavorit

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

Parametrar

favorite: GitRefFavorite

Referensfavoriten att skapa.

project: string

Projekt-ID eller projektnamn

Returer

Promise<GitRefFavorite>

createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)

Begär att en annan lagringsplatss referens hämtas till den här. Den synkroniserar två befintliga gafflar. Information om hur du skapar en förgrening finns i <en href="https://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1"> slutpunkten för lagringsplatser</a>

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

Parametrar

syncParams: GitForkSyncRequestParameters

Källlagringsplats och referensmappning.

repositoryNameOrId: string

Lagringsplatsens namn eller ID.

project: string

Projekt-ID eller projektnamn

includeLinks: boolean

Sant att inkludera länkar

Returer

Promise<GitForkSyncRequest>

createImportRequest(GitImportRequest, string, string)

Skapa en importbegäran.

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

Parametrar

importRequest: GitImportRequest

Importbegäran som ska skapas.

project: string

Projekt-ID eller projektnamn

repositoryId: string

Lagringsplatsens namn eller ID.

Returer

Promise<GitImportRequest>

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

Lägg till en liknande i en kommentar.

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

Parametrar

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

threadId: number

ID:t för tråden som innehåller kommentaren.

commentId: number

ID:t för kommentaren.

project: string

Projekt-ID eller projektnamn

Returer

Promise<void>

createMergeRequest(GitMergeParameters, string, string, boolean)

Begär en git-sammanslagningsåtgärd. För närvarande stöder vi endast sammanslagning av 2 incheckningar.

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

Parametrar

mergeParameters: GitMergeParameters

Föräldrar commitIds and merge commit messsage.

project: string

Projekt-ID eller projektnamn

repositoryNameOrId: string

Lagringsplatsens namn eller ID.

includeLinks: boolean

Sant att inkludera länkar

Returer

Promise<GitMerge>

createPullRequest(GitPullRequest, string, string, boolean)

Skapa en pull-begäran.

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

Parametrar

gitPullRequestToCreate: GitPullRequest

Pull-begäran att skapa.

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

project: string

Projekt-ID eller projektnamn

supportsIterations: boolean

Om det är sant kan efterföljande push-meddelanden till pull-begäran granskas individuellt. Ställ in detta på false för stora pull-begäranden av prestandaskäl om den här funktionen inte behövs.

Returer

Promise<GitPullRequest>

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

Skapa en pull-begärandestatus för iterationen. Den här åtgärden får samma resultat som Skapa status för pull-begäran med angivet iterations-ID i begärandetexten.

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

Parametrar

status: GitPullRequestStatus

Status för pull-begäran för att skapa.

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

iterationId: number

ID för iterationen för pull-begäran.

project: string

Projekt-ID eller projektnamn

Returer

Promise<GitPullRequestStatus>

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

Skapa en tagg (om det inte finns ännu) och lägg till den som en etikett (tagg) för en angiven pull-begäran. Det enda obligatoriska fältet är namnet på den nya etiketten (taggen).

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

Parametrar

label: WebApiCreateTagRequestData

Etikett som ska tilldelas till pull-begäran.

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

project: string

Projekt-ID eller projektnamn

projectId: string

Projekt-ID eller projektnamn.

Returer

Promise<WebApiTagDefinition>

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

Lägg till en granskare i en pull-begäran eller rösta.

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

Parametrar

reviewer: IdentityRefWithVote

Granskarens röst.<br/>Om granskarens ID ingår här måste det matcha parametern reviewerID.<br/>Granskare kan ange sin egen röst med den här metoden. När du lägger till andra granskare måste omröstningen vara inställd på noll.

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

reviewerId: string

ID för granskaren.

project: string

Projekt-ID eller projektnamn

Returer

Promise<IdentityRefWithVote>

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

Lägg till granskare i en pull-begäran.

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

Parametrar

reviewers: IdentityRef[]

Granskare som ska läggas till i pull-begäran.

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

project: string

Projekt-ID eller projektnamn

Returer

Promise<IdentityRefWithVote[]>

createPullRequestStatus(GitPullRequestStatus, string, number, string)

Skapa en status för pull-begäran.

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

Parametrar

status: GitPullRequestStatus

Status för pull-begäran för att skapa.

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

project: string

Projekt-ID eller projektnamn

Returer

Promise<GitPullRequestStatus>

createPush(GitPush, string, string)

Skicka ändringar till lagringsplatsen.

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

Parametrar

push: GitPush

repositoryId: string

Lagringsplatsens namn eller ID.

project: string

Projekt-ID eller projektnamn

Returer

Promise<GitPush>

createRepository(GitRepositoryCreateOptions, string, string)

Skapa en git-lagringsplats i ett teamprojekt.

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

Parametrar

gitRepositoryToCreate: GitRepositoryCreateOptions

Ange lagringsplatsens namn, gruppprojekt och/eller överordnad lagringsplats. Teamprojektinformation kan utelämnas från gitRepositoryToCreate om begäran är projektomfångsbaserad (t.ex. innehåller projekt-ID).

project: string

Projekt-ID eller projektnamn

sourceRef: string

[valfritt] Ange käll refs som ska användas när du skapar en lagringsplats för gafflar

Returer

Promise<GitRepository>

createRevert(GitAsyncRefOperationParameters, string, string)

Startar åtgärden för att skapa en ny gren som återställer ändringar som införts av en specifik incheckning eller incheckningar som är associerade till en pull-begäran.

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

Parametrar

revertToCreate: GitAsyncRefOperationParameters

project: string

Projekt-ID eller projektnamn

repositoryId: string

ID för lagringsplatsen.

Returer

Promise<GitRevert>

createThread(GitPullRequestCommentThread, string, number, string)

Skapa en tråd i en pull-begäran.

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

Parametrar

commentThread: GitPullRequestCommentThread

Tråden som ska skapas. Tråden måste innehålla minst en kommentar.

repositoryId: string

Lagringsplats-ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

project: string

Projekt-ID eller projektnamn

Returer

Promise<GitPullRequestCommentThread>

createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)

Lägg till en omaterialiserad identitet till granskarna av en pull-begäran.

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

Parametrar

reviewer: IdentityRefWithVote

Granskare som ska läggas till i pull-begäran.

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

project: string

Projekt-ID eller projektnamn

Returer

Promise<IdentityRefWithVote>

deleteAttachment(string, string, number, string)

Ta bort en bifogad pull-begäran.

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

Parametrar

fileName: string

Namnet på den bifogade filen som ska tas bort.

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

project: string

Projekt-ID eller projektnamn

Returer

Promise<void>

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

Ta bort en kommentar som är associerad med en specifik tråd i en pull-begäran.

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

Parametrar

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

threadId: number

ID för den tråd som den önskade kommentaren finns i.

commentId: number

ID för kommentaren.

project: string

Projekt-ID eller projektnamn

Returer

Promise<void>

deleteEnablementStatus(boolean, boolean, string[])

DELETE Tar bort aktiveringsstatus och BillableCommitters-data från DB. Om du tar bort aktiveringsdata inaktiveras den effektivt för de berörda lagringsplatserna.

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

Parametrar

allProjects: boolean

includeBillableCommitters: boolean

projectIds: string[]

Returer

Promise<void>

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

Ta bort en liknande i en kommentar.

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

Parametrar

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

threadId: number

ID:t för tråden som innehåller kommentaren.

commentId: number

ID:t för kommentaren.

project: string

Projekt-ID eller projektnamn

Returer

Promise<void>

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

Ta bort iterationsstatus för pull-begäran.

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

Parametrar

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

iterationId: number

ID för iterationen för pull-begäran.

statusId: number

ID för pull-begärandestatusen.

project: string

Projekt-ID eller projektnamn

Returer

Promise<void>

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

Tar bort en etikett (tagg) från uppsättningen med de som tilldelats pull-begäran. Själva taggen tas inte bort.

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

Parametrar

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

labelIdOrName: string

Namnet eller ID:t för den begärda etiketten.

project: string

Projekt-ID eller projektnamn

projectId: string

Projekt-ID eller projektnamn.

Returer

Promise<void>

deletePullRequestReviewer(string, number, string, string)

Ta bort en granskare från en pull-begäran.

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

Parametrar

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

reviewerId: string

ID för granskaren att ta bort.

project: string

Projekt-ID eller projektnamn

Returer

Promise<void>

deletePullRequestStatus(string, number, number, string)

Ta bort status för pull-begäran.

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

Parametrar

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

statusId: number

ID för pull-begärandestatusen.

project: string

Projekt-ID eller projektnamn

Returer

Promise<void>

deleteRefFavorite(string, number)

Tar bort refs-favoriten som angetts

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

Parametrar

project: string

Projekt-ID eller projektnamn

favoriteId: number

ID:t för referensfavoriten att ta bort.

Returer

Promise<void>

deleteRepository(string, string)

Ta bort en git-lagringsplats

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

Parametrar

repositoryId: string

Lagringsplatsens ID.

project: string

Projekt-ID eller projektnamn

Returer

Promise<void>

deleteRepositoryFromRecycleBin(string, string)

Förstör (hård borttagning) en mjuk borttagen Git-lagringsplats.

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

Parametrar

project: string

Projekt-ID eller projektnamn

repositoryId: string

Lagringsplatsens ID.

Returer

Promise<void>

getAnnotatedTag(string, string, string)

Hämta en kommenterad tagg.

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

Parametrar

project: string

Projekt-ID eller projektnamn

repositoryId: string

ID eller namn på lagringsplatsen.

objectId: string

ObjectId (Sha1Id) för tagg att hämta.

Returer

Promise<GitAnnotatedTag>

getAttachmentContent(string, string, number, string)

Hämta filinnehållet i en bifogad pull-begäran.

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

Parametrar

fileName: string

Namnet på den bifogade filen.

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

project: string

Projekt-ID eller projektnamn

Returer

Promise<ArrayBuffer>

getAttachments(string, number, string)

Hämta en lista över filer som är kopplade till en viss pull-begäran.

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

Parametrar

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

project: string

Projekt-ID eller projektnamn

Returer

Promise<Attachment[]>

getAttachmentZip(string, string, number, string)

Hämta filinnehållet i en bifogad pull-begäran.

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

Parametrar

fileName: string

Namnet på den bifogade filen.

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

project: string

Projekt-ID eller projektnamn

Returer

Promise<ArrayBuffer>

getBillableCommitters(string, Date, number, number)

Hämta faktiska fakturerbara incheckningar för Advanced Security Service för ett visst datum.

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

Parametrar

project: string

Projekt-ID eller projektnamn

billingDate: Date

UTC förväntades. Om du inte har angett standardvärdet för föregående faktureringsdag.

skip: number

Hoppa över X rader med resultatuppsättning för att simulera växling.

take: number

Returnera Y-rader med resultatuppsättning för att simulera växling.

Returer

Promise<BillableCommitter[]>

getBillableCommittersDetail(string, string, Date)

Hämta detaljerade faktiska fakturerbara incheckningar för Advanced Security Service för ett visst datum. Detaljerade resultat filtrerar avsiktligt inte bort mjukt borttagna projekt och lagringsplatser för att diagnostisera faktureringsproblem.

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

Parametrar

project: string

Projekt-ID eller projektnamn

includeDetails: string

Returnera all information om de fakturerbara incheckningarna.

billingDate: Date

UTC förväntades. Om du inte har angett standardvärdet för föregående faktureringsdag.

Returer

Promise<BillableCommitterDetail[]>

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

Hämta en enda blob.

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

Parametrar

repositoryId: string

Lagringsplatsens namn eller ID.

sha1: string

SHA1-hash för filen. Du kan hämta SHA1 för en fil med slutpunkten "Git/Items/Get Item".

project: string

Projekt-ID eller projektnamn

download: boolean

Om det är sant frågar du efter en nedladdning i stället för att återge i en webbläsare. Obs! Det här värdet är standardvärdet sant om $format är zip

fileName: string

Ange ett fileName som ska användas för en nedladdning.

resolveLfs: boolean

Om det är sant försöker du matcha en blob till dess LFS-innehåll, om det är en LFS-pekarfil. Endast kompatibel med oktettström Acceptera rubriker eller $format typer

Returer

Promise<GitBlobRef>

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

Hämta en enda blob.

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

Parametrar

repositoryId: string

Lagringsplatsens namn eller ID.

sha1: string

SHA1-hash för filen. Du kan hämta SHA1 för en fil med slutpunkten "Git/Items/Get Item".

project: string

Projekt-ID eller projektnamn

download: boolean

Om det är sant frågar du efter en nedladdning i stället för att återge i en webbläsare. Obs! Det här värdet är standardvärdet sant om $format är zip

fileName: string

Ange ett fileName som ska användas för en nedladdning.

resolveLfs: boolean

Om det är sant försöker du matcha en blob till dess LFS-innehåll, om det är en LFS-pekarfil. Endast kompatibel med oktettström Acceptera rubriker eller $format typer

Returer

Promise<ArrayBuffer>

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

Hämtar en eller flera blobar i en zip-filnedladdning.

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

Parametrar

blobIds: string[]

Blob-ID :er (SHA1-hashvärden) som ska returneras i zip-filen.

repositoryId: string

Lagringsplatsens namn eller ID.

project: string

Projekt-ID eller projektnamn

filename: string

Returer

Promise<ArrayBuffer>

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

Hämta en enda blob.

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

Parametrar

repositoryId: string

Lagringsplatsens namn eller ID.

sha1: string

SHA1-hash för filen. Du kan hämta SHA1 för en fil med slutpunkten "Git/Items/Get Item".

project: string

Projekt-ID eller projektnamn

download: boolean

Om det är sant frågar du efter en nedladdning i stället för att återge i en webbläsare. Obs! Det här värdet är standardvärdet sant om $format är zip

fileName: string

Ange ett fileName som ska användas för en nedladdning.

resolveLfs: boolean

Om det är sant försöker du matcha en blob till dess LFS-innehåll, om det är en LFS-pekarfil. Endast kompatibel med oktettström Acceptera rubriker eller $format typer

Returer

Promise<ArrayBuffer>

getBranch(string, string, string, GitVersionDescriptor)

Hämta statistik om en enda gren.

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

Parametrar

repositoryId: string

Lagringsplatsens namn eller ID.

name: string

Namnet på grenen.

project: string

Projekt-ID eller projektnamn

baseVersionDescriptor: GitVersionDescriptor

Identifierar incheckningen eller grenen som ska användas som bas.

Returer

Promise<GitBranchStats>

getBranches(string, string, GitVersionDescriptor)

Hämta statistik om alla grenar på en lagringsplats.

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

Parametrar

repositoryId: string

Lagringsplatsens namn eller ID.

project: string

Projekt-ID eller projektnamn

baseVersionDescriptor: GitVersionDescriptor

Identifierar incheckningen eller grenen som ska användas som bas.

Returer

Promise<GitBranchStats[]>

getBranchStatsBatch(GitQueryBranchStatsCriteria, string, string)

Hämta statistik för flera incheckningar

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

Parametrar

searchCriteria: GitQueryBranchStatsCriteria

Grundläggande incheckning och lista över målincheckningar att jämföra.

repositoryId: string

Lagringsplatsens namn eller ID.

project: string

Projekt-ID eller projektnamn

Returer

Promise<GitBranchStats[]>

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

Hämta ändringar för en viss incheckning.

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

Parametrar

commitId: string

ID:t för incheckningen.

repositoryId: string

ID eller eget namn på lagringsplatsen. Om du vill använda det egna namnet måste projectId också anges.

project: string

Projekt-ID eller projektnamn

top: number

Det maximala antalet ändringar som ska returneras.

skip: number

Antalet ändringar som ska hoppa över.

Returer

Promise<GitCommitChanges>

getCherryPick(string, number, string)

Hämta information om en körsbärsplockningsåtgärd med körsbärsplocknings-ID.

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

Parametrar

project: string

Projekt-ID eller projektnamn

cherryPickId: number

ID för körsbärsplockningen.

repositoryId: string

ID för lagringsplatsen.

Returer

Promise<GitCherryPick>

getCherryPickConflict(string, number, number, string)

Hämta en konflikt för ett körsbärsval efter ID

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

Parametrar

repositoryId: string

cherryPickId: number

conflictId: number

project: string

Projekt-ID eller projektnamn

Returer

Promise<GitConflict>

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

Hämta alla konflikter för ett körsbärsval

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

Parametrar

repositoryId: string

cherryPickId: number

project: string

Projekt-ID eller projektnamn

continuationToken: string

top: number

excludeResolved: boolean

onlyResolved: boolean

includeObsolete: boolean

Returer

Promise<PagedList<GitConflict>>

getCherryPickForRefName(string, string, string)

Hämta information om en körsbärsplockningsåtgärd för en specifik gren. Den här åtgärden är dyr på grund av den underliggande objektstrukturen, så det här API:et tittar bara på de 1 000 senaste åtgärderna för körsbärsplockning.

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

Parametrar

project: string

Projekt-ID eller projektnamn

repositoryId: string

ID för lagringsplatsen.

refName: string

GitAsyncRefOperationParameters genereradeRefName som används för körsbärsplockningsåtgärden.

Returer

Promise<GitCherryPick>

getCherryPickRelationships(string, string, string, boolean)

Givet ett commitId returnerar en lista över incheckningar som finns i samma cherry-pick-familj.

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

Parametrar

repositoryNameOrId: string

commitId: string

project: string

Projekt-ID eller projektnamn

includeLinks: boolean

Returer

Promise<GitCommitRef[]>

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

Hämta en kommentar som är associerad med en specifik tråd i en pull-begäran.

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

Parametrar

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

threadId: number

ID för den tråd som den önskade kommentaren finns i.

commentId: number

ID för kommentaren.

project: string

Projekt-ID eller projektnamn

Returer

Promise<Comment>

getComments(string, number, number, string)

Hämta alla kommentarer som är associerade med en specifik tråd i en pull-begäran.

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

Parametrar

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

threadId: number

ID för tråden.

project: string

Projekt-ID eller projektnamn

Returer

Promise<Comment[]>

getCommit(string, string, string, number)

Hämta en viss incheckning.

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

Parametrar

commitId: string

ID:t för incheckningen.

repositoryId: string

ID eller eget namn på lagringsplatsen. Om du vill använda det egna namnet måste projectId också anges.

project: string

Projekt-ID eller projektnamn

changeCount: number

Antalet ändringar som ska inkluderas i resultatet.

Returer

Promise<GitCommit>

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

Hitta den närmaste gemensamma incheckningen (kopplingsbasen) mellan bas- och målincheckningar och hämta diff mellan antingen bas- och målincheckningarna eller vanliga incheckningar och målincheckningar.

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

Parametrar

repositoryId: string

Lagringsplatsens namn eller ID.

project: string

Projekt-ID eller projektnamn

diffCommonCommit: boolean

Om det är sant kan du skilja mellan vanliga incheckningar och målincheckningar. Om det är falskt kan du skilja mellan bas- och målincheckningar.

top: number

Maximalt antal ändringar som ska returneras. Standardvärdet är 100.

skip: number

Antal ändringar att hoppa över

baseVersionDescriptor: GitBaseVersionDescriptor

Beskrivning för basincheckning.

targetVersionDescriptor: GitTargetVersionDescriptor

Beskrivning för målincheckning.

Returer

Promise<GitCommitDiffs>

getCommits(string, GitQueryCommitsCriteria, string)

Hämta git-incheckningar för ett projekt

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

Parametrar

repositoryId: string

ID eller eget namn på lagringsplatsen. Om du vill använda det egna namnet måste projectId också anges.

searchCriteria: GitQueryCommitsCriteria

project: string

Projekt-ID eller projektnamn

Returer

Promise<GitCommitRef[]>

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

Hämta git-incheckningar för ett projekt som matchar sökvillkoren

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

Parametrar

searchCriteria: GitQueryCommitsCriteria

Sökalternativ

repositoryId: string

Lagringsplatsens namn eller ID.

project: string

Projekt-ID eller projektnamn

skip: number

Antal incheckningar som ska hoppa över. Värdet får inte överstiga 3 000 000.

top: number

Maximalt antal incheckningar som ska returneras. Värdet får inte överstiga 50 000.

includeStatuses: boolean

Sant för att inkludera ytterligare incheckningsstatusinformation.

Returer

Promise<GitCommitRef[]>

getDeletedRepositories(string)

Hämta borttagna git-lagringsplatser.

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

Parametrar

project: string

Projekt-ID eller projektnamn

Returer

Promise<GitDeletedRepository[]>

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

GET-aktiveringsstatus för projektets lagringsplatser.

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

Parametrar

projectIds: string[]

Null är standardvärdet för alla projekt i värden, en lista över projektets lagringsplatsers status som ska returneras

billingDate: Date

UTC-förväntat, Null-standardvärdet UtcNow() kan anges för en tidpunktsstatus

skip: number

Hoppa över X rader med resultatuppsättning för att simulera växling.

take: number

Returnera Y-rader med resultatuppsättning för att simulera växling.

Returer

Promise<AdvSecEnablementStatus[]>

getEnableOnCreateHost(boolean)

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

Parametrar

enableOnCreateHost: boolean

Returer

Promise<boolean>

getEnableOnCreateProject(string)

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

Parametrar

enableOnCreateProjectId: string

Returer

Promise<boolean>

getEstimatedBillableCommittersRepo(string, string)

Hämta uppskattade fakturerbara incheckningar för en lagringsplats under de senaste 90 dagarna.

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

Parametrar

project: string

Projekt-ID eller projektnamn

repositoryId: string

Returer

Promise<BillableCommitter[]>

getEstimatedBillablePushersOrg()

Hämta uppskattade fakturerbara push-enheter för en organisation för de senaste 90 dagarna.

function getEstimatedBillablePushersOrg(): Promise<BillablePusher[]>

Returer

Promise<BillablePusher[]>

getEstimatedBillablePushersProject(string)

Hämta uppskattade fakturerbara push-enheter för ett projekt för de senaste 90 dagarna.

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

Parametrar

project: string

Projekt-ID eller projektnamn

Returer

Promise<BillablePusher[]>

getFileDiffs(FileDiffsCriteria, string, string)

Hämta fildiffen för var och en av de angivna filerna

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

Parametrar

fileDiffsCriteria: FileDiffsCriteria

Lista över filparametrar

project: string

Projekt-ID eller projektnamn

repositoryId: string

Lagringsplatsens namn eller ID

Returer

Promise<FileDiff[]>

getForks(string, string, string, boolean)

Hämta alla förgreningar för en lagringsplats i samlingen.

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

Parametrar

repositoryNameOrId: string

Lagringsplatsens namn eller ID.

collectionId: string

Samlings-ID för teamprojekt.

project: string

Projekt-ID eller projektnamn

includeLinks: boolean

Sant för att inkludera länkar.

Returer

Promise<GitRepositoryRef[]>

getForkSyncRequest(string, number, string, boolean)

Hämta information om en specifik förgreningssynkroniseringsåtgärd.

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

Parametrar

repositoryNameOrId: string

Lagringsplatsens namn eller ID.

forkSyncOperationId: number

OperationId för synkroniseringsbegäran.

project: string

Projekt-ID eller projektnamn

includeLinks: boolean

Sant för att inkludera länkar.

Returer

Promise<GitForkSyncRequest>

getForkSyncRequests(string, string, boolean, boolean)

Hämta alla begärda synkroniseringsåtgärder för förgrening på den här lagringsplatsen.

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

Parametrar

repositoryNameOrId: string

Lagringsplatsens namn eller ID.

project: string

Projekt-ID eller projektnamn

includeAbandoned: boolean

Sant att inkludera övergivna begäranden.

includeLinks: boolean

Sant för att inkludera länkar.

Returer

Promise<GitForkSyncRequest[]>

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

Hämta objektmetadata och/eller innehåll för ett enskilt objekt. Hämtningsparametern är att ange om innehållet ska vara tillgängligt som en nedladdning eller bara skickas som en ström i svaret. Gäller inte för zippat innehåll, som alltid returneras som en nedladdning.

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>

Parametrar

repositoryId: string

Lagringsplatsens namn eller ID.

path: string

Objektsökvägen.

project: string

Projekt-ID eller projektnamn

scopePath: string

Sökvägsomfånget. Standardvärdet är null.

recursionLevel: VersionControlRecursionType

Rekursionsnivån för den här begäran. Standardvärdet är "none", ingen rekursion.

includeContentMetadata: boolean

Ställ in på true för att inkludera innehållsmetadata. Standardvärdet är falskt.

latestProcessedChange: boolean

Ställ in på true för att inkludera de senaste ändringarna. Standardvärdet är falskt.

download: boolean

Ställ in på true för att ladda ned svaret som en fil. Standardvärdet är falskt.

versionDescriptor: GitVersionDescriptor

Versionsbeskrivning. Standard är standardgrenen för lagringsplatsen.

includeContent: boolean

Ställ in på true för att inkludera objektinnehåll när du begär json. Standardvärdet är falskt.

resolveHfs: boolean

Ställ in på true för att matcha Git HFS-pekarfiler för att returnera verkligt innehåll från Git HFS. Standardvärdet är sant.

sanitize: boolean

Ställ in på true för att sanera en svg-fil och returnera den som avbildning. Endast användbart om det begärs för svg-filen. Standardvärdet är falskt.

Returer

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>

Parametrar

repositoryId: string

Lagringsplatsens namn eller ID.

path: string

Objektsökvägen.

project: string

Projekt-ID eller projektnamn

scopePath: string

Sökvägsomfånget. Standardvärdet är null.

recursionLevel: VersionControlRecursionType

Rekursionsnivån för den här begäran. Standardvärdet är "none", ingen rekursion.

includeContentMetadata: boolean

Ställ in på true för att inkludera innehållsmetadata. Standardvärdet är falskt.

latestProcessedChange: boolean

Ställ in på true för att inkludera de senaste ändringarna. Standardvärdet är falskt.

download: boolean

Ställ in på true för att ladda ned svaret som en fil. Standardvärdet är falskt.

versionDescriptor: GitVersionDescriptor

Versionsbeskrivning. Standard är standardgrenen för lagringsplatsen.

includeContent: boolean

Ställ in på true för att inkludera objektinnehåll när du begär json. Standardvärdet är falskt.

resolveHfs: boolean

Ställ in på true för att matcha Git HFS-pekarfiler för att returnera verkligt innehåll från Git HFS. Standardvärdet är sant.

sanitize: boolean

Ställ in på true för att sanera en svg-fil och returnera den som avbildning. Endast användbart om det begärs för svg-filen. Standardvärdet är falskt.

Returer

Promise<ArrayBuffer>

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

Hämta objektmetadata och/eller innehåll för en samling objekt. Hämtningsparametern är att ange om innehållet ska vara tillgängligt som en nedladdning eller bara skickas som en ström i svaret. Gäller inte för zippat innehåll som alltid returneras som en nedladdning.

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

Parametrar

repositoryId: string

Lagringsplatsens namn eller ID.

project: string

Projekt-ID eller projektnamn

scopePath: string

Sökvägsomfånget. Standardvärdet är null.

recursionLevel: VersionControlRecursionType

Rekursionsnivån för den här begäran. Standardvärdet är "none", ingen rekursion.

includeContentMetadata: boolean

Ställ in på true för att inkludera innehållsmetadata. Standardvärdet är falskt.

latestProcessedChange: boolean

Ställ in på true för att inkludera de senaste ändringarna. Standardvärdet är falskt.

download: boolean

Ställ in på true för att ladda ned svaret som en fil. Standardvärdet är falskt.

includeLinks: boolean

Ställ in på true för att inkludera länkar till objekt. Standardvärdet är falskt.

versionDescriptor: GitVersionDescriptor

Versionsbeskrivning. Standard är standardgrenen för lagringsplatsen.

zipForUnix: boolean

Ställ in på true för att behålla filbehörigheterna för unix-system (och POSIX)-system som körbara filer och symlinks

Returer

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>

Parametrar

repositoryId: string

Lagringsplatsens namn eller ID.

path: string

Objektsökvägen.

project: string

Projekt-ID eller projektnamn

scopePath: string

Sökvägsomfånget. Standardvärdet är null.

recursionLevel: VersionControlRecursionType

Rekursionsnivån för den här begäran. Standardvärdet är "none", ingen rekursion.

includeContentMetadata: boolean

Ställ in på true för att inkludera innehållsmetadata. Standardvärdet är falskt.

latestProcessedChange: boolean

Ställ in på true för att inkludera de senaste ändringarna. Standardvärdet är falskt.

download: boolean

Ställ in på true för att ladda ned svaret som en fil. Standardvärdet är falskt.

versionDescriptor: GitVersionDescriptor

Versionsbeskrivning. Standard är standardgrenen för lagringsplatsen.

includeContent: boolean

Ställ in på true för att inkludera objektinnehåll när du begär json. Standardvärdet är falskt.

resolveHfs: boolean

Ställ in på true för att matcha Git HFS-pekarfiler för att returnera verkligt innehåll från Git HFS. Standardvärdet är sant.

sanitize: boolean

Ställ in på true för att sanera en svg-fil och returnera den som avbildning. Endast användbart om det begärs för svg-filen. Standardvärdet är falskt.

Returer

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>

Parametrar

repositoryId: string

Lagringsplatsens namn eller ID.

path: string

Objektsökvägen.

project: string

Projekt-ID eller projektnamn

scopePath: string

Sökvägsomfånget. Standardvärdet är null.

recursionLevel: VersionControlRecursionType

Rekursionsnivån för den här begäran. Standardvärdet är "none", ingen rekursion.

includeContentMetadata: boolean

Ställ in på true för att inkludera innehållsmetadata. Standardvärdet är falskt.

latestProcessedChange: boolean

Ställ in på true för att inkludera de senaste ändringarna. Standardvärdet är falskt.

download: boolean

Ställ in på true för att ladda ned svaret som en fil. Standardvärdet är falskt.

versionDescriptor: GitVersionDescriptor

Versionsbeskrivning. Standard är standardgrenen för lagringsplatsen.

includeContent: boolean

Ställ in på true för att inkludera objektinnehåll när du begär json. Standardvärdet är falskt.

resolveHfs: boolean

Ställ in på true för att matcha Git HFS-pekarfiler för att returnera verkligt innehåll från Git HFS. Standardvärdet är sant.

sanitize: boolean

Ställ in på true för att sanera en svg-fil och returnera den som avbildning. Endast användbart om det begärs för svg-filen. Standardvärdet är falskt.

Returer

Promise<ArrayBuffer>

getImportRequest(string, string, number)

Hämta en viss importbegäran.

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

Parametrar

project: string

Projekt-ID eller projektnamn

repositoryId: string

Lagringsplatsens namn eller ID.

importRequestId: number

Den unika identifieraren för importbegäran.

Returer

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>

Parametrar

repositoryId: string

Lagringsplatsens namn eller ID.

path: string

Objektsökvägen.

project: string

Projekt-ID eller projektnamn

scopePath: string

Sökvägsomfånget. Standardvärdet är null.

recursionLevel: VersionControlRecursionType

Rekursionsnivån för den här begäran. Standardvärdet är "none", ingen rekursion.

includeContentMetadata: boolean

Ställ in på true för att inkludera innehållsmetadata. Standardvärdet är falskt.

latestProcessedChange: boolean

Ställ in på true för att inkludera de senaste ändringarna. Standardvärdet är falskt.

download: boolean

Ställ in på true för att ladda ned svaret som en fil. Standardvärdet är falskt.

versionDescriptor: GitVersionDescriptor

Versionsbeskrivning. Standard är standardgrenen för lagringsplatsen.

includeContent: boolean

Ställ in på true för att inkludera objektinnehåll när du begär json. Standardvärdet är falskt.

resolveLfs: boolean

Ställ in på true för att matcha Git LFS-pekarfiler för att returnera faktiskt innehåll från Git LFS. Standardvärdet är falskt.

sanitize: boolean

Ställ in på true för att sanera en svg-fil och returnera den som avbildning. Endast användbart om det begärs för svg-filen. Standardvärdet är falskt.

Returer

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>

Parametrar

repositoryId: string

Lagringsplatsens namn eller ID.

path: string

Objektsökvägen.

project: string

Projekt-ID eller projektnamn

scopePath: string

Sökvägsomfånget. Standardvärdet är null.

recursionLevel: VersionControlRecursionType

Rekursionsnivån för den här begäran. Standardvärdet är "none", ingen rekursion.

includeContentMetadata: boolean

Ställ in på true för att inkludera innehållsmetadata. Standardvärdet är falskt.

latestProcessedChange: boolean

Ställ in på true för att inkludera de senaste ändringarna. Standardvärdet är falskt.

download: boolean

Ställ in på true för att ladda ned svaret som en fil. Standardvärdet är falskt.

versionDescriptor: GitVersionDescriptor

Versionsbeskrivning. Standard är standardgrenen för lagringsplatsen.

includeContent: boolean

Ställ in på true för att inkludera objektinnehåll när du begär json. Standardvärdet är falskt.

resolveLfs: boolean

Ställ in på true för att matcha Git LFS-pekarfiler för att returnera faktiskt innehåll från Git LFS. Standardvärdet är falskt.

sanitize: boolean

Ställ in på true för att sanera en svg-fil och returnera den som avbildning. Endast användbart om det begärs för svg-filen. Standardvärdet är falskt.

Returer

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

Parametrar

repositoryId: string

Lagringsplatsens namn eller ID.

project: string

Projekt-ID eller projektnamn

scopePath: string

Sökvägsomfånget. Standardvärdet är null.

recursionLevel: VersionControlRecursionType

Rekursionsnivån för den här begäran. Standardvärdet är "none", ingen rekursion.

includeContentMetadata: boolean

Ställ in på true för att inkludera innehållsmetadata. Standardvärdet är falskt.

latestProcessedChange: boolean

Ställ in på true för att inkludera de senaste ändringarna. Standardvärdet är falskt.

download: boolean

Ställ in på true för att ladda ned svaret som en fil. Standardvärdet är falskt.

includeLinks: boolean

Ställ in på true för att inkludera länkar till objekt. Standardvärdet är falskt.

versionDescriptor: GitVersionDescriptor

Versionsbeskrivning. Standard är standardgrenen för lagringsplatsen.

zipForUnix: boolean

Ställ in på true för att behålla filbehörigheterna för unix-system (och POSIX)-system som körbara filer och symlinks

Returer

Promise<GitItem[]>

getItemsBatch(GitItemRequestData, string, string)

Publicera för att hämta en skapande av en batch från en uppsättning objekt i en lagringsplats/ett projekt med en lista över sökvägar eller en lång sökväg

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

Parametrar

requestData: GitItemRequestData

Begär dataattribut: ItemDescriptors, IncludeContentMetadata, LatestProcessedChange, IncludeLinks. ItemDescriptors: Samling objekt som ska hämtas, inklusive sökväg, version och rekursionsnivå. IncludeContentMetadata: Om metadata ska inkluderas för alla objekt LatestProcessedChange: Om du vill inkludera ytlig referens för incheckning som senast ändrade varje objekt. IncludeLinks: Om fältet _links ska inkluderas i de grunda referenserna.

repositoryId: string

Lagringsplatsens namn eller ID

project: string

Projekt-ID eller projektnamn

Returer

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>

Parametrar

repositoryId: string

Lagringsplatsens namn eller ID.

path: string

Objektsökvägen.

project: string

Projekt-ID eller projektnamn

scopePath: string

Sökvägsomfånget. Standardvärdet är null.

recursionLevel: VersionControlRecursionType

Rekursionsnivån för den här begäran. Standardvärdet är "none", ingen rekursion.

includeContentMetadata: boolean

Ställ in på true för att inkludera innehållsmetadata. Standardvärdet är falskt.

latestProcessedChange: boolean

Ställ in på true för att inkludera de senaste ändringarna. Standardvärdet är falskt.

download: boolean

Ställ in på true för att ladda ned svaret som en fil. Standardvärdet är falskt.

versionDescriptor: GitVersionDescriptor

Versionsbeskrivning. Standard är standardgrenen för lagringsplatsen.

includeContent: boolean

Ställ in på true för att inkludera objektinnehåll när du begär json. Standardvärdet är falskt.

resolveLfs: boolean

Ställ in på true för att matcha Git LFS-pekarfiler för att returnera faktiskt innehåll från Git LFS. Standardvärdet är falskt.

sanitize: boolean

Ställ in på true för att sanera en svg-fil och returnera den som avbildning. Endast användbart om det begärs för svg-filen. Standardvärdet är falskt.

Returer

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>

Parametrar

repositoryId: string

Lagringsplatsens namn eller ID.

path: string

Objektsökvägen.

project: string

Projekt-ID eller projektnamn

scopePath: string

Sökvägsomfånget. Standardvärdet är null.

recursionLevel: VersionControlRecursionType

Rekursionsnivån för den här begäran. Standardvärdet är "none", ingen rekursion.

includeContentMetadata: boolean

Ställ in på true för att inkludera innehållsmetadata. Standardvärdet är falskt.

latestProcessedChange: boolean

Ställ in på true för att inkludera de senaste ändringarna. Standardvärdet är falskt.

download: boolean

Ställ in på true för att ladda ned svaret som en fil. Standardvärdet är falskt.

versionDescriptor: GitVersionDescriptor

Versionsbeskrivning. Standard är standardgrenen för lagringsplatsen.

includeContent: boolean

Ställ in på true för att inkludera objektinnehåll när du begär json. Standardvärdet är falskt.

resolveLfs: boolean

Ställ in på true för att matcha Git LFS-pekarfiler för att returnera faktiskt innehåll från Git LFS. Standardvärdet är falskt.

sanitize: boolean

Ställ in på true för att sanera en svg-fil och returnera den som avbildning. Endast användbart om det begärs för svg-filen. Standardvärdet är falskt.

Returer

Promise<ArrayBuffer>

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

Få likes för en kommentar.

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

Parametrar

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

threadId: number

ID:t för tråden som innehåller kommentaren.

commentId: number

ID:t för kommentaren.

project: string

Projekt-ID eller projektnamn

Returer

Promise<IdentityRef[]>

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

Hitta sammanslagningsbaserna för två incheckningar, om du vill över förgreningar. Om otherRepositoryId inte anges beräknas sammanslagningsbaserna endast inom kontexten för den lokala lagringsplatsenNameOrId.

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

Parametrar

repositoryNameOrId: string

ID eller namn på den lokala lagringsplatsen.

commitId: string

Första incheckningen, vanligtvis spetsen på målgrenen för den potentiella sammanfogningen.

otherCommitId: string

Annan incheckning, vanligtvis spetsen på källgrenen för den potentiella sammanfogningen.

project: string

Projekt-ID eller projektnamn

otherCollectionId: string

Samlings-ID:t där otherCommitId finns.

otherRepositoryId: string

Lagringsplatsens ID där otherCommitId finns.

Returer

Promise<GitCommitRef[]>

getMergeRequest(string, string, number, boolean)

Hämta information om en specifik sammanslagningsåtgärd.

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

Parametrar

project: string

Projekt-ID eller projektnamn

repositoryNameOrId: string

Lagringsplatsens namn eller ID.

mergeOperationId: number

OperationId för sammanslagningsbegäran.

includeLinks: boolean

Sant att inkludera länkar

Returer

Promise<GitMerge>

getPermission(string, string, string)

STATUS FÖR GET Advanced Security-behörighet.

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

Parametrar

projectName: string

repositoryId: string

Lagringsplatsens användare försöker komma åt

permission: string

Behörighet som begärs måste vara "viewAlert" "dismissAlert" "manage" "viewEnablement" eller "repoRead"

Returer

Promise<boolean>

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

Hämta en pull-begäran.

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

Parametrar

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID:t för pull-begäran som ska hämtas.

project: string

Projekt-ID eller projektnamn

maxCommentLength: number

Används inte.

skip: number

Används inte.

top: number

Används inte.

includeCommits: boolean

Om det är sant returneras pull-begäran med de associerade incheckningarna.

includeWorkItemRefs: boolean

Om det är sant returneras pull-begäran med de associerade arbetsobjektreferenserna.

Returer

Promise<GitPullRequest>

getPullRequestById(number, string)

Hämta en pull-begäran.

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

Parametrar

pullRequestId: number

ID:t för pull-begäran som ska hämtas.

project: string

Projekt-ID eller projektnamn

Returer

Promise<GitPullRequest>

getPullRequestCommits(string, number, string)

Hämta incheckningarna för den angivna pull-begäran.

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

Parametrar

repositoryId: string

ID eller namn på lagringsplatsen.

pullRequestId: number

ID för pull-begäran.

project: string

Projekt-ID eller projektnamn

Returer

Promise<PagedList<GitCommitRef>>

getPullRequestConflict(string, number, number, string)

Hämta en konflikt för en pull-begäran efter ID

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

Parametrar

repositoryId: string

pullRequestId: number

conflictId: number

project: string

Projekt-ID eller projektnamn

Returer

Promise<GitConflict>

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

Hämta alla konflikter för en pull-begäran

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

Parametrar

repositoryId: string

Lagringsplatsen för pull-begäran.

pullRequestId: number

Pull-begärande-ID:t.

project: string

Projekt-ID eller projektnamn

skip: number

Konflikter att hoppa över.

top: number

Konflikter som ska returneras efter hoppa.

includeObsolete: boolean

Innehåller föråldrade konflikter.

excludeResolved: boolean

Utesluter konflikter som redan har lösts.

onlyResolved: boolean

Returnerar endast de konflikter som är lösta.

Returer

Promise<GitConflict[]>

getPullRequestIteration(string, number, number, string)

Hämta den angivna iterationen för en pull-begäran.

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

Parametrar

repositoryId: string

ID eller namn på lagringsplatsen.

pullRequestId: number

ID för pull-begäran.

iterationId: number

ID för iterationen för pull-begäran som ska returneras.

project: string

Projekt-ID eller projektnamn

Returer

Promise<GitPullRequestIteration>

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

Hämta ändringarna som gjorts i en pull-begäran mellan två iterationer.

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

Parametrar

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

iterationId: number

ID för iterationen för pull-begäran. <br/> Iteration en är chefen för källgrenen när pull-begäran skapas och efterföljande iterationer skapas när det finns push-meddelanden till källgrenen. Tillåtna värden är mellan 1 och den maximala iterationen för den här pull-begäran.

project: string

Projekt-ID eller projektnamn

top: number

Valfri. Antalet ändringar som ska hämtas. Standardvärdet är 100 och det maximala värdet är 2 000.

skip: number

Valfri. Antalet ändringar som ska ignoreras. Om du till exempel vill hämta ändringarna 101–150 anger du topp 50 och hoppar över till 100.

compareTo: number

ID för iterationen för pull-begäran som ska jämföras med. Standardvärdet är noll, vilket indikerar att jämförelsen görs mot den gemensamma incheckningen mellan käll- och målgrenarna

Returer

Promise<GitPullRequestIterationChanges>

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

Hämta incheckningarna för den angivna iterationen av en pull-begäran.

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

Parametrar

repositoryId: string

ID eller namn på lagringsplatsen.

pullRequestId: number

ID för pull-begäran.

iterationId: number

ID för den iteration som incheckningarna ska hämtas från.

project: string

Projekt-ID eller projektnamn

top: number

Maximalt antal incheckningar som ska returneras. Det maximala antalet incheckningar som kan returneras per batch är 500.

skip: number

Antal incheckningar som ska hoppa över.

Returer

Promise<GitCommitRef[]>

getPullRequestIterations(string, number, string, boolean)

Hämta listan över iterationer för den angivna pull-begäran.

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

Parametrar

repositoryId: string

ID eller namn på lagringsplatsen.

pullRequestId: number

ID för pull-begäran.

project: string

Projekt-ID eller projektnamn

includeCommits: boolean

Om sant inkluderar du de incheckningar som är associerade med varje iteration i svaret.

Returer

Promise<GitPullRequestIteration[]>

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

Hämta den specifika iterationsstatusen för pull-begäran efter ID. Status-ID:t är unikt i pull-begäran för alla iterationer.

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

Parametrar

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

iterationId: number

ID för iterationen för pull-begäran.

statusId: number

ID för pull-begärandestatusen.

project: string

Projekt-ID eller projektnamn

Returer

Promise<GitPullRequestStatus>

getPullRequestIterationStatuses(string, number, number, string)

Hämta alla statusar som är associerade med en iteration för pull-begäran.

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

Parametrar

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

iterationId: number

ID för iterationen för pull-begäran.

project: string

Projekt-ID eller projektnamn

Returer

Promise<GitPullRequestStatus[]>

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

Hämtar en enskild etikett (tagg) som har tilldelats en pull-begäran.

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

Parametrar

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

labelIdOrName: string

Namnet eller ID:t för den begärda etiketten.

project: string

Projekt-ID eller projektnamn

projectId: string

Projekt-ID eller projektnamn.

Returer

Promise<WebApiTagDefinition>

getPullRequestLabels(string, number, string, string)

Hämta alla etiketter (taggar) som tilldelats en pull-begäran.

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

Parametrar

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

project: string

Projekt-ID eller projektnamn

projectId: string

Projekt-ID eller projektnamn.

Returer

Promise<WebApiTagDefinition[]>

getPullRequestProperties(string, number, string)

Hämta externa egenskaper för pull-begäran.

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

Parametrar

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

project: string

Projekt-ID eller projektnamn

Returer

Promise<any>

getPullRequestQuery(GitPullRequestQuery, string, string)

Det här API:et används för att hitta vilka pull-begäranden som är relaterade till en viss incheckning. Den kan användas för att antingen hitta pull-begäran som skapade en viss kopplingsincheckning eller så kan den användas för att hitta alla pull-begäranden som någonsin har sammanfogat en viss incheckning. Indata är en lista över frågor som var och en innehåller en lista över incheckningar. För varje incheckning som du söker efter får du tillbaka en ordlista med incheckning –> pull-begäranden.

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

Parametrar

queries: GitPullRequestQuery

Listan över frågor som ska utföras.

repositoryId: string

ID för lagringsplatsen.

project: string

Projekt-ID eller projektnamn

Returer

Promise<GitPullRequestQuery>

getPullRequestReviewer(string, number, string, string)

Hämta information om en viss granskare för en pull-begäran

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

Parametrar

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

reviewerId: string

ID för granskaren.

project: string

Projekt-ID eller projektnamn

Returer

Promise<IdentityRefWithVote>

getPullRequestReviewers(string, number, string)

Hämta granskarna för en pull-begäran

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

Parametrar

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

project: string

Projekt-ID eller projektnamn

Returer

Promise<IdentityRefWithVote[]>

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

Hämta alla pull-begäranden som matchar ett angivet villkor.

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

Parametrar

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

searchCriteria: GitPullRequestSearchCriteria

Pull-begäranden returneras som matchar det här sökvillkoren.

project: string

Projekt-ID eller projektnamn

maxCommentLength: number

Används inte.

skip: number

Antalet pull-begäranden som ska ignoreras. Om du till exempel vill hämta resultat 101–150 anger du topp till 50 och hoppar över till 100.

top: number

Antalet pull-begäranden som ska hämtas.

Returer

Promise<GitPullRequest[]>

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

Hämta alla pull-begäranden som matchar ett angivet villkor.

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

Parametrar

project: string

Projekt-ID eller projektnamn

searchCriteria: GitPullRequestSearchCriteria

Pull-begäranden returneras som matchar det här sökvillkoren.

maxCommentLength: number

Används inte.

skip: number

Antalet pull-begäranden som ska ignoreras. Om du till exempel vill hämta resultat 101–150 anger du topp till 50 och hoppar över till 100.

top: number

Antalet pull-begäranden som ska hämtas.

Returer

Promise<GitPullRequest[]>

getPullRequestStatus(string, number, number, string)

Hämta den specifika pull-begärandestatusen efter ID. Status-ID:t är unikt i pull-begäran för alla iterationer.

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

Parametrar

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

statusId: number

ID för pull-begärandestatusen.

project: string

Projekt-ID eller projektnamn

Returer

Promise<GitPullRequestStatus>

getPullRequestStatuses(string, number, string)

Hämta alla statusar som är associerade med en pull-begäran.

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

Parametrar

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

project: string

Projekt-ID eller projektnamn

Returer

Promise<GitPullRequestStatus[]>

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

Hämta en tråd i en pull-begäran.

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

Parametrar

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

threadId: number

ID för tråden.

project: string

Projekt-ID eller projektnamn

iteration: number

Om det anges spåras trådpositionen med den här iterationen som höger sida av diffet.

baseIteration: number

Om det anges spåras trådpositionen med den här iterationen som vänster sida av diffet.

Returer

Promise<GitPullRequestCommentThread>

getPullRequestWorkItemRefs(string, number, string)

Hämta en lista över arbetsobjekt som är associerade med en pull-begäran.

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

Parametrar

repositoryId: string

ID eller namn på lagringsplatsen.

pullRequestId: number

ID för pull-begäran.

project: string

Projekt-ID eller projektnamn

Returer

Promise<ResourceRef[]>

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

Hämtar en viss push-överföring.

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

Parametrar

repositoryId: string

Lagringsplatsens namn eller ID.

pushId: number

ID för push-överföringen.

project: string

Projekt-ID eller projektnamn

includeCommits: number

Antalet incheckningar som ska inkluderas i resultatet.

includeRefUpdates: boolean

Om det är sant tar du med listan med refs som uppdaterades av push-överföringen.

Returer

Promise<GitPush>

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

Hämta en lista över incheckningar som är associerade med en viss push-överföring.

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

Parametrar

repositoryId: string

ID eller eget namn på lagringsplatsen. Om du vill använda det egna namnet måste projectId också anges.

pushId: number

ID:t för push-överföringen.

project: string

Projekt-ID eller projektnamn

top: number

Det maximala antalet incheckningar som ska returneras ("get the top x commits").

skip: number

Antalet incheckningar som ska hoppa över.

includeLinks: boolean

Ställ in på false för att undvika att inkludera REST Url-länkar för resurser. Standardvärdet är sant.

Returer

Promise<GitCommitRef[]>

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

Hämtar push-meddelanden som är associerade med den angivna lagringsplatsen.

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

Parametrar

repositoryId: string

Lagringsplatsens namn eller ID.

project: string

Projekt-ID eller projektnamn

skip: number

Antal push-meddelanden att hoppa över.

top: number

Antal push-meddelanden som ska returneras.

searchCriteria: GitPushSearchCriteria

Sökvillkorsattribut: fromDate, toDate, pusherId, refName, includeRefUpdates eller includeLinks. fromDate: Startdatum att söka från. toDate: Slutdatum att söka efter. pusherId: Identitet för den person som skickade push-överföringen. refName: Grennamn att tänka på. includeRefUpdates: Om sant tar du med listan med refs som uppdaterades av push-överföringen. includeLinks: Om fältet _links ska inkluderas i de grunda referenserna.

Returer

Promise<GitPush[]>

getRecycleBinRepositories(string)

Hämta git-lagringsplatser med mjuk borttagning från papperskorgen.

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

Parametrar

project: string

Projekt-ID eller projektnamn

Returer

Promise<GitDeletedRepository[]>

getRefFavorite(string, number)

Hämtar refs-favoriten för ett favorit-ID.

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

Parametrar

project: string

Projekt-ID eller projektnamn

favoriteId: number

ID:t för den begärda ref-favoriten.

Returer

Promise<GitRefFavorite>

getRefFavorites(string, string, string)

Hämtar refs-favoriter för en lagringsplats och en identitet.

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

Parametrar

project: string

Projekt-ID eller projektnamn

repositoryId: string

ID:t för lagringsplatsen.

identityId: string

ID:t för den identitet vars favoriter ska hämtas. Om värdet är null används den begärande identiteten.

Returer

Promise<GitRefFavorite[]>

getRefFavoritesForProject(string, string)

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

Parametrar

project: string

Projekt-ID eller projektnamn

identityId: string

Returer

Promise<GitRefFavorite[]>

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

Frågar den angivna lagringsplatsen efter sina referenser och returnerar dem.

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

Parametrar

repositoryId: string

Lagringsplatsens namn eller ID.

project: string

Projekt-ID eller projektnamn

filter: string

[valfritt] Ett filter som ska tillämpas på referenserna (börjar med).

includeLinks: boolean

[valfritt] Anger om referenceLinks ska ingå i resultatet. standardvärdet är falskt.

includeStatuses: boolean

[valfritt] Innehåller upp till de första 1 000 incheckningsstatusarna för varje referens. Standardvärdet är falskt.

includeMyBranches: boolean

[valfritt] Innehåller endast grenar som användaren äger, grenarna användarens favoriter och standardgrenen. Standardvärdet är falskt. Det går inte att kombinera med filterparametern.

latestStatusesOnly: boolean

[valfritt] Sant att endast inkludera incheckningsstatus för tips för varje referens. Det här alternativet kräver att includeStatuses är sant. Standardvärdet är falskt.

peelTags: boolean

[valfritt] Kommenterade taggar fyller egenskapen PeeledObjectId. standardvärdet är falskt.

filterContains: string

[valfritt] Ett filter som ska tillämpas på referenserna (innehåller).

Returer

Promise<PagedList<GitRef>>

getRepositories(string, boolean, boolean, boolean)

Hämta git-lagringsplatser.

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

Parametrar

project: string

Projekt-ID eller projektnamn

includeLinks: boolean

[valfritt] Sant för att inkludera referenslänkar. Standardvärdet är falskt.

includeAllUrls: boolean

[valfritt] Sant för att inkludera alla fjärr-URL:er. Standardvärdet är falskt.

includeHidden: boolean

[valfritt] Sant för att inkludera dolda lagringsplatser. Standardvärdet är falskt.

Returer

Promise<GitRepository[]>

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

Hämta git-lagringsplatser med filter efter namn och sidnumrering.

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

Parametrar

projectId: string

ID eller namn på teamprojektet.

includeLinks: boolean

[valfritt] Sant för att inkludera referenslänkar. Standardvärdet är falskt.

includeAllUrls: boolean

[valfritt] Sant för att inkludera alla fjärr-URL:er. Standardvärdet är falskt.

includeHidden: boolean

[valfritt] Sant för att inkludera dolda lagringsplatser. Standardvärdet är falskt.

filterContains: string

[valfritt] Ett filter som ska tillämpas på referenserna (innehåller).

top: number

[valfritt] Maximalt antal lagringsplatser som ska returneras. Den får inte vara större än 500. Om det inte tillhandahålls men continuationToken är, kommer top som standard att vara 100.

continuationToken: string

Fortsättningstoken som används för sidnumrering.

Returer

Promise<PagedList<GitRepository>>

getRepository(string, string)

Hämta en git-lagringsplats.

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

Parametrar

repositoryId: string

Lagringsplatsens namn eller ID.

project: string

Projekt-ID eller projektnamn

Returer

Promise<GitRepository>

getRepositoryWithParent(string, boolean, string)

Hämta en git-lagringsplats.

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

Parametrar

repositoryId: string

Lagringsplatsens namn eller ID.

includeParent: boolean

Sant att inkludera överordnad lagringsplats. Endast tillgängligt i autentiserade anrop.

project: string

Projekt-ID eller projektnamn

Returer

Promise<GitRepository>

getRevert(string, number, string)

Hämta information om en återställningsåtgärd genom att återställa ID.

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

Parametrar

project: string

Projekt-ID eller projektnamn

revertId: number

ID för återställningsåtgärden.

repositoryId: string

ID för lagringsplatsen.

Returer

Promise<GitRevert>

getRevertConflict(string, number, number, string)

Hämta en konflikt för återställning efter ID

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

Parametrar

repositoryId: string

revertId: number

conflictId: number

project: string

Projekt-ID eller projektnamn

Returer

Promise<GitConflict>

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

Hämta alla konflikter för en återställning

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

Parametrar

repositoryId: string

revertId: number

project: string

Projekt-ID eller projektnamn

continuationToken: string

top: number

excludeResolved: boolean

onlyResolved: boolean

includeObsolete: boolean

Returer

Promise<PagedList<GitConflict>>

getRevertForRefName(string, string, string)

Hämta information om en återställningsåtgärd för en specifik gren.

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

Parametrar

project: string

Projekt-ID eller projektnamn

repositoryId: string

ID för lagringsplatsen.

refName: string

GitAsyncRefOperationParameters genereradeRefName som används för återställningsåtgärden.

Returer

Promise<GitRevert>

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

Hämta statusar som är associerade med Git-incheckningen.

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

Parametrar

commitId: string

ID för Git-incheckningen.

repositoryId: string

ID för lagringsplatsen.

project: string

Projekt-ID eller projektnamn

top: number

Valfri. Antalet statusar som ska hämtas. Standardvärdet är 1 000.

skip: number

Valfri. Antalet statusar som ska ignoreras. Standardvärdet är 0. Om du till exempel vill hämta resultat 101–150 anger du topp till 50 och hoppar över till 100.

latestOnly: boolean

Flaggan anger om endast de senaste statusarna ska grupperas efter Context.Name och Context.Genre.

Returer

Promise<GitStatus[]>

getSuggestions(string, string, boolean)

Hämta ett pull-begäransförslag för en viss lagringsplats eller ett visst teamprojekt.

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

Parametrar

repositoryId: string

ID för git-lagringsplatsen.

project: string

Projekt-ID eller projektnamn

preferCompareBranch: boolean

Om det är sant föredrar du jämförelsegrenen framför standardgrenen som målgren för pull-begäranden.

Returer

Promise<GitSuggestion[]>

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

Hämta alla trådar i en pull-begäran.

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

Parametrar

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

project: string

Projekt-ID eller projektnamn

iteration: number

Om det anges spåras trådpositioner med den här iterationen som höger sida av diffet.

baseIteration: number

Om det anges spåras trådpositioner med den här iterationen som vänster sida av diffet.

Returer

Promise<GitPullRequestCommentThread[]>

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

Trädslutpunkten returnerar samlingen med objekt under det angivna trädet. Träd är mappar på en Git-lagringsplats.

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

Parametrar

repositoryId: string

Lagringsplats-ID.

sha1: string

SHA1-hash för trädobjektet.

project: string

Projekt-ID eller projektnamn

projectId: string

Projekt-ID.

recursive: boolean

Sök rekursivt. Ta med träd under det här trädet. Standardvärdet är falskt.

fileName: string

Namn som ska användas om en .zip fil returneras. Standardvärdet är objekt-ID.

Returer

Promise<GitTreeRef>

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

Trädslutpunkten returnerar samlingen med objekt under det angivna trädet. Träd är mappar på en Git-lagringsplats.

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

Parametrar

repositoryId: string

Lagringsplats-ID.

sha1: string

SHA1-hash för trädobjektet.

project: string

Projekt-ID eller projektnamn

projectId: string

Projekt-ID.

recursive: boolean

Sök rekursivt. Ta med träd under det här trädet. Standardvärdet är falskt.

fileName: string

Namn som ska användas om en .zip fil returneras. Standardvärdet är objekt-ID.

Returer

Promise<ArrayBuffer>

queryImportRequests(string, string, boolean)

Hämta importbegäranden för en lagringsplats.

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

Parametrar

project: string

Projekt-ID eller projektnamn

repositoryId: string

Lagringsplatsens namn eller ID.

includeAbandoned: boolean

Sant att inkludera övergivna importbegäranden i resultatet.

Returer

Promise<GitImportRequest[]>

restoreRepositoryFromRecycleBin(GitRecycleBinRepositoryDetails, string, string)

Återställa en mjuk borttagen Git-lagringsplats. Nyligen borttagna lagringsplatser hamnar i ett tillstånd för mjuk borttagning under en tidsperiod innan de tas bort hårt och blir oåterkalleliga.

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

Parametrar

repositoryDetails: GitRecycleBinRepositoryDetails

project: string

Projekt-ID eller projektnamn

repositoryId: string

Lagringsplatsens ID.

Returer

Promise<GitRepository>

setEnableOnCreateHost(boolean)

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

Parametrar

enableOnCreateHost: boolean

Returer

Promise<void>

setEnableOnCreateProject(string, boolean)

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

Parametrar

enableOnCreateProjectId: string

enableOnStatus: boolean

Returer

Promise<void>

sharePullRequest(ShareNotificationContext, string, number, string)

Skickar ett e-postmeddelande om en specifik pull-begäran till en uppsättning mottagare

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

Parametrar

userMessage: ShareNotificationContext

repositoryId: string

ID för git-lagringsplatsen.

pullRequestId: number

ID för pull-begäran.

project: string

Projekt-ID eller projektnamn

Returer

Promise<void>

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

Lösning av konflikt vid uppdatering av sammanslagning

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

Parametrar

conflict: GitConflict

repositoryId: string

cherryPickId: number

conflictId: number

project: string

Projekt-ID eller projektnamn

Returer

Promise<GitConflict>

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

Uppdatera flera sammanslagningskonflikter

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

Parametrar

conflictUpdates: GitConflict[]

repositoryId: string

cherryPickId: number

project: string

Projekt-ID eller projektnamn

Returer

Promise<GitConflictUpdateResult[]>

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

Uppdatera en kommentar som är associerad med en specifik tråd i en pull-begäran.

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

Parametrar

comment: Comment

Kommentarsinnehållet som ska uppdateras. Kommentarer kan vara upp till 150 000 tecken.

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

threadId: number

ID för den tråd som den önskade kommentaren finns i.

commentId: number

ID för kommentaren som ska uppdateras.

project: string

Projekt-ID eller projektnamn

Returer

Promise<Comment>

updateEnablementStatus(AdvSecEnablementUpdate[])

POST-aktiveringsstatus för lagringsplatser.

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

Parametrar

enablementUpdates: AdvSecEnablementUpdate[]

Returer

Promise<void>

updateImportRequest(GitImportRequest, string, string, number)

Försök igen eller avbryt en misslyckad importbegäran.

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

Parametrar

importRequestToUpdate: GitImportRequest

Den uppdaterade versionen av importbegäran. För närvarande är den enda tillåtna ändringen att ange Status till I kö eller Övergiven.

project: string

Projekt-ID eller projektnamn

repositoryId: string

Lagringsplatsens namn eller ID.

importRequestId: number

Den unika identifieraren för importbegäran som ska uppdateras.

Returer

Promise<GitImportRequest>

updatePullRequest(GitPullRequest, string, number, string)

Uppdatera en pull-begäran

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

Parametrar

gitPullRequestToUpdate: GitPullRequest

Det pull-begärandeinnehåll som ska uppdateras.

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran om uppdatering.

project: string

Projekt-ID eller projektnamn

Returer

Promise<GitPullRequest>

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

Lösning av konflikt vid uppdatering av sammanslagning

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

Parametrar

conflict: GitConflict

repositoryId: string

pullRequestId: number

conflictId: number

project: string

Projekt-ID eller projektnamn

Returer

Promise<GitConflict>

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

Uppdatera flera sammanslagningskonflikter

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

Parametrar

conflictUpdates: GitConflict[]

repositoryId: string

pullRequestId: number

project: string

Projekt-ID eller projektnamn

Returer

Promise<GitConflictUpdateResult[]>

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

Uppdatera insamling av iterationsstatusar för pull-begäranden. Den enda åtgärdstypen som stöds är remove.

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

Parametrar

patchDocument: JsonPatchDocument

Åtgärder som ska tillämpas på status för pull-begäranden i JSON Patch-format.

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

iterationId: number

ID för iterationen för pull-begäran.

project: string

Projekt-ID eller projektnamn

Returer

Promise<void>

updatePullRequestProperties(JsonPatchDocument, string, number, string)

Skapa eller uppdatera externa egenskaper för pull-begäran. Korrigeringsåtgärden kan vara add, replace eller remove. För add åtgärden kan sökvägen vara tom. Om sökvägen är tom måste värdet vara en lista med nyckelvärdepar. För replace åtgärden kan sökvägen inte vara tom. Om sökvägen inte finns läggs egenskapen till i samlingen. För remove åtgärden kan sökvägen inte vara tom. Om sökvägen inte finns utförs ingen åtgärd.

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

Parametrar

patchDocument: JsonPatchDocument

Egenskaper för att lägga till, ersätta eller ta bort i JSON Patch-format.

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

project: string

Projekt-ID eller projektnamn

Returer

Promise<any>

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

Redigera en granskarpost. Dessa fält kan korrigeras: isFlagged, hasDeclined

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

Parametrar

reviewer: IdentityRefWithVote

Granskardata.<br/>Om granskarens ID ingår här måste det matcha parametern reviewerID.

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

reviewerId: string

ID för granskaren.

project: string

Projekt-ID eller projektnamn

Returer

Promise<IdentityRefWithVote>

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

Återställ rösterna från flera granskare på en pull-begäran. Obs! Den här slutpunkten stöder endast uppdatering av röster, men stöder inte uppdatering av nödvändiga granskare (användningsprincip) eller visningsnamn.

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

Parametrar

patchVotes: IdentityRefWithVote[]

ID:t för granskarna vars röster återställs till noll

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran

project: string

Projekt-ID eller projektnamn

Returer

Promise<void>

updatePullRequestStatuses(JsonPatchDocument, string, number, string)

Uppdatera insamling av status för pull-begäranden. Den enda åtgärdstypen som stöds är remove.

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

Parametrar

patchDocument: JsonPatchDocument

Åtgärder som ska tillämpas på status för pull-begäranden i JSON Patch-format.

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

project: string

Projekt-ID eller projektnamn

Returer

Promise<void>

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

Lås eller lås upp en gren.

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

Parametrar

newRefInfo: GitRefUpdate

Referensuppdateringsåtgärden (lås/upplåsning) som ska utföras

repositoryId: string

Lagringsplatsens namn eller ID.

filter: string

Namnet på grenen som ska låsas/låsas upp

project: string

Projekt-ID eller projektnamn

projectId: string

ID eller namn på teamprojektet. Valfritt om du anger ett ID för lagringsplatsen.

Returer

Promise<GitRef>

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

Skapa, uppdatera eller ta bort refs (grenar).

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

Parametrar

refUpdates: GitRefUpdate[]

Lista över referensuppdateringar som ska utföras

repositoryId: string

Lagringsplatsens namn eller ID.

project: string

Projekt-ID eller projektnamn

projectId: string

ID eller namn på teamprojektet. Valfritt om du anger ett ID för lagringsplatsen.

Returer

Promise<GitRefUpdateResult[]>

updateRepository(GitRepository, string, string)

Uppdaterar Git-lagringsplatsen med antingen ett nytt lagringsplatsnamn eller en ny standardgren.

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

Parametrar

newRepositoryInfo: GitRepository

Ange ett nytt lagringsplatsnamn eller en ny standardgren för lagringsplatsen

repositoryId: string

Lagringsplatsens ID.

project: string

Projekt-ID eller projektnamn

Returer

Promise<GitRepository>

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

Lösning av konflikt vid uppdatering av sammanslagning

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

Parametrar

conflict: GitConflict

repositoryId: string

revertId: number

conflictId: number

project: string

Projekt-ID eller projektnamn

Returer

Promise<GitConflict>

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

Uppdatera flera sammanslagningskonflikter

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

Parametrar

conflictUpdates: GitConflict[]

repositoryId: string

revertId: number

project: string

Projekt-ID eller projektnamn

Returer

Promise<GitConflictUpdateResult[]>

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

Uppdatera en tråd i en pull-begäran.

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

Parametrar

commentThread: GitPullRequestCommentThread

Det trådinnehåll som ska uppdateras.

repositoryId: string

Lagringsplatsens ID för pull-begärans målgren.

pullRequestId: number

ID för pull-begäran.

threadId: number

ID för den tråd som ska uppdateras.

project: string

Projekt-ID eller projektnamn

Returer

Promise<GitPullRequestCommentThread>

Dela via

GitRestClient class

Konstruktorer

Egenskaper

Metoder

Konstruktorinformation

GitRestClient(IVssRestClientOptions)

Parametrar

Egenskapsinformation

RESOURCE_AREA_ID

Egenskapsvärde

Metodinformation

createAnnotatedTag(GitAnnotatedTag, string, string)

Parametrar

Returer

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

Parametrar

Returer

createCherryPick(GitAsyncRefOperationParameters, string, string)

Parametrar

Returer

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

Parametrar

Returer

createCommitStatus(GitStatus, string, string, string)

Parametrar

Returer

createFavorite(GitRefFavorite, string)

Parametrar

Returer

createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)

Parametrar

Returer

createImportRequest(GitImportRequest, string, string)

Parametrar

Returer

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

Parametrar

Returer

createMergeRequest(GitMergeParameters, string, string, boolean)

Parametrar

Returer

createPullRequest(GitPullRequest, string, string, boolean)

Parametrar

Returer

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

Parametrar

Returer

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

Parametrar

Returer

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

Parametrar

Returer

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

Parametrar

Returer

createPullRequestStatus(GitPullRequestStatus, string, number, string)

Parametrar

Returer

createPush(GitPush, string, string)

Parametrar

Returer

createRepository(GitRepositoryCreateOptions, string, string)

Parametrar

Returer

createRevert(GitAsyncRefOperationParameters, string, string)

Parametrar

Returer

createThread(GitPullRequestCommentThread, string, number, string)

Parametrar

Returer

createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)

Parametrar

Returer

deleteAttachment(string, string, number, string)

Parametrar

Returer

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

Parametrar