GitRestClient class

Odwołanie

Pakiet:: azure-devops-extension-api

Klasa bazowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS

Rozszerzenie: RestClientBase

Konstruktory

GitRestClient(IVssRestClientOptions)

Właściwości

RESOURCE_AREA_ID

Metody

createAnnotatedTag(GitAnnotatedTag, string, string)	Utwórz tag z adnotacjami.
createAttachment(any, string, string, number, string)	Dołącz nowy plik do żądania ściągnięcia.
createCherryPick(GitAsyncRefOperationParameters, string, string)	Cherry wybierz określone zatwierdzenie lub zatwierdzenia, które są skojarzone z żądaniem ściągnięcia do nowej gałęzi.
createComment(Comment, string, number, number, string)	Utwórz komentarz do określonego wątku w żądaniu ściągnięcia (można utworzyć maksymalnie 500 komentarzy na wątek).
createCommitStatus(GitStatus, string, string, string)	Utwórz stan zatwierdzenia usługi Git.
createFavorite(GitRefFavorite, string)	Tworzy ulubiony element ref
createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)	Zażądaj pobrania do tego odwołania innego repozytorium. Synchronizuje dwa istniejące rozwidlenia. Aby utworzyć rozwidlenie, zobacz <href="https://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1" Punkt końcowy repozytoriów></a>
createImportRequest(GitImportRequest, string, string)	Utwórz żądanie importu.
createLike(string, number, number, number, string)	Dodaj polubić komentarz.
createMergeRequest(GitMergeParameters, string, string, boolean)	Zażądaj operacji scalania git. Obecnie obsługujemy scalanie tylko 2 zatwierdzeń.
createPullRequest(GitPullRequest, string, string, boolean)	Utwórz żądanie ściągnięcia.
createPullRequestIterationStatus(GitPullRequestStatus, string, number, number, string)	Utwórz stan żądania ściągnięcia w iteracji. Ta operacja będzie mieć taki sam wynik jak tworzenie stanu żądania ściągnięcia z określonym identyfikatorem iteracji w treści żądania.
createPullRequestLabel(WebApiCreateTagRequestData, string, number, string, string)	Utwórz tag (jeśli jeszcze nie istnieje) i dodaj go jako etykietę (tag) dla określonego żądania ściągnięcia. Jedynym wymaganym polem jest nazwa nowej etykiety (tagu).
createPullRequestReviewer(IdentityRefWithVote, string, number, string, string)	Dodaj recenzenta do żądania ściągnięcia lub oddaj głos.
createPullRequestReviewers(IdentityRef[], string, number, string)	Dodaj recenzentów do żądania ściągnięcia.
createPullRequestStatus(GitPullRequestStatus, string, number, string)	Utwórz stan żądania ściągnięcia.
createPush(GitPush, string, string)	Wypychanie zmian do repozytorium.
createRepository(GitRepositoryCreateOptions, string, string)	Utwórz repozytorium git w projekcie zespołowym.
createRevert(GitAsyncRefOperationParameters, string, string)	Uruchamia operację, aby utworzyć nową gałąź, która przywraca zmiany wprowadzone przez określone zatwierdzenie lub zatwierdzenia skojarzone z żądaniem ściągnięcia.
createThread(GitPullRequestCommentThread, string, number, string)	Utwórz wątek w żądaniu ściągnięcia.
createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)	Dodaj niematerializowaną tożsamość do recenzentów żądania ściągnięcia.
deleteAttachment(string, string, number, string)	Usuń załącznik żądania ściągnięcia.
deleteComment(string, number, number, number, string)	Usuń komentarz skojarzony z określonym wątkiem w żądaniu ściągnięcia.
deleteEnablementStatus(boolean, boolean, string[])	DELETE usuwa stan włączania i rozliczaneSkładniki danych z bazy danych. Usunięcie danych włączania spowoduje efektywne wyłączenie ich dla repozytoriów, których dotyczy problem.
deleteLike(string, number, number, number, string)	Usuń obiekt podobny do komentarza.
deletePullRequestIterationStatus(string, number, number, number, string)	Usuń stan iteracji żądania ściągnięcia.
deletePullRequestLabels(string, number, string, string, string)	Usuwa etykietę (tag) z zestawu przypisanych do żądania ściągnięcia. Sam tag nie zostanie usunięty.
deletePullRequestReviewer(string, number, string, string)	Usuń recenzenta z żądania ściągnięcia.
deletePullRequestStatus(string, number, number, string)	Usuń stan żądania ściągnięcia.
deleteRefFavorite(string, number)	Usuwa określone ulubione odwołania
deleteRepository(string, string)	Usuwanie repozytorium git
deleteRepositoryFromRecycleBin(string, string)	Zniszczenie (usuwanie twarde) nietrwałego repozytorium Git.
getAnnotatedTag(string, string, string)	Pobierz tag z adnotacjami.
getAttachmentContent(string, string, number, string)	Pobierz zawartość pliku załącznika żądania ściągnięcia.
getAttachments(string, number, string)	Pobierz listę plików dołączonych do danego żądania ściągnięcia.
getAttachmentZip(string, string, number, string)	Pobierz zawartość pliku załącznika żądania ściągnięcia.
getBillableCommitters(string, Date, number, number)	Pobierz rzeczywiste rozliczane osoby zatwierdzane dla usługi Advanced Security dla danej daty.
getBillableCommittersDetail(string, string, Date)	Pobierz szczegółowe rozliczane osoby zatwierdzane dla usługi Advanced Security dla danej daty. Szczegółowe wyniki celowo nie filtrują nietrwałych usuniętych projektów i repozytoriów, aby ułatwić diagnozowanie problemów z rozliczeniami.
getBlob(string, string, string, boolean, string, boolean)	Pobierz pojedynczy obiekt blob.
getBlobContent(string, string, string, boolean, string, boolean)	Pobierz pojedynczy obiekt blob.
getBlobsZip(string[], string, string, string)	Pobiera co najmniej jeden obiekt blob w pliku zip.
getBlobZip(string, string, string, boolean, string, boolean)	Pobierz pojedynczy obiekt blob.
getBranch(string, string, string, GitVersionDescriptor)	Pobieranie statystyk dotyczących pojedynczej gałęzi.
getBranches(string, string, GitVersionDescriptor)	Pobieranie statystyk dotyczących wszystkich gałęzi w repozytorium.
getBranchStatsBatch(GitQueryBranchStatsCriteria, string, string)	Pobieranie statystyk dla wielu zatwierdzeń
getChanges(string, string, string, number, number)	Pobieranie zmian dla określonego zatwierdzenia.
getCherryPick(string, number, string)	Pobierz informacje o operacji wyboru wiśni według identyfikatora wyboru wiśni.
getCherryPickConflict(string, number, number, string)	Pobieranie jednego konfliktu dla wyboru wiśni według identyfikatora
getCherryPickConflicts(string, number, string, string, number, boolean, boolean, boolean)	Pobieranie wszystkich konfliktów dla wyboru wiśni
getCherryPickForRefName(string, string, string)	Pobierz informacje o operacji wybierania wiśni dla określonej gałęzi. Ta operacja jest kosztowna ze względu na podstawową strukturę obiektów, więc ten interfejs API analizuje tylko 1000 najnowszych operacji wyboru wiśni.
getCherryPickRelationships(string, string, string, boolean)	Biorąc pod uwagę identyfikator commitId, zwraca listę zatwierdzeń, które znajdują się w tej samej rodzinie cherry-pick.
getComment(string, number, number, number, string)	Pobieranie komentarza skojarzonego z określonym wątkiem w żądaniu ściągnięcia.
getComments(string, number, number, string)	Pobierz wszystkie komentarze skojarzone z określonym wątkiem w żądaniu ściągnięcia.
getCommit(string, string, string, number)	Pobieranie określonego zatwierdzenia.
getCommitDiffs(string, string, boolean, number, number, GitBaseVersionDescriptor, GitTargetVersionDescriptor)	Znajdź najbliższe wspólne zatwierdzenie (bazę scalania) między zatwierdzeniami podstawowymi i docelowymi, a następnie uzyskaj różnicę między zatwierdzeniami podstawowymi i docelowymi albo wspólnymi i docelowymi zatwierdzeniami.
getCommits(string, GitQueryCommitsCriteria, string)	Pobieranie zatwierdzeń git dla projektu
getCommitsBatch(GitQueryCommitsCriteria, string, string, number, number, boolean)	Pobieranie zatwierdzeń git dla projektu spełniającego kryteria wyszukiwania
getDeletedRepositories(string)	Pobieranie usuniętych repozytoriów git.
getEnablementStatus(string[], Date, number, number)	Stan włączania GET dla repozytoriów projektu.
getEnableOnCreateHost(boolean)
getEnableOnCreateProject(string)
getEstimatedBillableCommittersRepo(string, string)	Uzyskaj szacowane rozliczane osoby zatwierdzane dla repozytorium z ostatnich 90 dni.
getEstimatedBillablePushersOrg()	Uzyskaj szacowane rozliczane wypychacze dla organizacji w ciągu ostatnich 90 dni.
getEstimatedBillablePushersProject(string)	Uzyskaj szacowane rozliczane wypychacze dla projektu z ostatnich 90 dni.
getFileDiffs(FileDiffsCriteria, string, string)	Pobieranie różnic między plikami dla każdego z określonych plików
getForks(string, string, string, boolean)	Pobierz wszystkie rozwidlenia repozytorium w kolekcji.
getForkSyncRequest(string, number, string, boolean)	Pobierz szczegóły konkretnej operacji synchronizacji rozwidlenia.
getForkSyncRequests(string, string, boolean, boolean)	Pobierz wszystkie żądane operacje synchronizacji rozwidlenia w tym repozytorium.
getHfsItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Pobierz metadane elementu i/lub zawartość dla pojedynczego elementu. Parametr pobierania wskazuje, czy zawartość powinna być dostępna jako pobieranie, czy po prostu wysłana jako strumień w odpowiedzi. Nie ma zastosowania do spakowanej zawartości, która jest zawsze zwracana jako pobieranie.
getHfsItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Pobierz metadane elementu i/lub zawartość dla pojedynczego elementu. Parametr pobierania wskazuje, czy zawartość powinna być dostępna jako pobieranie, czy po prostu wysłana jako strumień w odpowiedzi. Nie ma zastosowania do spakowanej zawartości, która jest zawsze zwracana jako pobieranie.
getHfsItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)	Pobierz metadane elementu i/lub zawartość dla kolekcji elementów. Parametr pobierania wskazuje, czy zawartość powinna być dostępna jako pobieranie, czy po prostu wysłana jako strumień w odpowiedzi. Nie ma zastosowania do spakowanej zawartości, która jest zawsze zwracana jako pobieranie.
getHfsItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Pobierz metadane elementu i/lub zawartość dla pojedynczego elementu. Parametr pobierania wskazuje, czy zawartość powinna być dostępna jako pobieranie, czy po prostu wysłana jako strumień w odpowiedzi. Nie ma zastosowania do spakowanej zawartości, która jest zawsze zwracana jako pobieranie.
getHfsItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Pobierz metadane elementu i/lub zawartość dla pojedynczego elementu. Parametr pobierania wskazuje, czy zawartość powinna być dostępna jako pobieranie, czy po prostu wysłana jako strumień w odpowiedzi. Nie ma zastosowania do spakowanej zawartości, która jest zawsze zwracana jako pobieranie.
getImportRequest(string, string, number)	Pobieranie określonego żądania importu.
getItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Pobierz metadane elementu i/lub zawartość dla pojedynczego elementu. Parametr pobierania wskazuje, czy zawartość powinna być dostępna jako pobieranie, czy po prostu wysłana jako strumień w odpowiedzi. Nie ma zastosowania do spakowanej zawartości, która jest zawsze zwracana jako pobieranie.
getItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Pobierz metadane elementu i/lub zawartość dla pojedynczego elementu. Parametr pobierania wskazuje, czy zawartość powinna być dostępna jako pobieranie, czy po prostu wysłana jako strumień w odpowiedzi. Nie ma zastosowania do spakowanej zawartości, która jest zawsze zwracana jako pobieranie.
getItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)	Pobierz metadane elementu i/lub zawartość dla kolekcji elementów. Parametr pobierania wskazuje, czy zawartość powinna być dostępna jako pobieranie, czy po prostu wysłana jako strumień w odpowiedzi. Nie ma zastosowania do spakowanej zawartości, która jest zawsze zwracana jako pobieranie.
getItemsBatch(GitItemRequestData, string, string)	Opublikuj na potrzeby pobierania partii z zestawu elementów w repozytorium/projekcie, biorąc pod uwagę listę ścieżek lub długą ścieżkę
getItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Pobierz metadane elementu i/lub zawartość dla pojedynczego elementu. Parametr pobierania wskazuje, czy zawartość powinna być dostępna jako pobieranie, czy po prostu wysłana jako strumień w odpowiedzi. Nie ma zastosowania do spakowanej zawartości, która jest zawsze zwracana jako pobieranie.
getItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Pobierz metadane elementu i/lub zawartość dla pojedynczego elementu. Parametr pobierania wskazuje, czy zawartość powinna być dostępna jako pobieranie, czy po prostu wysłana jako strumień w odpowiedzi. Nie ma zastosowania do spakowanej zawartości, która jest zawsze zwracana jako pobieranie.
getLikes(string, number, number, number, string)	Pobierz polubień dla komentarza.
getMergeBases(string, string, string, string, string, string)	Znajdź podstawy scalania dwóch zatwierdzeń, opcjonalnie w rozwidleniu. Jeśli nie określono parametru otherRepositoryId, bazy scalania będą obliczane tylko w kontekście lokalnego identyfikatora repositoryNameOrId.
getMergeRequest(string, string, number, boolean)	Pobierz szczegóły konkretnej operacji scalania.
getPermission(string, string, string)	UZYSKAJ stan uprawnień zabezpieczeń zaawansowanych.
getPullRequest(string, number, string, number, number, number, boolean, boolean)	Pobieranie żądania ściągnięcia.
getPullRequestById(number, string)	Pobieranie żądania ściągnięcia.
getPullRequestCommits(string, number, string)	Pobierz zatwierdzenia dla określonego żądania ściągnięcia.
getPullRequestConflict(string, number, number, string)	Pobieranie jednego konfliktu dla żądania ściągnięcia według identyfikatora
getPullRequestConflicts(string, number, string, number, number, boolean, boolean, boolean)	Pobieranie wszystkich konfliktów dla żądania ściągnięcia
getPullRequestIteration(string, number, number, string)	Pobierz określoną iterację dla żądania ściągnięcia.
getPullRequestIterationChanges(string, number, number, string, number, number, number)	Pobierz zmiany wprowadzone w żądaniu ściągnięcia między dwiema iteracjami.
getPullRequestIterationCommits(string, number, number, string, number, number)	Pobierz zatwierdzenia dla określonej iteracji żądania ściągnięcia.
getPullRequestIterations(string, number, string, boolean)	Pobierz listę iteracji dla określonego żądania ściągnięcia.
getPullRequestIterationStatus(string, number, number, number, string)	Uzyskaj określony stan iteracji żądania ściągnięcia według identyfikatora. Identyfikator stanu jest unikatowy w ramach żądania ściągnięcia we wszystkich iteracji.
getPullRequestIterationStatuses(string, number, number, string)	Pobierz wszystkie stany skojarzone z iteracją żądania ściągnięcia.
getPullRequestLabel(string, number, string, string, string)	Pobiera pojedynczą etykietę (tag), która została przypisana do żądania ściągnięcia.
getPullRequestLabels(string, number, string, string)	Pobierz wszystkie etykiety (tagi) przypisane do żądania ściągnięcia.
getPullRequestProperties(string, number, string)	Pobierz właściwości zewnętrzne żądania ściągnięcia.
getPullRequestQuery(GitPullRequestQuery, string, string)	Ten interfejs API służy do znajdowania żądań ściągnięcia powiązanych z danym zatwierdzeniem. Może służyć do znajdowania żądania ściągnięcia, które utworzyło określone zatwierdzenie scalania, lub może służyć do znajdowania wszystkich żądań ściągnięcia, które kiedykolwiek scaliły określone zatwierdzenie. Dane wejściowe to lista zapytań, które zawierają listę zatwierdzeń. Dla każdego przeszukiwanego zatwierdzenia zostanie wyświetlony słownik zatwierdzeń —> żądania ściągnięcia.
getPullRequestReviewer(string, number, string, string)	Pobieranie informacji o konkretnym recenzentze w żądaniu ściągnięcia
getPullRequestReviewers(string, number, string)	Pobieranie recenzentów dla żądania ściągnięcia
getPullRequests(string, GitPullRequestSearchCriteria, string, number, number, number)	Pobierz wszystkie żądania ściągnięcia spełniające określone kryteria.
getPullRequestsByProject(string, GitPullRequestSearchCriteria, number, number, number)	Pobierz wszystkie żądania ściągnięcia spełniające określone kryteria.
getPullRequestStatus(string, number, number, string)	Uzyskaj określony stan żądania ściągnięcia według identyfikatora. Identyfikator stanu jest unikatowy w ramach żądania ściągnięcia we wszystkich iteracji.
getPullRequestStatuses(string, number, string)	Pobierz wszystkie stany skojarzone z żądaniem ściągnięcia.
getPullRequestThread(string, number, number, string, number, number)	Pobieranie wątku w żądaniu ściągnięcia.
getPullRequestWorkItemRefs(string, number, string)	Pobierz listę elementów roboczych skojarzonych z żądaniem ściągnięcia.
getPush(string, number, string, number, boolean)	Pobiera określone wypychanie.
getPushCommits(string, number, string, number, number, boolean)	Pobierz listę zatwierdzeń skojarzonych z określonym wypchnięciem.
getPushes(string, string, number, number, GitPushSearchCriteria)	Pobiera wypychania skojarzone z określonym repozytorium.
getRecycleBinRepositories(string)	Pobieranie nietrwałych repozytoriów git z kosza.
getRefFavorite(string, number)	Pobiera ulubione odwołania dla ulubionego identyfikatora.
getRefFavorites(string, string, string)	Pobiera ulubione odwołania dla repozytorium i tożsamości.
getRefFavoritesForProject(string, string)
getRefs(string, string, string, boolean, boolean, boolean, boolean, boolean, string)	Wysyła zapytanie do podanego repozytorium pod kątem jego refs i zwraca je.
getRepositories(string, boolean, boolean, boolean)	Pobieranie repozytoriów git.
getRepositoriesPaged(string, boolean, boolean, boolean, string, number, string)	Pobieranie repozytoriów git z filtrem według nazwy i stronicowania.
getRepository(string, string)	Pobieranie repozytorium git.
getRepositoryWithParent(string, boolean, string)	Pobieranie repozytorium git.
getRevert(string, number, string)	Pobierz informacje o operacji przywracania, przywracając identyfikator.
getRevertConflict(string, number, number, string)	Pobieranie jednego konfliktu dla przywracania według identyfikatora
getRevertConflicts(string, number, string, string, number, boolean, boolean, boolean)	Pobieranie wszystkich konfliktów dla przywracania
getRevertForRefName(string, string, string)	Pobierz informacje o operacji przywracania dla określonej gałęzi.
getStatuses(string, string, string, number, number, boolean)	Pobierz stany skojarzone z zatwierdzeniem usługi Git.
getSuggestions(string, string, boolean)	Pobierz sugestię żądania ściągnięcia dla określonego repozytorium lub projektu zespołowego.
getThreads(string, number, string, number, number)	Pobierz wszystkie wątki w żądaniu ściągnięcia.
getTree(string, string, string, string, boolean, string)	Punkt końcowy Drzewa zwraca kolekcję obiektów znajdujących się pod określonym drzewem. Drzewa to foldery w repozytorium Git.
getTreeZip(string, string, string, string, boolean, string)	Punkt końcowy Drzewa zwraca kolekcję obiektów znajdujących się pod określonym drzewem. Drzewa to foldery w repozytorium Git.
queryImportRequests(string, string, boolean)	Pobieranie żądań importu dla repozytorium.
restoreRepositoryFromRecycleBin(GitRecycleBinRepositoryDetails, string, string)	Odzyskiwanie nietrwałego repozytorium Git. Ostatnio usunięte repozytoria przechodzą w stan usuwania nietrwałego przez pewien czas, zanim zostaną one trwale usunięte i staną się nieodwracalne.
setEnableOnCreateHost(boolean)
setEnableOnCreateProject(string, boolean)
sharePullRequest(ShareNotificationContext, string, number, string)	Wysyła powiadomienie e-mail dotyczące określonego żądania ściągnięcia do zestawu adresatów
updateCherryPickConflict(GitConflict, string, number, number, string)	Aktualizowanie rozwiązywania konfliktów scalania
updateCherryPickConflicts(GitConflict[], string, number, string)	Aktualizowanie wielu rozwiązań konfliktów scalania
updateComment(Comment, string, number, number, number, string)	Zaktualizuj komentarz skojarzony z określonym wątkiem w żądaniu ściągnięcia.
updateEnablementStatus(AdvSecEnablementUpdate[])	Stan włączania POST dla repozytoriów.
updateImportRequest(GitImportRequest, string, string, number)	Ponów próbę lub porzucanie nieudanego żądania importu.
updatePullRequest(GitPullRequest, string, number, string)	Aktualizowanie żądania ściągnięcia
updatePullRequestConflict(GitConflict, string, number, number, string)	Aktualizowanie rozwiązywania konfliktów scalania
updatePullRequestConflicts(GitConflict[], string, number, string)	Aktualizowanie wielu rozwiązań konfliktów scalania
updatePullRequestIterationStatuses(JsonPatchDocument, string, number, number, string)	Aktualizowanie kolekcji stanów iteracji żądania ściągnięcia. Jedynym obsługiwanym typem operacji jest `remove`.
updatePullRequestProperties(JsonPatchDocument, string, number, string)	Tworzenie lub aktualizowanie właściwości zewnętrznych żądania ściągnięcia. Operację stosowania poprawek można `add`, `replace` lub `remove`. W przypadku operacji `add` ścieżka może być pusta. Jeśli ścieżka jest pusta, wartość musi być listą par klucz-wartość. W przypadku operacji `replace` ścieżka nie może być pusta. Jeśli ścieżka nie istnieje, właściwość zostanie dodana do kolekcji. W przypadku operacji `remove` ścieżka nie może być pusta. Jeśli ścieżka nie istnieje, nie zostanie wykonana żadna akcja.
updatePullRequestReviewer(IdentityRefWithVote, string, number, string, string)	Edytuj wpis recenzenta. Te pola można zastosować poprawki: isFlagged, hasDeclined
updatePullRequestReviewers(IdentityRefWithVote[], string, number, string)	Zresetuj głosy wielu recenzentów na żądanie ściągnięcia. UWAGA: ten punkt końcowy obsługuje tylko aktualizowanie głosów, ale nie obsługuje aktualizowania wymaganych recenzentów (użyj zasad) ani nazw wyświetlanych.
updatePullRequestStatuses(JsonPatchDocument, string, number, string)	Aktualizowanie kolekcji stanów żądań ściągnięcia. Jedynym obsługiwanym typem operacji jest `remove`.
updateRef(GitRefUpdate, string, string, string, string)	Blokowanie lub odblokowywanie gałęzi.
updateRefs(GitRefUpdate[], string, string, string)	Tworzenie, aktualizowanie lub usuwanie elementów refs(gałęzi).
updateRepository(GitRepository, string, string)	Aktualizuje repozytorium Git przy użyciu nowej nazwy repozytorium lub nowej gałęzi domyślnej.
updateRevertConflict(GitConflict, string, number, number, string)	Aktualizowanie rozwiązywania konfliktów scalania
updateRevertConflicts(GitConflict[], string, number, string)	Aktualizowanie wielu rozwiązań konfliktów scalania
updateThread(GitPullRequestCommentThread, string, number, number, string)	Zaktualizuj wątek w żądaniu ściągnięcia.

Szczegóły konstruktora

GitRestClient(IVssRestClientOptions)

new GitRestClient(options: IVssRestClientOptions)

Parametry

options: IVssRestClientOptions

Szczegóły właściwości

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Wartość właściwości

string

Szczegóły metody

createAnnotatedTag(GitAnnotatedTag, string, string)

Utwórz tag z adnotacjami.

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

Parametry

tagObject: GitAnnotatedTag

Obiekt zawierający szczegóły tagu do utworzenia.

project: string

Identyfikator projektu lub nazwa projektu

repositoryId: string

Identyfikator lub nazwa repozytorium.

Zwraca

Promise<GitAnnotatedTag>

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

Dołącz nowy plik do żądania ściągnięcia.

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

Parametry

content: any

Zawartość do przekazania

fileName: string

Nazwa pliku.

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<Attachment>

createCherryPick(GitAsyncRefOperationParameters, string, string)

Cherry wybierz określone zatwierdzenie lub zatwierdzenia, które są skojarzone z żądaniem ściągnięcia do nowej gałęzi.

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

Parametry

cherryPickToCreate: GitAsyncRefOperationParameters

project: string

Identyfikator projektu lub nazwa projektu

repositoryId: string

Identyfikator repozytorium.

Zwraca

Promise<GitCherryPick>

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

Utwórz komentarz do określonego wątku w żądaniu ściągnięcia (można utworzyć maksymalnie 500 komentarzy na wątek).

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

Parametry

comment: Comment

Komentarz do utworzenia. Komentarze mogą mieć maksymalnie 150 000 znaków.

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

threadId: number

Identyfikator wątku, w którego znajduje się żądany komentarz.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<Comment>

createCommitStatus(GitStatus, string, string, string)

Utwórz stan zatwierdzenia usługi Git.

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

Parametry

gitCommitStatusToCreate: GitStatus

Obiekt stanu zatwierdzenia usługi Git do utworzenia.

commitId: string

Identyfikator zatwierdzenia usługi Git.

repositoryId: string

Identyfikator repozytorium.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<GitStatus>

createFavorite(GitRefFavorite, string)

Tworzy ulubiony element ref

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

Parametry

favorite: GitRefFavorite

Ulubiony element ref do utworzenia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<GitRefFavorite>

createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)

Zażądaj pobrania do tego odwołania innego repozytorium. Synchronizuje dwa istniejące rozwidlenia. Aby utworzyć rozwidlenie, zobacz <href="https://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1" Punkt końcowy repozytoriów></a>

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

Parametry

syncParams: GitForkSyncRequestParameters

Repozytorium źródłowe i mapowanie ref.

repositoryNameOrId: string

Nazwa lub identyfikator repozytorium.

project: string

Identyfikator projektu lub nazwa projektu

includeLinks: boolean

Wartość True do uwzględnienia łączy

Zwraca

Promise<GitForkSyncRequest>

createImportRequest(GitImportRequest, string, string)

Utwórz żądanie importu.

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

Parametry

importRequest: GitImportRequest

Żądanie importu do utworzenia.

project: string

Identyfikator projektu lub nazwa projektu

repositoryId: string

Nazwa lub identyfikator repozytorium.

Zwraca

Promise<GitImportRequest>

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

Dodaj polubić komentarz.

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

Parametry

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

threadId: number

Identyfikator wątku zawierającego komentarz.

commentId: number

Identyfikator komentarza.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<void>

createMergeRequest(GitMergeParameters, string, string, boolean)

Zażądaj operacji scalania git. Obecnie obsługujemy scalanie tylko 2 zatwierdzeń.

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

Parametry

mergeParameters: GitMergeParameters

Identyfikatory commitId elementów nadrzędnych i scalanie bałaganu zatwierdzeń.

project: string

Identyfikator projektu lub nazwa projektu

repositoryNameOrId: string

Nazwa lub identyfikator repozytorium.

includeLinks: boolean

Wartość True do uwzględnienia łączy

Zwraca

Promise<GitMerge>

createPullRequest(GitPullRequest, string, string, boolean)

Utwórz żądanie ściągnięcia.

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

Parametry

gitPullRequestToCreate: GitPullRequest

Żądanie ściągnięcia do utworzenia.

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

project: string

Identyfikator projektu lub nazwa projektu

supportsIterations: boolean

Jeśli wartość true, kolejne wypchnięcia do żądania ściągnięcia będą można przeglądać indywidualnie. Ustaw wartość false dla dużych żądań ściągnięcia ze względów wydajności, jeśli ta funkcja nie jest potrzebna.

Zwraca

Promise<GitPullRequest>

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

Utwórz stan żądania ściągnięcia w iteracji. Ta operacja będzie mieć taki sam wynik jak tworzenie stanu żądania ściągnięcia z określonym identyfikatorem iteracji w treści żądania.

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

Parametry

status: GitPullRequestStatus

Stan żądania ściągnięcia do utworzenia.

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

iterationId: number

Identyfikator iteracji żądania ściągnięcia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<GitPullRequestStatus>

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

Utwórz tag (jeśli jeszcze nie istnieje) i dodaj go jako etykietę (tag) dla określonego żądania ściągnięcia. Jedynym wymaganym polem jest nazwa nowej etykiety (tagu).

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

Parametry

label: WebApiCreateTagRequestData

Etykieta do przypisania do żądania ściągnięcia.

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

project: string

Identyfikator projektu lub nazwa projektu

projectId: string

Identyfikator projektu lub nazwa projektu.

Zwraca

Promise<WebApiTagDefinition>

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

Dodaj recenzenta do żądania ściągnięcia lub oddaj głos.

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

Parametry

reviewer: IdentityRefWithVote

Głosowanie recenzenta.<br/>Jeśli w tym miejscu znajduje się identyfikator recenzenta, musi być zgodny z parametrem reviewerID.<br/>Recenzenci mogą ustawić własny głos za pomocą tej metody. Podczas dodawania innych recenzentów głosowanie musi być ustawione na zero.

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

reviewerId: string

Identyfikator recenzenta.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<IdentityRefWithVote>

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

Dodaj recenzentów do żądania ściągnięcia.

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

Parametry

reviewers: IdentityRef[]

Recenzenci, którzy mają zostać dodani do żądania ściągnięcia.

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<IdentityRefWithVote[]>

createPullRequestStatus(GitPullRequestStatus, string, number, string)

Utwórz stan żądania ściągnięcia.

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

Parametry

status: GitPullRequestStatus

Stan żądania ściągnięcia do utworzenia.

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<GitPullRequestStatus>

createPush(GitPush, string, string)

Wypychanie zmian do repozytorium.

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

Parametry

push: GitPush

repositoryId: string

Nazwa lub identyfikator repozytorium.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<GitPush>

createRepository(GitRepositoryCreateOptions, string, string)

Utwórz repozytorium git w projekcie zespołowym.

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

Parametry

gitRepositoryToCreate: GitRepositoryCreateOptions

Określ nazwę repozytorium, projekt zespołowy i/lub repozytorium nadrzędne. Informacje o projekcie zespołowym można pominąć z repozytorium gitRepositoryToCreate, jeśli żądanie ma zakres projektu (tj. zawiera identyfikator projektu).

project: string

Identyfikator projektu lub nazwa projektu

sourceRef: string

[opcjonalnie] Określ odwołania źródłowe do użycia podczas tworzenia repozytorium rozwidlenia

Zwraca

Promise<GitRepository>

createRevert(GitAsyncRefOperationParameters, string, string)

Uruchamia operację, aby utworzyć nową gałąź, która przywraca zmiany wprowadzone przez określone zatwierdzenie lub zatwierdzenia skojarzone z żądaniem ściągnięcia.

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

Parametry

revertToCreate: GitAsyncRefOperationParameters

project: string

Identyfikator projektu lub nazwa projektu

repositoryId: string

Identyfikator repozytorium.

Zwraca

Promise<GitRevert>

createThread(GitPullRequestCommentThread, string, number, string)

Utwórz wątek w żądaniu ściągnięcia.

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

Parametry

commentThread: GitPullRequestCommentThread

Wątek do utworzenia. Wątek musi zawierać co najmniej jeden komentarz.

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<GitPullRequestCommentThread>

createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)

Dodaj niematerializowaną tożsamość do recenzentów żądania ściągnięcia.

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

Parametry

reviewer: IdentityRefWithVote

Recenzent, który ma zostać dodany do żądania ściągnięcia.

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<IdentityRefWithVote>

deleteAttachment(string, string, number, string)

Usuń załącznik żądania ściągnięcia.

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

Parametry

fileName: string

Nazwa załącznika do usunięcia.

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<void>

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

Usuń komentarz skojarzony z określonym wątkiem w żądaniu ściągnięcia.

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

Parametry

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

threadId: number

Identyfikator wątku, w którego znajduje się żądany komentarz.

commentId: number

Identyfikator komentarza.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<void>

deleteEnablementStatus(boolean, boolean, string[])

DELETE usuwa stan włączania i rozliczaneSkładniki danych z bazy danych. Usunięcie danych włączania spowoduje efektywne wyłączenie ich dla repozytoriów, których dotyczy problem.

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

Parametry

allProjects: boolean

includeBillableCommitters: boolean

projectIds: string[]

Zwraca

Promise<void>

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

Usuń obiekt podobny do komentarza.

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

Parametry

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

threadId: number

Identyfikator wątku zawierającego komentarz.

commentId: number

Identyfikator komentarza.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<void>

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

Usuń stan iteracji żądania ściągnięcia.

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

Parametry

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

iterationId: number

Identyfikator iteracji żądania ściągnięcia.

statusId: number

Identyfikator stanu żądania ściągnięcia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<void>

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

Usuwa etykietę (tag) z zestawu przypisanych do żądania ściągnięcia. Sam tag nie zostanie usunięty.

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

Parametry

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

labelIdOrName: string

Nazwa lub identyfikator żądanej etykiety.

project: string

Identyfikator projektu lub nazwa projektu

projectId: string

Identyfikator projektu lub nazwa projektu.

Zwraca

Promise<void>

deletePullRequestReviewer(string, number, string, string)

Usuń recenzenta z żądania ściągnięcia.

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

Parametry

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

reviewerId: string

Identyfikator recenzenta do usunięcia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<void>

deletePullRequestStatus(string, number, number, string)

Usuń stan żądania ściągnięcia.

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

Parametry

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

statusId: number

Identyfikator stanu żądania ściągnięcia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<void>

deleteRefFavorite(string, number)

Usuwa określone ulubione odwołania

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

favoriteId: number

Identyfikator ulubionego odwołania do usunięcia.

Zwraca

Promise<void>

deleteRepository(string, string)

Usuwanie repozytorium git

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

Parametry

repositoryId: string

Identyfikator repozytorium.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<void>

deleteRepositoryFromRecycleBin(string, string)

Zniszczenie (usuwanie twarde) nietrwałego repozytorium Git.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

repositoryId: string

Identyfikator repozytorium.

Zwraca

Promise<void>

getAnnotatedTag(string, string, string)

Pobierz tag z adnotacjami.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

repositoryId: string

Identyfikator lub nazwa repozytorium.

objectId: string

ObjectId (Sha1Id) tagu do pobrania.

Zwraca

Promise<GitAnnotatedTag>

getAttachmentContent(string, string, number, string)

Pobierz zawartość pliku załącznika żądania ściągnięcia.

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

Parametry

fileName: string

Nazwa załącznika.

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<ArrayBuffer>

getAttachments(string, number, string)

Pobierz listę plików dołączonych do danego żądania ściągnięcia.

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

Parametry

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<Attachment[]>

getAttachmentZip(string, string, number, string)

Pobierz zawartość pliku załącznika żądania ściągnięcia.

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

Parametry

fileName: string

Nazwa załącznika.

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<ArrayBuffer>

getBillableCommitters(string, Date, number, number)

Pobierz rzeczywiste rozliczane osoby zatwierdzane dla usługi Advanced Security dla danej daty.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

billingDate: Date

Oczekiwano czasu UTC. Jeśli nie określono wartości domyślnych z poprzedniego dnia rozliczeniowego.

skip: number

Pomiń X wiersze zestawu wyników, aby symulować stronicowanie.

take: number

Zwróć wiersze Y zestawu wyników, aby symulować stronicowanie.

Zwraca

Promise<BillableCommitter[]>

getBillableCommittersDetail(string, string, Date)

Pobierz szczegółowe rozliczane osoby zatwierdzane dla usługi Advanced Security dla danej daty. Szczegółowe wyniki celowo nie filtrują nietrwałych usuniętych projektów i repozytoriów, aby ułatwić diagnozowanie problemów z rozliczeniami.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

includeDetails: string

Zwróć wszystkie szczegóły dotyczące rozliczanych osób zatwierdzających.

billingDate: Date

Oczekiwano czasu UTC. Jeśli nie określono wartości domyślnych z poprzedniego dnia rozliczeniowego.

Zwraca

Promise<BillableCommitterDetail[]>

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

Pobierz pojedynczy obiekt blob.

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

Parametry

repositoryId: string

Nazwa lub identyfikator repozytorium.

sha1: string

Skrót SHA1 pliku. Sha1 pliku można pobrać przy użyciu punktu końcowego "Git/Items/Get Item".

project: string

Identyfikator projektu lub nazwa projektu

download: boolean

Jeśli wartość true, wyświetl monit o pobranie, a nie renderowanie w przeglądarce. Uwaga: ta wartość jest domyślnie ustawiona na true, jeśli $format jest zip

fileName: string

Podaj nazwę pliku, która ma być używana do pobrania.

resolveLfs: boolean

Jeśli to prawda, spróbuj rozpoznać obiekt blob w jego zawartości LFS, jeśli jest to plik wskaźnika LFS. Tylko zgodne z oktet-stream Akceptuj nagłówki lub typy $format

Zwraca

Promise<GitBlobRef>

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

Pobierz pojedynczy obiekt blob.

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

Parametry

repositoryId: string

Nazwa lub identyfikator repozytorium.

sha1: string

Skrót SHA1 pliku. Sha1 pliku można pobrać przy użyciu punktu końcowego "Git/Items/Get Item".

project: string

Identyfikator projektu lub nazwa projektu

download: boolean

Jeśli wartość true, wyświetl monit o pobranie, a nie renderowanie w przeglądarce. Uwaga: ta wartość jest domyślnie ustawiona na true, jeśli $format jest zip

fileName: string

Podaj nazwę pliku, która ma być używana do pobrania.

resolveLfs: boolean

Jeśli to prawda, spróbuj rozpoznać obiekt blob w jego zawartości LFS, jeśli jest to plik wskaźnika LFS. Tylko zgodne z oktet-stream Akceptuj nagłówki lub typy $format

Zwraca

Promise<ArrayBuffer>

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

Pobiera co najmniej jeden obiekt blob w pliku zip.

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

Parametry

blobIds: string[]

Identyfikatory obiektów blob (skróty SHA1) do zwrócenia w pliku zip.

repositoryId: string

Nazwa lub identyfikator repozytorium.

project: string

Identyfikator projektu lub nazwa projektu

filename: string

Zwraca

Promise<ArrayBuffer>

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

Pobierz pojedynczy obiekt blob.

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

Parametry

repositoryId: string

Nazwa lub identyfikator repozytorium.

sha1: string

Skrót SHA1 pliku. Sha1 pliku można pobrać przy użyciu punktu końcowego "Git/Items/Get Item".

project: string

Identyfikator projektu lub nazwa projektu

download: boolean

Jeśli wartość true, wyświetl monit o pobranie, a nie renderowanie w przeglądarce. Uwaga: ta wartość jest domyślnie ustawiona na true, jeśli $format jest zip

fileName: string

Podaj nazwę pliku, która ma być używana do pobrania.

resolveLfs: boolean

Jeśli to prawda, spróbuj rozpoznać obiekt blob w jego zawartości LFS, jeśli jest to plik wskaźnika LFS. Tylko zgodne z oktet-stream Akceptuj nagłówki lub typy $format

Zwraca

Promise<ArrayBuffer>

getBranch(string, string, string, GitVersionDescriptor)

Pobieranie statystyk dotyczących pojedynczej gałęzi.

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

Parametry

repositoryId: string

Nazwa lub identyfikator repozytorium.

name: string

Nazwa gałęzi.

project: string

Identyfikator projektu lub nazwa projektu

baseVersionDescriptor: GitVersionDescriptor

Identyfikuje zatwierdzenie lub gałąź, która ma być używana jako baza.

Zwraca

Promise<GitBranchStats>

getBranches(string, string, GitVersionDescriptor)

Pobieranie statystyk dotyczących wszystkich gałęzi w repozytorium.

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

Parametry

repositoryId: string

Nazwa lub identyfikator repozytorium.

project: string

Identyfikator projektu lub nazwa projektu

baseVersionDescriptor: GitVersionDescriptor

Identyfikuje zatwierdzenie lub gałąź, która ma być używana jako baza.

Zwraca

Promise<GitBranchStats[]>

getBranchStatsBatch(GitQueryBranchStatsCriteria, string, string)

Pobieranie statystyk dla wielu zatwierdzeń

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

Parametry

searchCriteria: GitQueryBranchStatsCriteria

Zatwierdzanie podstawowe i lista zatwierdzeń docelowych do porównania.

repositoryId: string

Nazwa lub identyfikator repozytorium.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<GitBranchStats[]>

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

Pobieranie zmian dla określonego zatwierdzenia.

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

Parametry

commitId: string

Identyfikator zatwierdzenia.

repositoryId: string

Identyfikator lub przyjazna nazwa repozytorium. Aby użyć przyjaznej nazwy, należy również określić identyfikator projectId.

project: string

Identyfikator projektu lub nazwa projektu

top: number

Maksymalna liczba zmian do zwrócenia.

skip: number

Liczba zmian do pominięcia.

Zwraca

Promise<GitCommitChanges>

getCherryPick(string, number, string)

Pobierz informacje o operacji wyboru wiśni według identyfikatora wyboru wiśni.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

cherryPickId: number

Identyfikator wyboru wiśni.

repositoryId: string

Identyfikator repozytorium.

Zwraca

Promise<GitCherryPick>

getCherryPickConflict(string, number, number, string)

Pobieranie jednego konfliktu dla wyboru wiśni według identyfikatora

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

Parametry

repositoryId: string

cherryPickId: number

conflictId: number

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<GitConflict>

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

Pobieranie wszystkich konfliktów dla wyboru wiśni

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

Parametry

repositoryId: string

cherryPickId: number

project: string

Identyfikator projektu lub nazwa projektu

continuationToken: string

top: number

excludeResolved: boolean

onlyResolved: boolean

includeObsolete: boolean

Zwraca

Promise<PagedList<GitConflict>>

getCherryPickForRefName(string, string, string)

Pobierz informacje o operacji wybierania wiśni dla określonej gałęzi. Ta operacja jest kosztowna ze względu na podstawową strukturę obiektów, więc ten interfejs API analizuje tylko 1000 najnowszych operacji wyboru wiśni.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

repositoryId: string

Identyfikator repozytorium.

refName: string

GitAsyncRefOperationParameters generatedRefName używany do operacji wybierania wiśni.

Zwraca

Promise<GitCherryPick>

getCherryPickRelationships(string, string, string, boolean)

Biorąc pod uwagę identyfikator commitId, zwraca listę zatwierdzeń, które znajdują się w tej samej rodzinie cherry-pick.

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

Parametry

repositoryNameOrId: string

commitId: string

project: string

Identyfikator projektu lub nazwa projektu

includeLinks: boolean

Zwraca

Promise<GitCommitRef[]>

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

Pobieranie komentarza skojarzonego z określonym wątkiem w żądaniu ściągnięcia.

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

Parametry

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

threadId: number

Identyfikator wątku, w którego znajduje się żądany komentarz.

commentId: number

Identyfikator komentarza.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<Comment>

getComments(string, number, number, string)

Pobierz wszystkie komentarze skojarzone z określonym wątkiem w żądaniu ściągnięcia.

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

Parametry

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

threadId: number

Identyfikator wątku.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<Comment[]>

getCommit(string, string, string, number)

Pobieranie określonego zatwierdzenia.

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

Parametry

commitId: string

Identyfikator zatwierdzenia.

repositoryId: string

Identyfikator lub przyjazna nazwa repozytorium. Aby użyć przyjaznej nazwy, należy również określić identyfikator projectId.

project: string

Identyfikator projektu lub nazwa projektu

changeCount: number

Liczba zmian, które mają być uwzględnione w wyniku.

Zwraca

Promise<GitCommit>

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

Znajdź najbliższe wspólne zatwierdzenie (bazę scalania) między zatwierdzeniami podstawowymi i docelowymi, a następnie uzyskaj różnicę między zatwierdzeniami podstawowymi i docelowymi albo wspólnymi i docelowymi zatwierdzeniami.

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

Parametry

repositoryId: string

Nazwa lub identyfikator repozytorium.

project: string

Identyfikator projektu lub nazwa projektu

diffCommonCommit: boolean

Jeśli to prawda, różnice między wspólnymi i docelowymi zatwierdzeniami. Jeśli wartość false, różnice między zatwierdzeniami podstawowymi i docelowymi.

top: number

Maksymalna liczba zmian do zwrócenia. Wartość domyślna to 100.

skip: number

Liczba zmian do pominięcia

baseVersionDescriptor: GitBaseVersionDescriptor

Deskryptor dla zatwierdzenia podstawowego.

targetVersionDescriptor: GitTargetVersionDescriptor

Deskryptor dla zatwierdzenia docelowego.

Zwraca

Promise<GitCommitDiffs>

getCommits(string, GitQueryCommitsCriteria, string)

Pobieranie zatwierdzeń git dla projektu

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

Parametry

repositoryId: string

Identyfikator lub przyjazna nazwa repozytorium. Aby użyć przyjaznej nazwy, należy również określić identyfikator projectId.

searchCriteria: GitQueryCommitsCriteria

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<GitCommitRef[]>

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

Pobieranie zatwierdzeń git dla projektu spełniającego kryteria wyszukiwania

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

Parametry

searchCriteria: GitQueryCommitsCriteria

Opcje wyszukiwania

repositoryId: string

Nazwa lub identyfikator repozytorium.

project: string

Identyfikator projektu lub nazwa projektu

skip: number

Liczba zatwierdzeń do pominięcia. Wartość nie może przekraczać 3000 000.

top: number

Maksymalna liczba zatwierdzeń do zwrócenia. Wartość nie może przekraczać 50 000.

includeStatuses: boolean

Wartość True, aby uwzględnić dodatkowe informacje o stanie zatwierdzenia.

Zwraca

Promise<GitCommitRef[]>

getDeletedRepositories(string)

Pobieranie usuniętych repozytoriów git.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<GitDeletedRepository[]>

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

Stan włączania GET dla repozytoriów projektu.

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

Parametry

projectIds: string[]

Wartość domyślna null dla wszystkich projektów na hoście, lista stanu repozytoriów projektu, które mają być zwracane

billingDate: Date

Oczekiwano czasu UTC, wartością domyślną null jest UtcNow(), można podać dla stanu punktu w czasie

skip: number

Pomiń X wiersze zestawu wyników, aby symulować stronicowanie.

take: number

Zwróć wiersze Y zestawu wyników, aby symulować stronicowanie.

Zwraca

Promise<AdvSecEnablementStatus[]>

getEnableOnCreateHost(boolean)

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

Parametry

enableOnCreateHost: boolean

Zwraca

Promise<boolean>

getEnableOnCreateProject(string)

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

Parametry

enableOnCreateProjectId: string

Zwraca

Promise<boolean>

getEstimatedBillableCommittersRepo(string, string)

Uzyskaj szacowane rozliczane osoby zatwierdzane dla repozytorium z ostatnich 90 dni.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

repositoryId: string

Zwraca

Promise<BillableCommitter[]>

getEstimatedBillablePushersOrg()

Uzyskaj szacowane rozliczane wypychacze dla organizacji w ciągu ostatnich 90 dni.

function getEstimatedBillablePushersOrg(): Promise<BillablePusher[]>

Zwraca

Promise<BillablePusher[]>

getEstimatedBillablePushersProject(string)

Uzyskaj szacowane rozliczane wypychacze dla projektu z ostatnich 90 dni.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<BillablePusher[]>

getFileDiffs(FileDiffsCriteria, string, string)

Pobieranie różnic między plikami dla każdego z określonych plików

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

Parametry

fileDiffsCriteria: FileDiffsCriteria

Lista obiektów parametrów pliku

project: string

Identyfikator projektu lub nazwa projektu

repositoryId: string

Nazwa lub identyfikator repozytorium

Zwraca

Promise<FileDiff[]>

getForks(string, string, string, boolean)

Pobierz wszystkie rozwidlenia repozytorium w kolekcji.

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

Parametry

repositoryNameOrId: string

Nazwa lub identyfikator repozytorium.

collectionId: string

Identyfikator kolekcji projektów zespołowych.

project: string

Identyfikator projektu lub nazwa projektu

includeLinks: boolean

Wartość True do uwzględnienia łączy.

Zwraca

Promise<GitRepositoryRef[]>

getForkSyncRequest(string, number, string, boolean)

Pobierz szczegóły konkretnej operacji synchronizacji rozwidlenia.

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

Parametry

repositoryNameOrId: string

Nazwa lub identyfikator repozytorium.

forkSyncOperationId: number

OperationId żądania synchronizacji.

project: string

Identyfikator projektu lub nazwa projektu

includeLinks: boolean

Wartość True do uwzględnienia łączy.

Zwraca

Promise<GitForkSyncRequest>

getForkSyncRequests(string, string, boolean, boolean)

Pobierz wszystkie żądane operacje synchronizacji rozwidlenia w tym repozytorium.

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

Parametry

repositoryNameOrId: string

Nazwa lub identyfikator repozytorium.

project: string

Identyfikator projektu lub nazwa projektu

includeAbandoned: boolean

Wartość True do uwzględnienia porzuconych żądań.

includeLinks: boolean

Wartość True do uwzględnienia łączy.

Zwraca

Promise<GitForkSyncRequest[]>

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

Pobierz metadane elementu i/lub zawartość dla pojedynczego elementu. Parametr pobierania wskazuje, czy zawartość powinna być dostępna jako pobieranie, czy po prostu wysłana jako strumień w odpowiedzi. Nie ma zastosowania do spakowanej zawartości, która jest zawsze zwracana jako pobieranie.

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>

Parametry

repositoryId: string

Nazwa lub identyfikator repozytorium.

path: string

Ścieżka elementu.

project: string

Identyfikator projektu lub nazwa projektu

scopePath: string

Zakres ścieżki. Wartość domyślna to null.

recursionLevel: VersionControlRecursionType

Poziom rekursji tego żądania. Wartość domyślna to "none", brak rekursji.

includeContentMetadata: boolean

Ustaw wartość true, aby uwzględnić metadane zawartości. Wartość domyślna to false.

latestProcessedChange: boolean

Ustaw wartość true, aby uwzględnić najnowsze zmiany. Wartość domyślna to false.

download: boolean

Ustaw wartość true, aby pobrać odpowiedź jako plik. Wartość domyślna to false.

versionDescriptor: GitVersionDescriptor

Deskryptor wersji. Wartość domyślna to domyślna gałąź repozytorium.

includeContent: boolean

Ustaw wartość true, aby uwzględnić zawartość elementu podczas żądania pliku json. Wartość domyślna to false.

resolveHfs: boolean

Ustaw wartość true, aby rozpoznać pliki wskaźnika HFS usługi Git w celu zwrócenia rzeczywistej zawartości z usługi Git HFS. Wartość domyślna to true.

sanitize: boolean

Ustaw wartość true, aby odczyścić plik svg i zwrócić go jako obraz. Przydatne tylko wtedy, gdy zażądano pliku svg. Wartość domyślna to false.

Zwraca

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>

Parametry

repositoryId: string

Nazwa lub identyfikator repozytorium.

path: string

Ścieżka elementu.

project: string

Identyfikator projektu lub nazwa projektu

scopePath: string

Zakres ścieżki. Wartość domyślna to null.

recursionLevel: VersionControlRecursionType

Poziom rekursji tego żądania. Wartość domyślna to "none", brak rekursji.

includeContentMetadata: boolean

Ustaw wartość true, aby uwzględnić metadane zawartości. Wartość domyślna to false.

latestProcessedChange: boolean

Ustaw wartość true, aby uwzględnić najnowsze zmiany. Wartość domyślna to false.

download: boolean

Ustaw wartość true, aby pobrać odpowiedź jako plik. Wartość domyślna to false.

versionDescriptor: GitVersionDescriptor

Deskryptor wersji. Wartość domyślna to domyślna gałąź repozytorium.

includeContent: boolean

Ustaw wartość true, aby uwzględnić zawartość elementu podczas żądania pliku json. Wartość domyślna to false.

resolveHfs: boolean

Ustaw wartość true, aby rozpoznać pliki wskaźnika HFS usługi Git w celu zwrócenia rzeczywistej zawartości z usługi Git HFS. Wartość domyślna to true.

sanitize: boolean

Ustaw wartość true, aby odczyścić plik svg i zwrócić go jako obraz. Przydatne tylko wtedy, gdy zażądano pliku svg. Wartość domyślna to false.

Zwraca

Promise<ArrayBuffer>

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

Pobierz metadane elementu i/lub zawartość dla kolekcji elementów. Parametr pobierania wskazuje, czy zawartość powinna być dostępna jako pobieranie, czy po prostu wysłana jako strumień w odpowiedzi. Nie ma zastosowania do spakowanej zawartości, która jest zawsze zwracana jako pobieranie.

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

Parametry

repositoryId: string

Nazwa lub identyfikator repozytorium.

project: string

Identyfikator projektu lub nazwa projektu

scopePath: string

Zakres ścieżki. Wartość domyślna to null.

recursionLevel: VersionControlRecursionType

Poziom rekursji tego żądania. Wartość domyślna to "none", brak rekursji.

includeContentMetadata: boolean

Ustaw wartość true, aby uwzględnić metadane zawartości. Wartość domyślna to false.

latestProcessedChange: boolean

Ustaw wartość true, aby uwzględnić najnowsze zmiany. Wartość domyślna to false.

download: boolean

Ustaw wartość true, aby pobrać odpowiedź jako plik. Wartość domyślna to false.

includeLinks: boolean

Ustaw wartość true, aby uwzględnić łącza do elementów. Wartość domyślna to false.

versionDescriptor: GitVersionDescriptor

Deskryptor wersji. Wartość domyślna to domyślna gałąź repozytorium.

zipForUnix: boolean

Ustaw wartość true, aby zachować uprawnienia do plików dla systemów unix (i POSIX), takich jak pliki wykonywalne i sylinki

Zwraca

Promise<GitItem[]>

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

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

Parametry

repositoryId: string

Nazwa lub identyfikator repozytorium.

path: string

Ścieżka elementu.

project: string

Identyfikator projektu lub nazwa projektu

scopePath: string

Zakres ścieżki. Wartość domyślna to null.

recursionLevel: VersionControlRecursionType

Poziom rekursji tego żądania. Wartość domyślna to "none", brak rekursji.

includeContentMetadata: boolean

Ustaw wartość true, aby uwzględnić metadane zawartości. Wartość domyślna to false.

latestProcessedChange: boolean

Ustaw wartość true, aby uwzględnić najnowsze zmiany. Wartość domyślna to false.

download: boolean

Ustaw wartość true, aby pobrać odpowiedź jako plik. Wartość domyślna to false.

versionDescriptor: GitVersionDescriptor

Deskryptor wersji. Wartość domyślna to domyślna gałąź repozytorium.

includeContent: boolean

Ustaw wartość true, aby uwzględnić zawartość elementu podczas żądania pliku json. Wartość domyślna to false.

resolveHfs: boolean

Ustaw wartość true, aby rozpoznać pliki wskaźnika HFS usługi Git w celu zwrócenia rzeczywistej zawartości z usługi Git HFS. Wartość domyślna to true.

sanitize: boolean

Ustaw wartość true, aby odczyścić plik svg i zwrócić go jako obraz. Przydatne tylko wtedy, gdy zażądano pliku svg. Wartość domyślna to false.

Zwraca

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>

Parametry

repositoryId: string

Nazwa lub identyfikator repozytorium.

path: string

Ścieżka elementu.

project: string

Identyfikator projektu lub nazwa projektu

scopePath: string

Zakres ścieżki. Wartość domyślna to null.

recursionLevel: VersionControlRecursionType

Poziom rekursji tego żądania. Wartość domyślna to "none", brak rekursji.

includeContentMetadata: boolean

Ustaw wartość true, aby uwzględnić metadane zawartości. Wartość domyślna to false.

latestProcessedChange: boolean

Ustaw wartość true, aby uwzględnić najnowsze zmiany. Wartość domyślna to false.

download: boolean

Ustaw wartość true, aby pobrać odpowiedź jako plik. Wartość domyślna to false.

versionDescriptor: GitVersionDescriptor

Deskryptor wersji. Wartość domyślna to domyślna gałąź repozytorium.

includeContent: boolean

Ustaw wartość true, aby uwzględnić zawartość elementu podczas żądania pliku json. Wartość domyślna to false.

resolveHfs: boolean

Ustaw wartość true, aby rozpoznać pliki wskaźnika HFS usługi Git w celu zwrócenia rzeczywistej zawartości z usługi Git HFS. Wartość domyślna to true.

sanitize: boolean

Ustaw wartość true, aby odczyścić plik svg i zwrócić go jako obraz. Przydatne tylko wtedy, gdy zażądano pliku svg. Wartość domyślna to false.

Zwraca

Promise<ArrayBuffer>

getImportRequest(string, string, number)

Pobieranie określonego żądania importu.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

repositoryId: string

Nazwa lub identyfikator repozytorium.

importRequestId: number

Unikatowy identyfikator żądania importu.

Zwraca

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>

Parametry

repositoryId: string

Nazwa lub identyfikator repozytorium.

path: string

Ścieżka elementu.

project: string

Identyfikator projektu lub nazwa projektu

scopePath: string

Zakres ścieżki. Wartość domyślna to null.

recursionLevel: VersionControlRecursionType

Poziom rekursji tego żądania. Wartość domyślna to "none", brak rekursji.

includeContentMetadata: boolean

Ustaw wartość true, aby uwzględnić metadane zawartości. Wartość domyślna to false.

latestProcessedChange: boolean

Ustaw wartość true, aby uwzględnić najnowsze zmiany. Wartość domyślna to false.

download: boolean

Ustaw wartość true, aby pobrać odpowiedź jako plik. Wartość domyślna to false.

versionDescriptor: GitVersionDescriptor

Deskryptor wersji. Wartość domyślna to domyślna gałąź repozytorium.

includeContent: boolean

Ustaw wartość true, aby uwzględnić zawartość elementu podczas żądania pliku json. Wartość domyślna to false.

resolveLfs: boolean

Ustaw wartość true, aby rozpoznać pliki wskaźnika LFS usługi Git w celu zwrócenia rzeczywistej zawartości z usługi Git LFS. Wartość domyślna to false.

sanitize: boolean

Ustaw wartość true, aby odczyścić plik svg i zwrócić go jako obraz. Przydatne tylko wtedy, gdy zażądano pliku svg. Wartość domyślna to false.

Zwraca

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>

Parametry

repositoryId: string

Nazwa lub identyfikator repozytorium.

path: string

Ścieżka elementu.

project: string

Identyfikator projektu lub nazwa projektu

scopePath: string

Zakres ścieżki. Wartość domyślna to null.

recursionLevel: VersionControlRecursionType

Poziom rekursji tego żądania. Wartość domyślna to "none", brak rekursji.

includeContentMetadata: boolean

Ustaw wartość true, aby uwzględnić metadane zawartości. Wartość domyślna to false.

latestProcessedChange: boolean

Ustaw wartość true, aby uwzględnić najnowsze zmiany. Wartość domyślna to false.

download: boolean

Ustaw wartość true, aby pobrać odpowiedź jako plik. Wartość domyślna to false.

versionDescriptor: GitVersionDescriptor

Deskryptor wersji. Wartość domyślna to domyślna gałąź repozytorium.

includeContent: boolean

Ustaw wartość true, aby uwzględnić zawartość elementu podczas żądania pliku json. Wartość domyślna to false.

resolveLfs: boolean

Ustaw wartość true, aby rozpoznać pliki wskaźnika LFS usługi Git w celu zwrócenia rzeczywistej zawartości z usługi Git LFS. Wartość domyślna to false.

sanitize: boolean

Ustaw wartość true, aby odczyścić plik svg i zwrócić go jako obraz. Przydatne tylko wtedy, gdy zażądano pliku svg. Wartość domyślna to false.

Zwraca

Promise<ArrayBuffer>

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

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

Parametry

repositoryId: string

Nazwa lub identyfikator repozytorium.

project: string

Identyfikator projektu lub nazwa projektu

scopePath: string

Zakres ścieżki. Wartość domyślna to null.

recursionLevel: VersionControlRecursionType

Poziom rekursji tego żądania. Wartość domyślna to "none", brak rekursji.

includeContentMetadata: boolean

Ustaw wartość true, aby uwzględnić metadane zawartości. Wartość domyślna to false.

latestProcessedChange: boolean

Ustaw wartość true, aby uwzględnić najnowsze zmiany. Wartość domyślna to false.

download: boolean

Ustaw wartość true, aby pobrać odpowiedź jako plik. Wartość domyślna to false.

includeLinks: boolean

Ustaw wartość true, aby uwzględnić łącza do elementów. Wartość domyślna to false.

versionDescriptor: GitVersionDescriptor

Deskryptor wersji. Wartość domyślna to domyślna gałąź repozytorium.

zipForUnix: boolean

Ustaw wartość true, aby zachować uprawnienia do plików dla systemów unix (i POSIX), takich jak pliki wykonywalne i sylinki

Zwraca

Promise<GitItem[]>

getItemsBatch(GitItemRequestData, string, string)

Opublikuj na potrzeby pobierania partii z zestawu elementów w repozytorium/projekcie, biorąc pod uwagę listę ścieżek lub długą ścieżkę

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

Parametry

requestData: GitItemRequestData

Atrybuty danych żądania: ItemDescriptors, IncludeContentMetadata, LatestProcessedChange, IncludeLinks. ItemDescriptors: kolekcja elementów do pobrania, w tym ścieżka, wersja i poziom rekursji. IncludeContentMetadata: czy uwzględnić metadane dla wszystkich elementów LatestProcessedChange: czy dołączyć płytki ref do zatwierdzenia, które ostatnio zmieniły każdy element. IncludeLinks: czy dołączyć pole _links do płytkich odwołań.

repositoryId: string

Nazwa lub identyfikator repozytorium

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

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>

Parametry

repositoryId: string

Nazwa lub identyfikator repozytorium.

path: string

Ścieżka elementu.

project: string

Identyfikator projektu lub nazwa projektu

scopePath: string

Zakres ścieżki. Wartość domyślna to null.

recursionLevel: VersionControlRecursionType

Poziom rekursji tego żądania. Wartość domyślna to "none", brak rekursji.

includeContentMetadata: boolean

Ustaw wartość true, aby uwzględnić metadane zawartości. Wartość domyślna to false.

latestProcessedChange: boolean

Ustaw wartość true, aby uwzględnić najnowsze zmiany. Wartość domyślna to false.

download: boolean

Ustaw wartość true, aby pobrać odpowiedź jako plik. Wartość domyślna to false.

versionDescriptor: GitVersionDescriptor

Deskryptor wersji. Wartość domyślna to domyślna gałąź repozytorium.

includeContent: boolean

Ustaw wartość true, aby uwzględnić zawartość elementu podczas żądania pliku json. Wartość domyślna to false.

resolveLfs: boolean

Ustaw wartość true, aby rozpoznać pliki wskaźnika LFS usługi Git w celu zwrócenia rzeczywistej zawartości z usługi Git LFS. Wartość domyślna to false.

sanitize: boolean

Ustaw wartość true, aby odczyścić plik svg i zwrócić go jako obraz. Przydatne tylko wtedy, gdy zażądano pliku svg. Wartość domyślna to false.

Zwraca

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>

Parametry

repositoryId: string

Nazwa lub identyfikator repozytorium.

path: string

Ścieżka elementu.

project: string

Identyfikator projektu lub nazwa projektu

scopePath: string

Zakres ścieżki. Wartość domyślna to null.

recursionLevel: VersionControlRecursionType

Poziom rekursji tego żądania. Wartość domyślna to "none", brak rekursji.

includeContentMetadata: boolean

Ustaw wartość true, aby uwzględnić metadane zawartości. Wartość domyślna to false.

latestProcessedChange: boolean

Ustaw wartość true, aby uwzględnić najnowsze zmiany. Wartość domyślna to false.

download: boolean

Ustaw wartość true, aby pobrać odpowiedź jako plik. Wartość domyślna to false.

versionDescriptor: GitVersionDescriptor

Deskryptor wersji. Wartość domyślna to domyślna gałąź repozytorium.

includeContent: boolean

Ustaw wartość true, aby uwzględnić zawartość elementu podczas żądania pliku json. Wartość domyślna to false.

resolveLfs: boolean

Ustaw wartość true, aby rozpoznać pliki wskaźnika LFS usługi Git w celu zwrócenia rzeczywistej zawartości z usługi Git LFS. Wartość domyślna to false.

sanitize: boolean

Ustaw wartość true, aby odczyścić plik svg i zwrócić go jako obraz. Przydatne tylko wtedy, gdy zażądano pliku svg. Wartość domyślna to false.

Zwraca

Promise<ArrayBuffer>

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

Pobierz polubień dla komentarza.

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

Parametry

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

threadId: number

Identyfikator wątku zawierającego komentarz.

commentId: number

Identyfikator komentarza.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<IdentityRef[]>

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

Znajdź podstawy scalania dwóch zatwierdzeń, opcjonalnie w rozwidleniu. Jeśli nie określono parametru otherRepositoryId, bazy scalania będą obliczane tylko w kontekście lokalnego identyfikatora repositoryNameOrId.

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

Parametry

repositoryNameOrId: string

Identyfikator lub nazwa repozytorium lokalnego.

commitId: string

Najpierw zatwierdź, zazwyczaj końcówka gałęzi docelowej potencjalnego scalania.

otherCommitId: string

Inne zatwierdzenie, zazwyczaj końcówka gałęzi źródłowej potencjalnego scalania.

project: string

Identyfikator projektu lub nazwa projektu

otherCollectionId: string

Identyfikator kolekcji, w którym znajduje się inneCommitId.

otherRepositoryId: string

Identyfikator repozytorium, w którym znajduje się inny identyfikatorCommitId.

Zwraca

Promise<GitCommitRef[]>

getMergeRequest(string, string, number, boolean)

Pobierz szczegóły konkretnej operacji scalania.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

repositoryNameOrId: string

Nazwa lub identyfikator repozytorium.

mergeOperationId: number

OperationId żądania scalania.

includeLinks: boolean

Wartość True do uwzględnienia łączy

Zwraca

Promise<GitMerge>

getPermission(string, string, string)

UZYSKAJ stan uprawnień zabezpieczeń zaawansowanych.

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

Parametry

projectName: string

repositoryId: string

Użytkownik repozytorium próbuje uzyskać dostęp

permission: string

Żądane uprawnienie musi mieć wartość "viewAlert" "dismissAlert" "manage" "viewEnablement" lub "repoRead"

Zwraca

Promise<boolean>

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

Pobieranie żądania ściągnięcia.

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

Parametry

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia do pobrania.

project: string

Identyfikator projektu lub nazwa projektu

maxCommentLength: number

Nieużytne.

skip: number

Nieużytne.

top: number

Nieużytne.

includeCommits: boolean

Jeśli to prawda, żądanie ściągnięcia zostanie zwrócone ze skojarzonymi zatwierdzeniami.

includeWorkItemRefs: boolean

Jeśli to prawda, żądanie ściągnięcia zostanie zwrócone wraz ze skojarzonymi odwołaniami do elementu roboczego.

Zwraca

Promise<GitPullRequest>

getPullRequestById(number, string)

Pobieranie żądania ściągnięcia.

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

Parametry

pullRequestId: number

Identyfikator żądania ściągnięcia do pobrania.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<GitPullRequest>

getPullRequestCommits(string, number, string)

Pobierz zatwierdzenia dla określonego żądania ściągnięcia.

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

Parametry

repositoryId: string

Identyfikator lub nazwa repozytorium.

pullRequestId: number

Identyfikator żądania ściągnięcia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<PagedList<GitCommitRef>>

getPullRequestConflict(string, number, number, string)

Pobieranie jednego konfliktu dla żądania ściągnięcia według identyfikatora

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

Parametry

repositoryId: string

pullRequestId: number

conflictId: number

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<GitConflict>

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

Pobieranie wszystkich konfliktów dla żądania ściągnięcia

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

Parametry

repositoryId: string

Repozytorium żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

project: string

Identyfikator projektu lub nazwa projektu

skip: number

Konflikty do pominięcia.

top: number

Konflikty, które mają być zwracane po pominięcia.

includeObsolete: boolean

Obejmuje przestarzałe konflikty.

excludeResolved: boolean

Wyklucza już rozwiązane konflikty.

onlyResolved: boolean

Zwraca tylko konflikty, które zostały rozwiązane.

Zwraca

Promise<GitConflict[]>

getPullRequestIteration(string, number, number, string)

Pobierz określoną iterację dla żądania ściągnięcia.

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

Parametry

repositoryId: string

Identyfikator lub nazwa repozytorium.

pullRequestId: number

Identyfikator żądania ściągnięcia.

iterationId: number

Identyfikator iteracji żądania ściągnięcia do zwrócenia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<GitPullRequestIteration>

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

Pobierz zmiany wprowadzone w żądaniu ściągnięcia między dwiema iteracjami.

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

Parametry

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

iterationId: number

Identyfikator iteracji żądania ściągnięcia. <br/> iteracja jest szefem gałęzi źródłowej w momencie utworzenia żądania ściągnięcia, a kolejne iteracji są tworzone podczas wypychania do gałęzi źródłowej. Dozwolone wartości to od 1 do maksymalnej iteracji dla tego żądania ściągnięcia.

project: string

Identyfikator projektu lub nazwa projektu

top: number

Fakultatywny. Liczba zmian do pobrania. Wartość domyślna to 100, a wartość maksymalna to 2000.

skip: number

Fakultatywny. Liczba zmian do zignorowania. Na przykład aby pobrać zmiany 101-150, ustaw 50 pierwszych i przejdź do 100.

compareTo: number

Identyfikator iteracji żądania ściągnięcia do porównania. Wartość domyślna to zero, co wskazuje, że porównanie jest wykonywane względem wspólnego zatwierdzenia między gałęziami źródłowymi i docelowymi

Zwraca

Promise<GitPullRequestIterationChanges>

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

Pobierz zatwierdzenia dla określonej iteracji żądania ściągnięcia.

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

Parametry

repositoryId: string

Identyfikator lub nazwa repozytorium.

pullRequestId: number

Identyfikator żądania ściągnięcia.

iterationId: number

Identyfikator iteracji, z której mają być uzyskiwane zatwierdzenia.

project: string

Identyfikator projektu lub nazwa projektu

top: number

Maksymalna liczba zatwierdzeń do zwrócenia. Maksymalna liczba zatwierdzeń, które można zwrócić na partię, wynosi 500.

skip: number

Liczba zatwierdzeń do pominięcia.

Zwraca

Promise<GitCommitRef[]>

getPullRequestIterations(string, number, string, boolean)

Pobierz listę iteracji dla określonego żądania ściągnięcia.

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

Parametry

repositoryId: string

Identyfikator lub nazwa repozytorium.

pullRequestId: number

Identyfikator żądania ściągnięcia.

project: string

Identyfikator projektu lub nazwa projektu

includeCommits: boolean

Jeśli wartość true, dołącz zatwierdzenia skojarzone z każdą iterację w odpowiedzi.

Zwraca

Promise<GitPullRequestIteration[]>

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

Uzyskaj określony stan iteracji żądania ściągnięcia według identyfikatora. Identyfikator stanu jest unikatowy w ramach żądania ściągnięcia we wszystkich iteracji.

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

Parametry

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

iterationId: number

Identyfikator iteracji żądania ściągnięcia.

statusId: number

Identyfikator stanu żądania ściągnięcia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<GitPullRequestStatus>

getPullRequestIterationStatuses(string, number, number, string)

Pobierz wszystkie stany skojarzone z iteracją żądania ściągnięcia.

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

Parametry

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

iterationId: number

Identyfikator iteracji żądania ściągnięcia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<GitPullRequestStatus[]>

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

Pobiera pojedynczą etykietę (tag), która została przypisana do żądania ściągnięcia.

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

Parametry

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

labelIdOrName: string

Nazwa lub identyfikator żądanej etykiety.

project: string

Identyfikator projektu lub nazwa projektu

projectId: string

Identyfikator projektu lub nazwa projektu.

Zwraca

Promise<WebApiTagDefinition>

getPullRequestLabels(string, number, string, string)

Pobierz wszystkie etykiety (tagi) przypisane do żądania ściągnięcia.

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

Parametry

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

project: string

Identyfikator projektu lub nazwa projektu

projectId: string

Identyfikator projektu lub nazwa projektu.

Zwraca

Promise<WebApiTagDefinition[]>

getPullRequestProperties(string, number, string)

Pobierz właściwości zewnętrzne żądania ściągnięcia.

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

Parametry

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<any>

getPullRequestQuery(GitPullRequestQuery, string, string)

Ten interfejs API służy do znajdowania żądań ściągnięcia powiązanych z danym zatwierdzeniem. Może służyć do znajdowania żądania ściągnięcia, które utworzyło określone zatwierdzenie scalania, lub może służyć do znajdowania wszystkich żądań ściągnięcia, które kiedykolwiek scaliły określone zatwierdzenie. Dane wejściowe to lista zapytań, które zawierają listę zatwierdzeń. Dla każdego przeszukiwanego zatwierdzenia zostanie wyświetlony słownik zatwierdzeń —> żądania ściągnięcia.

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

Parametry

queries: GitPullRequestQuery

Lista zapytań do wykonania.

repositoryId: string

Identyfikator repozytorium.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<GitPullRequestQuery>

getPullRequestReviewer(string, number, string, string)

Pobieranie informacji o konkretnym recenzentze w żądaniu ściągnięcia

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

Parametry

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

reviewerId: string

Identyfikator recenzenta.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<IdentityRefWithVote>

getPullRequestReviewers(string, number, string)

Pobieranie recenzentów dla żądania ściągnięcia

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

Parametry

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<IdentityRefWithVote[]>

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

Pobierz wszystkie żądania ściągnięcia spełniające określone kryteria.

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

Parametry

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

searchCriteria: GitPullRequestSearchCriteria

Żądania ściągnięcia zostaną zwrócone, które spełniają te kryteria wyszukiwania.

project: string

Identyfikator projektu lub nazwa projektu

maxCommentLength: number

Nieużytne.

skip: number

Liczba żądań ściągnięcia do zignorowania. Na przykład aby pobrać wyniki 101-150, ustaw wartość 50 pierwszych i przejdź do wartości 100.

top: number

Liczba żądań ściągnięcia do pobrania.

Zwraca

Promise<GitPullRequest[]>

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

Pobierz wszystkie żądania ściągnięcia spełniające określone kryteria.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

searchCriteria: GitPullRequestSearchCriteria

Żądania ściągnięcia zostaną zwrócone, które spełniają te kryteria wyszukiwania.

maxCommentLength: number

Nieużytne.

skip: number

Liczba żądań ściągnięcia do zignorowania. Na przykład aby pobrać wyniki 101-150, ustaw wartość 50 pierwszych i przejdź do wartości 100.

top: number

Liczba żądań ściągnięcia do pobrania.

Zwraca

Promise<GitPullRequest[]>

getPullRequestStatus(string, number, number, string)

Uzyskaj określony stan żądania ściągnięcia według identyfikatora. Identyfikator stanu jest unikatowy w ramach żądania ściągnięcia we wszystkich iteracji.

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

Parametry

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

statusId: number

Identyfikator stanu żądania ściągnięcia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<GitPullRequestStatus>

getPullRequestStatuses(string, number, string)

Pobierz wszystkie stany skojarzone z żądaniem ściągnięcia.

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

Parametry

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<GitPullRequestStatus[]>

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

Pobieranie wątku w żądaniu ściągnięcia.

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

Parametry

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

threadId: number

Identyfikator wątku.

project: string

Identyfikator projektu lub nazwa projektu

iteration: number

Jeśli określono, pozycja wątku będzie śledzona przy użyciu tej iteracji jako prawej strony różnicy.

baseIteration: number

Jeśli określono, pozycja wątku będzie śledzona przy użyciu tej iteracji jako lewej strony różnicy.

Zwraca

Promise<GitPullRequestCommentThread>

getPullRequestWorkItemRefs(string, number, string)

Pobierz listę elementów roboczych skojarzonych z żądaniem ściągnięcia.

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

Parametry

repositoryId: string

Identyfikator lub nazwa repozytorium.

pullRequestId: number

Identyfikator żądania ściągnięcia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<ResourceRef[]>

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

Pobiera określone wypychanie.

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

Parametry

repositoryId: string

Nazwa lub identyfikator repozytorium.

pushId: number

Identyfikator wypychania.

project: string

Identyfikator projektu lub nazwa projektu

includeCommits: number

Liczba zatwierdzeń do uwzględnienia w wyniku.

includeRefUpdates: boolean

Jeśli wartość true, dołącz listę refs, które zostały zaktualizowane przez wypchnięcie.

Zwraca

Promise<GitPush>

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

Pobierz listę zatwierdzeń skojarzonych z określonym wypchnięciem.

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

Parametry

repositoryId: string

Identyfikator lub przyjazna nazwa repozytorium. Aby użyć przyjaznej nazwy, należy również określić identyfikator projectId.

pushId: number

Identyfikator wypychania.

project: string

Identyfikator projektu lub nazwa projektu

top: number

Maksymalna liczba zatwierdzeń do zwrócenia ("pobierz pierwsze zatwierdzenia x").

skip: number

Liczba zatwierdzeń do pominięcia.

includeLinks: boolean

Ustaw wartość false, aby uniknąć dołączania linków adresów URL REST dla zasobów. Wartość domyślna to true.

Zwraca

Promise<GitCommitRef[]>

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

Pobiera wypychania skojarzone z określonym repozytorium.

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

Parametry

repositoryId: string

Nazwa lub identyfikator repozytorium.

project: string

Identyfikator projektu lub nazwa projektu

skip: number

Liczba wypchnięć do pominięcia.

top: number

Liczba wypchnięć do zwrócenia.

searchCriteria: GitPushSearchCriteria

Atrybuty kryteriów wyszukiwania: fromDate, toDate, pusherId, refName, includeRefUpdates lub includeLinks. fromDate: data rozpoczęcia wyszukiwania. toDate: data zakończenia wyszukiwania. pusherId: tożsamość osoby, która przesłała wypychanie. refName: nazwa gałęzi do rozważenia. includeRefUpdates: Jeśli wartość true, dołącz listę refs, które zostały zaktualizowane przez wypchnięcie. includeLinks: czy dołączyć pole _links do płytkich odwołań.

Zwraca

Promise<GitPush[]>

getRecycleBinRepositories(string)

Pobieranie nietrwałych repozytoriów git z kosza.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<GitDeletedRepository[]>

getRefFavorite(string, number)

Pobiera ulubione odwołania dla ulubionego identyfikatora.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

favoriteId: number

Identyfikator żądanego elementu ulubionego odwołania.

Zwraca

Promise<GitRefFavorite>

getRefFavorites(string, string, string)

Pobiera ulubione odwołania dla repozytorium i tożsamości.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

repositoryId: string

Identyfikator repozytorium.

identityId: string

Identyfikator tożsamości, której ulubione mają zostać pobrane. Jeśli wartość null, używana jest żądana tożsamość.

Zwraca

Promise<GitRefFavorite[]>

getRefFavoritesForProject(string, string)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

identityId: string

Zwraca

Promise<GitRefFavorite[]>

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

Wysyła zapytanie do podanego repozytorium pod kątem jego refs i zwraca je.

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

Parametry

repositoryId: string

Nazwa lub identyfikator repozytorium.

project: string

Identyfikator projektu lub nazwa projektu

filter: string

[opcjonalnie] Filtr do zastosowania do refs (zaczyna się od).

includeLinks: boolean

[opcjonalnie] Określa, czy odwołaniaLinks powinny być uwzględnione w wyniku. wartość domyślna to false.

includeStatuses: boolean

[opcjonalnie] Obejmuje maksymalnie 1000 pierwszych stanów zatwierdzeń dla każdego odwołania. Wartość domyślna to false.

includeMyBranches: boolean

[opcjonalnie] Obejmuje tylko gałęzie, które użytkownik jest właścicielem, gałęzie ulubione użytkownika i gałąź domyślna. Wartość domyślna to false. Nie można połączyć z parametrem filtru.

latestStatusesOnly: boolean

[opcjonalnie] Wartość True, aby uwzględnić tylko stan zatwierdzenia porad dla każdego odwołania. Ta opcja wymaga, aby includeStatuses mieć wartość true. Wartość domyślna to false.

peelTags: boolean

[opcjonalnie] Tagi z adnotacjami wypełnią właściwość PeeledObjectId. wartość domyślna to false.

filterContains: string

[opcjonalnie] Filtr do zastosowania do refs (zawiera).

Zwraca

Promise<PagedList<GitRef>>

getRepositories(string, boolean, boolean, boolean)

Pobieranie repozytoriów git.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

includeLinks: boolean

[opcjonalnie] Wartość True do uwzględnienia linków referencyjnych. Wartość domyślna to false.

includeAllUrls: boolean

[opcjonalnie] Wartość True, aby uwzględnić wszystkie zdalne adresy URL. Wartość domyślna to false.

includeHidden: boolean

[opcjonalnie] Wartość True do uwzględnienia ukrytych repozytoriów. Wartość domyślna to false.

Zwraca

Promise<GitRepository[]>

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

Pobieranie repozytoriów git z filtrem według nazwy i stronicowania.

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

Parametry

projectId: string

Identyfikator lub nazwa projektu zespołowego.

includeLinks: boolean

[opcjonalnie] Wartość True do uwzględnienia linków referencyjnych. Wartość domyślna to false.

includeAllUrls: boolean

[opcjonalnie] Wartość True, aby uwzględnić wszystkie zdalne adresy URL. Wartość domyślna to false.

includeHidden: boolean

[opcjonalnie] Wartość True do uwzględnienia ukrytych repozytoriów. Wartość domyślna to false.

filterContains: string

[opcjonalnie] Filtr do zastosowania do refs (zawiera).

top: number

[opcjonalnie] Maksymalna liczba repozytoriów do zwrócenia. Nie może być większy niż 500. Jeśli nie zostanie podana, ale parametr continuationToken to , wartość domyślna to 100.

continuationToken: string

Token kontynuacji używany do stronicowania.

Zwraca

Promise<PagedList<GitRepository>>

getRepository(string, string)

Pobieranie repozytorium git.

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

Parametry

repositoryId: string

Nazwa lub identyfikator repozytorium.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<GitRepository>

getRepositoryWithParent(string, boolean, string)

Pobieranie repozytorium git.

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

Parametry

repositoryId: string

Nazwa lub identyfikator repozytorium.

includeParent: boolean

Wartość True do uwzględnienia repozytorium nadrzędnego. Dostępne tylko w uwierzytelnionych wywołaniach.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<GitRepository>

getRevert(string, number, string)

Pobierz informacje o operacji przywracania, przywracając identyfikator.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

revertId: number

Identyfikator operacji przywracania.

repositoryId: string

Identyfikator repozytorium.

Zwraca

Promise<GitRevert>

getRevertConflict(string, number, number, string)

Pobieranie jednego konfliktu dla przywracania według identyfikatora

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

Parametry

repositoryId: string

revertId: number

conflictId: number

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<GitConflict>

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

Pobieranie wszystkich konfliktów dla przywracania

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

Parametry

repositoryId: string

revertId: number

project: string

Identyfikator projektu lub nazwa projektu

continuationToken: string

top: number

excludeResolved: boolean

onlyResolved: boolean

includeObsolete: boolean

Zwraca

Promise<PagedList<GitConflict>>

getRevertForRefName(string, string, string)

Pobierz informacje o operacji przywracania dla określonej gałęzi.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

repositoryId: string

Identyfikator repozytorium.

refName: string

GitAsyncRefOperationParameters generatedRefName używany do operacji przywracania.

Zwraca

Promise<GitRevert>

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

Pobierz stany skojarzone z zatwierdzeniem usługi Git.

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

Parametry

commitId: string

Identyfikator zatwierdzenia usługi Git.

repositoryId: string

Identyfikator repozytorium.

project: string

Identyfikator projektu lub nazwa projektu

top: number

Fakultatywny. Liczba stanów do pobrania. Wartość domyślna to 1000.

skip: number

Fakultatywny. Liczba stanów do zignorowania. Wartość domyślna to 0. Na przykład aby pobrać wyniki 101-150, ustaw wartość 50 pierwszych i przejdź do wartości 100.

latestOnly: boolean

Flaga wskazuje, czy pobrać tylko najnowsze stany pogrupowane według Context.Name i Context.Genre.

Zwraca

Promise<GitStatus[]>

getSuggestions(string, string, boolean)

Pobierz sugestię żądania ściągnięcia dla określonego repozytorium lub projektu zespołowego.

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

Parametry

repositoryId: string

Identyfikator repozytorium git.

project: string

Identyfikator projektu lub nazwa projektu

preferCompareBranch: boolean

Jeśli wartość true, preferuj gałąź porównawczą w gałęzi domyślnej jako gałąź docelową dla żądań ściągnięcia.

Zwraca

Promise<GitSuggestion[]>

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

Pobierz wszystkie wątki w żądaniu ściągnięcia.

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

Parametry

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

project: string

Identyfikator projektu lub nazwa projektu

iteration: number

Jeśli określono, pozycje wątków będą śledzone przy użyciu tej iteracji jako prawej strony różnicy.

baseIteration: number

Jeśli określono, pozycje wątków będą śledzone przy użyciu tej iteracji jako lewej strony różnicy.

Zwraca

Promise<GitPullRequestCommentThread[]>

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

Punkt końcowy Drzewa zwraca kolekcję obiektów znajdujących się pod określonym drzewem. Drzewa to foldery w repozytorium Git.

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

Parametry

repositoryId: string

Identyfikator repozytorium.

sha1: string

Skrót SHA1 obiektu drzewa.

project: string

Identyfikator projektu lub nazwa projektu

projectId: string

Identyfikator projektu.

recursive: boolean

Wyszukiwanie cyklicznie. Uwzględnij drzewa pod tym drzewem. Wartość domyślna to false.

fileName: string

Nazwa do użycia, jeśli zostanie zwrócony plik .zip. Wartość domyślna to identyfikator obiektu.

Zwraca

Promise<GitTreeRef>

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

Punkt końcowy Drzewa zwraca kolekcję obiektów znajdujących się pod określonym drzewem. Drzewa to foldery w repozytorium Git.

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

Parametry

repositoryId: string

Identyfikator repozytorium.

sha1: string

Skrót SHA1 obiektu drzewa.

project: string

Identyfikator projektu lub nazwa projektu

projectId: string

Identyfikator projektu.

recursive: boolean

Wyszukiwanie cyklicznie. Uwzględnij drzewa pod tym drzewem. Wartość domyślna to false.

fileName: string

Nazwa do użycia, jeśli zostanie zwrócony plik .zip. Wartość domyślna to identyfikator obiektu.

Zwraca

Promise<ArrayBuffer>

queryImportRequests(string, string, boolean)

Pobieranie żądań importu dla repozytorium.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

repositoryId: string

Nazwa lub identyfikator repozytorium.

includeAbandoned: boolean

Wartość True w celu uwzględnienia porzuconych żądań importu w wynikach.

Zwraca

Promise<GitImportRequest[]>

restoreRepositoryFromRecycleBin(GitRecycleBinRepositoryDetails, string, string)

Odzyskiwanie nietrwałego repozytorium Git. Ostatnio usunięte repozytoria przechodzą w stan usuwania nietrwałego przez pewien czas, zanim zostaną one trwale usunięte i staną się nieodwracalne.

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

Parametry

repositoryDetails: GitRecycleBinRepositoryDetails

project: string

Identyfikator projektu lub nazwa projektu

repositoryId: string

Identyfikator repozytorium.

Zwraca

Promise<GitRepository>

setEnableOnCreateHost(boolean)

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

Parametry

enableOnCreateHost: boolean

Zwraca

Promise<void>

setEnableOnCreateProject(string, boolean)

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

Parametry

enableOnCreateProjectId: string

enableOnStatus: boolean

Zwraca

Promise<void>

sharePullRequest(ShareNotificationContext, string, number, string)

Wysyła powiadomienie e-mail dotyczące określonego żądania ściągnięcia do zestawu adresatów

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

Parametry

userMessage: ShareNotificationContext

repositoryId: string

Identyfikator repozytorium git.

pullRequestId: number

Identyfikator żądania ściągnięcia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<void>

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

Aktualizowanie rozwiązywania konfliktów scalania

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

Parametry

conflict: GitConflict

repositoryId: string

cherryPickId: number

conflictId: number

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<GitConflict>

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

Aktualizowanie wielu rozwiązań konfliktów scalania

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

Parametry

conflictUpdates: GitConflict[]

repositoryId: string

cherryPickId: number

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<GitConflictUpdateResult[]>

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

Zaktualizuj komentarz skojarzony z określonym wątkiem w żądaniu ściągnięcia.

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

Parametry

comment: Comment

Zawartość komentarza, która powinna zostać zaktualizowana. Komentarze mogą mieć maksymalnie 150 000 znaków.

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

threadId: number

Identyfikator wątku, w którego znajduje się żądany komentarz.

commentId: number

Identyfikator komentarza do aktualizacji.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<Comment>

updateEnablementStatus(AdvSecEnablementUpdate[])

Stan włączania POST dla repozytoriów.

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

Parametry

enablementUpdates: AdvSecEnablementUpdate[]

Zwraca

Promise<void>

updateImportRequest(GitImportRequest, string, string, number)

Ponów próbę lub porzucanie nieudanego żądania importu.

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

Parametry

importRequestToUpdate: GitImportRequest

Zaktualizowana wersja żądania importu. Obecnie jedyną dozwoloną zmianą jest ustawienie pozycji Stan na Stan w kolejce lub Porzucony.

project: string

Identyfikator projektu lub nazwa projektu

repositoryId: string

Nazwa lub identyfikator repozytorium.

importRequestId: number

Unikatowy identyfikator żądania importu do zaktualizowania.

Zwraca

Promise<GitImportRequest>

updatePullRequest(GitPullRequest, string, number, string)

Aktualizowanie żądania ściągnięcia

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

Parametry

gitPullRequestToUpdate: GitPullRequest

Zawartość żądania ściągnięcia, która ma zostać zaktualizowana.

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia do zaktualizowania.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<GitPullRequest>

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

Aktualizowanie rozwiązywania konfliktów scalania

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

Parametry

conflict: GitConflict

repositoryId: string

pullRequestId: number

conflictId: number

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<GitConflict>

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

Aktualizowanie wielu rozwiązań konfliktów scalania

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

Parametry

conflictUpdates: GitConflict[]

repositoryId: string

pullRequestId: number

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<GitConflictUpdateResult[]>

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

Aktualizowanie kolekcji stanów iteracji żądania ściągnięcia. Jedynym obsługiwanym typem operacji jest remove.

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

Parametry

patchDocument: JsonPatchDocument

Operacje stosowane do stanu żądania ściągnięcia w formacie JSON Patch.

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

iterationId: number

Identyfikator iteracji żądania ściągnięcia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<void>

updatePullRequestProperties(JsonPatchDocument, string, number, string)

Tworzenie lub aktualizowanie właściwości zewnętrznych żądania ściągnięcia. Operację stosowania poprawek można add, replace lub remove. W przypadku operacji add ścieżka może być pusta. Jeśli ścieżka jest pusta, wartość musi być listą par klucz-wartość. W przypadku operacji replace ścieżka nie może być pusta. Jeśli ścieżka nie istnieje, właściwość zostanie dodana do kolekcji. W przypadku operacji remove ścieżka nie może być pusta. Jeśli ścieżka nie istnieje, nie zostanie wykonana żadna akcja.

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

Parametry

patchDocument: JsonPatchDocument

Właściwości do dodawania, zastępowania lub usuwania w formacie poprawki JSON.

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<any>

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

Edytuj wpis recenzenta. Te pola można zastosować poprawki: isFlagged, hasDeclined

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

Parametry

reviewer: IdentityRefWithVote

Dane recenzenta.<br/>Jeśli w tym miejscu znajduje się identyfikator recenzenta, musi być zgodny z parametrem reviewerID.

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

reviewerId: string

Identyfikator recenzenta.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<IdentityRefWithVote>

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

Zresetuj głosy wielu recenzentów na żądanie ściągnięcia. UWAGA: ten punkt końcowy obsługuje tylko aktualizowanie głosów, ale nie obsługuje aktualizowania wymaganych recenzentów (użyj zasad) ani nazw wyświetlanych.

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

Parametry

patchVotes: IdentityRefWithVote[]

Identyfikatory recenzentów, których głosy zostaną zresetowane do zera

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<void>

updatePullRequestStatuses(JsonPatchDocument, string, number, string)

Aktualizowanie kolekcji stanów żądań ściągnięcia. Jedynym obsługiwanym typem operacji jest remove.

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

Parametry

patchDocument: JsonPatchDocument

Operacje stosowane do stanu żądania ściągnięcia w formacie JSON Patch.

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<void>

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

Blokowanie lub odblokowywanie gałęzi.

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

Parametry

newRefInfo: GitRefUpdate

Akcja aktualizacji ref (blokowanie/odblokowywanie) do wykonania

repositoryId: string

Nazwa lub identyfikator repozytorium.

filter: string

Nazwa gałęzi do blokowania/odblokowywania

project: string

Identyfikator projektu lub nazwa projektu

projectId: string

Identyfikator lub nazwa projektu zespołowego. Opcjonalnie, jeśli określono identyfikator repozytorium.

Zwraca

Promise<GitRef>

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

Tworzenie, aktualizowanie lub usuwanie elementów refs(gałęzi).

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

Parametry

refUpdates: GitRefUpdate[]

Lista aktualizacji ref do wykonania

repositoryId: string

Nazwa lub identyfikator repozytorium.

project: string

Identyfikator projektu lub nazwa projektu

projectId: string

Identyfikator lub nazwa projektu zespołowego. Opcjonalnie, jeśli określono identyfikator repozytorium.

Zwraca

Promise<GitRefUpdateResult[]>

updateRepository(GitRepository, string, string)

Aktualizuje repozytorium Git przy użyciu nowej nazwy repozytorium lub nowej gałęzi domyślnej.

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

Parametry

newRepositoryInfo: GitRepository

Określ nową nazwę repozytorium lub nową gałąź domyślną repozytorium

repositoryId: string

Identyfikator repozytorium.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<GitRepository>

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

Aktualizowanie rozwiązywania konfliktów scalania

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

Parametry

conflict: GitConflict

repositoryId: string

revertId: number

conflictId: number

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<GitConflict>

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

Aktualizowanie wielu rozwiązań konfliktów scalania

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

Parametry

conflictUpdates: GitConflict[]

repositoryId: string

revertId: number

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<GitConflictUpdateResult[]>

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

Zaktualizuj wątek w żądaniu ściągnięcia.

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

Parametry

commentThread: GitPullRequestCommentThread

Zawartość wątku, która powinna zostać zaktualizowana.

repositoryId: string

Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.

pullRequestId: number

Identyfikator żądania ściągnięcia.

threadId: number

Identyfikator wątku do zaktualizowania.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<GitPullRequestCommentThread>

Udostępnij za pośrednictwem

GitRestClient class

Konstruktory

Właściwości

Metody

Szczegóły konstruktora

GitRestClient(IVssRestClientOptions)

Parametry

Szczegóły właściwości

RESOURCE_AREA_ID

Wartość właściwości

Szczegóły metody

createAnnotatedTag(GitAnnotatedTag, string, string)

Parametry

Zwraca

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

Parametry

Zwraca

createCherryPick(GitAsyncRefOperationParameters, string, string)

Parametry

Zwraca

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

Parametry

Zwraca

createCommitStatus(GitStatus, string, string, string)

Parametry

Zwraca

createFavorite(GitRefFavorite, string)

Parametry

Zwraca

createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)

Parametry

Zwraca

createImportRequest(GitImportRequest, string, string)

Parametry

Zwraca

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

Parametry

Zwraca

createMergeRequest(GitMergeParameters, string, string, boolean)

Parametry

Zwraca

createPullRequest(GitPullRequest, string, string, boolean)

Parametry

Zwraca

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

Parametry

Zwraca

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

Parametry

Zwraca

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

Parametry

Zwraca

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

Parametry

Zwraca

createPullRequestStatus(GitPullRequestStatus, string, number, string)

Parametry

Zwraca

createPush(GitPush, string, string)

Parametry

Zwraca

createRepository(GitRepositoryCreateOptions, string, string)

Parametry

Zwraca

createRevert(GitAsyncRefOperationParameters, string, string)

Parametry

Zwraca

createThread(GitPullRequestCommentThread, string, number, string)

Parametry

Zwraca

createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)

Parametry

Zwraca

deleteAttachment(string, string, number, string)

Parametry

Zwraca

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

Parametry