GitRestClient class

Referenz

Paket:: azure-devops-extension-api

Basisklasse, die verwendet werden soll (abgeleitet von), um Anforderungen an VSS-REST-APIs zu stellen

Extends: RestClientBase

Konstruktoren

GitRestClient(IVssRestClientOptions)

Eigenschaften

RESOURCE_AREA_ID

Methoden

createAnnotatedTag(GitAnnotatedTag, string, string)	Erstellen Sie ein kommentiertes Tag.
createAttachment(any, string, string, number, string)	Fügen Sie eine neue Datei an eine Pullanforderung an.
createCherryPick(GitAsyncRefOperationParameters, string, string)	Cherry pick a specific commit or commits that are associated to a pull request into a new branch.
createComment(Comment, string, number, number, string)	Erstellen Eines Kommentars für einen bestimmten Thread in einer Pullanforderung (bis zu 500 Kommentare können pro Thread erstellt werden).
createCommitStatus(GitStatus, string, string, string)	Erstellen Sie den Git-Commit-Status.
createFavorite(GitRefFavorite, string)	Erstellt einen Verweisfavorit
createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)	Fordern Sie an, dass die Refs eines anderen Repositorys in diesem Repository abgerufen werden. Es synchronisiert zwei vorhandene Forks. Um eine Verzweigung zu erstellen, lesen Sie bitte die <ein href="https://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1"> Repository-Endpunkt</a>
createImportRequest(GitImportRequest, string, string)	Erstellen Sie eine Importanforderung.
createLike(string, number, number, number, string)	Fügen Sie einen "Gefällt mir" zu einem Kommentar hinzu.
createMergeRequest(GitMergeParameters, string, string, boolean)	Anfordern eines Git-Zusammenführungsvorgangs. Derzeit unterstützen wir das Zusammenführen von nur 2 Commits.
createPullRequest(GitPullRequest, string, string, boolean)	Erstellen Sie eine Pullanforderung.
createPullRequestIterationStatus(GitPullRequestStatus, string, number, number, string)	Erstellen Sie einen Pullanforderungsstatus für die Iteration. Dieser Vorgang hat das gleiche Ergebnis wie create status on pull request with specified iteration ID in the request body.
createPullRequestLabel(WebApiCreateTagRequestData, string, number, string, string)	Erstellen Sie ein Tag (sofern das noch nicht vorhanden ist), und fügen Sie es als Bezeichnung (Tag) für eine angegebene Pullanforderung hinzu. Das einzige erforderliche Feld ist der Name der neuen Bezeichnung (Tag).
createPullRequestReviewer(IdentityRefWithVote, string, number, string, string)	Fügen Sie einem Pull-Antrag einen Prüfer hinzu, oder geben Sie eine Stimme ab.
createPullRequestReviewers(IdentityRef[], string, number, string)	Fügen Sie Prüfer zu einer Pullanforderung hinzu.
createPullRequestStatus(GitPullRequestStatus, string, number, string)	Erstellen Sie einen Pullanforderungsstatus.
createPush(GitPush, string, string)	Pushänderungen an das Repository.
createRepository(GitRepositoryCreateOptions, string, string)	Erstellen Sie ein Git-Repository in einem Teamprojekt.
createRevert(GitAsyncRefOperationParameters, string, string)	Startet den Vorgang, um eine neue Verzweigung zu erstellen, mit der Änderungen, die durch einen bestimmten Commit oder Commits, die einer Pullanforderung zugeordnet sind, zurückgesetzt werden.
createThread(GitPullRequestCommentThread, string, number, string)	Erstellen Sie einen Thread in einer Pullanforderung.
createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)	Fügen Sie den Prüfern einer Pullanforderung eine nicht materialisierte Identität hinzu.
deleteAttachment(string, string, number, string)	Löschen einer Pullanforderungsanlage.
deleteComment(string, number, number, number, string)	Löschen Eines Kommentars, der einem bestimmten Thread in einer Pullanforderung zugeordnet ist.
deleteEnablementStatus(boolean, boolean, string[])	DELETE Löscht den Status "Enablement" und "BillableCommitters"-Daten aus DB. Durch das Löschen der Aktivierungsdaten wird sie effektiv für die betroffenen Repositorys deaktiviert.
deleteLike(string, number, number, number, string)	Löschen eines Likes in einem Kommentar.
deletePullRequestIterationStatus(string, number, number, number, string)	Löschen des Iterationsstatus der Pullanforderung.
deletePullRequestLabels(string, number, string, string, string)	Entfernt eine Bezeichnung (Tag) aus der Gruppe der Beschriftungen, die der Pullanforderung zugewiesen sind. Das Tag selbst wird nicht gelöscht.
deletePullRequestReviewer(string, number, string, string)	Entfernen eines Bearbeiters aus einer Pullanforderung.
deletePullRequestStatus(string, number, number, string)	Löschen des Status der Pullanforderung.
deleteRefFavorite(string, number)	Löscht den angegebenen Verweisfavorit.
deleteRepository(string, string)	Löschen eines Git-Repositorys
deleteRepositoryFromRecycleBin(string, string)	Zerstören (endgültig löschen) eines vorläufig gelöschten Git-Repositorys.
getAnnotatedTag(string, string, string)	Rufen Sie ein kommentiertes Tag ab.
getAttachmentContent(string, string, number, string)	Abrufen des Dateiinhalts einer Pullanforderungsanlage.
getAttachments(string, number, string)	Dient zum Abrufen einer Liste von Dateien, die an eine bestimmte Pullanforderung angefügt sind.
getAttachmentZip(string, string, number, string)	Abrufen des Dateiinhalts einer Pullanforderungsanlage.
getBillableCommitters(string, Date, number, number)	Rufen Sie aktuelle abrechnende Committer für den Advanced Security-Dienst für ein bestimmtes Datum ab.
getBillableCommittersDetail(string, string, Date)	Rufen Sie detaillierte abrechnende Committer für den Advanced Security-Dienst für ein bestimmtes Datum ab. Detaillierte Ergebnisse filtern absichtlich keine vorläufig gelöschten Projekte und Repositorys aus, um Abrechnungsprobleme zu diagnostizieren.
getBlob(string, string, string, boolean, string, boolean)	Rufen Sie ein einzelnes BLOB ab.
getBlobContent(string, string, string, boolean, string, boolean)	Rufen Sie ein einzelnes BLOB ab.
getBlobsZip(string[], string, string, string)	Ruft ein oder mehrere BLOBs in einem ZIP-Dateidownload ab.
getBlobZip(string, string, string, boolean, string, boolean)	Rufen Sie ein einzelnes BLOB ab.
getBranch(string, string, string, GitVersionDescriptor)	Dient zum Abrufen von Statistiken zu einer einzelnen Verzweigung.
getBranches(string, string, GitVersionDescriptor)	Dient zum Abrufen von Statistiken zu allen Verzweigungen innerhalb eines Repositorys.
getBranchStatsBatch(GitQueryBranchStatsCriteria, string, string)	Abrufen von Statistiken für mehrere Commits
getChanges(string, string, string, number, number)	Abrufen von Änderungen für einen bestimmten Commit.
getCherryPick(string, number, string)	Abrufen von Informationen zu einem Kirschauswahlvorgang durch Kirschauswahl-ID.
getCherryPickConflict(string, number, number, string)	Abrufen eines Konflikts für eine Kirschauswahl nach ID
getCherryPickConflicts(string, number, string, string, number, boolean, boolean, boolean)	Abrufen aller Konflikte für eine Kirschauswahl
getCherryPickForRefName(string, string, string)	Abrufen von Informationen zu einem Kirschauswahlvorgang für einen bestimmten Zweig. Dieser Vorgang ist aufgrund der zugrunde liegenden Objektstruktur teuer, sodass diese API nur die letzten 1000 Kirschauswahlvorgänge betrachtet.
getCherryPickRelationships(string, string, string, boolean)	Gibt bei einer CommitId eine Liste von Commits zurück, die sich in derselben Kirschauswahlfamilie befinden.
getComment(string, number, number, number, string)	Rufen Sie einen Kommentar ab, der einem bestimmten Thread in einer Pullanforderung zugeordnet ist.
getComments(string, number, number, string)	Rufen Sie alle Kommentare ab, die einem bestimmten Thread in einer Pullanforderung zugeordnet sind.
getCommit(string, string, string, number)	Rufen Sie einen bestimmten Commit ab.
getCommitDiffs(string, string, boolean, number, number, GitBaseVersionDescriptor, GitTargetVersionDescriptor)	Suchen Sie den nächstgelegenen gemeinsamen Commit (die Zusammenführungsbasis) zwischen Basis- und Ziel-Commits, und rufen Sie den Diff zwischen basis- und Ziel-Commits oder gemeinsamen Commits und Ziel-Commits ab.
getCommits(string, GitQueryCommitsCriteria, string)	Abrufen von Git-Commits für ein Projekt
getCommitsBatch(GitQueryCommitsCriteria, string, string, number, number, boolean)	Abrufen von Git-Commits für ein Projekt, das den Suchkriterien entspricht
getDeletedRepositories(string)	Abrufen gelöschter Git-Repositorys.
getEnablementStatus(string[], Date, number, number)	GET Enablement status for project's repositories.
getEnableOnCreateHost(boolean)
getEnableOnCreateProject(string)
getEstimatedBillableCommittersRepo(string, string)	Rufen Sie geschätzte abrechnende Committer für ein Repository für die letzten 90 Tage ab.
getEstimatedBillablePushersOrg()	Erhalten Sie geschätzte abrechnende Pusher für eine Organisation für die letzten 90 Tage.
getEstimatedBillablePushersProject(string)	Erhalten Sie geschätzte abrechnende Pusher für ein Projekt für die letzten 90 Tage.
getFileDiffs(FileDiffsCriteria, string, string)	Abrufen der Datei-Diffs für jede der angegebenen Dateien
getForks(string, string, string, boolean)	Rufen Sie alle Forks eines Repositorys in der Sammlung ab.
getForkSyncRequest(string, number, string, boolean)	Rufen Sie die Details eines bestimmten Verzweigungsvorgangs ab.
getForkSyncRequests(string, string, boolean, boolean)	Rufen Sie alle angeforderten Fork-Synchronisierungsvorgänge für dieses Repository ab.
getHfsItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Dient zum Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der Downloadparameter besteht darin, anzugeben, ob der Inhalt als Download verfügbar sein soll oder einfach als Stream in der Antwort gesendet werden soll. Gilt nicht für gezippten Inhalt, der immer als Download zurückgegeben wird.
getHfsItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Dient zum Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der Downloadparameter besteht darin, anzugeben, ob der Inhalt als Download verfügbar sein soll oder einfach als Stream in der Antwort gesendet werden soll. Gilt nicht für gezippten Inhalt, der immer als Download zurückgegeben wird.
getHfsItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)	Dient zum Abrufen von Elementmetadaten und/oder Inhalten für eine Sammlung von Elementen. Der Downloadparameter besteht darin, anzugeben, ob der Inhalt als Download verfügbar sein soll oder einfach als Stream in der Antwort gesendet werden soll. Gilt nicht für gezippten Inhalt, der immer als Download zurückgegeben wird.
getHfsItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Dient zum Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der Downloadparameter besteht darin, anzugeben, ob der Inhalt als Download verfügbar sein soll oder einfach als Stream in der Antwort gesendet werden soll. Gilt nicht für gezippten Inhalt, der immer als Download zurückgegeben wird.
getHfsItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Dient zum Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der Downloadparameter besteht darin, anzugeben, ob der Inhalt als Download verfügbar sein soll oder einfach als Stream in der Antwort gesendet werden soll. Gilt nicht für gezippten Inhalt, der immer als Download zurückgegeben wird.
getImportRequest(string, string, number)	Dient zum Abrufen einer bestimmten Importanforderung.
getItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Dient zum Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der Downloadparameter besteht darin, anzugeben, ob der Inhalt als Download verfügbar sein soll oder einfach als Stream in der Antwort gesendet werden soll. Gilt nicht für gezippten Inhalt, der immer als Download zurückgegeben wird.
getItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Dient zum Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der Downloadparameter besteht darin, anzugeben, ob der Inhalt als Download verfügbar sein soll oder einfach als Stream in der Antwort gesendet werden soll. Gilt nicht für gezippten Inhalt, der immer als Download zurückgegeben wird.
getItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)	Dient zum Abrufen von Elementmetadaten und/oder Inhalten für eine Sammlung von Elementen. Der Downloadparameter besteht darin, anzugeben, ob der Inhalt als Download verfügbar sein soll oder einfach als Stream in der Antwort gesendet werden soll. Gilt nicht für gezippten Inhalt, der immer als Download zurückgegeben wird.
getItemsBatch(GitItemRequestData, string, string)	Posten sie zum Abrufen eines Batches aus einer Reihe von Elementen in einem Repository/Projekt, das eine Liste von Pfaden oder einen langen Pfad enthält
getItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Dient zum Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der Downloadparameter besteht darin, anzugeben, ob der Inhalt als Download verfügbar sein soll oder einfach als Stream in der Antwort gesendet werden soll. Gilt nicht für gezippten Inhalt, der immer als Download zurückgegeben wird.
getItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Dient zum Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der Downloadparameter besteht darin, anzugeben, ob der Inhalt als Download verfügbar sein soll oder einfach als Stream in der Antwort gesendet werden soll. Gilt nicht für gezippten Inhalt, der immer als Download zurückgegeben wird.
getLikes(string, number, number, number, string)	Abrufen von Likes für einen Kommentar.
getMergeBases(string, string, string, string, string, string)	Suchen Sie die Zusammenführungsbasen von zwei Commits, optional über Forks hinweg. Wenn "otherRepositoryId" nicht angegeben ist, werden die Zusammenführungsbasen nur im Kontext der lokalen repositoryNameOrId berechnet.
getMergeRequest(string, string, number, boolean)	Rufen Sie die Details eines bestimmten Zusammenführungsvorgangs ab.
getPermission(string, string, string)	GET Advanced Security Permission status.
getPullRequest(string, number, string, number, number, number, boolean, boolean)	Abrufen einer Pullanforderung.
getPullRequestById(number, string)	Abrufen einer Pullanforderung.
getPullRequestCommits(string, number, string)	Rufen Sie die Commits für die angegebene Pullanforderung ab.
getPullRequestConflict(string, number, number, string)	Abrufen eines Konflikts für eine Pullanforderung nach ID
getPullRequestConflicts(string, number, string, number, number, boolean, boolean, boolean)	Abrufen aller Konflikte für eine Pullanforderung
getPullRequestIteration(string, number, number, string)	Rufen Sie die angegebene Iteration für eine Pullanforderung ab.
getPullRequestIterationChanges(string, number, number, string, number, number, number)	Rufen Sie die in einer Pullanforderung vorgenommenen Änderungen zwischen zwei Iterationen ab.
getPullRequestIterationCommits(string, number, number, string, number, number)	Rufen Sie die Commits für die angegebene Iteration einer Pullanforderung ab.
getPullRequestIterations(string, number, string, boolean)	Ruft die Liste der Iterationen für die angegebene Pullanforderung ab.
getPullRequestIterationStatus(string, number, number, number, string)	Rufen Sie den spezifischen Iterationsstatus der Pull-Anforderung nach ID ab. Die Status-ID ist innerhalb der Pullanforderung für alle Iterationen eindeutig.
getPullRequestIterationStatuses(string, number, number, string)	Rufen Sie alle Status ab, die einer Pullanforderungsiteration zugeordnet sind.
getPullRequestLabel(string, number, string, string, string)	Ruft eine einzelne Bezeichnung (Tag) ab, die einer Pullanforderung zugewiesen wurde.
getPullRequestLabels(string, number, string, string)	Rufen Sie alle Bezeichnungen (Tags) ab, die einer Pullanforderung zugewiesen sind.
getPullRequestProperties(string, number, string)	Abrufen externer Eigenschaften der Pullanforderung.
getPullRequestQuery(GitPullRequestQuery, string, string)	Diese API wird verwendet, um zu ermitteln, welche Pullanforderungen mit einem bestimmten Commit zusammenhängen. Sie kann verwendet werden, um entweder die Pullanforderung zu finden, die einen bestimmten Zusammenführungs-Commit erstellt hat, oder sie kann verwendet werden, um alle Pullanforderungen zu finden, die jemals einen bestimmten Commit zusammengeführt haben. Die Eingabe ist eine Liste von Abfragen, die jeweils eine Liste von Commits enthalten. Für jeden Commit, mit dem Sie suchen, erhalten Sie ein Verzeichnis mit Commit zurück –> Pullanforderungen.
getPullRequestReviewer(string, number, string, string)	Abrufen von Informationen zu einem bestimmten Bearbeiter in einer Pullanforderung
getPullRequestReviewers(string, number, string)	Abrufen der Prüfer für eine Pullanforderung
getPullRequests(string, GitPullRequestSearchCriteria, string, number, number, number)	Rufen Sie alle Pullanforderungen ab, die einem angegebenen Kriterium entsprechen.
getPullRequestsByProject(string, GitPullRequestSearchCriteria, number, number, number)	Rufen Sie alle Pullanforderungen ab, die einem angegebenen Kriterium entsprechen.
getPullRequestStatus(string, number, number, string)	Rufen Sie den spezifischen Pullanforderungsstatus nach ID ab. Die Status-ID ist innerhalb der Pullanforderung für alle Iterationen eindeutig.
getPullRequestStatuses(string, number, string)	Ruft alle Status ab, die einer Pullanforderung zugeordnet sind.
getPullRequestThread(string, number, number, string, number, number)	Abrufen eines Threads in einer Pullanforderung.
getPullRequestWorkItemRefs(string, number, string)	Dient zum Abrufen einer Liste von Arbeitsaufgaben, die einer Pullanforderung zugeordnet sind.
getPush(string, number, string, number, boolean)	Ruft einen bestimmten Push ab.
getPushCommits(string, number, string, number, number, boolean)	Dient zum Abrufen einer Liste von Commits, die einem bestimmten Push zugeordnet sind.
getPushes(string, string, number, number, GitPushSearchCriteria)	Ruft Pushes ab, die dem angegebenen Repository zugeordnet sind.
getRecycleBinRepositories(string)	Abrufen vorläufig gelöschter Git-Repositorys aus dem Papierkorb.
getRefFavorite(string, number)	Ruft den Verweisfavorit für eine Favoriten-ID ab.
getRefFavorites(string, string, string)	Ruft die Verweisfavoriten für ein Repository und eine Identität ab.
getRefFavoritesForProject(string, string)
getRefs(string, string, string, boolean, boolean, boolean, boolean, boolean, string)	Fragt das bereitgestellte Repository für seine Refs ab und gibt sie zurück.
getRepositories(string, boolean, boolean, boolean)	Abrufen von Git-Repositorys.
getRepositoriesPaged(string, boolean, boolean, boolean, string, number, string)	Abrufen von Git-Repositorys mit Filter nach Name und Paginierung.
getRepository(string, string)	Abrufen eines Git-Repositorys.
getRepositoryWithParent(string, boolean, string)	Abrufen eines Git-Repositorys.
getRevert(string, number, string)	Rufen Sie Informationen zu einem Wiederherstellungsvorgang ab, indem Sie die ID wiederherstellen.
getRevertConflict(string, number, number, string)	Abrufen eines Konflikts für eine Wiederherstellung nach ID
getRevertConflicts(string, number, string, string, number, boolean, boolean, boolean)	Abrufen aller Konflikte für eine Wiederherstellung
getRevertForRefName(string, string, string)	Abrufen von Informationen zu einem Wiederherstellungsvorgang für eine bestimmte Verzweigung.
getStatuses(string, string, string, number, number, boolean)	Abrufen von Status, die dem Git-Commit zugeordnet sind.
getSuggestions(string, string, boolean)	Rufen Sie einen Pullanforderungsvorschlag für ein bestimmtes Repository- oder Teamprojekt ab.
getThreads(string, number, string, number, number)	Rufen Sie alle Threads in einer Pullanforderung ab.
getTree(string, string, string, string, boolean, string)	Der Strukturendpunkt gibt die Auflistung von Objekten unterhalb der angegebenen Struktur zurück. Bäume sind Ordner in einem Git-Repository.
getTreeZip(string, string, string, string, boolean, string)	Der Strukturendpunkt gibt die Auflistung von Objekten unterhalb der angegebenen Struktur zurück. Bäume sind Ordner in einem Git-Repository.
queryImportRequests(string, string, boolean)	Abrufen von Importanforderungen für ein Repository.
restoreRepositoryFromRecycleBin(GitRecycleBinRepositoryDetails, string, string)	Wiederherstellen eines vorläufig gelöschten Git-Repositorys. Zuletzt gelöschte Repositorys werden für einen bestimmten Zeitraum in einen Vorläufigen Löschzustand versetzt, bevor sie endgültig gelöscht und nicht wiederhergestellt werden können.
setEnableOnCreateHost(boolean)
setEnableOnCreateProject(string, boolean)
sharePullRequest(ShareNotificationContext, string, number, string)	Sendet eine E-Mail-Benachrichtigung über eine bestimmte Pullanforderung an eine Gruppe von Empfängern.
updateCherryPickConflict(GitConflict, string, number, number, string)	Zusammenführen von Konfliktauflösung aktualisieren
updateCherryPickConflicts(GitConflict[], string, number, string)	Aktualisieren mehrerer Zusammenführungskonfliktauflösungen
updateComment(Comment, string, number, number, number, string)	Aktualisieren eines Kommentars, der einem bestimmten Thread in einer Pullanforderung zugeordnet ist.
updateEnablementStatus(AdvSecEnablementUpdate[])	POST-Aktivierungsstatus für Repositorys.
updateImportRequest(GitImportRequest, string, string, number)	Wiederholen oder Abbrechen einer fehlgeschlagenen Importanforderung.
updatePullRequest(GitPullRequest, string, number, string)	Aktualisieren einer Pullanforderung
updatePullRequestConflict(GitConflict, string, number, number, string)	Zusammenführen von Konfliktauflösung aktualisieren
updatePullRequestConflicts(GitConflict[], string, number, string)	Aktualisieren mehrerer Zusammenführungskonfliktauflösungen
updatePullRequestIterationStatuses(JsonPatchDocument, string, number, number, string)	Aktualisieren sie die Sammlung der Iterationsstatus der Pullanforderung. Der einzige unterstützte Vorgangstyp ist `remove`.
updatePullRequestProperties(JsonPatchDocument, string, number, string)	Erstellen oder Aktualisieren der externen Eigenschaften der Pullanforderung. Der Patchvorgang kann `add`, `replace` oder `remove`sein. Für `add` Vorgang kann der Pfad leer sein. Wenn der Pfad leer ist, muss der Wert eine Liste der Schlüsselwertpaare sein. Für `replace` Vorgang kann der Pfad nicht leer sein. Wenn der Pfad nicht vorhanden ist, wird die Eigenschaft der Auflistung hinzugefügt. Für `remove` Vorgang kann der Pfad nicht leer sein. Wenn der Pfad nicht vorhanden ist, wird keine Aktion ausgeführt.
updatePullRequestReviewer(IdentityRefWithVote, string, number, string, string)	Bearbeiten Sie einen Bearbeitereintrag. Diese Felder sind patchbar: isFlagged, hasDeclined
updatePullRequestReviewers(IdentityRefWithVote[], string, number, string)	Setzen Sie die Stimmen mehrerer Prüfer auf eine Pullanfrage zurück. HINWEIS: Dieser Endpunkt unterstützt nur das Aktualisieren von Stimmen, unterstützt aber nicht das Aktualisieren der erforderlichen Prüfer (Verwenden von Richtlinien) oder Anzeigenamen.
updatePullRequestStatuses(JsonPatchDocument, string, number, string)	Aktualisieren der Sammlung von Pullanforderungsstatus. Der einzige unterstützte Vorgangstyp ist `remove`.
updateRef(GitRefUpdate, string, string, string, string)	Sperren oder Entsperren einer Verzweigung
updateRefs(GitRefUpdate[], string, string, string)	Erstellen, Aktualisieren oder Löschen von Refs(Branches).
updateRepository(GitRepository, string, string)	Aktualisiert das Git-Repository entweder mit einem neuen Repositorynamen oder einem neuen Standardverzweigung.
updateRevertConflict(GitConflict, string, number, number, string)	Zusammenführen von Konfliktauflösung aktualisieren
updateRevertConflicts(GitConflict[], string, number, string)	Aktualisieren mehrerer Zusammenführungskonfliktauflösungen
updateThread(GitPullRequestCommentThread, string, number, number, string)	Aktualisieren eines Threads in einer Pullanforderung.

Details zum Konstruktor

GitRestClient(IVssRestClientOptions)

new GitRestClient(options: IVssRestClientOptions)

Parameter

options: IVssRestClientOptions

Details zur Eigenschaft

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Eigenschaftswert

string

Details zur Methode

createAnnotatedTag(GitAnnotatedTag, string, string)

Erstellen Sie ein kommentiertes Tag.

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

Parameter

tagObject: GitAnnotatedTag

Objekt, das Details des zu erstellenden Tags enthält.

project: string

Projekt-ID oder Projektname

repositoryId: string

ID oder Name des Repositorys.

Gibt zurück

Promise<GitAnnotatedTag>

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

Fügen Sie eine neue Datei an eine Pullanforderung an.

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

Parameter

content: any

Hochzuladende Inhalte

fileName: string

Der Name der Datei.

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<Attachment>

createCherryPick(GitAsyncRefOperationParameters, string, string)

Cherry pick a specific commit or commits that are associated to a pull request into a new branch.

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

Parameter

cherryPickToCreate: GitAsyncRefOperationParameters

project: string

Projekt-ID oder Projektname

repositoryId: string

ID des Repositorys.

Gibt zurück

Promise<GitCherryPick>

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

Erstellen Eines Kommentars für einen bestimmten Thread in einer Pullanforderung (bis zu 500 Kommentare können pro Thread erstellt werden).

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

Parameter

comment: Comment

Der zu erstellende Kommentar. Kommentare können bis zu 150.000 Zeichen umfassen.

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

threadId: number

ID des Threads, in dem sich der gewünschte Kommentar befindet.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<Comment>

createCommitStatus(GitStatus, string, string, string)

Erstellen Sie den Git-Commit-Status.

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

Parameter

gitCommitStatusToCreate: GitStatus

Git commit status object to create.

commitId: string

ID des Git-Commits.

repositoryId: string

ID des Repositorys.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitStatus>

createFavorite(GitRefFavorite, string)

Erstellt einen Verweisfavorit

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

Parameter

favorite: GitRefFavorite

Der zu erstellende Verweisfavorit.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitRefFavorite>

createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)

Fordern Sie an, dass die Refs eines anderen Repositorys in diesem Repository abgerufen werden. Es synchronisiert zwei vorhandene Forks. Um eine Verzweigung zu erstellen, lesen Sie bitte die <ein href="https://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1"> Repository-Endpunkt</a>

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

Parameter

syncParams: GitForkSyncRequestParameters

Quell-Repository und Referenzzuordnung.

repositoryNameOrId: string

Der Name oder die ID des Repositorys.

project: string

Projekt-ID oder Projektname

includeLinks: boolean

True, um Links einzuschließen

Gibt zurück

Promise<GitForkSyncRequest>

createImportRequest(GitImportRequest, string, string)

Erstellen Sie eine Importanforderung.

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

Parameter

importRequest: GitImportRequest

Die zu erstellende Importanforderung.

project: string

Projekt-ID oder Projektname

repositoryId: string

Der Name oder die ID des Repositorys.

Gibt zurück

Promise<GitImportRequest>

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

Fügen Sie einen "Gefällt mir" zu einem Kommentar hinzu.

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

Parameter

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

threadId: number

Die ID des Threads, der den Kommentar enthält.

commentId: number

Die ID des Kommentars.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<void>

createMergeRequest(GitMergeParameters, string, string, boolean)

Anfordern eines Git-Zusammenführungsvorgangs. Derzeit unterstützen wir das Zusammenführen von nur 2 Commits.

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

Parameter

mergeParameters: GitMergeParameters

Eltern commitIds und Zusammenführung übernehmen Unordnungen.

project: string

Projekt-ID oder Projektname

repositoryNameOrId: string

Der Name oder die ID des Repositorys.

includeLinks: boolean

True, um Links einzuschließen

Gibt zurück

Promise<GitMerge>

createPullRequest(GitPullRequest, string, string, boolean)

Erstellen Sie eine Pullanforderung.

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

Parameter

gitPullRequestToCreate: GitPullRequest

Die zu erstellende Pullanforderung.

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

project: string

Projekt-ID oder Projektname

supportsIterations: boolean

Bei "true" können nachfolgende Pushs an die Pullanforderung einzeln überprüft werden. Legen Sie diesen Wert für große Pullanforderungen aus Leistungsgründen auf "false" fest, wenn diese Funktion nicht benötigt wird.

Gibt zurück

Promise<GitPullRequest>

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

Erstellen Sie einen Pullanforderungsstatus für die Iteration. Dieser Vorgang hat das gleiche Ergebnis wie create status on pull request with specified iteration ID in the request body.

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

Parameter

status: GitPullRequestStatus

Abrufen des Anforderungsstatus zum Erstellen.

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

iterationId: number

ID der Pullanforderungsiteration.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitPullRequestStatus>

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

Erstellen Sie ein Tag (sofern das noch nicht vorhanden ist), und fügen Sie es als Bezeichnung (Tag) für eine angegebene Pullanforderung hinzu. Das einzige erforderliche Feld ist der Name der neuen Bezeichnung (Tag).

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

Parameter

label: WebApiCreateTagRequestData

Bezeichnung, die der Pullanforderung zugewiesen werden soll.

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

project: string

Projekt-ID oder Projektname

projectId: string

Projekt-ID oder Projektname.

Gibt zurück

Promise<WebApiTagDefinition>

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

Fügen Sie einem Pull-Antrag einen Prüfer hinzu, oder geben Sie eine Stimme ab.

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

Parameter

reviewer: IdentityRefWithVote

Stimmen des Bearbeiters.<br />Wenn die ID des Bearbeiters hier enthalten ist, muss sie mit dem Parameter "reviewerID" übereinstimmen.<br />Prüfer können mit dieser Methode ihre eigene Stimme festlegen. Wenn sie weitere Prüfer hinzufügen, muss die Abstimmung auf Null festgelegt werden.

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

reviewerId: string

ID des Bearbeiters.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<IdentityRefWithVote>

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

Fügen Sie Prüfer zu einer Pullanforderung hinzu.

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

Parameter

reviewers: IdentityRef[]

Prüfer, die der Pullanforderung hinzugefügt werden sollen.

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<IdentityRefWithVote[]>

createPullRequestStatus(GitPullRequestStatus, string, number, string)

Erstellen Sie einen Pullanforderungsstatus.

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

Parameter

status: GitPullRequestStatus

Abrufen des Anforderungsstatus zum Erstellen.

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitPullRequestStatus>

createPush(GitPush, string, string)

Pushänderungen an das Repository.

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

Parameter

push: GitPush

repositoryId: string

Der Name oder die ID des Repositorys.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitPush>

createRepository(GitRepositoryCreateOptions, string, string)

Erstellen Sie ein Git-Repository in einem Teamprojekt.

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

Parameter

gitRepositoryToCreate: GitRepositoryCreateOptions

Geben Sie den Repositorynamen, das Teamprojekt und/oder das übergeordnete Repository an. Teamprojektinformationen können von gitRepositoryToCreate weggelassen werden, wenn die Anforderung projektbereichsbezogenen (d. h. Projekt-ID enthält).

project: string

Projekt-ID oder Projektname

sourceRef: string

[optional] Angeben der beim Erstellen eines Verzweigungs-Repositorys zu verwendenden Quellverweisen

Gibt zurück

Promise<GitRepository>

createRevert(GitAsyncRefOperationParameters, string, string)

Startet den Vorgang, um eine neue Verzweigung zu erstellen, mit der Änderungen, die durch einen bestimmten Commit oder Commits, die einer Pullanforderung zugeordnet sind, zurückgesetzt werden.

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

Parameter

revertToCreate: GitAsyncRefOperationParameters

project: string

Projekt-ID oder Projektname

repositoryId: string

ID des Repositorys.

Gibt zurück

Promise<GitRevert>

createThread(GitPullRequestCommentThread, string, number, string)

Erstellen Sie einen Thread in einer Pullanforderung.

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

Parameter

commentThread: GitPullRequestCommentThread

Der zu erstellende Thread. Thread muss mindestens einen Kommentar enthalten.

repositoryId: string

Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitPullRequestCommentThread>

createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)

Fügen Sie den Prüfern einer Pullanforderung eine nicht materialisierte Identität hinzu.

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

Parameter

reviewer: IdentityRefWithVote

Prüfer, der der Pullanforderung hinzugefügt werden soll.

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<IdentityRefWithVote>

deleteAttachment(string, string, number, string)

Löschen einer Pullanforderungsanlage.

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

Parameter

fileName: string

Der Name der zu löschenden Anlage.

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<void>

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

Löschen Eines Kommentars, der einem bestimmten Thread in einer Pullanforderung zugeordnet ist.

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

Parameter

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

threadId: number

ID des Threads, in dem sich der gewünschte Kommentar befindet.

commentId: number

ID des Kommentars.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<void>

deleteEnablementStatus(boolean, boolean, string[])

DELETE Löscht den Status "Enablement" und "BillableCommitters"-Daten aus DB. Durch das Löschen der Aktivierungsdaten wird sie effektiv für die betroffenen Repositorys deaktiviert.

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

Parameter

allProjects: boolean

includeBillableCommitters: boolean

projectIds: string[]

Gibt zurück

Promise<void>

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

Löschen eines Likes in einem Kommentar.

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

Parameter

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

threadId: number

Die ID des Threads, der den Kommentar enthält.

commentId: number

Die ID des Kommentars.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<void>

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

Löschen des Iterationsstatus der Pullanforderung.

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

Parameter

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

iterationId: number

ID der Pullanforderungsiteration.

statusId: number

ID des Pullanforderungsstatus.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<void>

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

Entfernt eine Bezeichnung (Tag) aus der Gruppe der Beschriftungen, die der Pullanforderung zugewiesen sind. Das Tag selbst wird nicht gelöscht.

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

Parameter

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

labelIdOrName: string

Der Name oder die ID der angeforderten Bezeichnung.

project: string

Projekt-ID oder Projektname

projectId: string

Projekt-ID oder Projektname.

Gibt zurück

Promise<void>

deletePullRequestReviewer(string, number, string, string)

Entfernen eines Bearbeiters aus einer Pullanforderung.

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

Parameter

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

reviewerId: string

ID des zu entfernenden Bearbeiters.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<void>

deletePullRequestStatus(string, number, number, string)

Löschen des Status der Pullanforderung.

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

Parameter

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

statusId: number

ID des Pullanforderungsstatus.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<void>

deleteRefFavorite(string, number)

Löscht den angegebenen Verweisfavorit.

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

Parameter

project: string

Projekt-ID oder Projektname

favoriteId: number

Die ID des zu löschenden Referenzfavorits.

Gibt zurück

Promise<void>

deleteRepository(string, string)

Löschen eines Git-Repositorys

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

Parameter

repositoryId: string

Die ID des Repositorys.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<void>

deleteRepositoryFromRecycleBin(string, string)

Zerstören (endgültig löschen) eines vorläufig gelöschten Git-Repositorys.

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

Parameter

project: string

Projekt-ID oder Projektname

repositoryId: string

Die ID des Repositorys.

Gibt zurück

Promise<void>

getAnnotatedTag(string, string, string)

Rufen Sie ein kommentiertes Tag ab.

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

Parameter

project: string

Projekt-ID oder Projektname

repositoryId: string

ID oder Name des Repositorys.

objectId: string

ObjectId (Sha1Id) des abzurufenden Tags.

Gibt zurück

Promise<GitAnnotatedTag>

getAttachmentContent(string, string, number, string)

Abrufen des Dateiinhalts einer Pullanforderungsanlage.

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

Parameter

fileName: string

Der Name der Anlage.

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<ArrayBuffer>

getAttachments(string, number, string)

Dient zum Abrufen einer Liste von Dateien, die an eine bestimmte Pullanforderung angefügt sind.

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

Parameter

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<Attachment[]>

getAttachmentZip(string, string, number, string)

Abrufen des Dateiinhalts einer Pullanforderungsanlage.

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

Parameter

fileName: string

Der Name der Anlage.

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<ArrayBuffer>

getBillableCommitters(string, Date, number, number)

Rufen Sie aktuelle abrechnende Committer für den Advanced Security-Dienst für ein bestimmtes Datum ab.

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

Parameter

project: string

Projekt-ID oder Projektname

billingDate: Date

UTC erwartet. Wenn der Standardwert nicht auf den vorherigen Abrechnungstag festgelegt ist.

skip: number

Überspringen Sie X-Zeilen von Resultset, um paging zu simulieren.

take: number

Zurückgeben von Y-Zeilen mit Resultset zum Simulieren des Pagings.

Gibt zurück

Promise<BillableCommitter[]>

getBillableCommittersDetail(string, string, Date)

Rufen Sie detaillierte abrechnende Committer für den Advanced Security-Dienst für ein bestimmtes Datum ab. Detaillierte Ergebnisse filtern absichtlich keine vorläufig gelöschten Projekte und Repositorys aus, um Abrechnungsprobleme zu diagnostizieren.

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

Parameter

project: string

Projekt-ID oder Projektname

includeDetails: string

Geben Sie alle Details zu den abrechnenden Committern zurück.

billingDate: Date

UTC erwartet. Wenn der Standardwert nicht auf den vorherigen Abrechnungstag festgelegt ist.

Gibt zurück

Promise<BillableCommitterDetail[]>

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

Rufen Sie ein einzelnes BLOB ab.

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

Parameter

repositoryId: string

Der Name oder die ID des Repositorys.

sha1: string

SHA1-Hash der Datei. Sie können die SHA1 einer Datei mit dem Endpunkt "Git/Items/Get Item" abrufen.

project: string

Projekt-ID oder Projektname

download: boolean

Wenn wahr, fordern Sie einen Download auf, anstatt in einem Browser zu rendern. Hinweis: Dieser Wert ist standardmäßig auf "true" festgelegt, wenn $format zip ist.

fileName: string

Geben Sie einen Dateinamen an, der für einen Download verwendet werden soll.

resolveLfs: boolean

Wenn true, versuchen Sie, ein BLOB in seinen LFS-Inhalt aufzulösen, wenn es sich um eine LFS-Zeigerdatei handelt. Nur kompatibel mit Octet-Stream Accept-Headern oder $format Typen

Gibt zurück

Promise<GitBlobRef>

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

Rufen Sie ein einzelnes BLOB ab.

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

Parameter

repositoryId: string

Der Name oder die ID des Repositorys.

sha1: string

SHA1-Hash der Datei. Sie können die SHA1 einer Datei mit dem Endpunkt "Git/Items/Get Item" abrufen.

project: string

Projekt-ID oder Projektname

download: boolean

Wenn wahr, fordern Sie einen Download auf, anstatt in einem Browser zu rendern. Hinweis: Dieser Wert ist standardmäßig auf "true" festgelegt, wenn $format zip ist.

fileName: string

Geben Sie einen Dateinamen an, der für einen Download verwendet werden soll.

resolveLfs: boolean

Wenn true, versuchen Sie, ein BLOB in seinen LFS-Inhalt aufzulösen, wenn es sich um eine LFS-Zeigerdatei handelt. Nur kompatibel mit Octet-Stream Accept-Headern oder $format Typen

Gibt zurück

Promise<ArrayBuffer>

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

Ruft ein oder mehrere BLOBs in einem ZIP-Dateidownload ab.

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

Parameter

blobIds: string[]

Blob-IDs (SHA1-Hashes), die in der ZIP-Datei zurückgegeben werden sollen.

repositoryId: string

Der Name oder die ID des Repositorys.

project: string

Projekt-ID oder Projektname

filename: string

Gibt zurück

Promise<ArrayBuffer>

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

Rufen Sie ein einzelnes BLOB ab.

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

Parameter

repositoryId: string

Der Name oder die ID des Repositorys.

sha1: string

SHA1-Hash der Datei. Sie können die SHA1 einer Datei mit dem Endpunkt "Git/Items/Get Item" abrufen.

project: string

Projekt-ID oder Projektname

download: boolean

Wenn wahr, fordern Sie einen Download auf, anstatt in einem Browser zu rendern. Hinweis: Dieser Wert ist standardmäßig auf "true" festgelegt, wenn $format zip ist.

fileName: string

Geben Sie einen Dateinamen an, der für einen Download verwendet werden soll.

resolveLfs: boolean

Wenn true, versuchen Sie, ein BLOB in seinen LFS-Inhalt aufzulösen, wenn es sich um eine LFS-Zeigerdatei handelt. Nur kompatibel mit Octet-Stream Accept-Headern oder $format Typen

Gibt zurück

Promise<ArrayBuffer>

getBranch(string, string, string, GitVersionDescriptor)

Dient zum Abrufen von Statistiken zu einer einzelnen Verzweigung.

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

Parameter

repositoryId: string

Der Name oder die ID des Repositorys.

name: string

Name der Verzweigung.

project: string

Projekt-ID oder Projektname

baseVersionDescriptor: GitVersionDescriptor

Gibt den Commit oder die Verzweigung an, der als Basis verwendet werden soll.

Gibt zurück

Promise<GitBranchStats>

getBranches(string, string, GitVersionDescriptor)

Dient zum Abrufen von Statistiken zu allen Verzweigungen innerhalb eines Repositorys.

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

Parameter

repositoryId: string

Der Name oder die ID des Repositorys.

project: string

Projekt-ID oder Projektname

baseVersionDescriptor: GitVersionDescriptor

Gibt den Commit oder die Verzweigung an, der als Basis verwendet werden soll.

Gibt zurück

Promise<GitBranchStats[]>

getBranchStatsBatch(GitQueryBranchStatsCriteria, string, string)

Abrufen von Statistiken für mehrere Commits

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

Parameter

searchCriteria: GitQueryBranchStatsCriteria

Basis-Commit und Liste der zu vergleichenden Ziel-Commits.

repositoryId: string

Der Name oder die ID des Repositorys.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitBranchStats[]>

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

Abrufen von Änderungen für einen bestimmten Commit.

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

Parameter

commitId: string

Die ID des Commits.

repositoryId: string

Die ID oder der Anzeigename des Repositorys. Um den Anzeigenamen zu verwenden, muss projectId ebenfalls angegeben werden.

project: string

Projekt-ID oder Projektname

top: number

Die maximale Anzahl der zurückzugebenden Änderungen.

skip: number

Die Anzahl der zu überspringenden Änderungen.

Gibt zurück

Promise<GitCommitChanges>

getCherryPick(string, number, string)

Abrufen von Informationen zu einem Kirschauswahlvorgang durch Kirschauswahl-ID.

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

Parameter

project: string

Projekt-ID oder Projektname

cherryPickId: number

ID der Kirschauswahl.

repositoryId: string

ID des Repositorys.

Gibt zurück

Promise<GitCherryPick>

getCherryPickConflict(string, number, number, string)

Abrufen eines Konflikts für eine Kirschauswahl nach ID

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

Parameter

repositoryId: string

cherryPickId: number

conflictId: number

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitConflict>

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

Abrufen aller Konflikte für eine Kirschauswahl

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

Parameter

repositoryId: string

cherryPickId: number

project: string

Projekt-ID oder Projektname

continuationToken: string

top: number

excludeResolved: boolean

onlyResolved: boolean

includeObsolete: boolean

Gibt zurück

Promise<PagedList<GitConflict>>

getCherryPickForRefName(string, string, string)

Abrufen von Informationen zu einem Kirschauswahlvorgang für einen bestimmten Zweig. Dieser Vorgang ist aufgrund der zugrunde liegenden Objektstruktur teuer, sodass diese API nur die letzten 1000 Kirschauswahlvorgänge betrachtet.

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

Parameter

project: string

Projekt-ID oder Projektname

repositoryId: string

ID des Repositorys.

refName: string

Die gitAsyncRefOperationParameters generatedRefName, die für den Kirschauswahlvorgang verwendet werden.

Gibt zurück

Promise<GitCherryPick>

getCherryPickRelationships(string, string, string, boolean)

Gibt bei einer CommitId eine Liste von Commits zurück, die sich in derselben Kirschauswahlfamilie befinden.

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

Parameter

repositoryNameOrId: string

commitId: string

project: string

Projekt-ID oder Projektname

includeLinks: boolean

Gibt zurück

Promise<GitCommitRef[]>

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

Rufen Sie einen Kommentar ab, der einem bestimmten Thread in einer Pullanforderung zugeordnet ist.

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

Parameter

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

threadId: number

ID des Threads, in dem sich der gewünschte Kommentar befindet.

commentId: number

ID des Kommentars.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<Comment>

getComments(string, number, number, string)

Rufen Sie alle Kommentare ab, die einem bestimmten Thread in einer Pullanforderung zugeordnet sind.

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

Parameter

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

threadId: number

ID des Threads.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<Comment[]>

getCommit(string, string, string, number)

Rufen Sie einen bestimmten Commit ab.

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

Parameter

commitId: string

Die ID des Commits.

repositoryId: string

Die ID oder der Anzeigename des Repositorys. Um den Anzeigenamen zu verwenden, muss projectId ebenfalls angegeben werden.

project: string

Projekt-ID oder Projektname

changeCount: number

Die Anzahl der Änderungen, die in das Ergebnis eingeschlossen werden sollen.

Gibt zurück

Promise<GitCommit>

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

Suchen Sie den nächstgelegenen gemeinsamen Commit (die Zusammenführungsbasis) zwischen Basis- und Ziel-Commits, und rufen Sie den Diff zwischen basis- und Ziel-Commits oder gemeinsamen Commits und Ziel-Commits ab.

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

Parameter

repositoryId: string

Der Name oder die ID des Repositorys.

project: string

Projekt-ID oder Projektname

diffCommonCommit: boolean

Wenn wahr, diff between common and target commits. Wenn false, diff between base and target commits.

top: number

Maximale Anzahl der zurückzugebenden Änderungen. Standardwert ist 100.

skip: number

Anzahl der zu überspringenden Änderungen

baseVersionDescriptor: GitBaseVersionDescriptor

Deskriptor für Base Commit.

targetVersionDescriptor: GitTargetVersionDescriptor

Deskriptor für Ziel-Commit.

Gibt zurück

Promise<GitCommitDiffs>

getCommits(string, GitQueryCommitsCriteria, string)

Abrufen von Git-Commits für ein Projekt

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

Parameter

repositoryId: string

Die ID oder der Anzeigename des Repositorys. Um den Anzeigenamen zu verwenden, muss projectId ebenfalls angegeben werden.

searchCriteria: GitQueryCommitsCriteria

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitCommitRef[]>

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

Abrufen von Git-Commits für ein Projekt, das den Suchkriterien entspricht

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

Parameter

searchCriteria: GitQueryCommitsCriteria

Suchoptionen

repositoryId: string

Der Name oder die ID des Repositorys.

project: string

Projekt-ID oder Projektname

skip: number

Anzahl der zu überspringenden Commits. Der Wert darf 3.000.000 nicht überschreiten.

top: number

Maximale Anzahl von Commits, die zurückgegeben werden sollen. Der Wert darf 50.000 nicht überschreiten.

includeStatuses: boolean

True, um zusätzliche Commit-Statusinformationen einzuschließen.

Gibt zurück

Promise<GitCommitRef[]>

getDeletedRepositories(string)

Abrufen gelöschter Git-Repositorys.

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

Parameter

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitDeletedRepository[]>

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

GET Enablement status for project's repositories.

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

Parameter

projectIds: string[]

Null standardmäßig für alle Projekte im Host, Liste des Projekt-Repositorystatus, um zurückzugeben

billingDate: Date

UTC erwartet, Null-Standardwerte für UtcNow() können für einen Punkt im Zeitstatus bereitgestellt werden.

skip: number

Überspringen Sie X-Zeilen von Resultset, um paging zu simulieren.

take: number

Zurückgeben von Y-Zeilen mit Resultset zum Simulieren des Pagings.

Gibt zurück

Promise<AdvSecEnablementStatus[]>

getEnableOnCreateHost(boolean)

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

Parameter

enableOnCreateHost: boolean

Gibt zurück

Promise<boolean>

getEnableOnCreateProject(string)

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

Parameter

enableOnCreateProjectId: string

Gibt zurück

Promise<boolean>

getEstimatedBillableCommittersRepo(string, string)

Rufen Sie geschätzte abrechnende Committer für ein Repository für die letzten 90 Tage ab.

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

Parameter

project: string

Projekt-ID oder Projektname

repositoryId: string

Gibt zurück

Promise<BillableCommitter[]>

getEstimatedBillablePushersOrg()

Erhalten Sie geschätzte abrechnende Pusher für eine Organisation für die letzten 90 Tage.

function getEstimatedBillablePushersOrg(): Promise<BillablePusher[]>

Gibt zurück

Promise<BillablePusher[]>

getEstimatedBillablePushersProject(string)

Erhalten Sie geschätzte abrechnende Pusher für ein Projekt für die letzten 90 Tage.

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

Parameter

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<BillablePusher[]>

getFileDiffs(FileDiffsCriteria, string, string)

Abrufen der Datei-Diffs für jede der angegebenen Dateien

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

Parameter

fileDiffsCriteria: FileDiffsCriteria

Liste der Dateiparameterobjekte

project: string

Projekt-ID oder Projektname

repositoryId: string

Der Name oder die ID des Repositorys

Gibt zurück

Promise<FileDiff[]>

getForks(string, string, string, boolean)

Rufen Sie alle Forks eines Repositorys in der Sammlung ab.

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

Parameter

repositoryNameOrId: string

Der Name oder die ID des Repositorys.

collectionId: string

Teamprojektsammlungs-ID.

project: string

Projekt-ID oder Projektname

includeLinks: boolean

True, um Links einzuschließen.

Gibt zurück

Promise<GitRepositoryRef[]>

getForkSyncRequest(string, number, string, boolean)

Rufen Sie die Details eines bestimmten Verzweigungsvorgangs ab.

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

Parameter

repositoryNameOrId: string

Der Name oder die ID des Repositorys.

forkSyncOperationId: number

OperationId der Synchronisierungsanforderung.

project: string

Projekt-ID oder Projektname

includeLinks: boolean

True, um Links einzuschließen.

Gibt zurück

Promise<GitForkSyncRequest>

getForkSyncRequests(string, string, boolean, boolean)

Rufen Sie alle angeforderten Fork-Synchronisierungsvorgänge für dieses Repository ab.

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

Parameter

repositoryNameOrId: string

Der Name oder die ID des Repositorys.

project: string

Projekt-ID oder Projektname

includeAbandoned: boolean

True, um abgebrochene Anforderungen einzuschließen.

includeLinks: boolean

True, um Links einzuschließen.

Gibt zurück

Promise<GitForkSyncRequest[]>

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

Dient zum Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der Downloadparameter besteht darin, anzugeben, ob der Inhalt als Download verfügbar sein soll oder einfach als Stream in der Antwort gesendet werden soll. Gilt nicht für gezippten Inhalt, der immer als Download zurückgegeben wird.

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>

Parameter

repositoryId: string

Der Name oder die ID des Repositorys.

path: string

Der Elementpfad.

project: string

Projekt-ID oder Projektname

scopePath: string

Der Pfadbereich. Der Standardwert ist NULL.

recursionLevel: VersionControlRecursionType

Die Rekursionsebene dieser Anforderung. Der Standardwert ist "none", keine Rekursion.

includeContentMetadata: boolean

Auf "true" festlegen, um Inhaltsmetadaten einzuschließen. Der Standardwert ist "false".

latestProcessedChange: boolean

Auf "true" festlegen, um die neuesten Änderungen einzuschließen. Der Standardwert ist "false".

download: boolean

Legen Sie "true" fest, um die Antwort als Datei herunterzuladen. Der Standardwert ist "false".

versionDescriptor: GitVersionDescriptor

Versionsdeskriptor. Der Standardwert ist der Standardverzweigung für das Repository.

includeContent: boolean

Auf "true" festlegen, um Elementinhalte beim Anfordern von JSON einzuschließen. Der Standardwert ist "false".

resolveHfs: boolean

Auf "true" festgelegt, um Git HFS-Zeigerdateien aufzulösen, um tatsächlichen Inhalt von Git HFS zurückzugeben. Der Standardwert ist true.

sanitize: boolean

Legen Sie "true" fest, um eine svg-Datei zu sanitieren und als Bild zurückzugeben. Nur nützlich, wenn sie für svg-Datei angefordert wird. Der Standardwert ist "false".

Gibt zurück

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>

Parameter

repositoryId: string

Der Name oder die ID des Repositorys.

path: string

Der Elementpfad.

project: string

Projekt-ID oder Projektname

scopePath: string

Der Pfadbereich. Der Standardwert ist NULL.

recursionLevel: VersionControlRecursionType

Die Rekursionsebene dieser Anforderung. Der Standardwert ist "none", keine Rekursion.

includeContentMetadata: boolean

Auf "true" festlegen, um Inhaltsmetadaten einzuschließen. Der Standardwert ist "false".

latestProcessedChange: boolean

Auf "true" festlegen, um die neuesten Änderungen einzuschließen. Der Standardwert ist "false".

download: boolean

Legen Sie "true" fest, um die Antwort als Datei herunterzuladen. Der Standardwert ist "false".

versionDescriptor: GitVersionDescriptor

Versionsdeskriptor. Der Standardwert ist der Standardverzweigung für das Repository.

includeContent: boolean

Auf "true" festlegen, um Elementinhalte beim Anfordern von JSON einzuschließen. Der Standardwert ist "false".

resolveHfs: boolean

Auf "true" festgelegt, um Git HFS-Zeigerdateien aufzulösen, um tatsächlichen Inhalt von Git HFS zurückzugeben. Der Standardwert ist true.

sanitize: boolean

Legen Sie "true" fest, um eine svg-Datei zu sanitieren und als Bild zurückzugeben. Nur nützlich, wenn sie für svg-Datei angefordert wird. Der Standardwert ist "false".

Gibt zurück

Promise<ArrayBuffer>

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

Dient zum Abrufen von Elementmetadaten und/oder Inhalten für eine Sammlung von Elementen. Der Downloadparameter besteht darin, anzugeben, ob der Inhalt als Download verfügbar sein soll oder einfach als Stream in der Antwort gesendet werden soll. Gilt nicht für gezippten Inhalt, der immer als Download zurückgegeben wird.

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

Parameter

repositoryId: string

Der Name oder die ID des Repositorys.

project: string

Projekt-ID oder Projektname

scopePath: string

Der Pfadbereich. Der Standardwert ist NULL.

recursionLevel: VersionControlRecursionType

Die Rekursionsebene dieser Anforderung. Der Standardwert ist "none", keine Rekursion.

includeContentMetadata: boolean

Auf "true" festlegen, um Inhaltsmetadaten einzuschließen. Der Standardwert ist "false".

latestProcessedChange: boolean

Auf "true" festlegen, um die neuesten Änderungen einzuschließen. Der Standardwert ist "false".

download: boolean

Legen Sie "true" fest, um die Antwort als Datei herunterzuladen. Der Standardwert ist "false".

includeLinks: boolean

Auf "true" festgelegt, um Verknüpfungen zu Elementen einzuschließen. Der Standardwert ist "false".

versionDescriptor: GitVersionDescriptor

Versionsdeskriptor. Der Standardwert ist der Standardverzweigung für das Repository.

zipForUnix: boolean

Auf "true" festlegen, um die Dateiberechtigungen für Unix-Systeme (und POSIX) wie ausführbare Dateien und Symlinks beizubehalten

Gibt zurück

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>

Parameter

repositoryId: string

Der Name oder die ID des Repositorys.

path: string

Der Elementpfad.

project: string

Projekt-ID oder Projektname

scopePath: string

Der Pfadbereich. Der Standardwert ist NULL.

recursionLevel: VersionControlRecursionType

Die Rekursionsebene dieser Anforderung. Der Standardwert ist "none", keine Rekursion.

includeContentMetadata: boolean

Auf "true" festlegen, um Inhaltsmetadaten einzuschließen. Der Standardwert ist "false".

latestProcessedChange: boolean

Auf "true" festlegen, um die neuesten Änderungen einzuschließen. Der Standardwert ist "false".

download: boolean

Legen Sie "true" fest, um die Antwort als Datei herunterzuladen. Der Standardwert ist "false".

versionDescriptor: GitVersionDescriptor

Versionsdeskriptor. Der Standardwert ist der Standardverzweigung für das Repository.

includeContent: boolean

Auf "true" festlegen, um Elementinhalte beim Anfordern von JSON einzuschließen. Der Standardwert ist "false".

resolveHfs: boolean

Auf "true" festgelegt, um Git HFS-Zeigerdateien aufzulösen, um tatsächlichen Inhalt von Git HFS zurückzugeben. Der Standardwert ist true.

sanitize: boolean

Legen Sie "true" fest, um eine svg-Datei zu sanitieren und als Bild zurückzugeben. Nur nützlich, wenn sie für svg-Datei angefordert wird. Der Standardwert ist "false".

Gibt zurück

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>

Parameter

repositoryId: string

Der Name oder die ID des Repositorys.

path: string

Der Elementpfad.

project: string

Projekt-ID oder Projektname

scopePath: string

Der Pfadbereich. Der Standardwert ist NULL.

recursionLevel: VersionControlRecursionType

Die Rekursionsebene dieser Anforderung. Der Standardwert ist "none", keine Rekursion.

includeContentMetadata: boolean

Auf "true" festlegen, um Inhaltsmetadaten einzuschließen. Der Standardwert ist "false".

latestProcessedChange: boolean

Auf "true" festlegen, um die neuesten Änderungen einzuschließen. Der Standardwert ist "false".

download: boolean

Legen Sie "true" fest, um die Antwort als Datei herunterzuladen. Der Standardwert ist "false".

versionDescriptor: GitVersionDescriptor

Versionsdeskriptor. Der Standardwert ist der Standardverzweigung für das Repository.

includeContent: boolean

Auf "true" festlegen, um Elementinhalte beim Anfordern von JSON einzuschließen. Der Standardwert ist "false".

resolveHfs: boolean

Auf "true" festgelegt, um Git HFS-Zeigerdateien aufzulösen, um tatsächlichen Inhalt von Git HFS zurückzugeben. Der Standardwert ist true.

sanitize: boolean

Legen Sie "true" fest, um eine svg-Datei zu sanitieren und als Bild zurückzugeben. Nur nützlich, wenn sie für svg-Datei angefordert wird. Der Standardwert ist "false".

Gibt zurück

Promise<ArrayBuffer>

getImportRequest(string, string, number)

Dient zum Abrufen einer bestimmten Importanforderung.

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

Parameter

project: string

Projekt-ID oder Projektname

repositoryId: string

Der Name oder die ID des Repositorys.

importRequestId: number

Der eindeutige Bezeichner für die Importanforderung.

Gibt zurück

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>

Parameter

repositoryId: string

Der Name oder die ID des Repositorys.

path: string

Der Elementpfad.

project: string

Projekt-ID oder Projektname

scopePath: string

Der Pfadbereich. Der Standardwert ist NULL.

recursionLevel: VersionControlRecursionType

Die Rekursionsebene dieser Anforderung. Der Standardwert ist "none", keine Rekursion.

includeContentMetadata: boolean

Auf "true" festlegen, um Inhaltsmetadaten einzuschließen. Der Standardwert ist "false".

latestProcessedChange: boolean

Auf "true" festlegen, um die neuesten Änderungen einzuschließen. Der Standardwert ist "false".

download: boolean

Legen Sie "true" fest, um die Antwort als Datei herunterzuladen. Der Standardwert ist "false".

versionDescriptor: GitVersionDescriptor

Versionsdeskriptor. Der Standardwert ist der Standardverzweigung für das Repository.

includeContent: boolean

Auf "true" festlegen, um Elementinhalte beim Anfordern von JSON einzuschließen. Der Standardwert ist "false".

resolveLfs: boolean

Legen Sie den Wert auf "true" fest, um Git LFS-Zeigerdateien aufzulösen, um tatsächlichen Inhalt von Git LFS zurückzugeben. Der Standardwert ist "false".

sanitize: boolean

Legen Sie "true" fest, um eine svg-Datei zu sanitieren und als Bild zurückzugeben. Nur nützlich, wenn sie für svg-Datei angefordert wird. Der Standardwert ist "false".

Gibt zurück

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>

Parameter

repositoryId: string

Der Name oder die ID des Repositorys.

path: string

Der Elementpfad.

project: string

Projekt-ID oder Projektname

scopePath: string

Der Pfadbereich. Der Standardwert ist NULL.

recursionLevel: VersionControlRecursionType

Die Rekursionsebene dieser Anforderung. Der Standardwert ist "none", keine Rekursion.

includeContentMetadata: boolean

Auf "true" festlegen, um Inhaltsmetadaten einzuschließen. Der Standardwert ist "false".

latestProcessedChange: boolean

Auf "true" festlegen, um die neuesten Änderungen einzuschließen. Der Standardwert ist "false".

download: boolean

Legen Sie "true" fest, um die Antwort als Datei herunterzuladen. Der Standardwert ist "false".

versionDescriptor: GitVersionDescriptor

Versionsdeskriptor. Der Standardwert ist der Standardverzweigung für das Repository.

includeContent: boolean

Auf "true" festlegen, um Elementinhalte beim Anfordern von JSON einzuschließen. Der Standardwert ist "false".

resolveLfs: boolean

Legen Sie den Wert auf "true" fest, um Git LFS-Zeigerdateien aufzulösen, um tatsächlichen Inhalt von Git LFS zurückzugeben. Der Standardwert ist "false".

sanitize: boolean

Legen Sie "true" fest, um eine svg-Datei zu sanitieren und als Bild zurückzugeben. Nur nützlich, wenn sie für svg-Datei angefordert wird. Der Standardwert ist "false".

Gibt zurück

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

Parameter

repositoryId: string

Der Name oder die ID des Repositorys.

project: string

Projekt-ID oder Projektname

scopePath: string

Der Pfadbereich. Der Standardwert ist NULL.

recursionLevel: VersionControlRecursionType

Die Rekursionsebene dieser Anforderung. Der Standardwert ist "none", keine Rekursion.

includeContentMetadata: boolean

Auf "true" festlegen, um Inhaltsmetadaten einzuschließen. Der Standardwert ist "false".

latestProcessedChange: boolean

Auf "true" festlegen, um die neuesten Änderungen einzuschließen. Der Standardwert ist "false".

download: boolean

Legen Sie "true" fest, um die Antwort als Datei herunterzuladen. Der Standardwert ist "false".

includeLinks: boolean

Auf "true" festgelegt, um Verknüpfungen zu Elementen einzuschließen. Der Standardwert ist "false".

versionDescriptor: GitVersionDescriptor

Versionsdeskriptor. Der Standardwert ist der Standardverzweigung für das Repository.

zipForUnix: boolean

Auf "true" festlegen, um die Dateiberechtigungen für Unix-Systeme (und POSIX) wie ausführbare Dateien und Symlinks beizubehalten

Gibt zurück

Promise<GitItem[]>

getItemsBatch(GitItemRequestData, string, string)

Posten sie zum Abrufen eines Batches aus einer Reihe von Elementen in einem Repository/Projekt, das eine Liste von Pfaden oder einen langen Pfad enthält

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

Parameter

requestData: GitItemRequestData

Anforderungsdatenattribute: ItemDescriptors, IncludeContentMetadata, LatestProcessedChange, IncludeLinks. ItemDescriptors: Sammlung von abzurufenden Elementen, einschließlich Pfad-, Versions- und Rekursionsebene. IncludeContentMetadata: Gibt an, ob Metadaten für alle Elemente LatestProcessedChange eingeschlossen werden sollen: Gibt an, ob ein flacher Verweis eingeschlossen werden soll, um die zuletzt geänderten Elemente zu übernehmen. IncludeLinks: Gibt an, ob das feld _links in die flachen Verweise eingeschlossen werden soll.

repositoryId: string

Der Name oder die ID des Repositorys

project: string

Projekt-ID oder Projektname

Gibt zurück

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>

Parameter

repositoryId: string

Der Name oder die ID des Repositorys.

path: string

Der Elementpfad.

project: string

Projekt-ID oder Projektname

scopePath: string

Der Pfadbereich. Der Standardwert ist NULL.

recursionLevel: VersionControlRecursionType

Die Rekursionsebene dieser Anforderung. Der Standardwert ist "none", keine Rekursion.

includeContentMetadata: boolean

Auf "true" festlegen, um Inhaltsmetadaten einzuschließen. Der Standardwert ist "false".

latestProcessedChange: boolean

Auf "true" festlegen, um die neuesten Änderungen einzuschließen. Der Standardwert ist "false".

download: boolean

Legen Sie "true" fest, um die Antwort als Datei herunterzuladen. Der Standardwert ist "false".

versionDescriptor: GitVersionDescriptor

Versionsdeskriptor. Der Standardwert ist der Standardverzweigung für das Repository.

includeContent: boolean

Auf "true" festlegen, um Elementinhalte beim Anfordern von JSON einzuschließen. Der Standardwert ist "false".

resolveLfs: boolean

Legen Sie den Wert auf "true" fest, um Git LFS-Zeigerdateien aufzulösen, um tatsächlichen Inhalt von Git LFS zurückzugeben. Der Standardwert ist "false".

sanitize: boolean

Legen Sie "true" fest, um eine svg-Datei zu sanitieren und als Bild zurückzugeben. Nur nützlich, wenn sie für svg-Datei angefordert wird. Der Standardwert ist "false".

Gibt zurück

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>

Parameter

repositoryId: string

Der Name oder die ID des Repositorys.

path: string

Der Elementpfad.

project: string

Projekt-ID oder Projektname

scopePath: string

Der Pfadbereich. Der Standardwert ist NULL.

recursionLevel: VersionControlRecursionType

Die Rekursionsebene dieser Anforderung. Der Standardwert ist "none", keine Rekursion.

includeContentMetadata: boolean

Auf "true" festlegen, um Inhaltsmetadaten einzuschließen. Der Standardwert ist "false".

latestProcessedChange: boolean

Auf "true" festlegen, um die neuesten Änderungen einzuschließen. Der Standardwert ist "false".

download: boolean

Legen Sie "true" fest, um die Antwort als Datei herunterzuladen. Der Standardwert ist "false".

versionDescriptor: GitVersionDescriptor

Versionsdeskriptor. Der Standardwert ist der Standardverzweigung für das Repository.

includeContent: boolean

Auf "true" festlegen, um Elementinhalte beim Anfordern von JSON einzuschließen. Der Standardwert ist "false".

resolveLfs: boolean

Legen Sie den Wert auf "true" fest, um Git LFS-Zeigerdateien aufzulösen, um tatsächlichen Inhalt von Git LFS zurückzugeben. Der Standardwert ist "false".

sanitize: boolean

Legen Sie "true" fest, um eine svg-Datei zu sanitieren und als Bild zurückzugeben. Nur nützlich, wenn sie für svg-Datei angefordert wird. Der Standardwert ist "false".

Gibt zurück

Promise<ArrayBuffer>

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

Abrufen von Likes für einen Kommentar.

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

Parameter

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

threadId: number

Die ID des Threads, der den Kommentar enthält.

commentId: number

Die ID des Kommentars.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<IdentityRef[]>

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

Suchen Sie die Zusammenführungsbasen von zwei Commits, optional über Forks hinweg. Wenn "otherRepositoryId" nicht angegeben ist, werden die Zusammenführungsbasen nur im Kontext der lokalen repositoryNameOrId berechnet.

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

Parameter

repositoryNameOrId: string

ID oder Name des lokalen Repositorys.

commitId: string

Zuerst commit, in der Regel die Spitze des Zielzweigs des potenziellen Zusammenführens.

otherCommitId: string

Anderer Commit, in der Regel die Spitze des Quellzweigs des potenziellen Zusammenführens.

project: string

Projekt-ID oder Projektname

otherCollectionId: string

Die Sammlungs-ID, in der andereCommitId lebt.

otherRepositoryId: string

Die Repository-ID, in der sich andereCommitId befindet.

Gibt zurück

Promise<GitCommitRef[]>

getMergeRequest(string, string, number, boolean)

Rufen Sie die Details eines bestimmten Zusammenführungsvorgangs ab.

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

Parameter

project: string

Projekt-ID oder Projektname

repositoryNameOrId: string

Der Name oder die ID des Repositorys.

mergeOperationId: number

OperationId der Seriendruckanforderung.

includeLinks: boolean

True, um Links einzuschließen

Gibt zurück

Promise<GitMerge>

getPermission(string, string, string)

GET Advanced Security Permission status.

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

Parameter

projectName: string

repositoryId: string

Repositorybenutzer versuchen, auf den Zugriff zuzugreifen

permission: string

Die angeforderte Berechtigung muss "viewAlert" "dismissAlert" "manage" "viewEnablement" oder "repoRead" sein.

Gibt zurück

Promise<boolean>

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

Abrufen einer Pullanforderung.

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

Parameter

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

Die ID der abzurufenden Pullanforderung.

project: string

Projekt-ID oder Projektname

maxCommentLength: number

Wird nicht verwendet.

skip: number

Wird nicht verwendet.

top: number

Wird nicht verwendet.

includeCommits: boolean

Wenn true, wird die Pullanforderung mit den zugeordneten Commits zurückgegeben.

includeWorkItemRefs: boolean

Bei "true" wird die Pullanforderung mit den zugehörigen Arbeitsaufgabenverweisen zurückgegeben.

Gibt zurück

Promise<GitPullRequest>

getPullRequestById(number, string)

Abrufen einer Pullanforderung.

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

Parameter

pullRequestId: number

Die ID der abzurufenden Pullanforderung.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitPullRequest>

getPullRequestCommits(string, number, string)

Rufen Sie die Commits für die angegebene Pullanforderung ab.

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

Parameter

repositoryId: string

ID oder Name des Repositorys.

pullRequestId: number

ID der Pullanforderung.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<PagedList<GitCommitRef>>

getPullRequestConflict(string, number, number, string)

Abrufen eines Konflikts für eine Pullanforderung nach ID

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

Parameter

repositoryId: string

pullRequestId: number

conflictId: number

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitConflict>

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

Abrufen aller Konflikte für eine Pullanforderung

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

Parameter

repositoryId: string

Das Repository der Pullanforderung.

pullRequestId: number

Die Pullanforderungs-ID.

project: string

Projekt-ID oder Projektname

skip: number

Konflikte, die übersprungen werden sollen.

top: number

Konflikte, die nach dem Überspringen zurückgegeben werden sollen.

includeObsolete: boolean

Enthält veraltete Konflikte.

excludeResolved: boolean

Schließt bereits aufgelöste Konflikte aus.

onlyResolved: boolean

Gibt nur die Konflikte zurück, die aufgelöst werden.

Gibt zurück

Promise<GitConflict[]>

getPullRequestIteration(string, number, number, string)

Rufen Sie die angegebene Iteration für eine Pullanforderung ab.

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

Parameter

repositoryId: string

ID oder Name des Repositorys.

pullRequestId: number

ID der Pullanforderung.

iterationId: number

ID der zurückzugebenden Pullanforderungs-Iteration.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitPullRequestIteration>

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

Rufen Sie die in einer Pullanforderung vorgenommenen Änderungen zwischen zwei Iterationen ab.

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

Parameter

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

iterationId: number

ID der Pullanforderungsiteration. <br /> Iteration eins ist der Head of the source branch at the time the pull request is created and subsequent iterations are created when there are pushes to the source branch. Zulässige Werte liegen zwischen 1 und der maximalen Iteration für diese Pullanforderung.

project: string

Projekt-ID oder Projektname

top: number

Wahlfrei. Die Anzahl der abzurufenden Änderungen. Der Standardwert ist 100 und der Maximalwert ist 2000.

skip: number

Wahlfrei. Die Anzahl der zu ignorierenden Änderungen. Wenn Sie beispielsweise Änderungen 101-150 abrufen möchten, legen Sie die obere 50 fest, und fahren Sie mit 100 fort.

compareTo: number

ID der Pullanforderungs-Iteration, mit der verglichen werden soll. Der Standardwert ist Null, der angibt, dass der Vergleich mit dem gemeinsamen Commit zwischen der Quell- und Zielverzweigung erfolgt.

Gibt zurück

Promise<GitPullRequestIterationChanges>

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

Rufen Sie die Commits für die angegebene Iteration einer Pullanforderung ab.

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

Parameter

repositoryId: string

ID oder Name des Repositorys.

pullRequestId: number

ID der Pullanforderung.

iterationId: number

ID der Iteration, aus der die Commits abgerufen werden sollen.

project: string

Projekt-ID oder Projektname

top: number

Maximale Anzahl von Commits, die zurückgegeben werden sollen. Die maximale Anzahl von Commits, die pro Batch zurückgegeben werden können, beträgt 500.

skip: number

Anzahl der zu überspringenden Commits.

Gibt zurück

Promise<GitCommitRef[]>

getPullRequestIterations(string, number, string, boolean)

Ruft die Liste der Iterationen für die angegebene Pullanforderung ab.

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

Parameter

repositoryId: string

ID oder Name des Repositorys.

pullRequestId: number

ID der Pullanforderung.

project: string

Projekt-ID oder Projektname

includeCommits: boolean

Wenn true, schließen Sie die Commits ein, die jeder Iteration in der Antwort zugeordnet sind.

Gibt zurück

Promise<GitPullRequestIteration[]>

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

Rufen Sie den spezifischen Iterationsstatus der Pull-Anforderung nach ID ab. Die Status-ID ist innerhalb der Pullanforderung für alle Iterationen eindeutig.

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

Parameter

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

iterationId: number

ID der Pullanforderungsiteration.

statusId: number

ID des Pullanforderungsstatus.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitPullRequestStatus>

getPullRequestIterationStatuses(string, number, number, string)

Rufen Sie alle Status ab, die einer Pullanforderungsiteration zugeordnet sind.

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

Parameter

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

iterationId: number

ID der Pullanforderungsiteration.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitPullRequestStatus[]>

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

Ruft eine einzelne Bezeichnung (Tag) ab, die einer Pullanforderung zugewiesen wurde.

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

Parameter

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

labelIdOrName: string

Der Name oder die ID der angeforderten Bezeichnung.

project: string

Projekt-ID oder Projektname

projectId: string

Projekt-ID oder Projektname.

Gibt zurück

Promise<WebApiTagDefinition>

getPullRequestLabels(string, number, string, string)

Rufen Sie alle Bezeichnungen (Tags) ab, die einer Pullanforderung zugewiesen sind.

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

Parameter

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

project: string

Projekt-ID oder Projektname

projectId: string

Projekt-ID oder Projektname.

Gibt zurück

Promise<WebApiTagDefinition[]>

getPullRequestProperties(string, number, string)

Abrufen externer Eigenschaften der Pullanforderung.

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

Parameter

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<any>

getPullRequestQuery(GitPullRequestQuery, string, string)

Diese API wird verwendet, um zu ermitteln, welche Pullanforderungen mit einem bestimmten Commit zusammenhängen. Sie kann verwendet werden, um entweder die Pullanforderung zu finden, die einen bestimmten Zusammenführungs-Commit erstellt hat, oder sie kann verwendet werden, um alle Pullanforderungen zu finden, die jemals einen bestimmten Commit zusammengeführt haben. Die Eingabe ist eine Liste von Abfragen, die jeweils eine Liste von Commits enthalten. Für jeden Commit, mit dem Sie suchen, erhalten Sie ein Verzeichnis mit Commit zurück –> Pullanforderungen.

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

Parameter

queries: GitPullRequestQuery

Die Liste der auszuführenden Abfragen.

repositoryId: string

ID des Repositorys.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitPullRequestQuery>

getPullRequestReviewer(string, number, string, string)

Abrufen von Informationen zu einem bestimmten Bearbeiter in einer Pullanforderung

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

Parameter

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

reviewerId: string

ID des Bearbeiters.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<IdentityRefWithVote>

getPullRequestReviewers(string, number, string)

Abrufen der Prüfer für eine Pullanforderung

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

Parameter

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<IdentityRefWithVote[]>

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

Rufen Sie alle Pullanforderungen ab, die einem angegebenen Kriterium entsprechen.

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

Parameter

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

searchCriteria: GitPullRequestSearchCriteria

Pullanforderungen werden zurückgegeben, die diesen Suchkriterien entsprechen.

project: string

Projekt-ID oder Projektname

maxCommentLength: number

Wird nicht verwendet.

skip: number

Die Anzahl der zu ignorierenden Pullanforderungen. Wenn Sie z. B. Ergebnisse 101-150 abrufen möchten, legen Sie den Oberen auf 50 fest, und fahren Sie mit 100 fort.

top: number

Die Anzahl der abzurufenden Pullanforderungen.

Gibt zurück

Promise<GitPullRequest[]>

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

Rufen Sie alle Pullanforderungen ab, die einem angegebenen Kriterium entsprechen.

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

Parameter

project: string

Projekt-ID oder Projektname

searchCriteria: GitPullRequestSearchCriteria

Pullanforderungen werden zurückgegeben, die diesen Suchkriterien entsprechen.

maxCommentLength: number

Wird nicht verwendet.

skip: number

Die Anzahl der zu ignorierenden Pullanforderungen. Wenn Sie z. B. Ergebnisse 101-150 abrufen möchten, legen Sie den Oberen auf 50 fest, und fahren Sie mit 100 fort.

top: number

Die Anzahl der abzurufenden Pullanforderungen.

Gibt zurück

Promise<GitPullRequest[]>

getPullRequestStatus(string, number, number, string)

Rufen Sie den spezifischen Pullanforderungsstatus nach ID ab. Die Status-ID ist innerhalb der Pullanforderung für alle Iterationen eindeutig.

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

Parameter

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

statusId: number

ID des Pullanforderungsstatus.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitPullRequestStatus>

getPullRequestStatuses(string, number, string)

Ruft alle Status ab, die einer Pullanforderung zugeordnet sind.

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

Parameter

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitPullRequestStatus[]>

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

Abrufen eines Threads in einer Pullanforderung.

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

Parameter

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

threadId: number

ID des Threads.

project: string

Projekt-ID oder Projektname

iteration: number

Wenn angegeben, wird die Threadposition mithilfe dieser Iteration als rechte Seite des Diff nachverfolgt.

baseIteration: number

Wenn angegeben, wird die Threadposition mithilfe dieser Iteration als linke Seite des Diff nachverfolgt.

Gibt zurück

Promise<GitPullRequestCommentThread>

getPullRequestWorkItemRefs(string, number, string)

Dient zum Abrufen einer Liste von Arbeitsaufgaben, die einer Pullanforderung zugeordnet sind.

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

Parameter

repositoryId: string

ID oder Name des Repositorys.

pullRequestId: number

ID der Pullanforderung.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<ResourceRef[]>

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

Ruft einen bestimmten Push ab.

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

Parameter

repositoryId: string

Der Name oder die ID des Repositorys.

pushId: number

ID des Pushs.

project: string

Projekt-ID oder Projektname

includeCommits: number

Die Anzahl der Commits, die in das Ergebnis eingeschlossen werden sollen.

includeRefUpdates: boolean

Wenn "true", fügen Sie die Liste der Refs ein, die vom Push aktualisiert wurden.

Gibt zurück

Promise<GitPush>

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

Dient zum Abrufen einer Liste von Commits, die einem bestimmten Push zugeordnet sind.

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

Parameter

repositoryId: string

Die ID oder der Anzeigename des Repositorys. Um den Anzeigenamen zu verwenden, muss projectId ebenfalls angegeben werden.

pushId: number

Die ID des Pushs.

project: string

Projekt-ID oder Projektname

top: number

Die maximale Anzahl von Commits, die zurückgegeben werden sollen ("Abrufen des oberen X-Commits").

skip: number

Die Anzahl der zu überspringenden Commits.

includeLinks: boolean

Auf "false" festgelegt, um zu vermeiden, dass REST-URL-Links für Ressourcen eingeschlossen werden. Standardwert ist "true".

Gibt zurück

Promise<GitCommitRef[]>

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

Ruft Pushes ab, die dem angegebenen Repository zugeordnet sind.

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

Parameter

repositoryId: string

Der Name oder die ID des Repositorys.

project: string

Projekt-ID oder Projektname

skip: number

Anzahl der Drücke, die übersprungen werden sollen.

top: number

Anzahl der zurückzugebenden Pushs.

searchCriteria: GitPushSearchCriteria

Suchkriterienattribute: fromDate, toDate, pusherId, refName, includeRefUpdates oder includeLinks. fromDate: Startdatum für die Suche von. toDate: Enddatum, nach dem gesucht werden soll. pusherId: Identität der Person, die den Push übermittelt hat. refName: Zu berücksichtigender Verzweigungsname. includeRefUpdates: If true, include the list of refs that were updated by the push. includeLinks: Gibt an, ob das feld _links in die flachen Verweise eingeschlossen werden soll.

Gibt zurück

Promise<GitPush[]>

getRecycleBinRepositories(string)

Abrufen vorläufig gelöschter Git-Repositorys aus dem Papierkorb.

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

Parameter

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitDeletedRepository[]>

getRefFavorite(string, number)

Ruft den Verweisfavorit für eine Favoriten-ID ab.

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

Parameter

project: string

Projekt-ID oder Projektname

favoriteId: number

Die ID des angeforderten Referenzfavorits.

Gibt zurück

Promise<GitRefFavorite>

getRefFavorites(string, string, string)

Ruft die Verweisfavoriten für ein Repository und eine Identität ab.

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

Parameter

project: string

Projekt-ID oder Projektname

repositoryId: string

Die ID des Repositorys.

identityId: string

Die ID der Identität, deren Favoriten abgerufen werden sollen. Wenn NULL, wird die anfordernde Identität verwendet.

Gibt zurück

Promise<GitRefFavorite[]>

getRefFavoritesForProject(string, string)

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

Parameter

project: string

Projekt-ID oder Projektname

identityId: string

Gibt zurück

Promise<GitRefFavorite[]>

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

Fragt das bereitgestellte Repository für seine Refs ab und gibt sie zurück.

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

Parameter

repositoryId: string

Der Name oder die ID des Repositorys.

project: string

Projekt-ID oder Projektname

filter: string

[optional] Ein Filter, der auf die Refs angewendet werden soll (beginnt mit).

includeLinks: boolean

[optional] Gibt an, ob referenceLinks in das Ergebnis einbezogen werden sollen. Standardwert ist "false".

includeStatuses: boolean

[optional] Umfasst bis zu den ersten 1000 Commit-Status für jeden Verweis. Der Standardwert ist "false".

includeMyBranches: boolean

[optional] Umfasst nur Verzweigungen, die der Benutzer besitzt, die Verzweigungen der Benutzerfavoriten und die Standardverzweigung. Der Standardwert ist "false". Kann nicht mit dem Filterparameter kombiniert werden.

latestStatusesOnly: boolean

[optional] True, um nur den Tipp-Commit-Status für jede Referenz einzuschließen. Für diese Option muss includeStatuses wahr sein. Der Standardwert ist "false".

peelTags: boolean

[optional] Kommentierte Tags füllen die PeeledObjectId-Eigenschaft auf. Standardwert ist "false".

filterContains: string

[optional] Ein Filter, der auf die Refs angewendet werden soll (enthält).

Gibt zurück

Promise<PagedList<GitRef>>

getRepositories(string, boolean, boolean, boolean)

Abrufen von Git-Repositorys.

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

Parameter

project: string

Projekt-ID oder Projektname

includeLinks: boolean

[optional] True, um Referenzverknüpfungslinks einzuschließen. Der Standardwert ist "false".

includeAllUrls: boolean

[optional] True, um alle Remote-URLs einzuschließen. Der Standardwert ist "false".

includeHidden: boolean

[optional] True, um ausgeblendete Repositorys einzuschließen. Der Standardwert ist "false".

Gibt zurück

Promise<GitRepository[]>

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

Abrufen von Git-Repositorys mit Filter nach Name und Paginierung.

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

Parameter

projectId: string

ID oder Name des Teamprojekts.

includeLinks: boolean

[optional] True, um Referenzverknüpfungslinks einzuschließen. Der Standardwert ist "false".

includeAllUrls: boolean

[optional] True, um alle Remote-URLs einzuschließen. Der Standardwert ist "false".

includeHidden: boolean

[optional] True, um ausgeblendete Repositorys einzuschließen. Der Standardwert ist "false".

filterContains: string

[optional] Ein Filter, der auf die Refs angewendet werden soll (enthält).

top: number

[optional] Maximale Anzahl von Repositorys, die zurückgegeben werden sollen. Es darf nicht größer als 500 sein. Wenn dies nicht angegeben ist, aber fortsetzungstoken ist, wird der obere Standardwert auf 100 festgelegt.

continuationToken: string

Das fortsetzungstoken, das für die Paginierung verwendet wird.

Gibt zurück

Promise<PagedList<GitRepository>>

getRepository(string, string)

Abrufen eines Git-Repositorys.

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

Parameter

repositoryId: string

Der Name oder die ID des Repositorys.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitRepository>

getRepositoryWithParent(string, boolean, string)

Abrufen eines Git-Repositorys.

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

Parameter

repositoryId: string

Der Name oder die ID des Repositorys.

includeParent: boolean

True, um das übergeordnete Repository einzuschließen. Nur in authentifizierten Anrufen verfügbar.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitRepository>

getRevert(string, number, string)

Rufen Sie Informationen zu einem Wiederherstellungsvorgang ab, indem Sie die ID wiederherstellen.

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

Parameter

project: string

Projekt-ID oder Projektname

revertId: number

ID des Wiederherstellungsvorgangs.

repositoryId: string

ID des Repositorys.

Gibt zurück

Promise<GitRevert>

getRevertConflict(string, number, number, string)

Abrufen eines Konflikts für eine Wiederherstellung nach ID

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

Parameter

repositoryId: string

revertId: number

conflictId: number

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitConflict>

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

Abrufen aller Konflikte für eine Wiederherstellung

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

Parameter

repositoryId: string

revertId: number

project: string

Projekt-ID oder Projektname

continuationToken: string

top: number

excludeResolved: boolean

onlyResolved: boolean

includeObsolete: boolean

Gibt zurück

Promise<PagedList<GitConflict>>

getRevertForRefName(string, string, string)

Abrufen von Informationen zu einem Wiederherstellungsvorgang für eine bestimmte Verzweigung.

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

Parameter

project: string

Projekt-ID oder Projektname

repositoryId: string

ID des Repositorys.

refName: string

Die gitAsyncRefOperationParameters generatedRefName, die für den Revert-Vorgang verwendet werden.

Gibt zurück

Promise<GitRevert>

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

Abrufen von Status, die dem Git-Commit zugeordnet sind.

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

Parameter

commitId: string

ID des Git-Commits.

repositoryId: string

ID des Repositorys.

project: string

Projekt-ID oder Projektname

top: number

Wahlfrei. Die Anzahl der abzurufenden Status. Der Standardwert ist 1000.

skip: number

Wahlfrei. Die Anzahl der zu ignorierenden Status. Der Standardwert ist 0. Wenn Sie z. B. Ergebnisse 101-150 abrufen möchten, legen Sie den Oberen auf 50 fest, und fahren Sie mit 100 fort.

latestOnly: boolean

Das Flag gibt an, ob nur die neuesten Status nach Context.Name und Context.Genregruppiert werden sollen.

Gibt zurück

Promise<GitStatus[]>

getSuggestions(string, string, boolean)

Rufen Sie einen Pullanforderungsvorschlag für ein bestimmtes Repository- oder Teamprojekt ab.

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

Parameter

repositoryId: string

ID des Git-Repositorys.

project: string

Projekt-ID oder Projektname

preferCompareBranch: boolean

Wenn true, bevorzugen Sie die Vergleichsverzweigung über die Standardverzweigung als Zielverzweigung für Pullanforderungen.

Gibt zurück

Promise<GitSuggestion[]>

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

Rufen Sie alle Threads in einer Pullanforderung ab.

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

Parameter

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

project: string

Projekt-ID oder Projektname

iteration: number

Wenn angegeben, werden Threadpositionen mithilfe dieser Iteration als rechte Seite des Diff nachverfolgt.

baseIteration: number

Wenn angegeben, werden Threadpositionen mithilfe dieser Iteration als linke Seite des Diff nachverfolgt.

Gibt zurück

Promise<GitPullRequestCommentThread[]>

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

Der Strukturendpunkt gibt die Auflistung von Objekten unterhalb der angegebenen Struktur zurück. Bäume sind Ordner in einem Git-Repository.

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

Parameter

repositoryId: string

Repository-ID.

sha1: string

SHA1-Hash des Strukturobjekts.

project: string

Projekt-ID oder Projektname

projectId: string

Projekt-ID.

recursive: boolean

Rekursiv suchen. Schließen Sie Bäume unter diesem Baum ein. Der Standardwert ist "false".

fileName: string

Name, der verwendet werden soll, wenn eine .zip Datei zurückgegeben wird. Der Standardwert ist die Objekt-ID.

Gibt zurück

Promise<GitTreeRef>

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

Der Strukturendpunkt gibt die Auflistung von Objekten unterhalb der angegebenen Struktur zurück. Bäume sind Ordner in einem Git-Repository.

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

Parameter

repositoryId: string

Repository-ID.

sha1: string

SHA1-Hash des Strukturobjekts.

project: string

Projekt-ID oder Projektname

projectId: string

Projekt-ID.

recursive: boolean

Rekursiv suchen. Schließen Sie Bäume unter diesem Baum ein. Der Standardwert ist "false".

fileName: string

Name, der verwendet werden soll, wenn eine .zip Datei zurückgegeben wird. Der Standardwert ist die Objekt-ID.

Gibt zurück

Promise<ArrayBuffer>

queryImportRequests(string, string, boolean)

Abrufen von Importanforderungen für ein Repository.

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

Parameter

project: string

Projekt-ID oder Projektname

repositoryId: string

Der Name oder die ID des Repositorys.

includeAbandoned: boolean

True, um abgebrochene Importanforderungen in die Ergebnisse einzuschließen.

Gibt zurück

Promise<GitImportRequest[]>

restoreRepositoryFromRecycleBin(GitRecycleBinRepositoryDetails, string, string)

Wiederherstellen eines vorläufig gelöschten Git-Repositorys. Zuletzt gelöschte Repositorys werden für einen bestimmten Zeitraum in einen Vorläufigen Löschzustand versetzt, bevor sie endgültig gelöscht und nicht wiederhergestellt werden können.

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

Parameter

repositoryDetails: GitRecycleBinRepositoryDetails

project: string

Projekt-ID oder Projektname

repositoryId: string

Die ID des Repositorys.

Gibt zurück

Promise<GitRepository>

setEnableOnCreateHost(boolean)

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

Parameter

enableOnCreateHost: boolean

Gibt zurück

Promise<void>

setEnableOnCreateProject(string, boolean)

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

Parameter

enableOnCreateProjectId: string

enableOnStatus: boolean

Gibt zurück

Promise<void>

sharePullRequest(ShareNotificationContext, string, number, string)

Sendet eine E-Mail-Benachrichtigung über eine bestimmte Pullanforderung an eine Gruppe von Empfängern.

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

Parameter

userMessage: ShareNotificationContext

repositoryId: string

ID des Git-Repositorys.

pullRequestId: number

ID der Pullanforderung.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<void>

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

Zusammenführen von Konfliktauflösung aktualisieren

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

Parameter

conflict: GitConflict

repositoryId: string

cherryPickId: number

conflictId: number

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitConflict>

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

Aktualisieren mehrerer Zusammenführungskonfliktauflösungen

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

Parameter

conflictUpdates: GitConflict[]

repositoryId: string

cherryPickId: number

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitConflictUpdateResult[]>

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

Aktualisieren eines Kommentars, der einem bestimmten Thread in einer Pullanforderung zugeordnet ist.

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

Parameter

comment: Comment

Der Kommentarinhalt, der aktualisiert werden soll. Kommentare können bis zu 150.000 Zeichen umfassen.

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

threadId: number

ID des Threads, in dem sich der gewünschte Kommentar befindet.

commentId: number

ID des zu aktualisierenden Kommentars.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<Comment>

updateEnablementStatus(AdvSecEnablementUpdate[])

POST-Aktivierungsstatus für Repositorys.

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

Parameter

enablementUpdates: AdvSecEnablementUpdate[]

Gibt zurück

Promise<void>

updateImportRequest(GitImportRequest, string, string, number)

Wiederholen oder Abbrechen einer fehlgeschlagenen Importanforderung.

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

Parameter

importRequestToUpdate: GitImportRequest

Die aktualisierte Version der Importanforderung. Derzeit ist die einzige zulässige Änderung das Festlegen des Status auf "In die Warteschlange" oder "Abgebrochen" festgelegt.

project: string

Projekt-ID oder Projektname

repositoryId: string

Der Name oder die ID des Repositorys.

importRequestId: number

Der eindeutige Bezeichner für die zu aktualisierende Importanforderung.

Gibt zurück

Promise<GitImportRequest>

updatePullRequest(GitPullRequest, string, number, string)

Aktualisieren einer Pullanforderung

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

Parameter

gitPullRequestToUpdate: GitPullRequest

Der Inhalt der Pullanforderung, der aktualisiert werden soll.

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der zu aktualisierenden Pullanforderung.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitPullRequest>

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

Zusammenführen von Konfliktauflösung aktualisieren

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

Parameter

conflict: GitConflict

repositoryId: string

pullRequestId: number

conflictId: number

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitConflict>

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

Aktualisieren mehrerer Zusammenführungskonfliktauflösungen

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

Parameter

conflictUpdates: GitConflict[]

repositoryId: string

pullRequestId: number

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitConflictUpdateResult[]>

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

Aktualisieren sie die Sammlung der Iterationsstatus der Pullanforderung. Der einzige unterstützte Vorgangstyp ist remove.

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

Parameter

patchDocument: JsonPatchDocument

Vorgänge, die auf die Pullanforderungsstatus im JSON-Patchformat angewendet werden sollen.

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

iterationId: number

ID der Pullanforderungsiteration.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<void>

updatePullRequestProperties(JsonPatchDocument, string, number, string)

Erstellen oder Aktualisieren der externen Eigenschaften der Pullanforderung. Der Patchvorgang kann add, replace oder removesein. Für add Vorgang kann der Pfad leer sein. Wenn der Pfad leer ist, muss der Wert eine Liste der Schlüsselwertpaare sein. Für replace Vorgang kann der Pfad nicht leer sein. Wenn der Pfad nicht vorhanden ist, wird die Eigenschaft der Auflistung hinzugefügt. Für remove Vorgang kann der Pfad nicht leer sein. Wenn der Pfad nicht vorhanden ist, wird keine Aktion ausgeführt.

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

Parameter

patchDocument: JsonPatchDocument

Eigenschaften, die im JSON-Patchformat hinzugefügt, ersetzt oder entfernt werden sollen.

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<any>

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

Bearbeiten Sie einen Bearbeitereintrag. Diese Felder sind patchbar: isFlagged, hasDeclined

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

Parameter

reviewer: IdentityRefWithVote

Prüferdaten.<br />Wenn die ID des Bearbeiters hier enthalten ist, muss sie mit dem Parameter "reviewerID" übereinstimmen.

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

reviewerId: string

ID des Bearbeiters.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<IdentityRefWithVote>

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

Setzen Sie die Stimmen mehrerer Prüfer auf eine Pullanfrage zurück. HINWEIS: Dieser Endpunkt unterstützt nur das Aktualisieren von Stimmen, unterstützt aber nicht das Aktualisieren der erforderlichen Prüfer (Verwenden von Richtlinien) oder Anzeigenamen.

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

Parameter

patchVotes: IdentityRefWithVote[]

IDs der Prüfer, deren Stimmen auf Null zurückgesetzt werden

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<void>

updatePullRequestStatuses(JsonPatchDocument, string, number, string)

Aktualisieren der Sammlung von Pullanforderungsstatus. Der einzige unterstützte Vorgangstyp ist remove.

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

Parameter

patchDocument: JsonPatchDocument

Vorgänge, die auf die Pullanforderungsstatus im JSON-Patchformat angewendet werden sollen.

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<void>

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

Sperren oder Entsperren einer Verzweigung

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

Parameter

newRefInfo: GitRefUpdate

Auszuführende Verweisaktualisierungsaktion (Sperren/Entsperren)

repositoryId: string

Der Name oder die ID des Repositorys.

filter: string

Der Name der Verzweigung, die gesperrt/entsperrt werden soll

project: string

Projekt-ID oder Projektname

projectId: string

ID oder Name des Teamprojekts. Optional, wenn Sie eine ID für das Repository angeben.

Gibt zurück

Promise<GitRef>

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

Erstellen, Aktualisieren oder Löschen von Refs(Branches).

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

Parameter

refUpdates: GitRefUpdate[]

Liste der Referenzaktualisierungen, die versucht werden sollen, auszuführen

repositoryId: string

Der Name oder die ID des Repositorys.

project: string

Projekt-ID oder Projektname

projectId: string

ID oder Name des Teamprojekts. Optional, wenn Sie eine ID für das Repository angeben.

Gibt zurück

Promise<GitRefUpdateResult[]>

updateRepository(GitRepository, string, string)

Aktualisiert das Git-Repository entweder mit einem neuen Repositorynamen oder einem neuen Standardverzweigung.

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

Parameter

newRepositoryInfo: GitRepository

Angeben eines neuen Repositorynamens oder einer neuen Standardverzweigung des Repositorys

repositoryId: string

Die ID des Repositorys.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitRepository>

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

Zusammenführen von Konfliktauflösung aktualisieren

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

Parameter

conflict: GitConflict

repositoryId: string

revertId: number

conflictId: number

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitConflict>

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

Aktualisieren mehrerer Zusammenführungskonfliktauflösungen

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

Parameter

conflictUpdates: GitConflict[]

repositoryId: string

revertId: number

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitConflictUpdateResult[]>

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

Aktualisieren eines Threads in einer Pullanforderung.

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

Parameter

commentThread: GitPullRequestCommentThread

Der Threadinhalt, der aktualisiert werden soll.

repositoryId: string

Die Repository-ID des Zielzweigs der Pullanforderung.

pullRequestId: number

ID der Pullanforderung.

threadId: number

ID des zu aktualisierenden Threads.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitPullRequestCommentThread>

Freigeben über

GitRestClient class

Konstruktoren

Eigenschaften

Methoden

Details zum Konstruktor

GitRestClient(IVssRestClientOptions)

Parameter

Details zur Eigenschaft

RESOURCE_AREA_ID

Eigenschaftswert

Details zur Methode

createAnnotatedTag(GitAnnotatedTag, string, string)

Parameter

Gibt zurück

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

Parameter

Gibt zurück

createCherryPick(GitAsyncRefOperationParameters, string, string)

Parameter

Gibt zurück

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

Parameter

Gibt zurück

createCommitStatus(GitStatus, string, string, string)

Parameter

Gibt zurück

createFavorite(GitRefFavorite, string)

Parameter

Gibt zurück

createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)

Parameter

Gibt zurück

createImportRequest(GitImportRequest, string, string)

Parameter

Gibt zurück

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

Parameter

Gibt zurück

createMergeRequest(GitMergeParameters, string, string, boolean)

Parameter

Gibt zurück

createPullRequest(GitPullRequest, string, string, boolean)

Parameter

Gibt zurück

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

Parameter

Gibt zurück

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

Parameter

Gibt zurück

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

Parameter

Gibt zurück

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

Parameter

Gibt zurück

createPullRequestStatus(GitPullRequestStatus, string, number, string)

Parameter

Gibt zurück

createPush(GitPush, string, string)

Parameter

Gibt zurück

createRepository(GitRepositoryCreateOptions, string, string)

Parameter

Gibt zurück

createRevert(GitAsyncRefOperationParameters, string, string)

Parameter

Gibt zurück

createThread(GitPullRequestCommentThread, string, number, string)

Parameter

Gibt zurück

createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)

Parameter

Gibt zurück

deleteAttachment(string, string, number, string)

Parameter

Gibt zurück

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

Parameter