GitRestClient class

Referenz

Paket:: azure-devops-extension-api

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

Extends: RestClientBase

Konstruktoren

GitRestClient(IVssRestClientOptions)

Eigenschaften

RESOURCE_AREA_ID

Methoden

createAnnotatedTag(GitAnnotatedTag, string, string)	Create ein mit Anmerkungen versehenes Tag.
createAttachment(any, string, string, number, string)	Fügen Sie eine neue Datei an einen Pull Request an.
createCherryPick(GitAsyncRefOperationParameters, string, string)	Cherry wählt einen bestimmten Commit oder Commit aus, die einem Pull Request in einem neuen Branch zugeordnet sind.
createComment(Comment, string, number, number, string)	Create einen Kommentar zu einem bestimmten Thread in einem Pull Request (pro Thread können bis zu 500 Kommentare erstellt werden).
createCommitStatus(GitStatus, string, string, string)	Create Git-Commit-status.
createFavorite(GitRefFavorite, string)	Erstellt einen Ref-Favoriten
createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)	Fordern Sie an, dass die Refs eines anderen Repositorys in dieses Repository abgerufen werden. Es synchronisiert zwei vorhandene Forks. Informationen zum Erstellen eines Forks finden Sie im <Repository-Endpunkt< a href="https://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1">>
createImportRequest(GitImportRequest, string, string)	Create eine Importanforderung.
createLike(string, number, number, number, string)	Fügen Sie einem Kommentar ein Like hinzu.
createMergeRequest(GitMergeParameters, string, string, boolean)	Fordern Sie einen Git-Mergevorgang an. Derzeit wird nur das Zusammenführen von 2 Commits unterstützt.
createPullRequest(GitPullRequest, string, string, boolean)	Erstellen Sie einen Pull Request.
createPullRequestIterationStatus(GitPullRequestStatus, string, number, number, string)	Create einen Pull Request status für die Iteration. Dieser Vorgang hat das gleiche Ergebnis wie Create status für Pull Request mit der angegebenen Iterations-ID im Anforderungstext.
createPullRequestLabel(WebApiCreateTagRequestData, string, number, string, string)	Create ein Tag (sofern es noch nicht vorhanden ist) und fügen Sie es als Bezeichnung (Tag) für einen angegebenen Pull Request hinzu. Das einzige erforderliche Feld ist der Name der neuen Bezeichnung (Tag).
createPullRequestReviewer(IdentityRefWithVote, string, number, string, string)	Fügen Sie einem Pull Request einen Prüfer hinzu, oder geben Sie eine Stimme ab.
createPullRequestReviewers(IdentityRef[], string, number, string)	Fügen Sie einem Pull Request Prüfer hinzu.
createPullRequestStatus(GitPullRequestStatus, string, number, string)	Create einen Pull Request status.
createPush(GitPush, string, string)	Pushen Sie Änderungen an das Repository.
createRepository(GitRepositoryCreateOptions, string, string)	Create ein Git-Repository in einem Teamprojekt.
createRevert(GitAsyncRefOperationParameters, string, string)	Startet den Vorgang, um einen neuen Branch zu erstellen, der Änderungen zurücknimmt, die durch einen bestimmten Commit oder Commits, die einem Pull Request zugeordnet sind, vorgenommen wurden.
createThread(GitPullRequestCommentThread, string, number, string)	Create einen Thread in einem Pull Request.
createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)	Fügen Sie den Prüfern eines Pull Requests eine nicht materialisierte Identität hinzu.
deleteAttachment(string, string, number, string)	Löschen Sie eine Pull Request-Anlage.
deleteComment(string, number, number, number, string)	Löschen Sie einen Kommentar, der einem bestimmten Thread in einem Pull Request zugeordnet ist.
deleteEnablementStatus(boolean, boolean, string[])	DELETE Löscht Enablement status- und BillableCommitters-Daten aus der Datenbank. Wenn Sie die Aktivierungsdaten löschen, werden sie für die betroffenen Repositorys effektiv deaktiviert.
deleteLike(string, number, number, number, string)	Löschen Sie ein "Gefällt mir"-Element in einem Kommentar.
deletePullRequestIterationStatus(string, number, number, number, string)	Löschen sie status der Pull Request-Iteration.
deletePullRequestLabels(string, number, string, string, string)	Entfernt eine Bezeichnung (Tag) aus dem Satz derjenigen, die dem Pull Request zugewiesen sind. Das Tag selbst wird nicht gelöscht.
deletePullRequestReviewer(string, number, string, string)	Entfernen Sie einen Prüfer aus einem Pull Request.
deletePullRequestStatus(string, number, number, string)	Löschen sie pull request status.
deleteRefFavorite(string, number)	Löscht den angegebenen Verweisfavorit.
deleteRepository(string, string)	Löschen eines Git-Repositorys
deleteRepositoryFromRecycleBin(string, string)	Löschen Sie ein vorläufig gelöschtes Git-Repository (endgültig löschen).
getAnnotatedTag(string, string, string)	Rufen Sie ein mit Anmerkungen versehenes Tag ab.
getAttachmentContent(string, string, number, string)	Ruft den Dateiinhalt einer Pull Request-Anlage ab.
getAttachments(string, number, string)	Ruft eine Liste der Dateien ab, die an einen bestimmten Pull Request angefügt sind.
getAttachmentZip(string, string, number, string)	Ruft den Dateiinhalt einer Pull Request-Anlage ab.
getBillableCommitters(string, Date, number, number)	Rufen Sie die tatsächlichen abrechenbaren Committer für den Advanced Security-Dienst für ein bestimmtes Datum ab.
getBillableCommittersDetail(string, string, Date)	Rufen Sie detaillierte tatsächliche abrechenbare Committer für den Advanced Security-Dienst für ein bestimmtes Datum ab. Detaillierte Ergebnisse filtern vorläufig gelöschte Projekte und Repositorys absichtlich nicht heraus, 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)	Rufen Sie Statistiken zu einem einzelnen Branch ab.
getBranches(string, string, GitVersionDescriptor)	Ruft Statistiken zu allen Branches innerhalb eines Repositorys ab.
getBranchStatsBatch(GitQueryBranchStatsCriteria, string, string)	Abrufen von Statistiken für mehrere Commits
getChanges(string, string, string, number, number)	Rufen Sie Änderungen für einen bestimmten Commit ab.
getCherryPick(string, number, string)	Abrufen von Informationen zu einem Cherry Pick-Vorgang anhand der Cherry Pick-ID.
getCherryPickConflict(string, number, number, string)	Abrufen eines Konflikts für eine Cherry-Auswahl nach ID
getCherryPickConflicts(string, number, string, string, number, boolean, boolean, boolean)	Abrufen aller Konflikte für eine Rosinenauswahl
getCherryPickForRefName(string, string, string)	Rufen Sie Informationen zu einem Cherry Pick-Vorgang für einen bestimmten Branch ab. Dieser Vorgang ist aufgrund der zugrunde liegenden Objektstruktur teuer, sodass diese API nur die 1000 neuesten Cherry Pick-Vorgänge untersucht.
getCherryPickRelationships(string, string, string, boolean)	Gibt bei einer commitId eine Liste von Commits zurück, die sich in derselben Cherry-Pick-Familie befinden.
getComment(string, number, number, number, string)	Rufen Sie einen Kommentar ab, der einem bestimmten Thread in einem Pull Request zugeordnet ist.
getComments(string, number, number, string)	Ruft alle Kommentare ab, die einem bestimmten Thread in einem Pull Request 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 Mergebasis) zwischen Basis- und Zielcommits, und rufen Sie die diff zwischen den Basis- und Zielcommits oder allgemeinen und Zielcommits 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)	Rufen Sie gelöschte Git-Repositorys ab.
getEnablementStatus(string[], Date, number, number)	GET Enablement status für Projektrepositorys.
getEnableOnCreateHost(boolean)
getEnableOnCreateProject(string)
getEstimatedBillableCommittersRepo(string, string)	Rufen Sie geschätzte abrechenbare Committer für ein Repository für die letzten 90 Tage ab.
getEstimatedBillablePushersOrg()	Rufen Sie geschätzte abrechenbare Pusher für eine Organisation für die letzten 90 Tage ab.
getEstimatedBillablePushersProject(string)	Rufen Sie geschätzte abrechenbare Pusher für ein Projekt für die letzten 90 Tage ab.
getFileDiffs(FileDiffsCriteria, string, string)	Abrufen der Datei diffs für jede der angegebenen Dateien
getForks(string, string, string, boolean)	Ruft alle Forks eines Repositorys in der Auflistung ab.
getForkSyncRequest(string, number, string, boolean)	Rufen Sie die Details eines bestimmten Forksynchronisierungsvorgangs ab.
getForkSyncRequests(string, string, boolean, boolean)	Rufen Sie alle angeforderten Forksynchronisierungsvorgänge für dieses Repository ab.
getHfsItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der download-Parameter gibt an, ob der Inhalt als Download verfügbar 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)	Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der download-Parameter gibt an, ob der Inhalt als Download verfügbar 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)	Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der download-Parameter gibt an, ob der Inhalt als Download verfügbar 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)	Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der download-Parameter gibt an, ob der Inhalt als Download verfügbar 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)	Rufen Sie eine bestimmte Importanforderung ab.
getItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der download-Parameter gibt an, ob der Inhalt als Download verfügbar 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)	Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der download-Parameter gibt an, ob der Inhalt als Download verfügbar 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)	Abrufen von Elementmetadaten und/oder Inhalten für eine Auflistung von Elementen. Der download-Parameter gibt an, ob der Inhalt als Download verfügbar 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)	Beitrag zum Abrufen eines Batches aus einer Gruppe von Elementen in einem Repository/Projekt unter Angabe einer Liste von Pfaden oder eines langen Pfads
getItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der download-Parameter gibt an, ob der Inhalt als Download verfügbar 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)	Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der download-Parameter gibt an, ob der Inhalt als Download verfügbar 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)	Erhalten Sie "Gefällt mir" für einen Kommentar.
getMergeBases(string, string, string, string, string, string)	Suchen Sie die Mergebasen von zwei Commits, optional über Forks hinweg. Wenn otherRepositoryId nicht angegeben ist, werden die Mergebasen nur im Kontext des lokalen repositoryNameOrId berechnet.
getMergeRequest(string, string, number, boolean)	Rufen Sie die Details eines bestimmten Mergevorgangs ab.
getPermission(string, string, string)	GET Advanced Security Permission status.
getPullRequest(string, number, string, number, number, number, boolean, boolean)	Rufen Sie einen Pull Request ab.
getPullRequestById(number, string)	Rufen Sie einen Pull Request ab.
getPullRequestCommits(string, number, string)	Rufen Sie die Commits für den angegebenen Pull Request ab.
getPullRequestConflict(string, number, number, string)	Abrufen eines Konflikts für einen Pull Request nach ID
getPullRequestConflicts(string, number, string, number, number, boolean, boolean, boolean)	Abrufen aller Konflikte für einen Pull Request
getPullRequestIteration(string, number, number, string)	Ruft die angegebene Iteration für einen Pull Request ab.
getPullRequestIterationChanges(string, number, number, string, number, number, number)	Rufen Sie die Änderungen ab, die in einem Pull Request zwischen zwei Iterationen vorgenommen wurden.
getPullRequestIterationCommits(string, number, number, string, number, number)	Ruft die Commits für die angegebene Iteration eines Pull Requests ab.
getPullRequestIterations(string, number, string, boolean)	Rufen Sie die Liste der Iterationen für den angegebenen Pull Request ab.
getPullRequestIterationStatus(string, number, number, number, string)	Rufen Sie die spezifische Pull Request-Iteration status nach ID ab. Die status-ID ist innerhalb des Pull Requests über alle Iterationen hinweg eindeutig.
getPullRequestIterationStatuses(string, number, number, string)	Ruft alle Status ab, die einer Pull Request-Iteration zugeordnet sind.
getPullRequestLabel(string, number, string, string, string)	Ruft eine einzelne Bezeichnung (Tag) ab, die einem Pull Request zugewiesen wurde.
getPullRequestLabels(string, number, string, string)	Ruft alle Bezeichnungen (Tags) ab, die einem Pull Request zugewiesen sind.
getPullRequestProperties(string, number, string)	Ruft externe Eigenschaften des Pull Requests ab.
getPullRequestQuery(GitPullRequestQuery, string, string)	Diese API wird verwendet, um zu ermitteln, welche Pull Requests im Zusammenhang mit einem bestimmten Commit stehen. Es kann verwendet werden, um entweder den Pull Request zu finden, der einen bestimmten Mergecommit erstellt hat, oder es kann verwendet werden, um alle Pull Requests 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, für den Sie suchen, erhalten Sie ein Verzeichnis mit Commit –> Pull Requests.
getPullRequestReviewer(string, number, string, string)	Abrufen von Informationen zu einem bestimmten Prüfer in einem Pull Request
getPullRequestReviewers(string, number, string)	Abrufen der Prüfer für einen Pull Request
getPullRequests(string, GitPullRequestSearchCriteria, string, number, number, number)	Ruft alle Pull Requests ab, die einem angegebenen Kriterium entsprechen.
getPullRequestsByProject(string, GitPullRequestSearchCriteria, number, number, number)	Ruft alle Pull Requests ab, die einem angegebenen Kriterium entsprechen.
getPullRequestStatus(string, number, number, string)	Rufen Sie die spezifischen Pull Request-status nach ID ab. Die status-ID ist innerhalb des Pull Requests über alle Iterationen hinweg eindeutig.
getPullRequestStatuses(string, number, string)	Ruft alle Status ab, die einem Pull Request zugeordnet sind.
getPullRequestThread(string, number, number, string, number, number)	Abrufen eines Threads in einem Pull Request.
getPullRequestWorkItemRefs(string, number, string)	Ruft eine Liste der Arbeitselemente ab, die einem Pull Request zugeordnet sind.
getPush(string, number, string, number, boolean)	Ruft einen bestimmten Push ab.
getPushCommits(string, number, string, number, number, boolean)	Rufen Sie eine Liste von Commits ab, die einem bestimmten Push zugeordnet sind.
getPushes(string, string, number, number, GitPushSearchCriteria)	Ruft Pushvorgänge ab, die dem angegebenen Repository zugeordnet sind.
getRecycleBinRepositories(string)	Rufen Sie vorläufig gelöschte Git-Repositorys aus dem Papierkorb ab.
getRefFavorite(string, number)	Ruft den Refs-Favoriten für eine Favoriten-ID ab.
getRefFavorites(string, string, string)	Ruft die Refs-Favoriten 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 nach seinen Refs ab und gibt sie zurück.
getRepositories(string, boolean, boolean, boolean)	Abrufen von Git-Repositorys.
getRepository(string, string)	Rufen Sie ein Git-Repository ab.
getRepositoryWithParent(string, boolean, string)	Rufen Sie ein Git-Repository ab.
getRevert(string, number, string)	Rufen Sie Informationen zu einem rückgängig machen Vorgang mit rückgängig machen ID ab.
getRevertConflict(string, number, number, string)	Abrufen eines Konflikts für einen rückgängig machen nach ID
getRevertConflicts(string, number, string, string, number, boolean, boolean, boolean)	Abrufen aller Konflikte für eine rückgängig machen
getRevertForRefName(string, string, string)	Ruft Informationen zu einem rückgängig machen Vorgang für einen bestimmten Branch ab.
getStatuses(string, string, string, number, number, boolean)	Abrufen von Status, die dem Git-Commit zugeordnet sind.
getSuggestions(string, string, boolean)	Rufen Sie einen Pull Request-Vorschlag für ein bestimmtes Repository oder Teamprojekt ab.
getThreads(string, number, string, number, number)	Ruft alle Threads in einem Pull Request ab.
getTree(string, string, string, string, boolean, string)	Der Tree-Endpunkt gibt die Auflistung von Objekten unter der angegebenen Struktur zurück. Strukturen sind Ordner in einem Git-Repository.
getTreeZip(string, string, string, string, boolean, string)	Der Tree-Endpunkt gibt die Auflistung von Objekten unter der angegebenen Struktur zurück. Strukturen sind Ordner in einem Git-Repository.
queryImportRequests(string, string, boolean)	Abrufen von Importanforderungen für ein Repository.
restoreRepositoryFromRecycleBin(GitRecycleBinRepositoryDetails, string, string)	Stellen Sie ein vorläufig gelöschtes Git-Repository wieder her. Kürzlich gelöschte Repositorys werden für einen bestimmten Zeitraum in einen vorläufigen Löschzustand versetzt, bevor sie hart gelöscht und nicht wiederhergestellt werden können.
setEnableOnCreateHost(boolean)
setEnableOnCreateProject(string, boolean)
sharePullRequest(ShareNotificationContext, string, number, string)	Sendet eine E-Mail-Benachrichtigung über einen bestimmten Pull Request an eine Gruppe von Empfängern
updateCherryPickConflict(GitConflict, string, number, number, string)	Aktualisieren der Mergekonfliktlösung
updateCherryPickConflicts(GitConflict[], string, number, string)	Aktualisieren mehrerer Mergekonfliktauflösungen
updateComment(Comment, string, number, number, number, string)	Aktualisieren Sie einen Kommentar, der einem bestimmten Thread in einem Pull Request zugeordnet ist.
updateEnablementStatus(AdvSecEnablementUpdate[])	POST Enablement status für Repositorys.
updateImportRequest(GitImportRequest, string, string, number)	Wiederholen Oder Abbrechen einer fehlerhaften Importanforderung.
updatePullRequest(GitPullRequest, string, number, string)	Aktualisieren eines Pull Requests
updatePullRequestConflict(GitConflict, string, number, number, string)	Aktualisieren der Mergekonfliktlösung
updatePullRequestConflicts(GitConflict[], string, number, string)	Aktualisieren mehrerer Mergekonfliktauflösungen
updatePullRequestIterationStatuses(JsonPatchDocument, string, number, number, string)	Aktualisieren Sie die Sammlung von Iterationsstatus für Pull Request. Der einzige unterstützte Vorgangstyp ist `remove`.
updatePullRequestProperties(JsonPatchDocument, string, number, string)	Create oder aktualisieren Sie externe Pull Request-Eigenschaften. Der Patchvorgang kann oder `replaceremove`sein`add`. Für `add` den Vorgang kann der Pfad leer sein. Wenn der Pfad leer ist, muss der Wert eine Liste von Schlüsselwertpaaren sein. Für `replace` den Vorgang darf der Pfad nicht leer sein. Wenn der Pfad nicht vorhanden ist, wird die -Eigenschaft der Auflistung hinzugefügt. Für `remove` den Vorgang darf 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 Prüfereintrag. Diese Felder sind patchbar: isFlagged, hasDeclined
updatePullRequestReviewers(IdentityRefWithVote[], string, number, string)	Setzen Sie die Stimmen mehrerer Prüfer für einen Pull Request zurück. HINWEIS: Dieser Endpunkt unterstützt nur das Aktualisieren von Stimmen, aber nicht das Aktualisieren erforderlicher Prüfer (Verwenden von Richtlinien) oder Anzeigenamen.
updatePullRequestStatuses(JsonPatchDocument, string, number, string)	Aktualisieren der Sammlung von Pull Request-Status. 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)	Updates das Git-Repository entweder mit einem neuen Repositorynamen oder einem neuen Standardbranch.
updateRevertConflict(GitConflict, string, number, number, string)	Aktualisieren der Lösung von Mergekonflikten
updateRevertConflicts(GitConflict[], string, number, string)	Aktualisieren mehrerer Mergekonfliktauflösungen
updateThread(GitPullRequestCommentThread, string, number, number, string)	Aktualisieren sie einen Thread in einem Pull Request.

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)

Create ein mit Anmerkungen versehenes 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 einen Pull Request 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 Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<Attachment>

createCherryPick(GitAsyncRefOperationParameters, string, string)

Cherry wählt einen bestimmten Commit oder Commit aus, die einem Pull Request in einem neuen Branch zugeordnet sind.

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)

Create einen Kommentar zu einem bestimmten Thread in einem Pull Request (pro Thread können bis zu 500 Kommentare 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 lang sein.

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

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)

Create Git-Commit-status.

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

Parameter

gitCommitStatusToCreate: GitStatus

Git-Commit status zu erstellende Objekt.

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 Ref-Favoriten

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

Parameter

favorite: GitRefFavorite

Der zu erstellende Ref-Favorit.

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 dieses Repository abgerufen werden. Es synchronisiert zwei vorhandene Forks. Informationen zum Erstellen eines Forks finden Sie im <Repository-Endpunkt< a href="https://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1">>

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

Parameter

syncParams: GitForkSyncRequestParameters

Quellrepository und Ref-Zuordnung.

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)

Create 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 einem Kommentar ein Like hinzu.

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

Parameter

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

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)

Fordern Sie einen Git-Mergevorgang an. Derzeit wird nur das Zusammenführen von 2 Commits unterstützt.

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

Parameter

mergeParameters: GitMergeParameters

Eltern commitIds und Merge commitsage.

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 einen Pull Request.

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

Parameter

gitPullRequestToCreate: GitPullRequest

Der zu erstellende Pull Request.

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

project: string

Projekt-ID oder Projektname

supportsIterations: boolean

Wenn true, können nachfolgende Pushvorgänge an den Pull Request einzeln überprüft werden. Legen Sie dies für große Pull Requests aus Leistungsgründen auf false fest, wenn diese Funktionalität nicht benötigt wird.

Gibt zurück

Promise<GitPullRequest>

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

Create einen Pull Request status für die Iteration. Dieser Vorgang hat das gleiche Ergebnis wie Create status für Pull Request mit der angegebenen Iterations-ID im Anforderungstext.

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

Parameter

status: GitPullRequestStatus

Pull Request status zu erstellen.

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

iterationId: number

ID der Pull Request-Iteration.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitPullRequestStatus>

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

Create ein Tag (sofern es noch nicht vorhanden ist) und fügen Sie es als Bezeichnung (Tag) für einen angegebenen Pull Request 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 dem Pull Request zugewiesen werden soll.

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

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 Request 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

Abstimmung des Prüfers.<br />Wenn die ID des Prüfers hier enthalten ist, muss sie mit dem ReviewerID-Parameter übereinstimmen.<br />Reviewer können mit dieser Methode ihre eigene Stimme festlegen. Beim Hinzufügen anderer Prüfer muss die Stimme auf 0 festgelegt werden.

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

reviewerId: string

ID des Prüfers.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<IdentityRefWithVote>

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

Fügen Sie einem Pull Request Prüfer hinzu.

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

Parameter

reviewers: IdentityRef[]

Prüfer, die dem Pull Request hinzugefügt werden sollen.

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<IdentityRefWithVote[]>

createPullRequestStatus(GitPullRequestStatus, string, number, string)

Create einen Pull Request status.

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

Parameter

status: GitPullRequestStatus

Pull Request status zu erstellen.

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitPullRequestStatus>

createPush(GitPush, string, string)

Pushen Sie Ä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)

Create 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 aus gitRepositoryToCreate ausgelassen werden, wenn die Anforderung projektbereichsmäßig ist (d. h. projekt-ID enthält).

project: string

Projekt-ID oder Projektname

sourceRef: string

[optional] Angeben der Quellrefs, die beim Erstellen eines Fork-Repositorys verwendet werden sollen

Gibt zurück

Promise<GitRepository>

createRevert(GitAsyncRefOperationParameters, string, string)

Startet den Vorgang, um einen neuen Branch zu erstellen, der Änderungen zurücknimmt, die durch einen bestimmten Commit oder Commits, die einem Pull Request zugeordnet sind, vorgenommen wurden.

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)

Create einen Thread in einem Pull Request.

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 Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitPullRequestCommentThread>

createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)

Fügen Sie den Prüfern eines Pull Requests eine nicht materialisierte Identität hinzu.

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

Parameter

reviewer: IdentityRefWithVote

Prüfer, der dem Pull Request hinzugefügt werden soll.

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<IdentityRefWithVote>

deleteAttachment(string, string, number, string)

Löschen Sie eine Pull Request-Anlage.

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 Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<void>

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

Löschen Sie einen Kommentar, der einem bestimmten Thread in einem Pull Request zugeordnet ist.

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

Parameter

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

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 Enablement status- und BillableCommitters-Daten aus der Datenbank. Wenn Sie die Aktivierungsdaten löschen, werden sie für die betroffenen Repositorys effektiv 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 Sie ein "Gefällt mir"-Element in einem Kommentar.

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

Parameter

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

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 sie status der Pull Request-Iteration.

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

Parameter

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

iterationId: number

ID der Pull Request-Iteration.

statusId: number

ID des Pull Request-status.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<void>

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

Entfernt eine Bezeichnung (Tag) aus dem Satz derjenigen, die dem Pull Request 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 Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

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 Sie einen Prüfer aus einem Pull Request.

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

Parameter

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

reviewerId: string

ID des zu entfernenden Prüfers.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<void>

deletePullRequestStatus(string, number, number, string)

Löschen sie pull request status.

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

Parameter

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

statusId: number

ID des Pull Request-status.

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 Verweisfavoriten.

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)

Löschen Sie ein vorläufig gelöschtes Git-Repository (endgültig löschen).

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 mit Anmerkungen versehenes 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)

Ruft den Dateiinhalt einer Pull Request-Anlage ab.

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 Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<ArrayBuffer>

getAttachments(string, number, string)

Ruft eine Liste der Dateien ab, die an einen bestimmten Pull Request angefügt sind.

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

Parameter

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<Attachment[]>

getAttachmentZip(string, string, number, string)

Ruft den Dateiinhalt einer Pull Request-Anlage ab.

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 Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<ArrayBuffer>

getBillableCommitters(string, Date, number, number)

Rufen Sie die tatsächlichen abrechenbaren 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 nicht angegeben, wird standardmäßig der vorherige Abrechnungstag verwendet.

skip: number

Überspringen Sie X-Zeilen des Resultsets, um das Paging zu simulieren.

take: number

Gibt Y-Zeilen des Resultsets zurück, um das Paging zu simulieren.

Gibt zurück

Promise<BillableCommitter[]>

getBillableCommittersDetail(string, string, Date)

Rufen Sie detaillierte tatsächliche abrechenbare Committer für den Advanced Security-Dienst für ein bestimmtes Datum ab. Detaillierte Ergebnisse filtern vorläufig gelöschte Projekte und Repositorys absichtlich nicht heraus, 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 abrechenbaren Committern zurück.

billingDate: Date

UTC erwartet. Wenn nicht angegeben, wird standardmäßig der vorherige Abrechnungstag verwendet.

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 den SHA1 einer Datei mithilfe des Endpunkts "Git/Items/Get Item" abrufen.

project: string

Projekt-ID oder Projektname

download: boolean

Wenn true, fordern Sie zu einem Download statt zum Rendern in einem Browser auf. Hinweis: Dieser Wert ist standardmäßig true, wenn $format zip ist.

fileName: string

Geben Sie einen FileName 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 den SHA1 einer Datei mithilfe des Endpunkts "Git/Items/Get Item" abrufen.

project: string

Projekt-ID oder Projektname

download: boolean

Wenn true, fordern Sie zu einem Download statt zum Rendern in einem Browser auf. Hinweis: Dieser Wert ist standardmäßig true, wenn $format zip ist.

fileName: string

Geben Sie einen FileName 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 das SHA1 einer Datei mithilfe des Endpunkts "Git/Items/Get Item" abrufen.

project: string

Projekt-ID oder Projektname

download: boolean

Wenn true, fordern Sie einen Download anstelle des Renderns in einem Browser an. Hinweis: Dieser Wert ist standardmäßig true, wenn $format zip ist.

fileName: string

Geben Sie einen FileName 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 Octetstream Accept-Headern oder $format Typen

Gibt zurück

Promise<ArrayBuffer>

getBranch(string, string, string, GitVersionDescriptor)

Rufen Sie Statistiken zu einem einzelnen Branch ab.

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 des Branchs.

project: string

Projekt-ID oder Projektname

baseVersionDescriptor: GitVersionDescriptor

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

Gibt zurück

Promise<GitBranchStats>

getBranches(string, string, GitVersionDescriptor)

Ruft Statistiken zu allen Branches innerhalb eines Repositorys ab.

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 Branch 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

Basiscommit und Liste der zu vergleichenden Zielcommits.

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)

Rufen Sie Änderungen für einen bestimmten Commit ab.

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 auch projectId 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 Cherry Pick-Vorgang anhand der Cherry Pick-ID.

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

Parameter

project: string

Projekt-ID oder Projektname

cherryPickId: number

ID der Rosinenauswahl.

repositoryId: string

ID des Repositorys.

Gibt zurück

Promise<GitCherryPick>

getCherryPickConflict(string, number, number, string)

Abrufen eines Konflikts für eine Cherry-Auswahl 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 Rosinenauswahl

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)

Rufen Sie Informationen zu einem Cherry Pick-Vorgang für einen bestimmten Branch ab. Dieser Vorgang ist aufgrund der zugrunde liegenden Objektstruktur teuer, sodass diese API nur die 1000 neuesten Cherry Pick-Vorgänge untersucht.

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

Parameter

project: string

Projekt-ID oder Projektname

repositoryId: string

ID des Repositorys.

refName: string

Der generierte GitAsyncRefOperationParametersRefName, der für den Cherry pick-Vorgang verwendet wird.

Gibt zurück

Promise<GitCherryPick>

getCherryPickRelationships(string, string, string, boolean)

Gibt bei einer commitId eine Liste von Commits zurück, die sich in derselben Cherry-Pick-Familie 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 einem Pull Request zugeordnet ist.

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

Parameter

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

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)

Ruft alle Kommentare ab, die einem bestimmten Thread in einem Pull Request zugeordnet sind.

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

Parameter

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

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 auch projectId angegeben werden.

project: string

Projekt-ID oder Projektname

changeCount: number

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

Gibt zurück

Promise<GitCommit>

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

Suchen Sie den nächstgelegenen gemeinsamen Commit (die Mergebasis) zwischen Basis- und Zielcommits, und rufen Sie die diff zwischen den Basis- und Zielcommits oder allgemeinen und Zielcommits 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 true, diff zwischen allgemeinen Commits und Zielcommits. Wenn false, diff zwischen Basis- und Zielcommits.

top: number

Die maximale Anzahl der zurückzugebenden Änderungen. Standardwert ist 100.

skip: number

Anzahl der zu überspringenden Änderungen

baseVersionDescriptor: GitBaseVersionDescriptor

Deskriptor für Basiscommit.

targetVersionDescriptor: GitTargetVersionDescriptor

Deskriptor für Zielcommit.

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 auch projectId 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-status Informationen einzuschließen.

Gibt zurück

Promise<GitCommitRef[]>

getDeletedRepositories(string)

Rufen Sie gelöschte Git-Repositorys ab.

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 für Projektrepositorys.

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

Parameter

projectIds: string[]

Null-Standardwerte für alle Projekte im Host, Liste der Projektreposs status zurückgeben

billingDate: Date

UTC erwartet, Null-Standardwerte auf UtcNow(), kann für einen Bestimmten Zeitpunkt status

skip: number

Überspringen Sie X-Zeilen des Resultsets, um das Paging zu simulieren.

take: number

Gibt Y-Zeilen des Resultsets zurück, um die Paging zu simulieren.

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 abrechenbare 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()

Rufen Sie geschätzte abrechenbare Pusher für eine Organisation für die letzten 90 Tage ab.

function getEstimatedBillablePushersOrg(): Promise<BillablePusher[]>

Gibt zurück

Promise<BillablePusher[]>

getEstimatedBillablePushersProject(string)

Rufen Sie geschätzte abrechenbare Pusher für ein Projekt für die letzten 90 Tage ab.

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)

Ruft alle Forks eines Repositorys in der Auflistung 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 Forksynchronisierungsvorgangs 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 Forksynchronisierungsvorgä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)

Abrufen von Elementmetadaten und/oder Inhalten für ein einzelnes Element. Der download-Parameter gibt an, ob der Inhalt als Download verfügbar 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 Rekursionsstufe dieser Anforderung. Der Standardwert ist "none", keine Rekursion.

includeContentMetadata: boolean

Legen Sie diesen Wert auf true fest, um Inhaltsmetadaten einzuschließen. Der Standardwert ist "false".

latestProcessedChange: boolean

Legen Sie diese Einstellung auf true fest, um die neuesten Änderungen einzuschließen. Der Standardwert ist "false".

download: boolean

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

versionDescriptor: GitVersionDescriptor

Versionsdeskriptor. Der Standardwert ist die Standardbranch für das Repository.

includeContent: boolean

Legen Sie diesen Wert auf true fest, um Elementinhalte beim Anfordern von JSON einzuschließen. Der Standardwert ist "false".

resolveHfs: boolean

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

sanitize: boolean

Legen Sie auf true fest, um eine svg-Datei zu bereinigen und als Bild zurückzugeben. Nur nützlich, wenn für die 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 Rekursionsstufe dieser Anforderung. Der Standardwert ist "none", keine Rekursion.

includeContentMetadata: boolean

Legen Sie diesen Wert auf true fest, um Inhaltsmetadaten einzuschließen. Der Standardwert ist "false".

latestProcessedChange: boolean

Legen Sie diese Einstellung auf true fest, um die neuesten Änderungen einzuschließen. Der Standardwert ist "false".

download: boolean

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

versionDescriptor: GitVersionDescriptor

Versionsdeskriptor. Der Standardwert ist die Standardbranch für das Repository.

includeContent: boolean

Legen Sie diesen Wert auf true fest, um Elementinhalte beim Anfordern von JSON einzuschließen. Der Standardwert ist "false".

resolveHfs: boolean

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

sanitize: boolean

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

Gibt zurück

Promise<ArrayBuffer>

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 Rekursionsstufe dieser Anforderung. Der Standardwert ist "none", keine Rekursion.

includeContentMetadata: boolean

Legen Sie diesen Wert auf true fest, um Inhaltsmetadaten einzuschließen. Der Standardwert ist "false".

latestProcessedChange: boolean

Legen Sie diese Einstellung auf true fest, um die neuesten Änderungen einzuschließen. Der Standardwert ist "false".

download: boolean

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

versionDescriptor: GitVersionDescriptor

Versionsdeskriptor. Der Standardwert ist die Standardbranch für das Repository.

includeContent: boolean

Legen Sie diesen Wert auf true fest, um Elementinhalte beim Anfordern von JSON einzuschließen. Der Standardwert ist "false".

resolveHfs: boolean

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

sanitize: boolean

Legen Sie auf true fest, um eine svg-Datei zu bereinigen und als Bild zurückzugeben. Nur nützlich, wenn für die 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 Rekursionsstufe dieser Anforderung. Der Standardwert ist "none", keine Rekursion.

includeContentMetadata: boolean

Legen Sie diesen Wert auf true fest, um Inhaltsmetadaten einzuschließen. Der Standardwert ist "false".

latestProcessedChange: boolean

Legen Sie diese Einstellung auf true fest, um die neuesten Änderungen einzuschließen. Der Standardwert ist "false".

download: boolean

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

versionDescriptor: GitVersionDescriptor

Versionsdeskriptor. Der Standardwert ist die Standardbranch für das Repository.

includeContent: boolean

Legen Sie diesen Wert auf true fest, um Elementinhalte beim Anfordern von JSON einzuschließen. Der Standardwert ist "false".

resolveHfs: boolean

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

sanitize: boolean

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

Gibt zurück

Promise<ArrayBuffer>

getImportRequest(string, string, number)

Rufen Sie eine bestimmte Importanforderung ab.

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 Rekursionsstufe dieser Anforderung. Der Standardwert ist "none", keine Rekursion.

includeContentMetadata: boolean

Legen Sie diesen Wert auf true fest, um Inhaltsmetadaten einzuschließen. Der Standardwert ist "false".

latestProcessedChange: boolean

Legen Sie diese Einstellung auf true fest, um die neuesten Änderungen einzuschließen. Der Standardwert ist "false".

download: boolean

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

versionDescriptor: GitVersionDescriptor

Versionsdeskriptor. Der Standardwert ist die Standardbranch für das Repository.

includeContent: boolean

Legen Sie diesen Wert auf true fest, um Elementinhalte beim Anfordern von JSON einzuschließen. Der Standardwert ist "false".

resolveLfs: boolean

Legen Sie diesen 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 auf true fest, um eine svg-Datei zu bereinigen und als Bild zurückzugeben. Nur nützlich, wenn für die 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 Rekursionsstufe dieser Anforderung. Der Standardwert ist "none", keine Rekursion.

includeContentMetadata: boolean

Legen Sie diesen Wert auf true fest, um Inhaltsmetadaten einzuschließen. Der Standardwert ist "false".

latestProcessedChange: boolean

Legen Sie diese Einstellung auf true fest, um die neuesten Änderungen einzuschließen. Der Standardwert ist "false".

download: boolean

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

versionDescriptor: GitVersionDescriptor

Versionsdeskriptor. Der Standardwert ist die Standardbranch für das Repository.

includeContent: boolean

Legen Sie diesen Wert auf true fest, um Elementinhalte beim Anfordern von JSON einzuschließen. Der Standardwert ist "false".

resolveLfs: boolean

Legen Sie diesen 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 auf true fest, um eine svg-Datei zu bereinigen und als Bild zurückzugeben. Nur nützlich, wenn für die svg-Datei angefordert wird. Der Standardwert ist "false".

Gibt zurück

Promise<ArrayBuffer>

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

Abrufen von Elementmetadaten und/oder Inhalten für eine Auflistung von Elementen. Der download-Parameter gibt an, ob der Inhalt als Download verfügbar oder einfach als Stream in der Antwort gesendet werden soll. Gilt nicht für gezippten Inhalt, der immer als Download zurückgegeben wird.

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 Rekursionsstufe dieser Anforderung. Der Standardwert ist "none", keine Rekursion.

includeContentMetadata: boolean

Legen Sie diesen Wert auf true fest, um Inhaltsmetadaten einzuschließen. Der Standardwert ist "false".

latestProcessedChange: boolean

Legen Sie diese Einstellung auf true fest, um die neuesten Änderungen einzuschließen. Der Standardwert ist "false".

download: boolean

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

includeLinks: boolean

Legen Sie diese Einstellung auf true fest, um Links zu Elementen einzuschließen. Der Standardwert ist "false".

versionDescriptor: GitVersionDescriptor

Versionsdeskriptor. Der Standardwert ist die Standardbranch für das Repository.

zipForUnix: boolean

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

Gibt zurück

Promise<GitItem[]>

getItemsBatch(GitItemRequestData, string, string)

Beitrag zum Abrufen eines Batches aus einer Gruppe von Elementen in einem Repository/Projekt unter Angabe einer Liste von Pfaden oder eines langen Pfads

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

Parameter

requestData: GitItemRequestData

Anforderungsdatenattribute: ItemDescriptors, IncludeContentMetadata, LatestProcessedChange, IncludeLinks. ItemDescriptors: Sammlung der abzurufenden Elemente, einschließlich Pfad, Version 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 committen. 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 Rekursionsstufe dieser Anforderung. Der Standardwert ist "none", keine Rekursion.

includeContentMetadata: boolean

Legen Sie diesen Wert auf true fest, um Inhaltsmetadaten einzuschließen. Der Standardwert ist "false".

latestProcessedChange: boolean

Legen Sie diese Einstellung auf true fest, um die neuesten Änderungen einzuschließen. Der Standardwert ist "false".

download: boolean

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

versionDescriptor: GitVersionDescriptor

Versionsdeskriptor. Der Standardwert ist die Standardbranch für das Repository.

includeContent: boolean

Legen Sie diesen Wert auf true fest, um Elementinhalte beim Anfordern von JSON einzuschließen. Der Standardwert ist "false".

resolveLfs: boolean

Legen Sie diesen 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 auf true fest, um eine svg-Datei zu bereinigen und als Bild zurückzugeben. Nur nützlich, wenn für die 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 Rekursionsstufe dieser Anforderung. Der Standardwert ist "none", keine Rekursion.

includeContentMetadata: boolean

Legen Sie diesen Wert auf true fest, um Inhaltsmetadaten einzuschließen. Der Standardwert ist "false".

latestProcessedChange: boolean

Legen Sie diese Einstellung auf true fest, um die neuesten Änderungen einzuschließen. Der Standardwert ist "false".

download: boolean

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

versionDescriptor: GitVersionDescriptor

Versionsdeskriptor. Der Standardwert ist die Standardbranch für das Repository.

includeContent: boolean

Legen Sie diesen Wert auf true fest, um Elementinhalte beim Anfordern von JSON einzuschließen. Der Standardwert ist "false".

resolveLfs: boolean

Legen Sie diesen 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 auf true fest, um eine svg-Datei zu bereinigen und als Bild zurückzugeben. Nur nützlich, wenn für die svg-Datei angefordert wird. Der Standardwert ist "false".

Gibt zurück

Promise<ArrayBuffer>

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

Erhalten Sie "Gefällt mir" 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 Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

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 Mergebasen von zwei Commits, optional über Forks hinweg. Wenn otherRepositoryId nicht angegeben ist, werden die Mergebasen nur im Kontext des 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

Erster Commit, in der Regel die Spitze des Zielbranchs des potenziellen Merges.

otherCommitId: string

Anderer Commit, in der Regel die Spitze des Quellbranchs des potenziellen Merges.

project: string

Projekt-ID oder Projektname

otherCollectionId: string

Die Sammlungs-ID, in der sich otherCommitId befindet.

otherRepositoryId: string

Die Repository-ID, in der sich otherCommitId befindet.

Gibt zurück

Promise<GitCommitRef[]>

getMergeRequest(string, string, number, boolean)

Rufen Sie die Details eines bestimmten Mergevorgangs 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 Mergeanforderung.

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

Der Repositorybenutzer versucht, auf

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)

Rufen Sie einen Pull Request ab.

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 Zielbranchs des Pull Requests.

pullRequestId: number

Die ID des abzurufenden Pull Requests.

project: string

Projekt-ID oder Projektname

maxCommentLength: number

Nicht verwendet.

skip: number

Nicht verwendet.

top: number

Nicht verwendet.

includeCommits: boolean

Wenn true, wird der Pull Request mit den zugeordneten Commits zurückgegeben.

includeWorkItemRefs: boolean

Wenn true, wird der Pull Request mit den zugeordneten Arbeitselementverweisen zurückgegeben.

Gibt zurück

Promise<GitPullRequest>

getPullRequestById(number, string)

Rufen Sie einen Pull Request ab.

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

Parameter

pullRequestId: number

Die ID des abzurufenden Pull Requests.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitPullRequest>

getPullRequestCommits(string, number, string)

Rufen Sie die Commits für den angegebenen Pull Request ab.

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

Parameter

repositoryId: string

ID oder Name des Repositorys.

pullRequestId: number

ID des Pull Requests.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<PagedList<GitCommitRef>>

getPullRequestConflict(string, number, number, string)

Abrufen eines Konflikts für einen Pull Request 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 einen Pull Request

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 des Pull Request.

pullRequestId: number

Die Pull Request-ID.

project: string

Projekt-ID oder Projektname

skip: number

Zu überspringende Konflikte.

top: number

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

includeObsolete: boolean

Schließt veraltete Konflikte ein.

excludeResolved: boolean

Schließt bereits gelöste Konflikte aus.

onlyResolved: boolean

Gibt nur die Konflikte zurück, die gelöst wurden.

Gibt zurück

Promise<GitConflict[]>

getPullRequestIteration(string, number, number, string)

Ruft die angegebene Iteration für einen Pull Request ab.

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

Parameter

repositoryId: string

ID oder Name des Repositorys.

pullRequestId: number

ID des Pull Requests.

iterationId: number

ID der zurückzugebenden Pull Request-Iteration.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitPullRequestIteration>

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

Rufen Sie die Änderungen ab, die in einem Pull Request zwischen zwei Iterationen vorgenommen wurden.

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 Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

iterationId: number

ID der Pull Request-Iteration. <br/> Iteration 1 ist der Kopf des Quellbranchs, wenn der Pull Request erstellt wird, und nachfolgende Iterationen werden erstellt, wenn Pushvorgänge an den Quellbranch erfolgen. Zulässige Werte liegen zwischen 1 und der maximalen Iteration für diesen Pull Request.

project: string

Projekt-ID oder Projektname

top: number

Optional. Die Anzahl der abzurufenden Änderungen. Der Standardwert ist 100, und der Höchstwert ist 2000.

skip: number

Optional. Die Anzahl der zu ignorierenden Änderungen. Um beispielsweise die Änderungen 101-150 abzurufen, legen Sie top 50 fest, und fahren Sie auf 100 fort.

compareTo: number

ID der Pull Request-Iteration, mit der verglichen werden soll. Der Standardwert ist 0(0), der angibt, dass der Vergleich mit dem gemeinsamen Commit zwischen den Quell- und Zielbranchen durchgeführt wird.

Gibt zurück

Promise<GitPullRequestIterationChanges>

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

Ruft die Commits für die angegebene Iteration eines Pull Requests 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 des Pull Requests.

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)

Rufen Sie die Liste der Iterationen für den angegebenen Pull Request ab.

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

Parameter

repositoryId: string

ID oder Name des Repositorys.

pullRequestId: number

ID des Pull Requests.

project: string

Projekt-ID oder Projektname

includeCommits: boolean

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

Gibt zurück

Promise<GitPullRequestIteration[]>

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

Rufen Sie die spezifische Pull Request-Iteration status nach ID ab. Die status-ID ist innerhalb des Pull Requests über alle Iterationen hinweg eindeutig.

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

Parameter

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

iterationId: number

ID der Pull Request-Iteration.

statusId: number

ID des Pull Request-status.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitPullRequestStatus>

getPullRequestIterationStatuses(string, number, number, string)

Ruft alle Status ab, die einer Pull Request-Iteration zugeordnet sind.

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

Parameter

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

iterationId: number

ID der Pull Request-Iteration.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitPullRequestStatus[]>

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

Ruft eine einzelne Bezeichnung (Tag) ab, die einem Pull Request zugewiesen wurde.

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

Parameter

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

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)

Ruft alle Bezeichnungen (Tags) ab, die einem Pull Request zugewiesen sind.

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

Parameter

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

project: string

Projekt-ID oder Projektname

projectId: string

Projekt-ID oder Projektname.

Gibt zurück

Promise<WebApiTagDefinition[]>

getPullRequestProperties(string, number, string)

Ruft externe Eigenschaften des Pull Requests ab.

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

Parameter

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<any>

getPullRequestQuery(GitPullRequestQuery, string, string)

Diese API wird verwendet, um zu ermitteln, welche Pull Requests im Zusammenhang mit einem bestimmten Commit stehen. Es kann verwendet werden, um entweder den Pull Request zu finden, der einen bestimmten Mergecommit erstellt hat, oder es kann verwendet werden, um alle Pull Requests 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, für den Sie suchen, erhalten Sie ein Verzeichnis mit Commit –> Pull Requests.

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 Prüfer in einem Pull Request

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

Parameter

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

reviewerId: string

ID des Prüfers.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<IdentityRefWithVote>

getPullRequestReviewers(string, number, string)

Abrufen der Prüfer für einen Pull Request

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

Parameter

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<IdentityRefWithVote[]>

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

Ruft alle Pull Requests 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 Zielbranchs des Pull Requests.

searchCriteria: GitPullRequestSearchCriteria

Pull Requests 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 Pull Requests. Wenn Sie z. B. die Ergebnisse 101-150 abrufen möchten, legen Sie oben auf 50 fest, und fahren Sie auf 100 fort.

top: number

Die Anzahl der abzurufenden Pull Requests.

Gibt zurück

Promise<GitPullRequest[]>

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

Ruft alle Pull Requests 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

Pull Requests werden zurückgegeben, die diesen Suchkriterien entsprechen.

maxCommentLength: number

Wird nicht verwendet.

skip: number

Die Anzahl der zu ignorierenden Pull Requests. Wenn Sie z. B. die Ergebnisse 101-150 abrufen möchten, legen Sie oben auf 50 fest, und fahren Sie auf 100 fort.

top: number

Die Anzahl der abzurufenden Pull Requests.

Gibt zurück

Promise<GitPullRequest[]>

getPullRequestStatus(string, number, number, string)

Rufen Sie die spezifischen Pull Request-status nach ID ab. Die status-ID ist innerhalb des Pull Requests über alle Iterationen hinweg eindeutig.

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

Parameter

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

statusId: number

ID des Pull Request-status.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitPullRequestStatus>

getPullRequestStatuses(string, number, string)

Ruft alle Status ab, die einem Pull Request zugeordnet sind.

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

Parameter

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitPullRequestStatus[]>

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

Abrufen eines Threads in einem Pull Request.

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

Parameter

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

threadId: number

ID des Threads.

project: string

Projekt-ID oder Projektname

iteration: number

Falls angegeben, wird die Threadposition mithilfe dieser Iteration auf der rechten Seite des diff nachverfolgt.

baseIteration: number

Falls angegeben, wird die Threadposition mithilfe dieser Iteration auf der linken Seite des diff nachverfolgt.

Gibt zurück

Promise<GitPullRequestCommentThread>

getPullRequestWorkItemRefs(string, number, string)

Ruft eine Liste der Arbeitselemente ab, die einem Pull Request zugeordnet sind.

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

Parameter

repositoryId: string

ID oder Name des Repositorys.

pullRequestId: number

ID des Pull Requests.

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 durch den Push aktualisiert wurden.

Gibt zurück

Promise<GitPush>

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

Rufen Sie eine Liste von Commits ab, 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 auch projectId 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 ("Get the top x commits").

skip: number

Die Anzahl der zu überspringenden Commits.

includeLinks: boolean

Legen Sie auf false fest, um das Einschließen von REST-URL-Links für Ressourcen zu vermeiden. Der Standardwert ist TRUE.

Gibt zurück

Promise<GitCommitRef[]>

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

Ruft Pushvorgänge 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 zu überspringenden Pushvorgänge.

top: number

Anzahl der zurückzugebenden Pushvorgänge.

searchCriteria: GitPushSearchCriteria

Search Kriterienattribute: fromDate, toDate, pusherId, refName, includeRefUpdates oder includeLinks. fromDate: Startdatum für die Suche. toDate: Enddatum, nach dem gesucht werden soll. pusherId: Identität der Person, die den Push übermittelt hat. refName: Zu berücksichtigender Branchname. includeRefUpdates: Wenn true, schließen Sie die Liste der Refs ein, die durch den Push aktualisiert wurden. includeLinks: Gibt an, ob das feld _links in die flachen Verweise eingeschlossen werden soll.

Gibt zurück

Promise<GitPush[]>

getRecycleBinRepositories(string)

Rufen Sie vorläufig gelöschte Git-Repositorys aus dem Papierkorb ab.

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

Parameter

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitDeletedRepository[]>

getRefFavorite(string, number)

Ruft den Refs-Favoriten 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 Ref-Favoriten.

Gibt zurück

Promise<GitRefFavorite>

getRefFavorites(string, string, string)

Ruft die Refs-Favoriten 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. Bei 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 nach seinen 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 im Ergebnis enthalten sein soll. default ist false.

includeStatuses: boolean

[optional] Enthält bis zu den ersten 1000 Commitstatus für jede Ref. Der Standardwert ist false.

includeMyBranches: boolean

[optional] Enthält nur Branches, die der Benutzer besitzt, die Branches der Benutzerfavoriten und die Standardbranch. Der Standardwert ist „FALSE“. Kann nicht mit dem Filterparameter kombiniert werden.

latestStatusesOnly: boolean

[optional] True, um nur den Tip-Commit status für jede Ref einzuschließen. Diese Option muss includeStatuses wahr sein. Der Standardwert ist „FALSE“.

peelTags: boolean

[optional] Mit Anmerkungen versehene Tags füllen die PeeledObjectId-Eigenschaft auf. default ist false.

filterContains: string

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

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

getRepository(string, string)

Rufen Sie ein Git-Repository ab.

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)

Rufen Sie ein Git-Repository ab.

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 Aufrufen verfügbar.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitRepository>

getRevert(string, number, string)

Rufen Sie Informationen zu einem rückgängig machen Vorgang mit rückgängig machen ID ab.

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

Parameter

project: string

Projekt-ID oder Projektname

revertId: number

ID des rückgängig machen Vorgangs.

repositoryId: string

ID des Repositorys.

Gibt zurück

Promise<GitRevert>

getRevertConflict(string, number, number, string)

Abrufen eines Konflikts für einen rückgängig machen 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 rückgängig machen

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)

Ruft Informationen zu einem rückgängig machen Vorgang für einen bestimmten Branch ab.

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

Parameter

project: string

Projekt-ID oder Projektname

repositoryId: string

ID des Repositorys.

refName: string

Der generierte GitAsyncRefOperationParametersRefName, der für den rückgängig machen-Vorgang verwendet wird.

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

Optional. Die Anzahl der abzurufenden Status. Der Standard ist 1000.

skip: number

Optional. Die Anzahl der zu ignorierenden Status. Standard ist "0". Um beispielsweise die Ergebnisse 101-150 abzurufen, legen Sie oben auf 50 fest, und fahren Sie mit 100 fort.

latestOnly: boolean

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

Gibt zurück

Promise<GitStatus[]>

getSuggestions(string, string, boolean)

Rufen Sie einen Pull Request-Vorschlag 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 den Vergleichsbranch dem Standardbranch als Zielbranch für Pull Requests.

Gibt zurück

Promise<GitSuggestion[]>

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

Ruft alle Threads in einem Pull Request ab.

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

Parameter

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

project: string

Projekt-ID oder Projektname

iteration: number

Falls angegeben, werden Threadpositionen mithilfe dieser Iteration als rechte Seite des diff nachverfolgt.

baseIteration: number

Falls angegeben, werden Threadpositionen mithilfe dieser Iteration auf der linken Seite des diff nachverfolgt.

Gibt zurück

Promise<GitPullRequestCommentThread[]>

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

Der Tree-Endpunkt gibt die Auflistung von Objekten unter der angegebenen Struktur zurück. Strukturen 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

Search rekursiv. Fügen Sie Bäume unter dieser Struktur ein. Der Standardwert ist "false".

fileName: string

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

Gibt zurück

Promise<GitTreeRef>

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

Der Tree-Endpunkt gibt die Auflistung von Objekten unter der angegebenen Struktur zurück. Strukturen 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

Search rekursiv. Fügen Sie Bäume unter dieser Struktur ein. Der Standardwert ist "false".

fileName: string

Name, der verwendet werden soll, wenn eine .zip-Datei zurückgegeben wird. Standard 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)

Stellen Sie ein vorläufig gelöschtes Git-Repository wieder her. Kürzlich gelöschte Repositorys werden für einen bestimmten Zeitraum in einen vorläufigen Löschzustand versetzt, bevor sie hart 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 einen bestimmten Pull Request 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 des Pull Requests.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<void>

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

Aktualisieren der Mergekonfliktlösung

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 Mergekonfliktauflö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 Sie einen Kommentar, der einem bestimmten Thread in einem Pull Request 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 lang sein.

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

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 Enablement status 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 fehlerhaften 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 Warteschlangen oder Verlassen.

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 eines Pull Requests

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

Parameter

gitPullRequestToUpdate: GitPullRequest

Der Pull Request-Inhalt, der aktualisiert werden soll.

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des zu aktualisierenden Pull Request.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitPullRequest>

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

Aktualisieren der Mergekonfliktlösung

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 Mergekonfliktauflö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 von Iterationsstatus für Pull Request. 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 den Pull Request-Status im JSON-Patchformat angewendet werden sollen.

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

iterationId: number

ID der Pull Request-Iteration.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<void>

updatePullRequestProperties(JsonPatchDocument, string, number, string)

Create oder aktualisieren Sie externe Pull Request-Eigenschaften. Der Patchvorgang kann oder replaceremoveseinadd. Für add den Vorgang kann der Pfad leer sein. Wenn der Pfad leer ist, muss der Wert eine Liste von Schlüsselwertpaaren sein. Für replace den Vorgang darf der Pfad nicht leer sein. Wenn der Pfad nicht vorhanden ist, wird die -Eigenschaft der Auflistung hinzugefügt. Für remove den Vorgang darf 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 Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<any>

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

Bearbeiten Sie einen Prüfereintrag. 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 Prüfers hier enthalten ist, muss sie mit dem ReviewerID-Parameter übereinstimmen.

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

reviewerId: string

ID des Prüfers.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<IdentityRefWithVote>

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

Setzen Sie die Stimmen mehrerer Prüfer für einen Pull Request zurück. HINWEIS: Dieser Endpunkt unterstützt nur das Aktualisieren von Stimmen, aber nicht das Aktualisieren erforderlicher 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 Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<void>

updatePullRequestStatuses(JsonPatchDocument, string, number, string)

Aktualisieren der Sammlung von Pull Request-Status. 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 Pull Request-Status im JSON-Patchformat angewendet werden sollen.

repositoryId: string

Die Repository-ID des Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

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

Die auszuführende Verweisaktualisierungsaktion (Sperren/Entsperren)

repositoryId: string

Der Name oder die ID des Repositorys.

filter: string

Der Name des Branchs, der gesperrt/entsperrt werden soll

project: string

Projekt-ID oder Projektname

projectId: string

ID oder Name des Teamprojekts. Optional, wenn eine ID für das Repository angegeben wird.

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 Ref-Updates, die durchgeführt werden sollen

repositoryId: string

Der Name oder die ID des Repositorys.

project: string

Projekt-ID oder Projektname

projectId: string

ID oder Name des Teamprojekts. Optional, wenn eine ID für das Repository angegeben wird.

Gibt zurück

Promise<GitRefUpdateResult[]>

updateRepository(GitRepository, string, string)

Updates das Git-Repository entweder mit einem neuen Repositorynamen oder einem neuen Standardbranch.

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

Parameter

newRepositoryInfo: GitRepository

Geben Sie einen neuen Repositorynamen oder einen neuen Standardbranch des Repositorys an.

repositoryId: string

Die ID des Repositorys.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitRepository>

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

Aktualisieren der Lösung von Mergekonflikten

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 Mergekonfliktauflö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 sie einen Thread in einem Pull Request.

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 Zielbranchs des Pull Requests.

pullRequestId: number

ID des Pull Requests.

threadId: number

ID des zu aktualisierenden Threads.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<GitPullRequestCommentThread>

Share via

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