GitRestClient class

Reference

Balíček:: azure-devops-extension-api

Základní třída, která by se měla používat (odvozená z) k vytváření požadavků na rozhraní REST api služby VSS

Extends: RestClientBase

Konstruktory

GitRestClient(IVssRestClientOptions)

Vlastnosti

RESOURCE_AREA_ID

Metody

createAnnotatedTag(GitAnnotatedTag, string, string)	Vytvořte značku s poznámkami.
createAttachment(any, string, string, number, string)	Připojení nového souboru k žádosti o přijetí změn
createCherryPick(GitAsyncRefOperationParameters, string, string)	Vyberte konkrétní potvrzení nebo potvrzení, která jsou přidružená k žádosti o přijetí změn do nové větve.
createComment(Comment, string, number, number, string)	Vytvoření komentáře ke konkrétnímu vláknu v žádosti o přijetí změn (v každém vlákně je možné vytvořit až 500 komentářů).
createCommitStatus(GitStatus, string, string, string)	Vytvořit stav potvrzení Gitu
createFavorite(GitRefFavorite, string)	Vytvoří oblíbenou položku odkazu.
createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)	Požádejte, aby se do tohoto úložiště načítá odkazy jiného úložiště. Synchronizuje dva existující forky. Pokud chcete vytvořit fork, projděte si <koncový bod< úložiště a href="https://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1">>
createImportRequest(GitImportRequest, string, string)	Vytvořte žádost o import.
createLike(string, number, number, number, string)	Přidání lajku ke komentáři
createMergeRequest(GitMergeParameters, string, string, boolean)	Vyžádejte si operaci sloučení Gitu. V současné době podporujeme sloučení pouze 2 potvrzení.
createPullRequest(GitPullRequest, string, string, boolean)	Vytvořte žádost o přijetí změn.
createPullRequestIterationStatus(GitPullRequestStatus, string, number, number, string)	Vytvořte stav žádosti o přijetí změn v iteraci. Tato operace bude mít stejný výsledek jako Stav vytvoření u žádosti o přijetí změn se zadaným ID iterace v textu požadavku.
createPullRequestLabel(WebApiCreateTagRequestData, string, number, string, string)	Vytvořte značku (pokud ještě neexistuje) a přidejte ji jako popisek (značku) pro zadanou žádost o přijetí změn. Jediným povinným polem je název nového popisku (značky).
createPullRequestReviewer(IdentityRefWithVote, string, number, string, string)	Přidání revidujícího k žádosti o přijetí změn nebo hlasování
createPullRequestReviewers(IdentityRef[], string, number, string)	Přidání revidujících k žádosti o přijetí změn
createPullRequestStatus(GitPullRequestStatus, string, number, string)	Vytvoření stavu žádosti o přijetí změn
createPush(GitPush, string, string)	Nasdílení změn do úložiště
createRepository(GitRepositoryCreateOptions, string, string)	Vytvořte úložiště Git v týmovém projektu.
createRevert(GitAsyncRefOperationParameters, string, string)	Spustí operaci a vytvoří novou větev, která vrátí změny provedené určitým potvrzením nebo potvrzeními přidruženými k žádosti o přijetí změn.
createThread(GitPullRequestCommentThread, string, number, string)	Vytvořte vlákno v žádosti o přijetí změn.
createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)	Přidejte nematerializovanou identitu kontrolorům žádosti o přijetí změn.
deleteAttachment(string, string, number, string)	Odstranění přílohy žádosti o přijetí změn
deleteComment(string, number, number, number, string)	Odstraňte komentář přidružený ke konkrétnímu vláknu v žádosti o přijetí změn.
deleteEnablementStatus(boolean, boolean, string[])	DELETE Odstraní stav povolení a fakturovatelná data z databáze. Odstraněním dat povolení se tato data pro ovlivněná úložiště deaktivují.
deleteLike(string, number, number, number, string)	Odstranění lajku u komentáře
deletePullRequestIterationStatus(string, number, number, number, string)	Odstranit stav iterace žádosti o přijetí změn
deletePullRequestLabels(string, number, string, string, string)	Odebere popisek (značku) ze sady těch, které jsou přiřazené k žádosti o přijetí změn. Samotná značka se neodstraní.
deletePullRequestReviewer(string, number, string, string)	Odebrání revidujícího ze žádosti o přijetí změn
deletePullRequestStatus(string, number, number, string)	Odstranit stav žádosti o přijetí změn
deleteRefFavorite(string, number)	Odstraní zadanou oblíbenou položku odkazů.
deleteRepository(string, string)	Odstranění úložiště Git
deleteRepositoryFromRecycleBin(string, string)	Zlikvidujte (pevně odstraňte) obnovitelně odstraněné úložiště Git.
getAnnotatedTag(string, string, string)	Získejte značku s poznámkami.
getAttachmentContent(string, string, number, string)	Získejte obsah souboru přílohy žádosti o přijetí změn.
getAttachments(string, number, string)	Získejte seznam souborů připojených k dané žádosti o přijetí změn.
getAttachmentZip(string, string, number, string)	Získejte obsah souboru přílohy žádosti o přijetí změn.
getBillableCommitters(string, Date, number, number)	Načtení skutečných fakturovatelných potvrzení pro službu Rozšířeného zabezpečení pro dané datum.
getBillableCommittersDetail(string, string, Date)	Načtení podrobných skutečných fakturovatelných potvrzení služby Advanced Security pro dané datum Podrobné výsledky záměrně nefiltrují obnovitelně odstraněné projekty a úložiště, aby pomohly diagnostikovat problémy s fakturací.
getBlob(string, string, string, boolean, string, boolean)	Získejte jeden objekt blob.
getBlobContent(string, string, string, boolean, string, boolean)	Získejte jeden objekt blob.
getBlobsZip(string[], string, string, string)	Získá jeden nebo více objektů blob ve stažení souboru ZIP.
getBlobZip(string, string, string, boolean, string, boolean)	Získejte jeden objekt blob.
getBranch(string, string, string, GitVersionDescriptor)	Načte statistiku o jedné větvi.
getBranches(string, string, GitVersionDescriptor)	Načte statistiky o všech větvích v úložišti.
getBranchStatsBatch(GitQueryBranchStatsCriteria, string, string)	Načtení statistik pro více potvrzení
getChanges(string, string, string, number, number)	Načte změny pro konkrétní potvrzení.
getCherryPick(string, number, string)	Načtěte informace o operaci výběru třešně pomocí ID výběru třešně.
getCherryPickConflict(string, number, number, string)	Načtení jednoho konfliktu pro výběr třešně podle ID
getCherryPickConflicts(string, number, string, string, number, boolean, boolean, boolean)	Načtení všech konfliktů pro výběr třešně
getCherryPickForRefName(string, string, string)	Načte informace o operaci výběru třešně pro konkrétní větev. Tato operace je nákladná kvůli základní struktuře objektů, takže toto rozhraní API sleduje pouze posledních 1 000 operací výběru třešně.
getCherryPickRelationships(string, string, string, boolean)	Když dostanete commitId, vrátí seznam potvrzení, která jsou ve stejné rodině cherry-pick.
getComment(string, number, number, number, string)	Načtěte komentář přidružený ke konkrétnímu vláknu v žádosti o přijetí změn.
getComments(string, number, number, string)	Načtěte všechny komentáře přidružené ke konkrétnímu vláknu v žádosti o přijetí změn.
getCommit(string, string, string, number)	Načte konkrétní potvrzení.
getCommitDiffs(string, string, boolean, number, number, GitBaseVersionDescriptor, GitTargetVersionDescriptor)	Vyhledejte nejbližší společné potvrzení (základ sloučení) mezi základním a cílovým potvrzením a získejte rozdíl mezi základním a cílovým potvrzením nebo mezi běžnými a cílovými potvrzeními.
getCommits(string, GitQueryCommitsCriteria, string)	Načtení potvrzení gitu pro projekt
getCommitsBatch(GitQueryCommitsCriteria, string, string, number, number, boolean)	Načtení potvrzení gitu pro projekt odpovídající kritériím hledání
getDeletedRepositories(string)	Načíst odstraněná úložiště Git.
getEnablementStatus(string[], Date, number, number)	GET Stav povolení pro úložiště projektu
getEnableOnCreateHost(boolean)
getEnableOnCreateProject(string)
getEstimatedBillableCommittersRepo(string, string)	Získejte odhadované fakturovatelné potvrzení pro úložiště za posledních 90 dnů.
getEstimatedBillablePushersOrg()	Získejte odhadované fakturovatelné odtlačení pro organizaci za posledních 90 dnů.
getEstimatedBillablePushersProject(string)	Získejte odhadované fakturovatelné protlačení pro projekt za posledních 90 dnů.
getFileDiffs(FileDiffsCriteria, string, string)	Získání rozdílů souborů pro každý ze zadaných souborů
getForks(string, string, string, boolean)	Načte všechny forky úložiště v kolekci.
getForkSyncRequest(string, number, string, boolean)	Získejte podrobnosti o konkrétní operaci synchronizace forku.
getForkSyncRequests(string, string, boolean, boolean)	Načíst všechny požadované operace synchronizace forku v tomto úložišti.
getHfsItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Získejte metadata nebo obsah položky pro jednu položku. Parametr download určuje, jestli má být obsah v odpovědi k dispozici jako stažený nebo jen poslaný jako stream. Nevztahuje se na komprimovaný obsah, který se vždy vrátí jako stažený obsah.
getHfsItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Získejte metadata nebo obsah položky pro jednu položku. Parametr download určuje, jestli má být obsah v odpovědi k dispozici jako stažený nebo jen poslaný jako stream. Nevztahuje se na komprimovaný obsah, který se vždy vrátí jako stažený obsah.
getHfsItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)	Načíst metadata nebo obsah položky pro kolekci položek. Parametr download určuje, jestli má být obsah v odpovědi k dispozici jako stažený nebo jen poslaný jako stream. Nevztahuje se na komprimovaný obsah, který se vždy vrátí jako stažený obsah.
getHfsItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Získejte metadata nebo obsah položky pro jednu položku. Parametr download určuje, jestli má být obsah v odpovědi k dispozici jako stažený nebo jen poslaný jako stream. Nevztahuje se na komprimovaný obsah, který se vždy vrátí jako stažený obsah.
getHfsItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Získejte metadata nebo obsah položky pro jednu položku. Parametr download označuje, jestli má být obsah v odpovědi dostupný jako soubor ke stažení, nebo jako datový proud. Nevztahuje se na komprimovaný obsah, který se vždy vrátí jako stažený obsah.
getImportRequest(string, string, number)	Načte konkrétní žádost o import.
getItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Získejte metadata nebo obsah položky pro jednu položku. Parametr download označuje, jestli má být obsah v odpovědi dostupný jako soubor ke stažení, nebo jako datový proud. Nevztahuje se na komprimovaný obsah, který se vždy vrátí jako stažený obsah.
getItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Získejte metadata nebo obsah položky pro jednu položku. Parametr download označuje, jestli má být obsah v odpovědi dostupný jako soubor ke stažení, nebo jako datový proud. Nevztahuje se na komprimovaný obsah, který se vždy vrátí jako stažený obsah.
getItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)	Načíst metadata položek nebo obsah pro kolekci položek Parametr download označuje, jestli má být obsah v odpovědi dostupný jako soubor ke stažení, nebo jako datový proud. Nevztahuje se na komprimovaný obsah, který se vždy vrací jako stažený obsah.
getItemsBatch(GitItemRequestData, string, string)	Publikování pro načtení dávky vytvoření ze sady položek v úložišti nebo projektu zadaném seznamem cest nebo dlouhou cestou
getItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Získejte metadata nebo obsah položky pro jednu položku. Parametr download označuje, jestli má být obsah v odpovědi dostupný jako soubor ke stažení, nebo jako datový proud. Nevztahuje se na komprimovaný obsah, který se vždy vrátí jako stažený obsah.
getItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Získejte metadata nebo obsah položky pro jednu položku. Parametr download označuje, jestli má být obsah v odpovědi dostupný jako soubor ke stažení, nebo jako datový proud. Nevztahuje se na komprimovaný obsah, který se vždy vrátí jako stažený obsah.
getLikes(string, number, number, number, string)	Získání lajků pro komentář
getMergeBases(string, string, string, string, string, string)	Vyhledejte slučovací základy dvou potvrzení, volitelně napříč forky. Pokud není zadán parametr otherRepositoryId, budou se základy sloučení počítat pouze v kontextu místního úložištěNameOrId.
getMergeRequest(string, string, number, boolean)	Získejte podrobnosti o konkrétní operaci sloučení.
getPermission(string, string, string)	ZÍSKAT stav oprávnění rozšířeného zabezpečení.
getPullRequest(string, number, string, number, number, number, boolean, boolean)	Načtěte žádost o přijetí změn.
getPullRequestById(number, string)	Načtěte žádost o přijetí změn.
getPullRequestCommits(string, number, string)	Získejte potvrzení pro zadanou žádost o přijetí změn.
getPullRequestConflict(string, number, number, string)	Načtení jednoho konfliktu pro žádost o přijetí změn podle ID
getPullRequestConflicts(string, number, string, number, number, boolean, boolean, boolean)	Načtení všech konfliktů pro žádost o přijetí změn
getPullRequestIteration(string, number, number, string)	Získejte zadanou iteraci pro žádost o přijetí změn.
getPullRequestIterationChanges(string, number, number, string, number, number, number)	Načtěte změny provedené v žádosti o přijetí změn mezi dvěma iteracemi.
getPullRequestIterationCommits(string, number, number, string, number, number)	Získejte potvrzení pro zadanou iteraci žádosti o přijetí změn.
getPullRequestIterations(string, number, string, boolean)	Získejte seznam iterací pro zadanou žádost o přijetí změn.
getPullRequestIterationStatus(string, number, number, number, string)	Získejte konkrétní stav iterace žádosti o přijetí změn podle ID. ID stavu je jedinečné v rámci žádosti o přijetí změn napříč všemi iteracemi.
getPullRequestIterationStatuses(string, number, number, string)	Získejte všechny stavy přidružené k iteraci žádosti o přijetí změn.
getPullRequestLabel(string, number, string, string, string)	Načte jeden popisek (značku), který byl přiřazen k žádosti o přijetí změn.
getPullRequestLabels(string, number, string, string)	Získejte všechny popisky (značky) přiřazené k žádosti o přijetí změn.
getPullRequestProperties(string, number, string)	Získejte externí vlastnosti žádosti o přijetí změn.
getPullRequestQuery(GitPullRequestQuery, string, string)	Toto rozhraní API slouží k vyhledání žádostí o přijetí změn souvisejících s daným potvrzením. Dá se použít k vyhledání žádosti o přijetí změn, která vytvořila konkrétní potvrzení sloučení, nebo k vyhledání všech žádostí o přijetí změn, které kdy sloučily konkrétní potvrzení. Vstup je seznam dotazů, z nichž každý obsahuje seznam potvrzení. Pro každé potvrzení, které hledáte, získáte zpět slovník potvrzení –> žádosti o přijetí změn.
getPullRequestReviewer(string, number, string, string)	Načtení informací o konkrétním revidujícím žádosti o přijetí změn
getPullRequestReviewers(string, number, string)	Načtení kontrolorů žádosti o přijetí změn
getPullRequests(string, GitPullRequestSearchCriteria, string, number, number, number)	Načtěte všechny žádosti o přijetí změn odpovídající zadaným kritériím.
getPullRequestsByProject(string, GitPullRequestSearchCriteria, number, number, number)	Načtěte všechny žádosti o přijetí změn odpovídající zadaným kritériím.
getPullRequestStatus(string, number, number, string)	Získejte konkrétní stav žádosti o přijetí změn podle ID. ID stavu je jedinečné v rámci žádosti o přijetí změn napříč všemi iteracemi.
getPullRequestStatuses(string, number, string)	Získejte všechny stavy přidružené k žádosti o přijetí změn.
getPullRequestThread(string, number, number, string, number, number)	Načtení vlákna v žádosti o přijetí změn
getPullRequestWorkItemRefs(string, number, string)	Načte seznam pracovních položek přidružených k žádosti o přijetí změn.
getPush(string, number, string, number, boolean)	Načte konkrétní nabízené oznámení.
getPushCommits(string, number, string, number, number, boolean)	Načte seznam potvrzení přidružených k určitému nabízenému oznámení.
getPushes(string, string, number, number, GitPushSearchCriteria)	Načte nabízená oznámení přidružená k zadanému úložišti.
getRecycleBinRepositories(string)	Načtěte obnovitelně odstraněná úložiště Git z koše.
getRefFavorite(string, number)	Získá odkazy oblíbené pro oblíbené ID.
getRefFavorites(string, string, string)	Získá oblíbené odkazy pro úložiště a identitu.
getRefFavoritesForProject(string, string)
getRefs(string, string, string, boolean, boolean, boolean, boolean, boolean, string)	Dotazuje zadané úložiště na jeho odkazy a vrátí je.
getRepositories(string, boolean, boolean, boolean)	Načtěte úložiště Git.
getRepository(string, string)	Načtěte úložiště Git.
getRepositoryWithParent(string, boolean, string)	Načtěte úložiště Git.
getRevert(string, number, string)	Načtěte informace o operaci vrácení zpět pomocí ID vrácení.
getRevertConflict(string, number, number, string)	Načtení jednoho konfliktu pro vrácení podle ID
getRevertConflicts(string, number, string, string, number, boolean, boolean, boolean)	Načtení všech konfliktů pro vrácení zpět
getRevertForRefName(string, string, string)	Načte informace o operaci vrácení pro konkrétní větev.
getStatuses(string, string, string, number, number, boolean)	Získejte stavy přidružené k potvrzení Gitu.
getSuggestions(string, string, boolean)	Načtěte návrh žádosti o přijetí změn pro konkrétní úložiště nebo týmový projekt.
getThreads(string, number, string, number, number)	Načtení všech vláken v žádosti o přijetí změn
getTree(string, string, string, string, boolean, string)	Koncový bod strom vrátí kolekci objektů pod zadaným stromem. Stromy jsou složky v úložišti Git.
getTreeZip(string, string, string, string, boolean, string)	Koncový bod strom vrátí kolekci objektů pod zadaným stromem. Stromy jsou složky v úložišti Git.
queryImportRequests(string, string, boolean)	Načtení žádostí o import pro úložiště
restoreRepositoryFromRecycleBin(GitRecycleBinRepositoryDetails, string, string)	Obnovení obnovitelného odstraněného úložiště Git Nedávno odstraněná úložiště přejdou na určitou dobu do stavu obnovitelného odstranění, než se trvale odstraní a stanou se neobnovitelnými.
setEnableOnCreateHost(boolean)
setEnableOnCreateProject(string, boolean)
sharePullRequest(ShareNotificationContext, string, number, string)	Odešle e-mailové oznámení o konkrétní žádosti o přijetí změn sadě příjemců.
updateCherryPickConflict(GitConflict, string, number, number, string)	Řešení konfliktů při slučování aktualizací
updateCherryPickConflicts(GitConflict[], string, number, string)	Aktualizace více řešení konfliktů při slučování
updateComment(Comment, string, number, number, number, string)	Aktualizujte komentář přidružený ke konkrétnímu vláknu v žádosti o přijetí změn.
updateEnablementStatus(AdvSecEnablementUpdate[])	Stav povolení POST pro úložiště
updateImportRequest(GitImportRequest, string, string, number)	Zkuste neúspěšnou žádost o import zopakovat nebo ji opustit.
updatePullRequest(GitPullRequest, string, number, string)	Aktualizace žádosti o přijetí změn
updatePullRequestConflict(GitConflict, string, number, number, string)	Řešení konfliktů při slučování aktualizací
updatePullRequestConflicts(GitConflict[], string, number, string)	Aktualizace více řešení konfliktů při slučování
updatePullRequestIterationStatuses(JsonPatchDocument, string, number, number, string)	Aktualizace shromažďování stavů iterace žádostí o přijetí změn Jediným podporovaným typem operace je `remove`.
updatePullRequestProperties(JsonPatchDocument, string, number, string)	Vytvořte nebo aktualizujte externí vlastnosti žádosti o přijetí změn. Operace opravy může být `add`, `replace` nebo `remove`. Pro `add` operaci může být cesta prázdná. Pokud je cesta prázdná, hodnota musí být seznamem párů hodnot klíčů. Pro `replace` operaci nemůže být cesta prázdná. Pokud cesta neexistuje, přidá se vlastnost do kolekce. Pro `remove` operaci nemůže být cesta prázdná. Pokud cesta neexistuje, neprovede se žádná akce.
updatePullRequestReviewer(IdentityRefWithVote, string, number, string, string)	Upravte položku revidujícího. Tato pole se dají opravit: isFlagged, hasDeclined
updatePullRequestReviewers(IdentityRefWithVote[], string, number, string)	Resetujte hlasy více revidujících u žádosti o přijetí změn. POZNÁMKA: Tento koncový bod podporuje pouze aktualizaci hlasů, ale nepodporuje aktualizaci požadovaných revidujících (zásady použití) ani zobrazovaných jmen.
updatePullRequestStatuses(JsonPatchDocument, string, number, string)	Aktualizace shromažďování stavů žádostí o přijetí změn Jediným podporovaným typem operace je `remove`.
updateRef(GitRefUpdate, string, string, string, string)	Zamknutí nebo odemknutí větve
updateRefs(GitRefUpdate[], string, string, string)	Vytváření, aktualizace nebo odstraňování odkazů (větví)
updateRepository(GitRepository, string, string)	Aktualizuje úložiště Git novým názvem úložiště nebo novou výchozí větví.
updateRevertConflict(GitConflict, string, number, number, string)	Řešení konfliktů při slučování aktualizací
updateRevertConflicts(GitConflict[], string, number, string)	Aktualizace více řešení konfliktů při slučování
updateThread(GitPullRequestCommentThread, string, number, number, string)	Aktualizujte vlákno v žádosti o přijetí změn.

Podrobnosti konstruktoru

GitRestClient(IVssRestClientOptions)

new GitRestClient(options: IVssRestClientOptions)

Parametry

options: IVssRestClientOptions

Podrobnosti vlastnosti

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Hodnota vlastnosti

string

Podrobnosti metody

createAnnotatedTag(GitAnnotatedTag, string, string)

Vytvořte značku s poznámkami.

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

Parametry

tagObject: GitAnnotatedTag

Objekt obsahující podrobnosti o značce, která má být vytvořena.

project: string

ID projektu nebo název projektu

repositoryId: string

ID nebo název úložiště.

Návraty

Promise<GitAnnotatedTag>

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

Připojení nového souboru k žádosti o přijetí změn

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

Parametry

content: any

Obsah k nahrání

fileName: string

Název souboru.

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn.

pullRequestId: number

ID žádosti o přijetí změn

project: string

ID projektu nebo název projektu

Návraty

Promise<Attachment>

createCherryPick(GitAsyncRefOperationParameters, string, string)

Vyberte konkrétní potvrzení nebo potvrzení, která jsou přidružená k žádosti o přijetí změn do nové větve.

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

Parametry

cherryPickToCreate: GitAsyncRefOperationParameters

project: string

ID projektu nebo název projektu

repositoryId: string

ID úložiště.

Návraty

Promise<GitCherryPick>

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

Vytvoření komentáře ke konkrétnímu vláknu v žádosti o přijetí změn (v každém vlákně je možné vytvořit až 500 komentářů).

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

Parametry

comment: Comment

Komentář, který chcete vytvořit. Komentáře můžou mít maximálně 150 000 znaků.

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn.

pullRequestId: number

ID žádosti o přijetí změn

threadId: number

ID vlákna, ve které se požadovaný komentář nachází.

project: string

ID projektu nebo název projektu

Návraty

Promise<Comment>

createCommitStatus(GitStatus, string, string, string)

Vytvořit stav potvrzení Gitu

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

Parametry

gitCommitStatusToCreate: GitStatus

Objekt stavu potvrzení Gitu, který se má vytvořit.

commitId: string

ID potvrzení Gitu

repositoryId: string

ID úložiště.

project: string

ID projektu nebo název projektu

Návraty

Promise<GitStatus>

createFavorite(GitRefFavorite, string)

Vytvoří oblíbenou položku odkazu.

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

Parametry

favorite: GitRefFavorite

Oblíbená položka odkazu, která se má vytvořit.

project: string

ID projektu nebo název projektu

Návraty

Promise<GitRefFavorite>

createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)

Požádejte, aby se do tohoto úložiště načítá odkazy jiného úložiště. Synchronizuje dva existující forky. Pokud chcete vytvořit fork, projděte si <koncový bod< úložiště a href="https://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1">>

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

Parametry

syncParams: GitForkSyncRequestParameters

Zdrojové úložiště a mapování odkazů.

repositoryNameOrId: string

Název nebo ID úložiště.

project: string

ID projektu nebo název projektu

includeLinks: boolean

True to include links

Návraty

Promise<GitForkSyncRequest>

createImportRequest(GitImportRequest, string, string)

Vytvořte žádost o import.

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

Parametry

importRequest: GitImportRequest

Žádost o import, která se má vytvořit.

project: string

ID projektu nebo název projektu

repositoryId: string

Název nebo ID úložiště.

Návraty

Promise<GitImportRequest>

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

Přidání lajku ke komentáři

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

Parametry

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn.

pullRequestId: number

ID žádosti o přijetí změn

threadId: number

ID vlákna, které obsahuje komentář.

commentId: number

ID komentáře.

project: string

ID projektu nebo název projektu

Návraty

Promise<void>

createMergeRequest(GitMergeParameters, string, string, boolean)

Vyžádejte si operaci sloučení Gitu. V současné době podporujeme sloučení pouze 2 potvrzení.

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

Parametry

mergeParameters: GitMergeParameters

Nadřazené commitIds a sloučení commit messsage.

project: string

ID projektu nebo název projektu

repositoryNameOrId: string

Název nebo ID úložiště.

includeLinks: boolean

True to include links

Návraty

Promise<GitMerge>

createPullRequest(GitPullRequest, string, string, boolean)

Vytvořte žádost o přijetí změn.

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

Parametry

gitPullRequestToCreate: GitPullRequest

Žádost o přijetí změn, která se má vytvořit.

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn.

project: string

ID projektu nebo název projektu

supportsIterations: boolean

Pokud je true, následná nasdílení změn do žádosti o přijetí změn se dají jednotlivě kontrolovat. U velkých žádostí o přijetí změn z důvodu výkonu nastavte tuto hodnotu na false, pokud tato funkce není potřeba.

Návraty

Promise<GitPullRequest>

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

Vytvořte stav žádosti o přijetí změn v iteraci. Tato operace bude mít stejný výsledek jako Stav vytvoření u žádosti o přijetí změn se zadaným ID iterace v textu požadavku.

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

Parametry

status: GitPullRequestStatus

Stav žádosti o přijetí změn, který se má vytvořit.

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn.

pullRequestId: number

ID žádosti o přijetí změn

iterationId: number

ID iterace žádosti o přijetí změn

project: string

ID projektu nebo název projektu

Návraty

Promise<GitPullRequestStatus>

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

Vytvořte značku (pokud ještě neexistuje) a přidejte ji jako popisek (značku) pro zadanou žádost o přijetí změn. Jediným povinným polem je název nového popisku (značky).

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

Parametry

label: WebApiCreateTagRequestData

Popisek, který chcete přiřadit k žádosti o přijetí změn.

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn.

pullRequestId: number

ID žádosti o přijetí změn

project: string

ID projektu nebo název projektu

projectId: string

ID projektu nebo název projektu.

Návraty

Promise<WebApiTagDefinition>

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

Přidání revidujícího k žádosti o přijetí změn nebo hlasování

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

Parametry

reviewer: IdentityRefWithVote

Hlasování revidujícího.<br />Pokud je zde id revidujícího zahrnuto, musí odpovídat parametru reviewerID.<Br />Reviewers mohou pomocí této metody nastavit své vlastní hlasy. Při přidávání dalších revidujících musí být hlas nastaven na nulu.

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn.

pullRequestId: number

ID žádosti o přijetí změn

reviewerId: string

ID revidujícího.

project: string

ID projektu nebo název projektu

Návraty

Promise<IdentityRefWithVote>

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

Přidání revidujících k žádosti o přijetí změn

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

Parametry

reviewers: IdentityRef[]

Revidující, kteří se mají přidat do žádosti o přijetí změn.

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn.

pullRequestId: number

ID žádosti o přijetí změn

project: string

ID projektu nebo název projektu

Návraty

Promise<IdentityRefWithVote[]>

createPullRequestStatus(GitPullRequestStatus, string, number, string)

Vytvoření stavu žádosti o přijetí změn

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

Parametry

status: GitPullRequestStatus

Stav žádosti o přijetí změn, který se má vytvořit.

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn.

pullRequestId: number

ID žádosti o přijetí změn

project: string

ID projektu nebo název projektu

Návraty

Promise<GitPullRequestStatus>

createPush(GitPush, string, string)

Nasdílení změn do úložiště

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

Parametry

push: GitPush

repositoryId: string

Název nebo ID úložiště.

project: string

ID projektu nebo název projektu

Návraty

Promise<GitPush>

createRepository(GitRepositoryCreateOptions, string, string)

Vytvořte úložiště Git v týmovém projektu.

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

Parametry

gitRepositoryToCreate: GitRepositoryCreateOptions

Zadejte název úložiště, týmový projekt nebo nadřazené úložiště. Informace o týmovém projektu je možné z gitRepositoryToCreate vynechat, pokud je požadavek vymezený na projekt (tj. zahrnuje ID projektu).

project: string

ID projektu nebo název projektu

sourceRef: string

[volitelné] Určení zdrojových odkazů, které se mají použít při vytváření úložiště forku

Návraty

Promise<GitRepository>

createRevert(GitAsyncRefOperationParameters, string, string)

Spustí operaci a vytvoří novou větev, která vrátí změny provedené určitým potvrzením nebo potvrzeními přidruženými k žádosti o přijetí změn.

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

Parametry

revertToCreate: GitAsyncRefOperationParameters

project: string

ID projektu nebo název projektu

repositoryId: string

ID úložiště.

Návraty

Promise<GitRevert>

createThread(GitPullRequestCommentThread, string, number, string)

Vytvořte vlákno v žádosti o přijetí změn.

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

Parametry

commentThread: GitPullRequestCommentThread

Vlákno, které chcete vytvořit. Vlákno musí obsahovat alespoň jeden komentář.

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn

pullRequestId: number

ID žádosti o přijetí změn

project: string

ID projektu nebo název projektu

Návraty

Promise<GitPullRequestCommentThread>

createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)

Přidejte nematerializovanou identitu kontrolorům žádosti o přijetí změn.

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

Parametry

reviewer: IdentityRefWithVote

Revidující, který přidá do žádosti o přijetí změn.

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn.

pullRequestId: number

ID žádosti o přijetí změn

project: string

ID projektu nebo název projektu

Návraty

Promise<IdentityRefWithVote>

deleteAttachment(string, string, number, string)

Odstranění přílohy žádosti o přijetí změn

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

Parametry

fileName: string

Název přílohy, která se má odstranit.

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn.

pullRequestId: number

ID žádosti o přijetí změn

project: string

ID projektu nebo název projektu

Návraty

Promise<void>

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

Odstraňte komentář přidružený ke konkrétnímu vláknu v žádosti o přijetí změn.

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

Parametry

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn.

pullRequestId: number

ID žádosti o přijetí změn

threadId: number

ID vlákna, ve které se požadovaný komentář nachází.

commentId: number

ID komentáře.

project: string

ID projektu nebo název projektu

Návraty

Promise<void>

deleteEnablementStatus(boolean, boolean, string[])

DELETE Odstraní stav povolení a fakturovatelná data z databáze. Odstraněním dat povolení se tato data pro ovlivněná úložiště deaktivují.

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

Parametry

allProjects: boolean

includeBillableCommitters: boolean

projectIds: string[]

Návraty

Promise<void>

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

Odstranění lajku u komentáře

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

Parametry

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn.

pullRequestId: number

ID žádosti o přijetí změn

threadId: number

ID vlákna, které obsahuje komentář.

commentId: number

ID komentáře.

project: string

ID projektu nebo název projektu

Návraty

Promise<void>

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

Odstranit stav iterace žádosti o přijetí změn

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

Parametry

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn.

pullRequestId: number

ID žádosti o přijetí změn

iterationId: number

ID iterace žádosti o přijetí změn

statusId: number

ID stavu žádosti o přijetí změn

project: string

ID projektu nebo název projektu

Návraty

Promise<void>

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

Odebere popisek (značku) ze sady těch, které jsou přiřazené k žádosti o přijetí změn. Samotná značka se neodstraní.

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

Parametry

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn.

pullRequestId: number

ID žádosti o přijetí změn

labelIdOrName: string

Název nebo ID požadovaného popisku.

project: string

ID projektu nebo název projektu

projectId: string

ID projektu nebo název projektu.

Návraty

Promise<void>

deletePullRequestReviewer(string, number, string, string)

Odebrání revidujícího ze žádosti o přijetí změn

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

Parametry

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn.

pullRequestId: number

ID žádosti o přijetí změn

reviewerId: string

ID revidujícího, který se má odebrat.

project: string

ID projektu nebo název projektu

Návraty

Promise<void>

deletePullRequestStatus(string, number, number, string)

Odstranit stav žádosti o přijetí změn

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

Parametry

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn.

pullRequestId: number

ID žádosti o přijetí změn

statusId: number

ID stavu žádosti o přijetí změn

project: string

ID projektu nebo název projektu

Návraty

Promise<void>

deleteRefFavorite(string, number)

Odstraní zadanou oblíbenou položku odkazů.

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

Parametry

project: string

ID projektu nebo název projektu

favoriteId: number

ID oblíbené položky odkazu, která se má odstranit.

Návraty

Promise<void>

deleteRepository(string, string)

Odstranění úložiště Git

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

Parametry

repositoryId: string

ID úložiště.

project: string

ID projektu nebo název projektu

Návraty

Promise<void>

deleteRepositoryFromRecycleBin(string, string)

Zlikvidujte (pevně odstraňte) obnovitelně odstraněné úložiště Git.

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

Parametry

project: string

ID projektu nebo název projektu

repositoryId: string

ID úložiště.

Návraty

Promise<void>

getAnnotatedTag(string, string, string)

Získejte značku s poznámkami.

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

Parametry

project: string

ID projektu nebo název projektu

repositoryId: string

ID nebo název úložiště.

objectId: string

ObjectId (Sha1Id) značky k získání.

Návraty

Promise<GitAnnotatedTag>

getAttachmentContent(string, string, number, string)

Získejte obsah souboru přílohy žádosti o přijetí změn.

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

Parametry

fileName: string

Název přílohy.

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn.

pullRequestId: number

ID žádosti o přijetí změn

project: string

ID projektu nebo název projektu

Návraty

Promise<ArrayBuffer>

getAttachments(string, number, string)

Získejte seznam souborů připojených k dané žádosti o přijetí změn.

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

Parametry

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn.

pullRequestId: number

ID žádosti o přijetí změn

project: string

ID projektu nebo název projektu

Návraty

Promise<Attachment[]>

getAttachmentZip(string, string, number, string)

Získejte obsah souboru přílohy žádosti o přijetí změn.

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

Parametry

fileName: string

Název přílohy.

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn.

pullRequestId: number

ID žádosti o přijetí změn

project: string

ID projektu nebo název projektu

Návraty

Promise<ArrayBuffer>

getBillableCommitters(string, Date, number, number)

Načtení skutečných fakturovatelných potvrzení pro službu Rozšířeného zabezpečení pro dané datum.

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

Parametry

project: string

ID projektu nebo název projektu

billingDate: Date

Byl očekáváno UTC. Pokud není zadaný, použije se výchozí hodnota k předchozímu fakturačnímu dni.

skip: number

Přeskočení X řádků sady výsledků pro simulaci stránkování

take: number

Vrácení řádků Y sady výsledků pro simulaci stránkování

Návraty

Promise<BillableCommitter[]>

getBillableCommittersDetail(string, string, Date)

Načtení podrobných skutečných fakturovatelných potvrzení služby Advanced Security pro dané datum Podrobné výsledky záměrně nefiltrují obnovitelně odstraněné projekty a úložiště, aby pomohly diagnostikovat problémy s fakturací.

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

Parametry

project: string

ID projektu nebo název projektu

includeDetails: string

Vrátí všechny podrobnosti o fakturovatelných potvrzeních.

billingDate: Date

Byl očekáváno UTC. Pokud není zadaný, použije se výchozí hodnota k předchozímu fakturačnímu dni.

Návraty

Promise<BillableCommitterDetail[]>

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

Získejte jeden objekt blob.

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

Parametry

repositoryId: string

Název nebo ID úložiště.

sha1: string

Sha1 hodnota hash souboru. Sha1 souboru můžete získat pomocí koncového bodu Git/Items/Get Item.

project: string

ID projektu nebo název projektu

download: boolean

Pokud je hodnota true, místo vykreslení v prohlížeči vyzývejte ke stažení. Poznámka: Tato hodnota je ve výchozím nastavení true, pokud je $format zip.

fileName: string

Zadejte fileName, který se má použít ke stažení.

resolveLfs: boolean

Pokud je hodnota true, zkuste přeložit objekt blob na jeho obsah LFS, pokud se jedná o soubor ukazatele LFS. Kompatibilní pouze s oktet-stream přijmout hlavičky nebo typy $format

Návraty

Promise<GitBlobRef>

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

Získejte jeden objekt blob.

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

Parametry

repositoryId: string

Název nebo ID úložiště.

sha1: string

Sha1 hodnota hash souboru. Sha1 souboru můžete získat pomocí koncového bodu Git/Items/Get Item.

project: string

ID projektu nebo název projektu

download: boolean

Pokud je hodnota true, místo vykreslení v prohlížeči vyzývejte ke stažení. Poznámka: Tato hodnota je ve výchozím nastavení true, pokud je $format zip.

fileName: string

Zadejte fileName, který se má použít ke stažení.

resolveLfs: boolean

Pokud je pravda, zkuste přeložit objekt blob na jeho obsah LFS, pokud se jedná o soubor ukazatele LFS. Kompatibilní pouze s oktetovými datovými proudy Přijmout hlavičky nebo typy $format

Návraty

Promise<ArrayBuffer>

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

Získá jeden nebo více objektů blob ve stažení souboru ZIP.

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

Parametry

blobIds: string[]

ID objektů blob (hodnoty hash SHA1), které se mají vrátit do souboru ZIP.

repositoryId: string

Název nebo ID úložiště.

project: string

ID projektu nebo název projektu

filename: string

Návraty

Promise<ArrayBuffer>

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

Získejte jeden objekt blob.

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

Parametry

repositoryId: string

Název nebo ID úložiště.

sha1: string

Sha1 hash souboru. Sha1 souboru můžete získat pomocí koncového bodu Git/Items/Get Item.

project: string

ID projektu nebo název projektu

download: boolean

Pokud ano, místo vykreslování v prohlížeči se zobrazí výzva ke stažení. Poznámka: Tato hodnota má výchozí hodnotu true, pokud je $format zip.

fileName: string

Zadejte fileName, který se má použít ke stažení.

resolveLfs: boolean

Pokud je pravda, zkuste přeložit objekt blob na jeho obsah LFS, pokud se jedná o soubor ukazatele LFS. Kompatibilní pouze s oktetovými datovými proudy Přijmout hlavičky nebo typy $format

Návraty

Promise<ArrayBuffer>

getBranch(string, string, string, GitVersionDescriptor)

Načte statistiku o jedné větvi.

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

Parametry

repositoryId: string

Název nebo ID úložiště.

name: string

Název větve.

project: string

ID projektu nebo název projektu

baseVersionDescriptor: GitVersionDescriptor

Identifikuje potvrzení nebo větev, která se má použít jako základ.

Návraty

Promise<GitBranchStats>

getBranches(string, string, GitVersionDescriptor)

Načte statistiky o všech větvích v úložišti.

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

Parametry

repositoryId: string

Název nebo ID úložiště.

project: string

ID projektu nebo název projektu

baseVersionDescriptor: GitVersionDescriptor

Identifikuje potvrzení nebo větev, která se má použít jako základ.

Návraty

Promise<GitBranchStats[]>

getBranchStatsBatch(GitQueryBranchStatsCriteria, string, string)

Načtení statistik pro více potvrzení

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

Parametry

searchCriteria: GitQueryBranchStatsCriteria

Základní potvrzení a seznam cílových potvrzení k porovnání.

repositoryId: string

Název nebo ID úložiště.

project: string

ID projektu nebo název projektu

Návraty

Promise<GitBranchStats[]>

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

Načte změny pro konkrétní potvrzení.

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

Parametry

commitId: string

ID potvrzení.

repositoryId: string

ID nebo popisný název úložiště. Pokud chcete použít popisný název, musí být zadáno také projectId.

project: string

ID projektu nebo název projektu

top: number

Maximální počet změn, které se mají vrátit.

skip: number

Počet změn, které se mají přeskočit.

Návraty

Promise<GitCommitChanges>

getCherryPick(string, number, string)

Načtěte informace o operaci výběru třešně pomocí ID výběru třešně.

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

Parametry

project: string

ID projektu nebo název projektu

cherryPickId: number

ID třešňového výběru.

repositoryId: string

ID úložiště.

Návraty

Promise<GitCherryPick>

getCherryPickConflict(string, number, number, string)

Načtení jednoho konfliktu pro výběr třešně podle ID

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

Parametry

repositoryId: string

cherryPickId: number

conflictId: number

project: string

ID projektu nebo název projektu

Návraty

Promise<GitConflict>

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

Načtení všech konfliktů pro výběr třešně

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

ID projektu nebo název projektu

continuationToken: string

top: number

excludeResolved: boolean

onlyResolved: boolean

includeObsolete: boolean

Návraty

Promise<PagedList<GitConflict>>

getCherryPickForRefName(string, string, string)

Načte informace o operaci výběru třešně pro konkrétní větev. Tato operace je nákladná kvůli základní struktuře objektů, takže toto rozhraní API sleduje pouze posledních 1 000 operací výběru třešně.

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

Parametry

project: string

ID projektu nebo název projektu

repositoryId: string

ID úložiště.

refName: string

GitAsyncRefOperationParameters vygenerovalRefName, který se používá pro operaci výběru třešně.

Návraty

Promise<GitCherryPick>

getCherryPickRelationships(string, string, string, boolean)

Když dostanete commitId, vrátí seznam potvrzení, která jsou ve stejné rodině cherry-pick.

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

Parametry

repositoryNameOrId: string

commitId: string

project: string

ID projektu nebo název projektu

includeLinks: boolean

Návraty

Promise<GitCommitRef[]>

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

Načtěte komentář přidružený ke konkrétnímu vláknu v žádosti o přijetí změn.

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

Parametry

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn

pullRequestId: number

ID žádosti o přijetí změn

threadId: number

ID vlákna, ve které se požadovaný komentář nachází.

commentId: number

ID komentáře.

project: string

ID projektu nebo název projektu

Návraty

Promise<Comment>

getComments(string, number, number, string)

Načtěte všechny komentáře přidružené ke konkrétnímu vláknu v žádosti o přijetí změn.

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

Parametry

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn

pullRequestId: number

ID žádosti o přijetí změn

threadId: number

ID vlákna.

project: string

ID projektu nebo název projektu

Návraty

Promise<Comment[]>

getCommit(string, string, string, number)

Načte konkrétní potvrzení.

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

Parametry

commitId: string

ID potvrzení.

repositoryId: string

ID nebo popisný název úložiště. Pokud chcete použít popisný název, musí být zadáno také projectId.

project: string

ID projektu nebo název projektu

changeCount: number

Počet změn, které se mají zahrnout do výsledku.

Návraty

Promise<GitCommit>

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

Vyhledejte nejbližší společné potvrzení (základ sloučení) mezi základním a cílovým potvrzením a získejte rozdíl mezi základním a cílovým potvrzením nebo mezi běžnými a cílovými potvrzeními.

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

Parametry

repositoryId: string

Název nebo ID úložiště.

project: string

ID projektu nebo název projektu

diffCommonCommit: boolean

Pokud je pravda, rozdíl mezi běžnými a cílovými potvrzeními. Pokud je false, rozdíl mezi základním a cílovým potvrzením.

top: number

Maximální počet vrácených změn Výchozí hodnota je 100.

skip: number

Počet změn, které se mají přeskočit

baseVersionDescriptor: GitBaseVersionDescriptor

Popisovač pro základní potvrzení.

targetVersionDescriptor: GitTargetVersionDescriptor

Popisovač pro potvrzení cíle.

Návraty

Promise<GitCommitDiffs>

getCommits(string, GitQueryCommitsCriteria, string)

Načtení potvrzení gitu pro projekt

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

Parametry

repositoryId: string

ID nebo popisný název úložiště. Pokud chcete použít popisný název, musí být zadáno také projectId.

searchCriteria: GitQueryCommitsCriteria

project: string

ID projektu nebo název projektu

Návraty

Promise<GitCommitRef[]>

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

Načtení potvrzení gitu pro projekt odpovídající kritériím hledání

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

Parametry

searchCriteria: GitQueryCommitsCriteria

Možnosti hledání

repositoryId: string

Název nebo ID úložiště.

project: string

ID projektu nebo název projektu

skip: number

Počet potvrzení, která se mají přeskočit Hodnota nesmí překročit 3 000 000.

top: number

Maximální počet potvrzení, která se mají vrátit. Hodnota nesmí překročit 50 000.

includeStatuses: boolean

True, pokud chcete zahrnout další informace o stavu potvrzení.

Návraty

Promise<GitCommitRef[]>

getDeletedRepositories(string)

Načíst odstraněná úložiště Git.

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

Parametry

project: string

ID projektu nebo název projektu

Návraty

Promise<GitDeletedRepository[]>

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

GET Stav povolení pro úložiště projektu

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

Parametry

projectIds: string[]

Výchozí hodnota null pro všechny projekty v hostiteli, seznam stavu úložišť projektu, který se má vrátit

billingDate: Date

Očekává se UTC, výchozí hodnota Null je UtcNow(), je možné zadat pro stav k určitému bodu v čase.

skip: number

Pokud chcete simulovat stránkování, přeskočte X řádků sady výsledků.

take: number

Vrácení řádků Y sady výsledků pro simulaci stránkování

Návraty

Promise<AdvSecEnablementStatus[]>

getEnableOnCreateHost(boolean)

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

Parametry

enableOnCreateHost: boolean

Návraty

Promise<boolean>

getEnableOnCreateProject(string)

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

Parametry

enableOnCreateProjectId: string

Návraty

Promise<boolean>

getEstimatedBillableCommittersRepo(string, string)

Získejte odhadované fakturovatelné potvrzení pro úložiště za posledních 90 dnů.

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

Parametry

project: string

ID projektu nebo název projektu

repositoryId: string

Návraty

Promise<BillableCommitter[]>

getEstimatedBillablePushersOrg()

Získejte odhadované fakturovatelné odtlačení pro organizaci za posledních 90 dnů.

function getEstimatedBillablePushersOrg(): Promise<BillablePusher[]>

Návraty

Promise<BillablePusher[]>

getEstimatedBillablePushersProject(string)

Získejte odhadované fakturovatelné protlačení pro projekt za posledních 90 dnů.

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

Parametry

project: string

ID projektu nebo název projektu

Návraty

Promise<BillablePusher[]>

getFileDiffs(FileDiffsCriteria, string, string)

Získání rozdílů souborů pro každý ze zadaných souborů

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

Parametry

fileDiffsCriteria: FileDiffsCriteria

Seznam objektů parametrů souboru

project: string

ID projektu nebo název projektu

repositoryId: string

Název nebo ID úložiště

Návraty

Promise<FileDiff[]>

getForks(string, string, string, boolean)

Načte všechny forky úložiště v kolekci.

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

Parametry

repositoryNameOrId: string

Název nebo ID úložiště.

collectionId: string

ID kolekce týmového projektu.

project: string

ID projektu nebo název projektu

includeLinks: boolean

True, pokud chcete zahrnout odkazy.

Návraty

Promise<GitRepositoryRef[]>

getForkSyncRequest(string, number, string, boolean)

Získejte podrobnosti o konkrétní operaci synchronizace forku.

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

Parametry

repositoryNameOrId: string

Název nebo ID úložiště.

forkSyncOperationId: number

OperationId požadavku na synchronizaci.

project: string

ID projektu nebo název projektu

includeLinks: boolean

True, pokud chcete zahrnout odkazy.

Návraty

Promise<GitForkSyncRequest>

getForkSyncRequests(string, string, boolean, boolean)

Načíst všechny požadované operace synchronizace forku v tomto úložišti.

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

Parametry

repositoryNameOrId: string

Název nebo ID úložiště.

project: string

ID projektu nebo název projektu

includeAbandoned: boolean

True, pokud chcete zahrnout opuštěné požadavky.

includeLinks: boolean

True, pokud chcete zahrnout odkazy.

Návraty

Promise<GitForkSyncRequest[]>

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

Získejte metadata nebo obsah položky pro jednu položku. Parametr download určuje, jestli má být obsah v odpovědi k dispozici jako stažený nebo jen poslaný jako stream. Nevztahuje se na komprimovaný obsah, který se vždy vrátí jako stažený obsah.

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

Název nebo ID úložiště.

path: string

Cesta k položce

project: string

ID projektu nebo název projektu

scopePath: string

Obor cesty. Výchozí hodnota je null.

recursionLevel: VersionControlRecursionType

Úroveň rekurze tohoto požadavku. Výchozí hodnota je žádná, žádná rekurze.

includeContentMetadata: boolean

Pokud chcete zahrnout metadata obsahu, nastavte na hodnotu true. Výchozí hodnota je false.

latestProcessedChange: boolean

Pokud chcete zahrnout nejnovější změny, nastavte na hodnotu true. Výchozí hodnota je false.

download: boolean

Nastavte na true, aby se odpověď stáhla jako soubor. Výchozí hodnota je false.

versionDescriptor: GitVersionDescriptor

Popisovač verze. Výchozí větev úložiště je výchozí.

includeContent: boolean

Nastavte na true, pokud chcete zahrnout obsah položky při žádosti o json. Výchozí hodnota je false.

resolveHfs: boolean

Nastavte na hodnotu true, pokud chcete přeložit soubory ukazatele Git HFS tak, aby vracely skutečný obsah z Git HFS. Platí výchozí hodnota.

sanitize: boolean

Pokud chcete soubor svg sanitizovat a vrátit ho jako obrázek, nastavte na hodnotu true. Užitečné pouze v případě, že se požaduje pro soubor SVG. Výchozí hodnota je false.

Návraty

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

Název nebo ID úložiště.

path: string

Cesta k položce

project: string

ID projektu nebo název projektu

scopePath: string

Obor cesty. Výchozí hodnota je null.

recursionLevel: VersionControlRecursionType

Úroveň rekurze tohoto požadavku. Výchozí hodnota je žádná, žádná rekurze.

includeContentMetadata: boolean

Pokud chcete zahrnout metadata obsahu, nastavte na hodnotu true. Výchozí hodnota je false.

latestProcessedChange: boolean

Pokud chcete zahrnout nejnovější změny, nastavte na hodnotu true. Výchozí hodnota je false.

download: boolean

Nastavte na true, aby se odpověď stáhla jako soubor. Výchozí hodnota je false.

versionDescriptor: GitVersionDescriptor

Popisovač verze. Výchozí větev úložiště je výchozí.

includeContent: boolean

Nastavte na true, pokud chcete zahrnout obsah položky při žádosti o json. Výchozí hodnota je false.

resolveHfs: boolean

Nastavte na hodnotu true, pokud chcete přeložit soubory ukazatele Git HFS tak, aby vracely skutečný obsah z Git HFS. Platí výchozí hodnota.

sanitize: boolean

Pokud chcete soubor svg sanitizovat a vrátit ho jako obrázek, nastavte na hodnotu true. Užitečné pouze v případě, že se požaduje pro soubor SVG. Výchozí hodnota je false.

Návraty

Promise<ArrayBuffer>

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

Načíst metadata nebo obsah položky pro kolekci položek. Parametr download určuje, jestli má být obsah v odpovědi k dispozici jako stažený nebo jen poslaný jako stream. Nevztahuje se na komprimovaný obsah, který se vždy vrátí jako stažený obsah.

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

Název nebo ID úložiště.

project: string

ID projektu nebo název projektu

scopePath: string

Obor cesty. Výchozí hodnota je null.

recursionLevel: VersionControlRecursionType

Úroveň rekurze tohoto požadavku. Výchozí hodnota je žádná, žádná rekurze.

includeContentMetadata: boolean

Pokud chcete zahrnout metadata obsahu, nastavte na hodnotu true. Výchozí hodnota je false.

latestProcessedChange: boolean

Pokud chcete zahrnout nejnovější změny, nastavte na hodnotu true. Výchozí hodnota je false.

download: boolean

Nastavte na true, aby se odpověď stáhla jako soubor. Výchozí hodnota je false.

includeLinks: boolean

Pokud chcete zahrnout odkazy na položky, nastavte na hodnotu true. Výchozí hodnota je false.

versionDescriptor: GitVersionDescriptor

Popisovač verze. Výchozí větev úložiště je výchozí.

zipForUnix: boolean

Pokud chcete zachovat oprávnění k souborům pro systémy unix (a POSIX), jako jsou spustitelné soubory a symlinky, nastavte na hodnotu true.

Návraty

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

Název nebo ID úložiště.

path: string

Cesta k položce

project: string

ID projektu nebo název projektu

scopePath: string

Obor cesty. Výchozí hodnota je null.

recursionLevel: VersionControlRecursionType

Rekurzivní úroveň tohoto požadavku. Výchozí hodnota je žádná, žádná rekurze.

includeContentMetadata: boolean

Pokud chcete zahrnout metadata obsahu, nastavte na hodnotu true. Výchozí hodnota je false.

latestProcessedChange: boolean

Pokud chcete zahrnout nejnovější změny, nastavte na hodnotu true. Výchozí hodnota je false.

download: boolean

Nastavte na hodnotu true, aby se odpověď stáhla jako soubor. Výchozí hodnota je false.

versionDescriptor: GitVersionDescriptor

Popisovač verze. Výchozí větev úložiště je výchozí.

includeContent: boolean

Pokud chcete zahrnout obsah položky při žádosti o json, nastavte na hodnotu true. Výchozí hodnota je false.

resolveHfs: boolean

Pokud chcete přeložit soubory ukazatele Git HFS a vrátit skutečný obsah z Git HFS, nastavte na hodnotu true. Platí výchozí hodnota.

sanitize: boolean

Nastavte na hodnotu true, pokud chcete soubor svg defikovat a vrátit ho jako obrázek. Užitečné pouze v případě, že je požadován soubor svg. Výchozí hodnota je false.

Návraty

Promise<string>

getHfsItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

Získejte metadata nebo obsah položky pro jednu položku. Parametr download označuje, jestli má být obsah v odpovědi dostupný jako soubor ke stažení, nebo jako datový proud. Nevztahuje se na komprimovaný obsah, který se vždy vrátí jako stažený obsah.

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

Název nebo ID úložiště.

path: string

Cesta k položce

project: string

ID projektu nebo název projektu

scopePath: string

Obor cesty. Výchozí hodnota je null.

recursionLevel: VersionControlRecursionType

Rekurzivní úroveň tohoto požadavku. Výchozí hodnota je žádná, žádná rekurze.

includeContentMetadata: boolean

Pokud chcete zahrnout metadata obsahu, nastavte na hodnotu true. Výchozí hodnota je false.

latestProcessedChange: boolean

Pokud chcete zahrnout nejnovější změny, nastavte na hodnotu true. Výchozí hodnota je false.

download: boolean

Nastavte na hodnotu true, aby se odpověď stáhla jako soubor. Výchozí hodnota je false.

versionDescriptor: GitVersionDescriptor

Popisovač verze. Výchozí větev úložiště je výchozí.

includeContent: boolean

Pokud chcete zahrnout obsah položky při žádosti o json, nastavte na hodnotu true. Výchozí hodnota je false.

resolveHfs: boolean

Pokud chcete přeložit soubory ukazatele Git HFS a vrátit skutečný obsah z Git HFS, nastavte na hodnotu true. Platí výchozí hodnota.

sanitize: boolean

Nastavte na hodnotu true, pokud chcete soubor svg defikovat a vrátit ho jako obrázek. Užitečné pouze v případě, že je požadován soubor svg. Výchozí hodnota je false.

Návraty

Promise<ArrayBuffer>

getImportRequest(string, string, number)

Načte konkrétní žádost o import.

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

Parametry

project: string

ID projektu nebo název projektu

repositoryId: string

Název nebo ID úložiště.

importRequestId: number

Jedinečný identifikátor žádosti o import.

Návraty

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

Název nebo ID úložiště.

path: string

Cesta k položce

project: string

ID projektu nebo název projektu

scopePath: string

Obor cesty. Výchozí hodnota je null.

recursionLevel: VersionControlRecursionType

Rekurzivní úroveň tohoto požadavku. Výchozí hodnota je žádná, žádná rekurze.

includeContentMetadata: boolean

Pokud chcete zahrnout metadata obsahu, nastavte na hodnotu true. Výchozí hodnota je false.

latestProcessedChange: boolean

Pokud chcete zahrnout nejnovější změny, nastavte na hodnotu true. Výchozí hodnota je false.

download: boolean

Nastavte na hodnotu true, aby se odpověď stáhla jako soubor. Výchozí hodnota je false.

versionDescriptor: GitVersionDescriptor

Popisovač verze. Výchozí větev úložiště je výchozí.

includeContent: boolean

Pokud chcete zahrnout obsah položky při žádosti o json, nastavte na hodnotu true. Výchozí hodnota je false.

resolveLfs: boolean

Nastavte na hodnotu true, pokud chcete přeložit soubory ukazatele Git LFS, aby se vrátil skutečný obsah z Git LFS. Výchozí hodnota je false.

sanitize: boolean

Nastavte na hodnotu true, pokud chcete soubor svg defikovat a vrátit ho jako obrázek. Užitečné pouze v případě, že je požadován soubor svg. Výchozí hodnota je false.

Návraty

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

Název nebo ID úložiště.

path: string

Cesta k položce

project: string

ID projektu nebo název projektu

scopePath: string

Obor cesty. Výchozí hodnota je null.

recursionLevel: VersionControlRecursionType

Rekurzivní úroveň tohoto požadavku. Výchozí hodnota je žádná, žádná rekurze.

includeContentMetadata: boolean

Pokud chcete zahrnout metadata obsahu, nastavte na hodnotu true. Výchozí hodnota je false.

latestProcessedChange: boolean

Pokud chcete zahrnout nejnovější změny, nastavte na hodnotu true. Výchozí hodnota je false.

download: boolean

Nastavte na hodnotu true, aby se odpověď stáhla jako soubor. Výchozí hodnota je false.

versionDescriptor: GitVersionDescriptor

Popisovač verze. Výchozí větev úložiště je výchozí.

includeContent: boolean

Pokud chcete zahrnout obsah položky při žádosti o json, nastavte na hodnotu true. Výchozí hodnota je false.

resolveLfs: boolean

Nastavte na hodnotu true, pokud chcete přeložit soubory ukazatele Git LFS, aby se vrátil skutečný obsah z Git LFS. Výchozí hodnota je false.

sanitize: boolean

Nastavte na hodnotu true, pokud chcete soubor svg defikovat a vrátit ho jako obrázek. Užitečné pouze v případě, že je požadován soubor svg. Výchozí hodnota je false.

Návraty

Promise<ArrayBuffer>

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

Načíst metadata položek nebo obsah pro kolekci položek Parametr download označuje, jestli má být obsah v odpovědi dostupný jako soubor ke stažení, nebo jako datový proud. Nevztahuje se na komprimovaný obsah, který se vždy vrací jako stažený obsah.

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

Název nebo ID úložiště.

project: string

ID projektu nebo název projektu

scopePath: string

Obor cesty. Výchozí hodnota je null.

recursionLevel: VersionControlRecursionType

Rekurzivní úroveň tohoto požadavku. Výchozí hodnota je žádná, žádná rekurze.

includeContentMetadata: boolean

Pokud chcete zahrnout metadata obsahu, nastavte na hodnotu true. Výchozí hodnota je false.

latestProcessedChange: boolean

Pokud chcete zahrnout nejnovější změny, nastavte na hodnotu true. Výchozí hodnota je false.

download: boolean

Nastavte na hodnotu true, aby se odpověď stáhla jako soubor. Výchozí hodnota je false.

includeLinks: boolean

Pokud chcete zahrnout odkazy na položky, nastavte na hodnotu true. Výchozí hodnota je false.

versionDescriptor: GitVersionDescriptor

Popisovač verze. Výchozí větev úložiště je výchozí.

zipForUnix: boolean

Pokud chcete zachovat oprávnění k souborům pro unixové systémy (a POSIX), jako jsou spustitelné soubory a symlinky, nastavte na hodnotu true.

Návraty

Promise<GitItem[]>

getItemsBatch(GitItemRequestData, string, string)

Publikování pro načtení dávky vytvoření ze sady položek v úložišti nebo projektu zadaném seznamem cest nebo dlouhou cestou

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

Parametry

requestData: GitItemRequestData

Atributy dat žádosti: ItemDescriptors, IncludeContentMetadata, LatestProcessedChange, IncludeLinks. ItemDescriptors: Kolekce položek, které se mají načíst, včetně cesty, verze a úrovně rekurze. IncludeContentMetadata: Jestli se mají zahrnout metadata pro všechny položky LatestProcessedChange: Jestli se mají zahrnout mělké odkazy k potvrzení, že poslední změna každé položky. IncludeLinks: Jestli se má zahrnout pole _links na mělké odkazy.

repositoryId: string

Název nebo ID úložiště

project: string

ID projektu nebo název projektu

Návraty

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

Název nebo ID úložiště.

path: string

Cesta k položce

project: string

ID projektu nebo název projektu

scopePath: string

Obor cesty. Výchozí hodnota je null.

recursionLevel: VersionControlRecursionType

Rekurzivní úroveň tohoto požadavku. Výchozí hodnota je žádná, žádná rekurze.

includeContentMetadata: boolean

Pokud chcete zahrnout metadata obsahu, nastavte na hodnotu true. Výchozí hodnota je false.

latestProcessedChange: boolean

Pokud chcete zahrnout nejnovější změny, nastavte na hodnotu true. Výchozí hodnota je false.

download: boolean

Nastavte na hodnotu true, aby se odpověď stáhla jako soubor. Výchozí hodnota je false.

versionDescriptor: GitVersionDescriptor

Popisovač verze. Výchozí větev úložiště je výchozí.

includeContent: boolean

Pokud chcete zahrnout obsah položky při žádosti o json, nastavte na hodnotu true. Výchozí hodnota je false.

resolveLfs: boolean

Nastavte na hodnotu true, pokud chcete přeložit soubory ukazatele Git LFS, aby se vrátil skutečný obsah z Git LFS. Výchozí hodnota je false.

sanitize: boolean

Nastavte na hodnotu true, pokud chcete soubor svg defikovat a vrátit ho jako obrázek. Užitečné pouze v případě, že je požadován soubor svg. Výchozí hodnota je false.

Návraty

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

Název nebo ID úložiště.

path: string

Cesta k položce

project: string

ID projektu nebo název projektu

scopePath: string

Obor cesty. Výchozí hodnota je null.

recursionLevel: VersionControlRecursionType

Rekurzivní úroveň tohoto požadavku. Výchozí hodnota je žádná, žádná rekurze.

includeContentMetadata: boolean

Pokud chcete zahrnout metadata obsahu, nastavte na hodnotu true. Výchozí hodnota je false.

latestProcessedChange: boolean

Pokud chcete zahrnout nejnovější změny, nastavte na hodnotu true. Výchozí hodnota je false.

download: boolean

Nastavte na hodnotu true, aby se odpověď stáhla jako soubor. Výchozí hodnota je false.

versionDescriptor: GitVersionDescriptor

Popisovač verze. Výchozí větev úložiště je výchozí.

includeContent: boolean

Pokud chcete zahrnout obsah položky při žádosti o json, nastavte na hodnotu true. Výchozí hodnota je false.

resolveLfs: boolean

Nastavte na hodnotu true, pokud chcete přeložit soubory ukazatele Git LFS, aby se vrátil skutečný obsah z Git LFS. Výchozí hodnota je false.

sanitize: boolean

Nastavte na hodnotu true, pokud chcete soubor svg defikovat a vrátit ho jako obrázek. Užitečné pouze v případě, že je požadován soubor svg. Výchozí hodnota je false.

Návraty

Promise<ArrayBuffer>

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

Získání lajků pro komentář

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

Parametry

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn

pullRequestId: number

ID žádosti o přijetí změn

threadId: number

ID vlákna, které obsahuje komentář.

commentId: number

ID komentáře.

project: string

ID projektu nebo název projektu

Návraty

Promise<IdentityRef[]>

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

Vyhledejte slučovací základy dvou potvrzení, volitelně napříč forky. Pokud není zadán parametr otherRepositoryId, budou se základy sloučení počítat pouze v kontextu místního úložištěNameOrId.

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

Parametry

repositoryNameOrId: string

ID nebo název místního úložiště.

commitId: string

První potvrzení, obvykle špička cílové větve potenciálního sloučení.

otherCommitId: string

Jiné potvrzení, obvykle tip zdrojové větve potenciálního sloučení.

project: string

ID projektu nebo název projektu

otherCollectionId: string

ID kolekce, kde se nachází id jinéhocommitId.

otherRepositoryId: string

ID úložiště, ve kterém se nachází id jinéhocommitId.

Návraty

Promise<GitCommitRef[]>

getMergeRequest(string, string, number, boolean)

Získejte podrobnosti o konkrétní operaci sloučení.

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

Parametry

project: string

ID projektu nebo název projektu

repositoryNameOrId: string

Název nebo ID úložiště.

mergeOperationId: number

OperationId žádosti o sloučení.

includeLinks: boolean

True to include links

Návraty

Promise<GitMerge>

getPermission(string, string, string)

ZÍSKAT stav oprávnění rozšířeného zabezpečení.

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

Parametry

projectName: string

repositoryId: string

Uživatel úložiště se pokouší získat přístup

permission: string

Požadované oprávnění musí být "viewAlert", "dismissAlert", "manage" "viewEnablement" nebo "repoRead".

Návraty

Promise<boolean>

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

Načtěte žádost o přijetí změn.

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

Parametry

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn

pullRequestId: number

ID žádosti o přijetí změn, která se má načíst.

project: string

ID projektu nebo název projektu

maxCommentLength: number

Nepoužívá se.

skip: number

Nepoužívá se.

top: number

Nepoužívá se.

includeCommits: boolean

Pokud ano, žádost o přijetí změn se vrátí s přidruženými potvrzeními.

includeWorkItemRefs: boolean

Pokud ano, vrátí se žádost o přijetí změn s přidruženými odkazy na pracovní položky.

Návraty

Promise<GitPullRequest>

getPullRequestById(number, string)

Načtěte žádost o přijetí změn.

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

Parametry

pullRequestId: number

ID žádosti o přijetí změn, která se má načíst.

project: string

ID projektu nebo název projektu

Návraty

Promise<GitPullRequest>

getPullRequestCommits(string, number, string)

Získejte potvrzení pro zadanou žádost o přijetí změn.

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

Parametry

repositoryId: string

ID nebo název úložiště.

pullRequestId: number

ID žádosti o přijetí změn

project: string

ID projektu nebo název projektu

Návraty

Promise<PagedList<GitCommitRef>>

getPullRequestConflict(string, number, number, string)

Načtení jednoho konfliktu pro žádost o přijetí změn podle ID

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

Parametry

repositoryId: string

pullRequestId: number

conflictId: number

project: string

ID projektu nebo název projektu

Návraty

Promise<GitConflict>

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

Načtení všech konfliktů pro žádost o přijetí změn

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

Parametry

repositoryId: string

Úložiště žádosti o přijetí změn

pullRequestId: number

ID žádosti o přijetí změn

project: string

ID projektu nebo název projektu

skip: number

Konflikty, které se mají přeskočit.

top: number

Konflikty, které se mají vrátit po přeskočení.

includeObsolete: boolean

Zahrnuje zastaralé konflikty.

excludeResolved: boolean

Vyloučí konflikty, které jsou již vyřešené.

onlyResolved: boolean

Vrátí pouze konflikty, které jsou vyřešeny.

Návraty

Promise<GitConflict[]>

getPullRequestIteration(string, number, number, string)

Získejte zadanou iteraci pro žádost o přijetí změn.

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

Parametry

repositoryId: string

ID nebo název úložiště.

pullRequestId: number

ID žádosti o přijetí změn

iterationId: number

ID iterace žádosti o přijetí změn, která se má vrátit.

project: string

ID projektu nebo název projektu

Návraty

Promise<GitPullRequestIteration>

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

Načtěte změny provedené v žádosti o přijetí změn mezi dvěma iteracemi.

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

Parametry

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn

pullRequestId: number

ID žádosti o přijetí změn

iterationId: number

ID iterace žádosti o přijetí změn <br /> Iterace jedna je vedoucí zdrojové větve v okamžiku vytvoření žádosti o přijetí změn a následné iterace se vytvoří, když dojde k odeslání do zdrojové větve. Povolené hodnoty jsou v této žádosti o přijetí změn mezi 1 a maximální iterací.

project: string

ID projektu nebo název projektu

top: number

Nepovinný parametr. Počet změn, které se mají načíst. Výchozí hodnota je 100 a maximální hodnota je 2000.

skip: number

Nepovinný parametr. Počet změn, které se mají ignorovat. Pokud například chcete načíst změny 101–150, nastavte prvních 50 a přeskočte na 100.

compareTo: number

ID iterace žádosti o přijetí změn, se která se má porovnat. Výchozí hodnota je nula, což značí, že je provedeno porovnání se společným potvrzením mezi zdrojovou a cílovou větví.

Návraty

Promise<GitPullRequestIterationChanges>

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

Získejte potvrzení pro zadanou iteraci žádosti o přijetí změn.

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

Parametry

repositoryId: string

ID nebo název úložiště.

pullRequestId: number

ID žádosti o přijetí změn

iterationId: number

ID iterace, ze které chcete získat potvrzení.

project: string

ID projektu nebo název projektu

top: number

Maximální počet potvrzení, která se mají vrátit. Maximální počet potvrzení, která lze vrátit na dávku, je 500.

skip: number

Počet potvrzení, která se mají přeskočit

Návraty

Promise<GitCommitRef[]>

getPullRequestIterations(string, number, string, boolean)

Získejte seznam iterací pro zadanou žádost o přijetí změn.

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

Parametry

repositoryId: string

ID nebo název úložiště.

pullRequestId: number

ID žádosti o přijetí změn

project: string

ID projektu nebo název projektu

includeCommits: boolean

Pokud je pravda, zahrňte do odpovědi potvrzení přidružená k jednotlivým iteracím.

Návraty

Promise<GitPullRequestIteration[]>

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

Získejte konkrétní stav iterace žádosti o přijetí změn podle ID. ID stavu je jedinečné v rámci žádosti o přijetí změn napříč všemi iteracemi.

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

Parametry

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn

pullRequestId: number

ID žádosti o přijetí změn

iterationId: number

ID iterace žádosti o přijetí změn

statusId: number

ID stavu žádosti o přijetí změn

project: string

ID projektu nebo název projektu

Návraty

Promise<GitPullRequestStatus>

getPullRequestIterationStatuses(string, number, number, string)

Získejte všechny stavy přidružené k iteraci žádosti o přijetí změn.

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

Parametry

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn

pullRequestId: number

ID žádosti o přijetí změn

iterationId: number

ID iterace žádosti o přijetí změn

project: string

ID projektu nebo název projektu

Návraty

Promise<GitPullRequestStatus[]>

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

Načte jeden popisek (značku), který byl přiřazen k žádosti o přijetí změn.

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

Parametry

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn

pullRequestId: number

ID žádosti o přijetí změn

labelIdOrName: string

Název nebo ID požadovaného popisku.

project: string

ID projektu nebo název projektu

projectId: string

ID projektu nebo název projektu.

Návraty

Promise<WebApiTagDefinition>

getPullRequestLabels(string, number, string, string)

Získejte všechny popisky (značky) přiřazené k žádosti o přijetí změn.

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

Parametry

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn

pullRequestId: number

ID žádosti o přijetí změn

project: string

ID projektu nebo název projektu

projectId: string

ID projektu nebo název projektu.

Návraty

Promise<WebApiTagDefinition[]>

getPullRequestProperties(string, number, string)

Získejte externí vlastnosti žádosti o přijetí změn.

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

Parametry

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn

pullRequestId: number

ID žádosti o přijetí změn

project: string

ID projektu nebo název projektu

Návraty

Promise<any>

getPullRequestQuery(GitPullRequestQuery, string, string)

Toto rozhraní API slouží k vyhledání žádostí o přijetí změn souvisejících s daným potvrzením. Dá se použít k vyhledání žádosti o přijetí změn, která vytvořila konkrétní potvrzení sloučení, nebo k vyhledání všech žádostí o přijetí změn, které kdy sloučily konkrétní potvrzení. Vstup je seznam dotazů, z nichž každý obsahuje seznam potvrzení. Pro každé potvrzení, které hledáte, získáte zpět slovník potvrzení –> žádosti o přijetí změn.

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

Parametry

queries: GitPullRequestQuery

Seznam dotazů, které se mají provést.

repositoryId: string

ID úložiště.

project: string

ID projektu nebo název projektu

Návraty

Promise<GitPullRequestQuery>

getPullRequestReviewer(string, number, string, string)

Načtení informací o konkrétním revidujícím žádosti o přijetí změn

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

Parametry

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn

pullRequestId: number

ID žádosti o přijetí změn

reviewerId: string

ID revidujícího.

project: string

ID projektu nebo název projektu

Návraty

Promise<IdentityRefWithVote>

getPullRequestReviewers(string, number, string)

Načtení kontrolorů žádosti o přijetí změn

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

Parametry

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn

pullRequestId: number

ID žádosti o přijetí změn

project: string

ID projektu nebo název projektu

Návraty

Promise<IdentityRefWithVote[]>

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

Načtěte všechny žádosti o přijetí změn odpovídající zadaným kritériím.

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

Parametry

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn

searchCriteria: GitPullRequestSearchCriteria

Budou vráceny žádosti o přijetí změn, které splňují tato kritéria hledání.

project: string

ID projektu nebo název projektu

maxCommentLength: number

Nepoužívá se.

skip: number

Počet žádostí o přijetí změn, které se mají ignorovat. Pokud chcete například načíst výsledky 101–150, nastavte na začátek 50 a přeskočte na 100.

top: number

Počet žádostí o přijetí změn, které se mají načíst.

Návraty

Promise<GitPullRequest[]>

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

Načtěte všechny žádosti o přijetí změn odpovídající zadaným kritériím.

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

Parametry

project: string

ID projektu nebo název projektu

searchCriteria: GitPullRequestSearchCriteria

Budou vráceny žádosti o přijetí změn, které splňují tato kritéria hledání.

maxCommentLength: number

Nepoužívá se.

skip: number

Počet žádostí o přijetí změn, které se mají ignorovat. Pokud chcete například načíst výsledky 101–150, nastavte na začátek 50 a přeskočte na 100.

top: number

Počet žádostí o přijetí změn, které se mají načíst.

Návraty

Promise<GitPullRequest[]>

getPullRequestStatus(string, number, number, string)

Získejte konkrétní stav žádosti o přijetí změn podle ID. ID stavu je jedinečné v rámci žádosti o přijetí změn napříč všemi iteracemi.

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

Parametry

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn

pullRequestId: number

ID žádosti o přijetí změn

statusId: number

ID stavu žádosti o přijetí změn

project: string

ID projektu nebo název projektu

Návraty

Promise<GitPullRequestStatus>

getPullRequestStatuses(string, number, string)

Získejte všechny stavy přidružené k žádosti o přijetí změn.

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

Parametry

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn

pullRequestId: number

ID žádosti o přijetí změn

project: string

ID projektu nebo název projektu

Návraty

Promise<GitPullRequestStatus[]>

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

Načtení vlákna v žádosti o přijetí změn

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

Parametry

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn

pullRequestId: number

ID žádosti o přijetí změn

threadId: number

ID vlákna.

project: string

ID projektu nebo název projektu

iteration: number

Pokud je tato hodnota zadána, bude pozice vlákna sledována pomocí této iterace jako pravé strany rozdílu.

baseIteration: number

Pokud je zadáno, bude pozice vlákna sledována pomocí této iterace jako levé strany rozdílu.

Návraty

Promise<GitPullRequestCommentThread>

getPullRequestWorkItemRefs(string, number, string)

Načte seznam pracovních položek přidružených k žádosti o přijetí změn.

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

Parametry

repositoryId: string

ID nebo název úložiště.

pullRequestId: number

ID žádosti o přijetí změn

project: string

ID projektu nebo název projektu

Návraty

Promise<ResourceRef[]>

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

Načte konkrétní nabízené oznámení.

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

Parametry

repositoryId: string

Název nebo ID úložiště.

pushId: number

ID nabízeného oznámení.

project: string

ID projektu nebo název projektu

includeCommits: number

Počet potvrzení, která se mají zahrnout do výsledku.

includeRefUpdates: boolean

Pokud ano, uveďte seznam odkazů, které byly aktualizovány nasdílením změn.

Návraty

Promise<GitPush>

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

Načte seznam potvrzení přidružených k určitému nabízenému oznámení.

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

Parametry

repositoryId: string

ID nebo popisný název úložiště. Pokud chcete použít popisný název, musí být zadáno také projectId.

pushId: number

ID nasdílení změn.

project: string

ID projektu nebo název projektu

top: number

Maximální počet potvrzení, která se mají vrátit ("get the top x commits").

skip: number

Počet potvrzení, která se mají přeskočit.

includeLinks: boolean

Nastavte na hodnotu false, abyste se vyhnuli zahrnutí odkazů REST Url pro prostředky. Výchozí hodnota je true.

Návraty

Promise<GitCommitRef[]>

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

Načte nabízená oznámení přidružená k zadanému úložišti.

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

Parametry

repositoryId: string

Název nebo ID úložiště.

project: string

ID projektu nebo název projektu

skip: number

Počet nasdílení změn, které se mají přeskočit.

top: number

Počet nasdílení, která se mají vrátit.

searchCriteria: GitPushSearchCriteria

Atributy kritérií vyhledávání: fromDate, toDate, pusherId, refName, includeRefUpdates nebo includeLinks. fromDate: Počáteční datum, ze které chcete hledat. toDate: Koncové datum, na které se má hledat. pusherId: Identita osoby, která odeslala nabízené oznámení. refName: Název větve, který je potřeba zvážit. includeRefUpdates: Pokud je true, uveďte seznam odkazů, které byly aktualizovány nabízeným oznámením. includeLinks: Zda se má zahrnout pole _links na mělké odkazy.

Návraty

Promise<GitPush[]>

getRecycleBinRepositories(string)

Načtěte obnovitelně odstraněná úložiště Git z koše.

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

Parametry

project: string

ID projektu nebo název projektu

Návraty

Promise<GitDeletedRepository[]>

getRefFavorite(string, number)

Získá odkazy oblíbené pro oblíbené ID.

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

Parametry

project: string

ID projektu nebo název projektu

favoriteId: number

ID požadované oblíbené referenční položky.

Návraty

Promise<GitRefFavorite>

getRefFavorites(string, string, string)

Získá oblíbené odkazy pro úložiště a identitu.

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

Parametry

project: string

ID projektu nebo název projektu

repositoryId: string

ID úložiště.

identityId: string

ID identity, jejíž oblíbené položky se mají načíst. Pokud je hodnota null, použije se žádající identita.

Návraty

Promise<GitRefFavorite[]>

getRefFavoritesForProject(string, string)

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

Parametry

project: string

ID projektu nebo název projektu

identityId: string

Návraty

Promise<GitRefFavorite[]>

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

Dotazuje zadané úložiště na jeho odkazy a vrátí 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

Název nebo ID úložiště.

project: string

ID projektu nebo název projektu

filter: string

[volitelné] Filtr, který se má použít na odkazy (začíná na).

includeLinks: boolean

[volitelné] Určuje, jestli mají být do výsledku zahrnuty odkazy. výchozí hodnota je false.

includeStatuses: boolean

[volitelné] Zahrnuje až prvních 1 000 stavů potvrzení pro každou referenční hodnotu. Výchozí hodnota je false.

includeMyBranches: boolean

[volitelné] Zahrnuje pouze větve, které uživatel vlastní, větve oblíbených uživatelů a výchozí větev. Výchozí hodnota je False. Nelze kombinovat s parametrem filtru.

latestStatusesOnly: boolean

[volitelné] True, pokud chcete zahrnout pouze stav potvrzení tipu pro každou odkaz. Tato možnost musí includeStatuses být pravdivá. Výchozí hodnota je False.

peelTags: boolean

[volitelné] Značky s poznámkami naplní vlastnost PeeledObjectId. výchozí hodnota je false.

filterContains: string

[volitelné] Filtr, který se má použít na odkazy (obsahuje).

Návraty

Promise<PagedList<GitRef>>

getRepositories(string, boolean, boolean, boolean)

Načtěte úložiště Git.

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

Parametry

project: string

ID projektu nebo název projektu

includeLinks: boolean

[volitelné] True, pokud chcete zahrnout odkazy. Výchozí hodnota je False.

includeAllUrls: boolean

[volitelné] True, pokud chcete zahrnout všechny vzdálené adresy URL. Výchozí hodnota je False.

includeHidden: boolean

[volitelné] True, pokud chcete zahrnout skrytá úložiště. Výchozí hodnota je False.

Návraty

Promise<GitRepository[]>

getRepository(string, string)

Načtěte úložiště Git.

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

Parametry

repositoryId: string

Název nebo ID úložiště.

project: string

ID projektu nebo název projektu

Návraty

Promise<GitRepository>

getRepositoryWithParent(string, boolean, string)

Načtěte úložiště Git.

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

Parametry

repositoryId: string

Název nebo ID úložiště.

includeParent: boolean

True, pokud chcete zahrnout nadřazené úložiště. K dispozici pouze v ověřených voláních.

project: string

ID projektu nebo název projektu

Návraty

Promise<GitRepository>

getRevert(string, number, string)

Načtěte informace o operaci vrácení zpět pomocí ID vrácení.

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

Parametry

project: string

ID projektu nebo název projektu

revertId: number

ID operace vrácení.

repositoryId: string

ID úložiště.

Návraty

Promise<GitRevert>

getRevertConflict(string, number, number, string)

Načtení jednoho konfliktu pro vrácení podle ID

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

Parametry

repositoryId: string

revertId: number

conflictId: number

project: string

ID projektu nebo název projektu

Návraty

Promise<GitConflict>

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

Načtení všech konfliktů pro vrácení zpět

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

ID projektu nebo název projektu

continuationToken: string

top: number

excludeResolved: boolean

onlyResolved: boolean

includeObsolete: boolean

Návraty

Promise<PagedList<GitConflict>>

getRevertForRefName(string, string, string)

Načte informace o operaci vrácení pro konkrétní větev.

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

Parametry

project: string

ID projektu nebo název projektu

repositoryId: string

ID úložiště.

refName: string

GitAsyncRefOperationParameters generatedRefName použitý pro operaci vrácení.

Návraty

Promise<GitRevert>

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

Získejte stavy přidružené k potvrzení Gitu.

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

Parametry

commitId: string

ID potvrzení Gitu

repositoryId: string

ID úložiště.

project: string

ID projektu nebo název projektu

top: number

Nepovinný parametr. Počet stavů, které se mají načíst. Výchozí hodnota je 1000.

skip: number

Nepovinný parametr. Počet stavů, které se mají ignorovat. Výchozí hodnota je 0. Pokud chcete například načíst výsledky 101–150, nastavte na začátek 50 a přeskočte na 100.

latestOnly: boolean

Příznak označuje, jestli se mají získat pouze nejnovější stavy seskupené podle Context.Name a Context.Genre.

Návraty

Promise<GitStatus[]>

getSuggestions(string, string, boolean)

Načtěte návrh žádosti o přijetí změn pro konkrétní úložiště nebo týmový projekt.

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

Parametry

repositoryId: string

ID úložiště Git.

project: string

ID projektu nebo název projektu

preferCompareBranch: boolean

Pokud ano, upřednostněte pro žádosti o přijetí změn větev compare před výchozí větví jako cílovou větev.

Návraty

Promise<GitSuggestion[]>

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

Načtení všech vláken v žádosti o přijetí změn

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

Parametry

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn

pullRequestId: number

ID žádosti o přijetí změn

project: string

ID projektu nebo název projektu

iteration: number

Pokud je zadáno, pozice vlákna budou sledovány pomocí této iterace jako pravé strany rozdílu.

baseIteration: number

Pokud je zadáno, pozice vlákna budou sledovány pomocí této iterace jako levé strany rozdílu.

Návraty

Promise<GitPullRequestCommentThread[]>

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

Koncový bod strom vrátí kolekci objektů pod zadaným stromem. Stromy jsou složky v úložišti Git.

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

Parametry

repositoryId: string

ID úložiště.

sha1: string

Hodnota hash SHA1 objektu stromu.

project: string

ID projektu nebo název projektu

projectId: string

ID projektu.

recursive: boolean

Hledat rekurzivně. Zahrňte stromy pod tímto stromem. Výchozí hodnota je false.

fileName: string

Název, který se má použít, pokud se vrátí soubor .zip. Výchozí je ID objektu.

Návraty

Promise<GitTreeRef>

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

Koncový bod strom vrátí kolekci objektů pod zadaným stromem. Stromy jsou složky v úložišti Git.

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

Parametry

repositoryId: string

ID úložiště.

sha1: string

Hodnota hash SHA1 objektu stromu.

project: string

ID projektu nebo název projektu

projectId: string

ID projektu.

recursive: boolean

Hledat rekurzivně. Zahrňte stromy pod tímto stromem. Výchozí hodnota je false.

fileName: string

Název, který se má použít, pokud se vrátí soubor .zip. Výchozí je ID objektu.

Návraty

Promise<ArrayBuffer>

queryImportRequests(string, string, boolean)

Načtení žádostí o import pro úložiště

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

Parametry

project: string

ID projektu nebo název projektu

repositoryId: string

Název nebo ID úložiště.

includeAbandoned: boolean

True, pokud chcete do výsledků zahrnout opuštěné žádosti o import.

Návraty

Promise<GitImportRequest[]>

restoreRepositoryFromRecycleBin(GitRecycleBinRepositoryDetails, string, string)

Obnovení obnovitelného odstraněného úložiště Git Nedávno odstraněná úložiště přejdou na určitou dobu do stavu obnovitelného odstranění, než se trvale odstraní a stanou se neobnovitelnými.

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

Parametry

repositoryDetails: GitRecycleBinRepositoryDetails

project: string

ID projektu nebo název projektu

repositoryId: string

ID úložiště.

Návraty

Promise<GitRepository>

setEnableOnCreateHost(boolean)

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

Parametry

enableOnCreateHost: boolean

Návraty

Promise<void>

setEnableOnCreateProject(string, boolean)

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

Parametry

enableOnCreateProjectId: string

enableOnStatus: boolean

Návraty

Promise<void>

sharePullRequest(ShareNotificationContext, string, number, string)

Odešle e-mailové oznámení o konkrétní žádosti o přijetí změn sadě příjemců.

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

Parametry

userMessage: ShareNotificationContext

repositoryId: string

ID úložiště Git.

pullRequestId: number

ID žádosti o přijetí změn

project: string

ID projektu nebo název projektu

Návraty

Promise<void>

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

Řešení konfliktů při slučování aktualizací

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

ID projektu nebo název projektu

Návraty

Promise<GitConflict>

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

Aktualizace více řešení konfliktů při slučování

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

Parametry

conflictUpdates: GitConflict[]

repositoryId: string

cherryPickId: number

project: string

ID projektu nebo název projektu

Návraty

Promise<GitConflictUpdateResult[]>

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

Aktualizujte komentář přidružený ke konkrétnímu vláknu v žádosti o přijetí změn.

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

Parametry

comment: Comment

Obsah komentáře, který se má aktualizovat. Komentáře můžou mít maximálně 150 000 znaků.

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn

pullRequestId: number

ID žádosti o přijetí změn

threadId: number

ID vlákna, ve které se požadovaný komentář nachází.

commentId: number

ID komentáře, který se má aktualizovat.

project: string

ID projektu nebo název projektu

Návraty

Promise<Comment>

updateEnablementStatus(AdvSecEnablementUpdate[])

Stav povolení POST pro úložiště

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

Parametry

enablementUpdates: AdvSecEnablementUpdate[]

Návraty

Promise<void>

updateImportRequest(GitImportRequest, string, string, number)

Zkuste neúspěšnou žádost o import zopakovat nebo ji opustit.

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

Parametry

importRequestToUpdate: GitImportRequest

Aktualizovaná verze žádosti o import. V současné době je jedinou povolenou změnou nastavení Stavu ve frontě nebo Opuštěno.

project: string

ID projektu nebo název projektu

repositoryId: string

Název nebo ID úložiště.

importRequestId: number

Jedinečný identifikátor žádosti o import, který se má aktualizovat.

Návraty

Promise<GitImportRequest>

updatePullRequest(GitPullRequest, string, number, string)

Aktualizace žádosti o přijetí změn

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

Parametry

gitPullRequestToUpdate: GitPullRequest

Obsah žádosti o přijetí změn, který by se měl aktualizovat.

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn

pullRequestId: number

ID žádosti o přijetí změn, která se má aktualizovat.

project: string

ID projektu nebo název projektu

Návraty

Promise<GitPullRequest>

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

Řešení konfliktů při slučování aktualizací

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

ID projektu nebo název projektu

Návraty

Promise<GitConflict>

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

Aktualizace více řešení konfliktů při slučování

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

Parametry

conflictUpdates: GitConflict[]

repositoryId: string

pullRequestId: number

project: string

ID projektu nebo název projektu

Návraty

Promise<GitConflictUpdateResult[]>

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

Aktualizace shromažďování stavů iterace žádostí o přijetí změn Jediným podporovaným typem operace je remove.

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

Parametry

patchDocument: JsonPatchDocument

Operace, které se mají použít na stavy žádostí o přijetí změn ve formátu opravy JSON

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn

pullRequestId: number

ID žádosti o přijetí změn

iterationId: number

ID iterace žádosti o přijetí změn

project: string

ID projektu nebo název projektu

Návraty

Promise<void>

updatePullRequestProperties(JsonPatchDocument, string, number, string)

Vytvořte nebo aktualizujte externí vlastnosti žádosti o přijetí změn. Operace opravy může být add, replace nebo remove. Pro add operaci může být cesta prázdná. Pokud je cesta prázdná, hodnota musí být seznamem párů hodnot klíčů. Pro replace operaci nemůže být cesta prázdná. Pokud cesta neexistuje, přidá se vlastnost do kolekce. Pro remove operaci nemůže být cesta prázdná. Pokud cesta neexistuje, neprovede se žádná akce.

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

Parametry

patchDocument: JsonPatchDocument

Vlastnosti, které se mají přidat, nahradit nebo odebrat ve formátu opravy JSON

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn

pullRequestId: number

ID žádosti o přijetí změn

project: string

ID projektu nebo název projektu

Návraty

Promise<any>

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

Upravte položku revidujícího. Tato pole se dají opravit: isFlagged, hasDeclined

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

Parametry

reviewer: IdentityRefWithVote

Data revidujícího.<br />Pokud je zde uvedeno ID revidujícího, musí se shodovat s parametrem reviewerID.

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn

pullRequestId: number

ID žádosti o přijetí změn

reviewerId: string

ID revidujícího.

project: string

ID projektu nebo název projektu

Návraty

Promise<IdentityRefWithVote>

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

Resetujte hlasy více revidujících u žádosti o přijetí změn. POZNÁMKA: Tento koncový bod podporuje pouze aktualizaci hlasů, ale nepodporuje aktualizaci požadovaných revidujících (zásady použití) ani zobrazovaných jmen.

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

Parametry

patchVotes: IdentityRefWithVote[]

ID revidujících, jejichž hlasy se resetují na nulu

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn

pullRequestId: number

ID žádosti o přijetí změn

project: string

ID projektu nebo název projektu

Návraty

Promise<void>

updatePullRequestStatuses(JsonPatchDocument, string, number, string)

Aktualizace shromažďování stavů žádostí o přijetí změn Jediným podporovaným typem operace je remove.

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

Parametry

patchDocument: JsonPatchDocument

Operace, které se mají použít na stavy žádostí o přijetí změn ve formátu opravy JSON

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn

pullRequestId: number

ID žádosti o přijetí změn

project: string

ID projektu nebo název projektu

Návraty

Promise<void>

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

Zamknutí nebo odemknutí větve

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

Parametry

newRefInfo: GitRefUpdate

Akce aktualizace odkazu (uzamčení/odemknutí) k provedení

repositoryId: string

Název nebo ID úložiště.

filter: string

Název větve, která se má uzamknout nebo odemknout

project: string

ID projektu nebo název projektu

projectId: string

ID nebo název týmového projektu. Volitelné, pokud zadáte ID úložiště.

Návraty

Promise<GitRef>

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

Vytváření, aktualizace nebo odstraňování odkazů (větví)

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

Parametry

refUpdates: GitRefUpdate[]

Seznam aktualizací odkazů, které se mají pokusit provést

repositoryId: string

Název nebo ID úložiště.

project: string

ID projektu nebo název projektu

projectId: string

ID nebo název týmového projektu. Volitelné, pokud zadáte ID úložiště.

Návraty

Promise<GitRefUpdateResult[]>

updateRepository(GitRepository, string, string)

Aktualizuje úložiště Git novým názvem úložiště nebo novou výchozí větví.

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

Parametry

newRepositoryInfo: GitRepository

Zadejte nový název úložiště nebo novou výchozí větev úložiště.

repositoryId: string

ID úložiště.

project: string

ID projektu nebo název projektu

Návraty

Promise<GitRepository>

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

Řešení konfliktů při slučování aktualizací

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

ID projektu nebo název projektu

Návraty

Promise<GitConflict>

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

Aktualizace více řešení konfliktů při slučování

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

Parametry

conflictUpdates: GitConflict[]

repositoryId: string

revertId: number

project: string

ID projektu nebo název projektu

Návraty

Promise<GitConflictUpdateResult[]>

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

Aktualizujte vlákno v žádosti o přijetí změn.

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

Parametry

commentThread: GitPullRequestCommentThread

Obsah vlákna, který by měl být aktualizován.

repositoryId: string

ID úložiště cílové větve žádosti o přijetí změn

pullRequestId: number

ID žádosti o přijetí změn

threadId: number

ID vlákna, které se má aktualizovat.

project: string

ID projektu nebo název projektu

Návraty

Promise<GitPullRequestCommentThread>

Sdílet prostřednictvím

GitRestClient class

Konstruktory

Vlastnosti

Metody

Podrobnosti konstruktoru

GitRestClient(IVssRestClientOptions)

Parametry

Podrobnosti vlastnosti

RESOURCE_AREA_ID

Hodnota vlastnosti

Podrobnosti metody

createAnnotatedTag(GitAnnotatedTag, string, string)

Parametry

Návraty

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

Parametry

Návraty

createCherryPick(GitAsyncRefOperationParameters, string, string)

Parametry

Návraty

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

Parametry

Návraty

createCommitStatus(GitStatus, string, string, string)

Parametry

Návraty

createFavorite(GitRefFavorite, string)

Parametry

Návraty

createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)

Parametry

Návraty

createImportRequest(GitImportRequest, string, string)

Parametry

Návraty

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

Parametry

Návraty

createMergeRequest(GitMergeParameters, string, string, boolean)

Parametry

Návraty

createPullRequest(GitPullRequest, string, string, boolean)

Parametry

Návraty

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

Parametry

Návraty

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

Parametry

Návraty

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

Parametry

Návraty

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

Parametry

Návraty

createPullRequestStatus(GitPullRequestStatus, string, number, string)

Parametry

Návraty

createPush(GitPush, string, string)

Parametry

Návraty

createRepository(GitRepositoryCreateOptions, string, string)

Parametry

Návraty

createRevert(GitAsyncRefOperationParameters, string, string)

Parametry

Návraty

createThread(GitPullRequestCommentThread, string, number, string)

Parametry

Návraty

createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)

Parametry

Návraty

deleteAttachment(string, string, number, string)

Parametry

Návraty

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

Parametry