GitRestClient class

Csomag:: azure-devops-extension-api

Alaposztály, amelyet a VSS REST API-k kéréseinek igényléséhez (származtatásából) kell használni

Kiterjeszti: RestClientBase

Konstruktorok

Kellékek

Módszerek

createAnnotatedTag(GitAnnotatedTag, string, string)	Jegyzetekkel ellátott címke létrehozása.
createAttachment(any, string, string, number, string)	Új fájl csatolása lekéréses kérelemhez.
createCherryPick(GitAsyncRefOperationParameters, string, string)	A Cherry kiválaszt egy adott véglegesítést vagy véglegesítést, amely egy lekéréses kérelemhez van társítva egy új ágba.
createComment(Comment, string, number, number, string)	Megjegyzés létrehozása egy adott szálhoz egy lekéréses kérelemben (szálonként legfeljebb 500 megjegyzés hozható létre).
createCommitStatus(GitStatus, string, string, string)	Git véglegesítési állapot létrehozása.
createFavorite(GitRefFavorite, string)	Létrehoz egy hiv-kedvencet
createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)	Kérje meg, hogy egy másik adattár adattárát is beolvassa ebbe a tárházba. Két meglévő elágazás szinkronizálása. A fork létrehozásához kérjük, nézze meg a <a href="https://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1" > repositories endpoint</a>
createImportRequest(GitImportRequest, string, string)	Hozzon létre egy importálási kérelmet.
createLike(string, number, number, number, string)	Adjon hozzá hasonlót egy megjegyzéshez.
createMergeRequest(GitMergeParameters, string, string, boolean)	Git-egyesítési művelet kérése. Jelenleg csak 2 véglegesítés egyesítését támogatjuk.
createPullRequest(GitPullRequest, string, string, boolean)	Lekéréses kérelem létrehozása.
createPullRequestIterationStatus(GitPullRequestStatus, string, number, number, string)	Hozzon létre egy lekéréses kérelem állapotát az iterációban. Ez a művelet ugyanazzal az eredménnyel fog rendelkezni, mint a lekéréses kérelem állapotának létrehozása a kérelem törzsében megadott iterációs azonosítóval.
createPullRequestLabel(WebApiCreateTagRequestData, string, number, string, string)	Hozzon létre egy címkét (ha még nem létezik), és adja hozzá címkeként (címkeként) egy adott lekéréses kérelemhez. Az egyetlen kötelező mező az új címke (címke) neve.
createPullRequestReviewer(IdentityRefWithVote, string, number, string, string)	Adjon hozzá egy véleményezőt egy lekéréses kérelemhez, vagy szavazzon.
createPullRequestReviewers(IdentityRef[], string, number, string)	Véleményezők hozzáadása lekéréses kérelemhez.
createPullRequestStatus(GitPullRequestStatus, string, number, string)	Lekéréses kérelem állapotának létrehozása.
createPush(GitPush, string, string)	Módosítások leküldése az adattárba.
createRepository(GitRepositoryCreateOptions, string, string)	Hozz létre git repositoryt egy csapat projektben.
createRevert(GitAsyncRefOperationParameters, string, string)	Elindítja a műveletet egy új ág létrehozásához, amely visszaállítja egy adott véglegesítés vagy egy lekéréses kérelemhez társított véglegesítések által bevezetett módosításokat.
createThread(GitPullRequestCommentThread, string, number, string)	Szál létrehozása lekéréses kérelemben.
createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)	Adjon hozzá egy nem lényegtelen identitást egy lekéréses kérelem véleményezőihez.
deleteAttachment(string, string, number, string)	Lekéréses kérelem mellékletének törlése.
deleteComment(string, number, number, number, string)	Töröljön egy adott szálhoz társított megjegyzést egy lekéréses kérelemben.
deleteEnablementStatus(boolean, boolean, string[])	A DELETE törli az engedélyezés állapotát és a BillableCommitters adatait a DB-ből. Az engedélyezési adatok törlése hatékonyan letiltja azokat az érintett adattárak esetében.
deleteLike(string, number, number, number, string)	Megjegyzésen lévő kedvelés törlése.
deletePullRequestIterationStatus(string, number, number, number, string)	A lekéréses kérelem iterációs állapotának törlése.
deletePullRequestLabels(string, number, string, string, string)	Eltávolít egy címkét (címkét) a lekéréses kérelemhez rendelt címkék készletéből. Maga a címke nem törlődik.
deletePullRequestReviewer(string, number, string, string)	Véleményező eltávolítása lekéréses kérelemből.
deletePullRequestStatus(string, number, number, string)	Lekéréses kérelem állapotának törlése.
deleteRefFavorite(string, number)	Törli a megadott refs kedvencet
deleteRepository(string, string)	Git-adattár törlése
deleteRepositoryFromRecycleBin(string, string)	Helyreállíthatóan törölt Git-adattár megsemmisítése (kemény törlés).
getAccessibleRepositories(GetAccessibleRepositoriesRequest)	POST kérés a hozzáférési tárolók megszerzéséhez az engedély alapján (batch operation).
getAnnotatedTag(string, string, string)	Jegyzetekkel ellátott címke lekérése.
getAttachmentContent(string, string, number, string)	Lekérheti a lekéréses kérelem mellékletének fájltartalmát.
getAttachments(string, number, string)	Lekérheti az adott lekéréses kérelemhez csatolt fájlok listáját.
getAttachmentZip(string, string, number, string)	Lekérheti a lekéréses kérelem mellékletének fájltartalmát.
getBillableCommitters(string, Date, number, number)	Az Advanced Security szolgáltatás tényleges számlázható véglegesítéseinek lekérése egy adott dátumhoz.
getBillableCommittersDetail(string, string, Date)	Részletes tényleges számlázható véglegesítések lekérése az Advanced Security szolgáltatáshoz egy adott dátumhoz. A részletes eredmények szándékosan nem szűrik ki a helyreállíthatóan törölt projekteket és adattárakat a számlázási problémák diagnosztizálásához.
getBlob(string, string, string, boolean, string, boolean)	Egyetlen blob lekérése.
getBlobContent(string, string, string, boolean, string, boolean)	Egyetlen blob lekérése.
getBlobsZip(string[], string, string, string)	Lekéri egy vagy több blobot egy zip-fájl letöltésében.
getBlobZip(string, string, string, boolean, string, boolean)	Egyetlen blob lekérése.
getBranch(string, string, string, GitVersionDescriptor)	Egyetlen ág statisztikáinak lekérése.
getBranches(string, string, GitVersionDescriptor)	Az adattárban lévő összes ág statisztikáinak lekérése.
getBranchStatsBatch(GitQueryBranchStatsCriteria, string, string)	Több véglegesítés statisztikáinak lekérése
getChanges(string, string, string, number, number)	Egy adott véglegesítés módosításainak lekérése.
getCherryPick(string, number, string)	A cseresznyeválasztási művelettel kapcsolatos információk lekérése cseresznyeválasztó azonosító alapján.
getCherryPickConflict(string, number, number, string)	Egy ütközés lekérése egy cseresznyeválasztáshoz azonosító szerint
getCherryPickConflicts(string, number, string, string, number, boolean, boolean, boolean)	Cseresznyés választás összes ütközésének lekérése
getCherryPickForRefName(string, string, string)	Egy adott ág cseresznyeválasztási műveletével kapcsolatos információk lekérése. Ez a művelet a mögöttes objektumstruktúra miatt költséges, ezért ez az API csak az 1000 legutóbbi cseresznyeválasztási műveletet vizsgálja.
getCherryPickRelationships(string, string, string, boolean)	A véglegesítési azonosító egy olyan véglegesítések listáját adja vissza, amelyek ugyanabban a cherry-pick családban találhatók.
getComment(string, number, number, number, string)	Lekérheti egy adott szálhoz társított megjegyzést egy lekéréses kérelemben.
getComments(string, number, number, string)	Lekérheti az adott szálhoz társított összes megjegyzést egy lekéréses kérelemben.
getCommit(string, string, string, number)	Egy adott véglegesítés lekérése.
getCommitDiffs(string, string, boolean, number, number, GitBaseVersionDescriptor, GitTargetVersionDescriptor)	Keresse meg a legközelebbi közös véglegesítést (az egyesítési alap) a bázis és a cél véglegesítés között, és kérje le a különbséget az alap- és a cél véglegesítések, illetve a közös és a cél véglegesítések között.
getCommits(string, GitQueryCommitsCriteria, string)	Retriev git commit-eket egy project számára
getCommitsBatch(GitQueryCommitsCriteria, string, string, number, number, boolean)	Retriev git commit-eket egy olyan project számára, amely megfelel a keresési kritériumoknak
getDeletedRepositories(string)	Törölt git-adattárak lekérése.
getEnablementStatus(string[], Date, number, number)	KAPD az Enablement státuszt a project repozióriumaihoz.
getEnableOnCreateHost(boolean)
getEnableOnCreateProject(string)
getEstimatedBillableCommittersRepo(string, string)	Lekérheti az elmúlt 90 napra vonatkozó becsült számlázható véglegesítéseket egy adattárhoz.
getEstimatedBillablePushersOrg()	Az elmúlt 90 napra vonatkozó becsült számlázható leküldések lekérése egy szervezet számára.
getEstimatedBillablePushersProject(string)	Kérj becsült számlázható forgalmazókat egy projekt utolsó 90 napjára.
getFileDiffs(FileDiffsCriteria, string, string)	A megadott fájlok fájldiffjeinek lekérése
getForks(string, string, string, boolean)	A gyűjteményben lévő adattár összes elágazásának lekérése.
getForkSyncRequest(string, number, string, boolean)	Lekérheti egy adott elágazás szinkronizálási műveletének részleteit.
getForkSyncRequests(string, string, boolean, boolean)	Kérje le az adattár összes kért elágazás-szinkronizálási műveletét.
getHfsItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Elem metaadatainak és/vagy tartalmának lekérése egyetlen elemhez. A letöltési paraméter azt jelzi, hogy a tartalom letöltésként elérhető legyen,vagy csak streamként legyen elküldve a válaszban. Nem vonatkozik a tömörített tartalomra, amelyet a rendszer mindig letöltésként ad vissza.
getHfsItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Elem metaadatainak és/vagy tartalmának lekérése egyetlen elemhez. A letöltési paraméter azt jelzi, hogy a tartalom letöltésként elérhető legyen,vagy csak streamként legyen elküldve a válaszban. Nem vonatkozik a tömörített tartalomra, amelyet a rendszer mindig letöltésként ad vissza.
getHfsItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)	Elem metaadatainak és/vagy tartalmának lekérése elemek gyűjteményéhez. A letöltési paraméter azt jelzi, hogy a tartalom letöltésként elérhető legyen,vagy csak streamként legyen elküldve a válaszban. Nem vonatkozik a tömörített tartalomra, amelyet mindig letöltésként ad vissza.
getHfsItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Elem metaadatainak és/vagy tartalmának lekérése egyetlen elemhez. A letöltési paraméter azt jelzi, hogy a tartalom letöltésként elérhető legyen,vagy csak streamként legyen elküldve a válaszban. Nem vonatkozik a tömörített tartalomra, amelyet a rendszer mindig letöltésként ad vissza.
getHfsItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Elem metaadatainak és/vagy tartalmának lekérése egyetlen elemhez. A letöltési paraméter azt jelzi, hogy a tartalom letöltésként elérhető legyen,vagy csak streamként legyen elküldve a válaszban. Nem vonatkozik a tömörített tartalomra, amelyet a rendszer mindig letöltésként ad vissza.
getImportRequest(string, string, number)	Egy adott importálási kérelem lekérése.
getItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Elem metaadatainak és/vagy tartalmának lekérése egyetlen elemhez. A letöltési paraméter azt jelzi, hogy a tartalom letöltésként elérhető legyen,vagy csak streamként legyen elküldve a válaszban. Nem vonatkozik a tömörített tartalomra, amelyet a rendszer mindig letöltésként ad vissza.
getItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Elem metaadatainak és/vagy tartalmának lekérése egyetlen elemhez. A letöltési paraméter azt jelzi, hogy a tartalom letöltésként elérhető legyen,vagy csak streamként legyen elküldve a válaszban. Nem vonatkozik a tömörített tartalomra, amelyet a rendszer mindig letöltésként ad vissza.
getItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)	Elem metaadatainak és/vagy tartalmának lekérése elemek gyűjteményéhez. A letöltési paraméter azt jelzi, hogy a tartalom letöltésként elérhető legyen,vagy csak streamként legyen elküldve a válaszban. Nem vonatkozik a tömörített tartalomra, amelyet mindig letöltésként ad vissza.
getItemsBatch(GitItemRequestData, string, string)	Egy adott útvonallistához vagy hosszú útvonalhoz tartozó tételeket kér egy repóban / project-ben
getItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Elem metaadatainak és/vagy tartalmának lekérése egyetlen elemhez. A letöltési paraméter azt jelzi, hogy a tartalom letöltésként elérhető legyen,vagy csak streamként legyen elküldve a válaszban. Nem vonatkozik a tömörített tartalomra, amelyet a rendszer mindig letöltésként ad vissza.
getItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Elem metaadatainak és/vagy tartalmának lekérése egyetlen elemhez. A letöltési paraméter azt jelzi, hogy a tartalom letöltésként elérhető legyen,vagy csak streamként legyen elküldve a válaszban. Nem vonatkozik a tömörített tartalomra, amelyet a rendszer mindig letöltésként ad vissza.
getLikes(string, number, number, number, string)	Kedveléseket kaphat egy megjegyzéshez.
getMergeBases(string, string, string, string, string, string)	Keresse meg két véglegesítés egyesítési alapjait, opcionálisan az elágazások között. Ha az otherRepositoryId nincs megadva, az egyesítési alapokat csak a helyi adattárNameOrId környezetében számítja ki a rendszer.
getMergeRequest(string, string, number, boolean)	Egy adott egyesítési művelet részleteinek lekérése.
getPermission(string, string, string)	Speciális biztonsági engedély állapota.
getPullRequest(string, number, string, number, number, number, boolean, boolean)	Lekéréses kérelem lekérése.
getPullRequestById(number, string)	Lekéréses kérelem lekérése.
getPullRequestCommits(string, number, string)	Kérje le a megadott lekéréses kérelem véglegesítéseit.
getPullRequestConflict(string, number, number, string)	Egy ütközés lekérése egy lekéréses kérelemhez azonosító szerint
getPullRequestConflicts(string, number, string, number, number, boolean, boolean, boolean)	Lekéréses kérelem összes ütközésének lekérése
getPullRequestIteration(string, number, number, string)	Lekérheti a lekéréses kérelemhez megadott iterációt.
getPullRequestIterationChanges(string, number, number, string, number, number, number)	Lekérheti a két iteráció közötti lekéréses kérelemben végrehajtott módosításokat.
getPullRequestIterationCommits(string, number, number, string, number, number)	Lekérheti a lekéréses kérelem megadott iterációjához tartozó véglegesítéseket.
getPullRequestIterations(string, number, string, boolean)	Kérje le a megadott lekéréses kérelem iterációinak listáját.
getPullRequestIterationStatus(string, number, number, number, string)	A lekéréses kérelem adott iterációs állapotának lekérése azonosító alapján. Az állapotazonosító minden iterációban egyedi a lekéréses kérelemben.
getPullRequestIterationStatuses(string, number, number, string)	Lekérheti a lekéréses kérelmek iterációjához társított összes állapotot.
getPullRequestLabel(string, number, string, string, string)	Lekéri a lekéréses kérelemhez hozzárendelt egyetlen címkét (címkét).
getPullRequestLabels(string, number, string, string)	Lekérheti a lekéréses kérelemhez rendelt összes címkét (címkét).
getPullRequestProperties(string, number, string)	A lekéréses kérelem külső tulajdonságainak lekérése.
getPullRequestQuery(GitPullRequestQuery, string, string)	Ez az API az adott véglegesítéshez kapcsolódó lekéréses kérelmek megkeresésére szolgál. Használható egy adott egyesítési véglegesítést létrehozó lekéréses kérelem megkeresésére, vagy az összes lekéréses kérelem megkeresésére, amely valaha egyesít egy adott véglegesítést. A bemenet a lekérdezések listája, amelyek mindegyike a véglegesítések listáját tartalmazza. Minden olyan véglegesítéshez, amelyhez keres, visszakapja a véglegesítési kérelmek szótárát.
getPullRequestReviewer(string, number, string, string)	Egy lekéréses kérelem adott véleményezője adatainak lekérése
getPullRequestReviewers(string, number, string)	Lekéréses kérelem véleményezőinek lekérése
getPullRequests(string, GitPullRequestSearchCriteria, string, number, number, number)	A megadott feltételeknek megfelelő lekéréses kérelmek lekérése.
getPullRequestsByProject(string, GitPullRequestSearchCriteria, number, number, number)	A megadott feltételeknek megfelelő lekéréses kérelmek lekérése.
getPullRequestStatus(string, number, number, string)	Az adott lekéréses kérelem állapotának lekérése azonosító alapján. Az állapotazonosító minden iterációban egyedi a lekéréses kérelemben.
getPullRequestStatuses(string, number, string)	Lekérheti a lekéréses kérelemhez társított összes állapotot.
getPullRequestThread(string, number, number, string, number, number)	Szál lekérése lekéréses kérelemben.
getPullRequestWorkItemRefs(string, number, string)	Lekérheti a lekéréses kérelemhez társított munkaelemek listáját.
getPush(string, number, string, number, boolean)	Lekéri az adott leküldést.
getPushCommits(string, number, string, number, number, boolean)	Lekérheti az adott leküldéshez társított véglegesítések listáját.
getPushes(string, string, number, number, GitPushSearchCriteria)	Lekéri a megadott adattárhoz társított leküldéseket.
getRecycleBinRepositories(string)	Kérje le a helyreállíthatóan törölt git-adattárakat a lomtárból.
getRefFavorite(string, number)	Lekéri a kedvenc azonosítóhoz tartozó refs kedvencet.
getRefFavorites(string, string, string)	Lekéri a refs kedvenceket egy adattárhoz és egy identitáshoz.
getRefFavoritesForProject(string, string)
getRefs(string, string, string, boolean, boolean, boolean, boolean, boolean, string, boolean)	Lekérdezi a megadott adattárat a saját adattáraihoz, és visszaadja őket.
getRepositories(string, boolean, boolean, boolean)	Git-adattárak lekérése.
getRepositoriesPaged(string, boolean, boolean, boolean, string, number, string)	Lekérheti a név és a lapozás szerinti szűrővel rendelkező git-adattárakat.
getRepository(string, string)	Git-adattár lekérése.
getRepositoryWithParent(string, boolean, string)	Git-adattár lekérése.
getRevert(string, number, string)	A visszaállítási művelettel kapcsolatos információk lekérése a visszaállítási azonosító alapján.
getRevertConflict(string, number, number, string)	Egy ütközés lekérése azonosító alapján történő visszaállításhoz
getRevertConflicts(string, number, string, string, number, boolean, boolean, boolean)	A visszaállítás összes ütközésének lekérése
getRevertForRefName(string, string, string)	Egy adott ág visszaállítási műveletével kapcsolatos információk lekérése.
getStatuses(string, string, string, number, number, boolean)	A Git-véglegesítéshez társított állapotok lekérése.
getSuggestions(string, string, boolean)	Szerezz elő egy pull request javaslatot egy adott tárolóhoz vagy csapat projekthez.
getThreads(string, number, string, number, number)	Lekérheti egy lekéréses kérelem összes szálát.
getTree(string, string, string, string, boolean, string)	A favégpont visszaadja a megadott fa alatti objektumok gyűjteményét. A fák a Git-adattár mappái.
getTreeZip(string, string, string, string, boolean, string)	A favégpont visszaadja a megadott fa alatti objektumok gyűjteményét. A fák a Git-adattár mappái.
queryImportRequests(string, string, boolean)	Az adattár importálási kérelmeinek lekérése.
restoreRepositoryFromRecycleBin(GitRecycleBinRepositoryDetails, string, string)	Helyreállíthatóan törölt Git-adattár helyreállítása. A legutóbb törölt adattárak helyreállítható törlési állapotba kerülnek egy ideig, mielőtt azok véglegesen törlődnek, és helyreállíthatatlanná válnak.
setEnableOnCreateHost(boolean)
setEnableOnCreateProject(string, boolean)
sharePullRequest(ShareNotificationContext, string, number, string)	E-mail-értesítést küld egy adott lekéréses kérelemről a címzettek egy csoportjának
updateCherryPickConflict(GitConflict, string, number, number, string)	Egyesítési ütközések feloldásának frissítése
updateCherryPickConflicts(GitConflict[], string, number, string)	Több egyesítési ütközés feloldásának frissítése
updateComment(Comment, string, number, number, number, string)	Egy adott szálhoz társított megjegyzés frissítése egy lekéréses kérelemben.
updateEnablementStatus(AdvSecEnablementUpdate[])	POST-engedélyezés állapota az adattárakhoz.
updateImportRequest(GitImportRequest, string, string, number)	Sikertelen importálási kérelem újrapróbálkozása vagy elhagyása.
updatePullRequest(GitPullRequest, string, number, string)	Lekéréses kérelem frissítése
updatePullRequestConflict(GitConflict, string, number, number, string)	Egyesítési ütközések feloldásának frissítése
updatePullRequestConflicts(GitConflict[], string, number, string)	Több egyesítési ütközés feloldásának frissítése
updatePullRequestIterationStatuses(JsonPatchDocument, string, number, number, string)	A lekéréses kérelem iterációs állapotainak gyűjteményének frissítése. Az egyetlen támogatott művelettípus a .
updatePullRequestProperties(JsonPatchDocument, string, number, string)	Lekéréses kérelem külső tulajdonságainak létrehozása vagy frissítése. A javítási művelet lehet , vagy . A működéshez az elérési út üres lehet. Ha az elérési út üres, az értéknek kulcsértékpárok listájának kell lennie. Működéshez az elérési út nem lehet üres. Ha az elérési út nem létezik, a tulajdonság hozzá lesz adva a gyűjteményhez. Működéshez az elérési út nem lehet üres. Ha az elérési út nem létezik, a program nem hajt végre műveletet.
updatePullRequestReviewer(IdentityRefWithVote, string, number, string, string)	Véleményező bejegyzés szerkesztése. Ezek a mezők javíthatók: isFlagged, hasDeclined
updatePullRequestReviewers(IdentityRefWithVote[], string, number, string)	Több véleményező szavazatának alaphelyzetbe állítása lekéréses kérelem esetén. MEGJEGYZÉS: Ez a végpont csak a szavazatok frissítését támogatja, de nem támogatja a szükséges véleményezők (szabályzat használata) vagy a megjelenített nevek frissítését.
updatePullRequestStatuses(JsonPatchDocument, string, number, string)	A lekéréses kérelmek állapotgyűjteményének frissítése. Az egyetlen támogatott művelettípus a .
updateRef(GitRefUpdate, string, string, string, string)	Ág zárolása vagy zárolásának feloldása.
updateRefs(GitRefUpdate[], string, string, string)	Refs(ágak) létrehozása, frissítése vagy törlése.
updateRepository(GitRepository, string, string)	Frissíti a Git-adattárat egy új adattárnévvel vagy egy új alapértelmezett ággal.
updateRevertConflict(GitConflict, string, number, number, string)	Egyesítési ütközések feloldásának frissítése
updateRevertConflicts(GitConflict[], string, number, string)	Több egyesítési ütközés feloldásának frissítése
updateThread(GitPullRequestCommentThread, string, number, number, string)	Egy szál frissítése lekéréses kérelemben.

Építő részletek

GitRestClient(IVssRestClientOptions)

new GitRestClient(options: IVssRestClientOptions)

Paraméterek

options: IVssRestClientOptions

Ingatlan részletei

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Ingatlanérték

string

Módszer részletei

createAnnotatedTag(GitAnnotatedTag, string, string)

Jegyzetekkel ellátott címke létrehozása.

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

Paraméterek

tagObject: GitAnnotatedTag

A létrehozandó címke részleteit tartalmazó objektum.

project: string

Project ID vagy project név

repositoryId: string

Az adattár azonosítója vagy neve.

Visszatér

Promise<GitAnnotatedTag>

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

Új fájl csatolása lekéréses kérelemhez.

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

Paraméterek

content: any

Feltöltendő tartalom

fileName: string

A fájl neve.

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<Attachment>

createCherryPick(GitAsyncRefOperationParameters, string, string)

A Cherry kiválaszt egy adott véglegesítést vagy véglegesítést, amely egy lekéréses kérelemhez van társítva egy új ágba.

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

Paraméterek

cherryPickToCreate: GitAsyncRefOperationParameters

project: string

Project ID vagy project név

repositoryId: string

Az adattár azonosítója.

Visszatér

Promise<GitCherryPick>

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

Megjegyzés létrehozása egy adott szálhoz egy lekéréses kérelemben (szálonként legfeljebb 500 megjegyzés hozható létre).

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

Paraméterek

comment: Comment

A létrehozandó megjegyzés. A megjegyzések legfeljebb 150 000 karakter hosszúságúak lehetnek.

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

threadId: number

Annak a szálnak az azonosítója, amelyben a kívánt megjegyzés szerepel.

project: string

Project ID vagy project név

Visszatér

Promise<Comment>

createCommitStatus(GitStatus, string, string, string)

Git véglegesítési állapot létrehozása.

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

Paraméterek

gitCommitStatusToCreate: GitStatus

Létre kell hozni a Git véglegesítési állapotobjektumát.

commitId: string

A Git-véglegesítés azonosítója.

repositoryId: string

Az adattár azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<GitStatus>

createFavorite(GitRefFavorite, string)

Létrehoz egy hiv-kedvencet

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

Paraméterek

favorite: GitRefFavorite

A létrehozandó ref kedvenc.

project: string

Project ID vagy project név

Visszatér

Promise<GitRefFavorite>

createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)

Kérje meg, hogy egy másik adattár adattárát is beolvassa ebbe a tárházba. Két meglévő elágazás szinkronizálása. A fork létrehozásához kérjük, nézze meg a <a href="https://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1" > repositories endpoint</a>

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

Paraméterek

syncParams: GitForkSyncRequestParameters

Forrástár és ref-leképezés.

repositoryNameOrId: string

Az adattár neve vagy azonosítója.

project: string

Project ID vagy project név

includeLinks: boolean

Igaz a hivatkozások belefoglalásához

Visszatér

Promise<GitForkSyncRequest>

createImportRequest(GitImportRequest, string, string)

Hozzon létre egy importálási kérelmet.

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

Paraméterek

importRequest: GitImportRequest

A létrehozandó importálási kérelem.

project: string

Project ID vagy project név

repositoryId: string

Az adattár neve vagy azonosítója.

Visszatér

Promise<GitImportRequest>

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

Adjon hozzá hasonlót egy megjegyzéshez.

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

Paraméterek

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

threadId: number

A megjegyzést tartalmazó szál azonosítója.

commentId: number

A megjegyzés azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<void>

createMergeRequest(GitMergeParameters, string, string, boolean)

Git-egyesítési művelet kérése. Jelenleg csak 2 véglegesítés egyesítését támogatjuk.

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

Paraméterek

mergeParameters: GitMergeParameters

A szülők véglegesítik a véglegesítési azonosítókat, és egyesítik a véglegesítési rendet.

project: string

Project ID vagy project név

repositoryNameOrId: string

Az adattár neve vagy azonosítója.

includeLinks: boolean

Igaz a hivatkozások belefoglalásához

Visszatér

Promise<GitMerge>

createPullRequest(GitPullRequest, string, string, boolean)

Lekéréses kérelem létrehozása.

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

Paraméterek

gitPullRequestToCreate: GitPullRequest

A létrehozandó lekéréses kérelem.

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

project: string

Project ID vagy project név

supportsIterations: boolean

Ha igaz, a lekéréses kérelemre irányuló későbbi leküldések egyenként áttekinthetők lesznek. Állítsa ezt hamis értékre nagy lekéréses kérelmek esetén teljesítménybeli okokból, ha erre a funkcióra nincs szükség.

Visszatér

Promise<GitPullRequest>

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

Hozzon létre egy lekéréses kérelem állapotát az iterációban. Ez a művelet ugyanazzal az eredménnyel fog rendelkezni, mint a lekéréses kérelem állapotának létrehozása a kérelem törzsében megadott iterációs azonosítóval.

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

Paraméterek

status: GitPullRequestStatus

Lekéréses kérelem állapotának létrehozása.

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

iterationId: number

A lekéréses kérelem iterációjának azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<GitPullRequestStatus>

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

Hozzon létre egy címkét (ha még nem létezik), és adja hozzá címkeként (címkeként) egy adott lekéréses kérelemhez. Az egyetlen kötelező mező az új címke (címke) neve.

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

Paraméterek

label: WebApiCreateTagRequestData

A lekéréses kérelemhez hozzárendelendő címke.

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

project: string

Project ID vagy project név

projectId: string

Project ID vagy project név.

Visszatér

Promise<WebApiTagDefinition>

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

Adjon hozzá egy véleményezőt egy lekéréses kérelemhez, vagy szavazzon.

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

Paraméterek

reviewer: IdentityRefWithVote

Bíráló szavazata.br /Ha a felülvizsgáló azonosítója szerepel itt, meg kell egyeznie a reviewerID paraméterrel.br /A véleményezők ezzel a módszerrel állíthatják be saját szavazatukat. Más véleményezők hozzáadásakor a szavazást nullára kell állítani.

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

reviewerId: string

A véleményező azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<IdentityRefWithVote>

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

Véleményezők hozzáadása lekéréses kérelemhez.

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

Paraméterek

reviewers: IdentityRef[]

A lekéréses kérelemhez hozzáadni kívánt véleményezők.

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<IdentityRefWithVote[]>

createPullRequestStatus(GitPullRequestStatus, string, number, string)

Lekéréses kérelem állapotának létrehozása.

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

Paraméterek

status: GitPullRequestStatus

Lekéréses kérelem állapotának létrehozása.

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<GitPullRequestStatus>

createPush(GitPush, string, string)

Módosítások leküldése az adattárba.

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

Paraméterek

push: GitPush

repositoryId: string

Az adattár neve vagy azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<GitPush>

createRepository(GitRepositoryCreateOptions, string, string)

Hozz létre git repositoryt egy csapat projektben.

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

Paraméterek

gitRepositoryToCreate: GitRepositoryCreateOptions

Megadja a repo nevét, a csapat projekt és/vagy a szülő tárolót. A csapat project adatai kihagyhatók a gitRepositoryToCreate oldalról, ha a kérés project-scope-ban van (azaz tartalmazza a project Id-t is).

project: string

Project ID vagy project név

sourceRef: string

[nem kötelező] Az elágazás-adattár létrehozásakor használni kívánt forrás-hivak megadása

Visszatér

Promise<GitRepository>

createRevert(GitAsyncRefOperationParameters, string, string)

Elindítja a műveletet egy új ág létrehozásához, amely visszaállítja egy adott véglegesítés vagy egy lekéréses kérelemhez társított véglegesítések által bevezetett módosításokat.

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

Paraméterek

revertToCreate: GitAsyncRefOperationParameters

project: string

Project ID vagy project név

repositoryId: string

Az adattár azonosítója.

Visszatér

Promise<GitRevert>

createThread(GitPullRequestCommentThread, string, number, string)

Szál létrehozása lekéréses kérelemben.

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

Paraméterek

commentThread: GitPullRequestCommentThread

A létrehozandó szál. A szálnak legalább egy megjegyzést tartalmaznia kell.

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<GitPullRequestCommentThread>

createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)

Adjon hozzá egy nem lényegtelen identitást egy lekéréses kérelem véleményezőihez.

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

Paraméterek

reviewer: IdentityRefWithVote

A lekéréses kérelemhez hozzáadni kívánt véleményező.

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<IdentityRefWithVote>

deleteAttachment(string, string, number, string)

Lekéréses kérelem mellékletének törlése.

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

Paraméterek

fileName: string

A törölni kívánt melléklet neve.

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<void>

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

Töröljön egy adott szálhoz társított megjegyzést egy lekéréses kérelemben.

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

Paraméterek

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

threadId: number

Annak a szálnak az azonosítója, amelyben a kívánt megjegyzés szerepel.

commentId: number

A megjegyzés azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<void>

deleteEnablementStatus(boolean, boolean, string[])

A DELETE törli az engedélyezés állapotát és a BillableCommitters adatait a DB-ből. Az engedélyezési adatok törlése hatékonyan letiltja azokat az érintett adattárak esetében.

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

Paraméterek

allProjects: boolean

includeBillableCommitters: boolean

projectIds: string[]

Visszatér

Promise<void>

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

Megjegyzésen lévő kedvelés törlése.

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

Paraméterek

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

threadId: number

A megjegyzést tartalmazó szál azonosítója.

commentId: number

A megjegyzés azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<void>

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

A lekéréses kérelem iterációs állapotának törlése.

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

Paraméterek

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

iterationId: number

A lekéréses kérelem iterációjának azonosítója.

statusId: number

A lekéréses kérelem állapotának azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<void>

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

Eltávolít egy címkét (címkét) a lekéréses kérelemhez rendelt címkék készletéből. Maga a címke nem törlődik.

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

Paraméterek

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

labelIdOrName: string

A kért címke neve vagy azonosítója.

project: string

Project ID vagy project név

projectId: string

Project ID vagy project név.

Visszatér

Promise<void>

deletePullRequestReviewer(string, number, string, string)

Véleményező eltávolítása lekéréses kérelemből.

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

Paraméterek

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

reviewerId: string

Az eltávolítandó véleményező azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<void>

deletePullRequestStatus(string, number, number, string)

Lekéréses kérelem állapotának törlése.

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

Paraméterek

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

statusId: number

A lekéréses kérelem állapotának azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<void>

deleteRefFavorite(string, number)

Törli a megadott refs kedvencet

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

Paraméterek

project: string

Project ID vagy project név

favoriteId: number

A törölni kívánt hiv-kedvenc azonosítója.

Visszatér

Promise<void>

deleteRepository(string, string)

Git-adattár törlése

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

Paraméterek

repositoryId: string

Az adattár azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<void>

deleteRepositoryFromRecycleBin(string, string)

Helyreállíthatóan törölt Git-adattár megsemmisítése (kemény törlés).

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

Paraméterek

project: string

Project ID vagy project név

repositoryId: string

Az adattár azonosítója.

Visszatér

Promise<void>

getAccessibleRepositories(GetAccessibleRepositoriesRequest)

POST kérés a hozzáférési tárolók megszerzéséhez az engedély alapján (batch operation).

function getAccessibleRepositories(request: GetAccessibleRepositoriesRequest): Promise<GetAccessibleRepositoriesResponse>

Paraméterek

request: GetAccessibleRepositoriesRequest

Kérelem, amely tartalmazza az engedélyt és a tárolóazonosítókat az ellenőrzéshez

Visszatér

Promise<GetAccessibleRepositoriesResponse>

getAnnotatedTag(string, string, string)

Jegyzetekkel ellátott címke lekérése.

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

Paraméterek

project: string

Project ID vagy project név

repositoryId: string

Az adattár azonosítója vagy neve.

objectId: string

A lekérendő címke ObjectId (Sha1Id) azonosítója.

Visszatér

Promise<GitAnnotatedTag>

getAttachmentContent(string, string, number, string)

Lekérheti a lekéréses kérelem mellékletének fájltartalmát.

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

Paraméterek

fileName: string

A melléklet neve.

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<ArrayBuffer>

getAttachments(string, number, string)

Lekérheti az adott lekéréses kérelemhez csatolt fájlok listáját.

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

Paraméterek

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<Attachment[]>

getAttachmentZip(string, string, number, string)

Lekérheti a lekéréses kérelem mellékletének fájltartalmát.

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

Paraméterek

fileName: string

A melléklet neve.

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<ArrayBuffer>

getBillableCommitters(string, Date, number, number)

Az Advanced Security szolgáltatás tényleges számlázható véglegesítéseinek lekérése egy adott dátumhoz.

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

Paraméterek

project: string

Project ID vagy project név

billingDate: Date

UTC várható. Ha nincs megadva alapértelmezett érték az előző számlázási napra.

skip: number

A lapozás szimulálásához hagyja ki az X eredményhalmaz-sorokat.

take: number

Az eredményhalmaz Y sorait adja vissza a lapozás szimulálásához.

Visszatér

Promise<BillableCommitter[]>

getBillableCommittersDetail(string, string, Date)

Részletes tényleges számlázható véglegesítések lekérése az Advanced Security szolgáltatáshoz egy adott dátumhoz. A részletes eredmények szándékosan nem szűrik ki a helyreállíthatóan törölt projekteket és adattárakat a számlázási problémák diagnosztizálásához.

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

Paraméterek

project: string

Project ID vagy project név

includeDetails: string

Adja vissza a számlázható véglegesítések összes részletét.

billingDate: Date

UTC várható. Ha nincs megadva alapértelmezett érték az előző számlázási napra.

Visszatér

Promise<BillableCommitterDetail[]>

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

Egyetlen blob lekérése.

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

Paraméterek

repositoryId: string

Az adattár neve vagy azonosítója.

sha1: string

A fájl SHA1 kivonata. A fájl SHA1-ét a "Git/Items/Get Item" végponttal szerezheti be.

project: string

Project ID vagy project név

download: boolean

Ha igaz, a böngészőben való megjelenítés helyett kérje le a letöltést. Megjegyzés: ez az érték alapértelmezés szerint igaz, ha $format zip

fileName: string

Adjon meg egy fájlnevet a letöltéshez.

resolveLfs: boolean

Ha igaz, próbálja meg feloldani a blobokat az LFS-tartalmára, ha az egy LFS-mutatófájl. Csak az octet-stream Accept fejlécekkel vagy $format típusokkal kompatibilis

Visszatér

Promise<GitBlobRef>

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

Egyetlen blob lekérése.

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

Paraméterek

repositoryId: string

Az adattár neve vagy azonosítója.

sha1: string

A fájl SHA1 kivonata. A fájl SHA1-ét a "Git/Items/Get Item" végponttal szerezheti be.

project: string

Project ID vagy project név

download: boolean

Ha igaz, a böngészőben való megjelenítés helyett kérje le a letöltést. Megjegyzés: ez az érték alapértelmezés szerint igaz, ha $format zip

fileName: string

Adjon meg egy fájlnevet a letöltéshez.

resolveLfs: boolean

Ha igaz, próbálja meg feloldani a blobokat az LFS-tartalmára, ha az egy LFS-mutatófájl. Csak az octet-stream Accept fejlécekkel vagy $format típusokkal kompatibilis

Visszatér

Promise<ArrayBuffer>

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

Lekéri egy vagy több blobot egy zip-fájl letöltésében.

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

Paraméterek

blobIds: string[]

A zip-fájlban visszaadandó blobazonosítók (SHA1 kivonatok).

repositoryId: string

Az adattár neve vagy azonosítója.

project: string

Project ID vagy project név

filename: string

Visszatér

Promise<ArrayBuffer>

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

Egyetlen blob lekérése.

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

Paraméterek

repositoryId: string

Az adattár neve vagy azonosítója.

sha1: string

A fájl SHA1 kivonata. A fájl SHA1-ét a "Git/Items/Get Item" végponttal szerezheti be.

project: string

Project ID vagy project név

download: boolean

Ha igaz, a böngészőben való megjelenítés helyett kérje le a letöltést. Megjegyzés: ez az érték alapértelmezés szerint igaz, ha $format zip

fileName: string

Adjon meg egy fájlnevet a letöltéshez.

resolveLfs: boolean

Ha igaz, próbálja meg feloldani a blobokat az LFS-tartalmára, ha az egy LFS-mutatófájl. Csak az octet-stream Accept fejlécekkel vagy $format típusokkal kompatibilis

Visszatér

Promise<ArrayBuffer>

getBranch(string, string, string, GitVersionDescriptor)

Egyetlen ág statisztikáinak lekérése.

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

Paraméterek

repositoryId: string

Az adattár neve vagy azonosítója.

name: string

Az ág neve.

project: string

Project ID vagy project név

baseVersionDescriptor: GitVersionDescriptor

Az alapként használni kívánt véglegesítést vagy ágat azonosítja.

Visszatér

Promise<GitBranchStats>

getBranches(string, string, GitVersionDescriptor)

Az adattárban lévő összes ág statisztikáinak lekérése.

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

Paraméterek

repositoryId: string

Az adattár neve vagy azonosítója.

project: string

Project ID vagy project név

baseVersionDescriptor: GitVersionDescriptor

Az alapként használni kívánt véglegesítést vagy ágat azonosítja.

Visszatér

Promise<GitBranchStats[]>

getBranchStatsBatch(GitQueryBranchStatsCriteria, string, string)

Több véglegesítés statisztikáinak lekérése

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

Paraméterek

searchCriteria: GitQueryBranchStatsCriteria

Alap véglegesítés és az összehasonlítandó cél véglegesítések listája.

repositoryId: string

Az adattár neve vagy azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<GitBranchStats[]>

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

Egy adott véglegesítés módosításainak lekérése.

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

Paraméterek

commitId: string

A véglegesítés azonosítója.

repositoryId: string

Az adattár azonosítója vagy rövid neve. A rövid név használatához meg kell adni a projectId azonosítót is.

project: string

Project ID vagy project név

top: number

A visszaadandó módosítások maximális száma.

skip: number

A kihagyandó módosítások száma.

Visszatér

Promise<GitCommitChanges>

getCherryPick(string, number, string)

A cseresznyeválasztási művelettel kapcsolatos információk lekérése cseresznyeválasztó azonosító alapján.

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

Paraméterek

project: string

Project ID vagy project név

cherryPickId: number

A cseresznye csákány azonosítója.

repositoryId: string

Az adattár azonosítója.

Visszatér

Promise<GitCherryPick>

getCherryPickConflict(string, number, number, string)

Egy ütközés lekérése egy cseresznyeválasztáshoz azonosító szerint

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

Paraméterek

repositoryId: string

cherryPickId: number

conflictId: number

project: string

Project ID vagy project név

Visszatér

Promise<GitConflict>

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

Cseresznyés választás összes ütközésének lekérése

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

Paraméterek

repositoryId: string

cherryPickId: number

project: string

Project ID vagy project név

continuationToken: string

top: number

excludeResolved: boolean

onlyResolved: boolean

includeObsolete: boolean

Visszatér

Promise<PagedList<GitConflict>>

getCherryPickForRefName(string, string, string)

Egy adott ág cseresznyeválasztási műveletével kapcsolatos információk lekérése. Ez a művelet a mögöttes objektumstruktúra miatt költséges, ezért ez az API csak az 1000 legutóbbi cseresznyeválasztási műveletet vizsgálja.

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

Paraméterek

project: string

Project ID vagy project név

repositoryId: string

Az adattár azonosítója.

refName: string

A cseresznyeválasztási művelethez használt GitAsyncRefOperationParameters generatedRefName.

Visszatér

Promise<GitCherryPick>

getCherryPickRelationships(string, string, string, boolean)

A véglegesítési azonosító egy olyan véglegesítések listáját adja vissza, amelyek ugyanabban a cherry-pick családban találhatók.

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

Paraméterek

repositoryNameOrId: string

commitId: string

project: string

Project ID vagy project név

includeLinks: boolean

Visszatér

Promise<GitCommitRef[]>

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

Lekérheti egy adott szálhoz társított megjegyzést egy lekéréses kérelemben.

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

Paraméterek

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

threadId: number

Annak a szálnak az azonosítója, amelyben a kívánt megjegyzés szerepel.

commentId: number

A megjegyzés azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<Comment>

getComments(string, number, number, string)

Lekérheti az adott szálhoz társított összes megjegyzést egy lekéréses kérelemben.

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

Paraméterek

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

threadId: number

A szál azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<Comment[]>

getCommit(string, string, string, number)

Egy adott véglegesítés lekérése.

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

Paraméterek

commitId: string

A véglegesítés azonosítója.

repositoryId: string

Az adattár azonosítója vagy rövid neve. A rövid név használatához meg kell adni a projectId azonosítót is.

project: string

Project ID vagy project név

changeCount: number

Az eredménybe belefoglalandó módosítások száma.

Visszatér

Promise<GitCommit>

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

Keresse meg a legközelebbi közös véglegesítést (az egyesítési alap) a bázis és a cél véglegesítés között, és kérje le a különbséget az alap- és a cél véglegesítések, illetve a közös és a cél véglegesítések között.

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

Paraméterek

repositoryId: string

Az adattár neve vagy azonosítója.

project: string

Project ID vagy project név

diffCommonCommit: boolean

Ha igaz, a közös és a cél véglegesítések közötti különbség. Ha hamis, az alap- és a cél véglegesítések közötti eltérés.

top: number

A visszaadandó módosítások maximális száma. Alapértelmezés szerint 100.

skip: number

Kihagyandó módosítások száma

baseVersionDescriptor: GitBaseVersionDescriptor

Az alap véglegesítés leírója.

targetVersionDescriptor: GitTargetVersionDescriptor

A cél véglegesítés leírója.

Visszatér

Promise<GitCommitDiffs>

getCommits(string, GitQueryCommitsCriteria, string)

Retriev git commit-eket egy project számára

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

Paraméterek

repositoryId: string

Az adattár azonosítója vagy rövid neve. A rövid név használatához meg kell adni a projectId azonosítót is.

searchCriteria: GitQueryCommitsCriteria

project: string

Project ID vagy project név

Visszatér

Promise<GitCommitRef[]>

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

Retriev git commit-eket egy olyan project számára, amely megfelel a keresési kritériumoknak

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

Paraméterek

searchCriteria: GitQueryCommitsCriteria

Keresési beállítások

repositoryId: string

Az adattár neve vagy azonosítója.

project: string

Project ID vagy project név

skip: number

Kihagyandó véglegesítések száma. Az érték nem haladhatja meg a 3 000 000 értéket.

top: number

A visszaadni kívánt véglegesítések maximális száma. Az érték nem haladhatja meg az 50 000 értéket.

includeStatuses: boolean

Igaz, hogy további véglegesítési állapotinformációkat is tartalmazzon.

Visszatér

Promise<GitCommitRef[]>

getDeletedRepositories(string)

Törölt git-adattárak lekérése.

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

Paraméterek

project: string

Project ID vagy project név

Visszatér

Promise<GitDeletedRepository[]>

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

KAPD az Enablement státuszt a project repozióriumaihoz.

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

Paraméterek

projectIds: string[]

Null alapértelmezett minden projekt a hostban, a project repos státuszának listája vissza kell adni

billingDate: Date

UTC várható, null alapértelmezett utcnow(), megadható egy időpont állapota

skip: number

A lapozás szimulálásához hagyja ki az X eredményhalmaz-sorokat.

take: number

Az eredményhalmaz Y sorait adja vissza a lapozás szimulálásához.

Visszatér

Promise<AdvSecEnablementStatus[]>

getEnableOnCreateHost(boolean)

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

Paraméterek

enableOnCreateHost: boolean

Visszatér

Promise<boolean>

getEnableOnCreateProject(string)

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

Paraméterek

enableOnCreateProjectId: string

Visszatér

Promise<boolean>

getEstimatedBillableCommittersRepo(string, string)

Lekérheti az elmúlt 90 napra vonatkozó becsült számlázható véglegesítéseket egy adattárhoz.

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

Paraméterek

project: string

Project ID vagy project név

repositoryId: string

Visszatér

Promise<BillableCommitter[]>

getEstimatedBillablePushersOrg()

Az elmúlt 90 napra vonatkozó becsült számlázható leküldések lekérése egy szervezet számára.

function getEstimatedBillablePushersOrg(): Promise<BillablePusher[]>

Visszatér

Promise<BillablePusher[]>

getEstimatedBillablePushersProject(string)

Kérj becsült számlázható forgalmazókat egy projekt utolsó 90 napjára.

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

Paraméterek

project: string

Project ID vagy project név

Visszatér

Promise<BillablePusher[]>

getFileDiffs(FileDiffsCriteria, string, string)

A megadott fájlok fájldiffjeinek lekérése

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

Paraméterek

fileDiffsCriteria: FileDiffsCriteria

Fájlparaméter-objektumok listája

project: string

Project ID vagy project név

repositoryId: string

Az adattár neve vagy azonosítója

Visszatér

Promise<FileDiff[]>

getForks(string, string, string, boolean)

A gyűjteményben lévő adattár összes elágazásának lekérése.

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

Paraméterek

repositoryNameOrId: string

Az adattár neve vagy azonosítója.

collectionId: string

Csapat project gyűjtemény azonosítója.

project: string

Project ID vagy project név

includeLinks: boolean

Igaz, hogy hivatkozásokat tartalmazzon.

Visszatér

Promise<GitRepositoryRef[]>

getForkSyncRequest(string, number, string, boolean)

Lekérheti egy adott elágazás szinkronizálási műveletének részleteit.

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

Paraméterek

repositoryNameOrId: string

Az adattár neve vagy azonosítója.

forkSyncOperationId: number

A szinkronizálási kérelem műveleti azonosítója.

project: string

Project ID vagy project név

includeLinks: boolean

Igaz, hogy hivatkozásokat tartalmazzon.

Visszatér

Promise<GitForkSyncRequest>

getForkSyncRequests(string, string, boolean, boolean)

Kérje le az adattár összes kért elágazás-szinkronizálási műveletét.

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

Paraméterek

repositoryNameOrId: string

Az adattár neve vagy azonosítója.

project: string

Project ID vagy project név

includeAbandoned: boolean

Igaz, hogy elhagyatott kéréseket is tartalmazzon.

includeLinks: boolean

Igaz, hogy hivatkozásokat tartalmazzon.

Visszatér

Promise<GitForkSyncRequest[]>

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

Elem metaadatainak és/vagy tartalmának lekérése egyetlen elemhez. A letöltési paraméter azt jelzi, hogy a tartalom letöltésként elérhető legyen,vagy csak streamként legyen elküldve a válaszban. Nem vonatkozik a tömörített tartalomra, amelyet a rendszer mindig letöltésként ad vissza.

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>

Paraméterek

repositoryId: string

Az adattár neve vagy azonosítója.

path: string

Az elem elérési útja.

project: string

Project ID vagy project név

scopePath: string

Az elérési út hatóköre. Az alapértelmezett érték null.

recursionLevel: VersionControlRecursionType

A kérés rekurziós szintje. Az alapértelmezett érték a "nincs", nincs rekurzió.

includeContentMetadata: boolean

Állítsa igaz értékre a tartalom metaadatainak belefoglalására. Az alapértelmezett érték hamis.

latestProcessedChange: boolean

Állítsa igaz értékre, hogy tartalmazza a legújabb módosításokat. Az alapértelmezett érték hamis.

download: boolean

Állítsa igaz értékre a válasz fájlként való letöltéséhez. Az alapértelmezett érték hamis.

versionDescriptor: GitVersionDescriptor

Verzióleíró. Az alapértelmezett ág az adattár alapértelmezett ága.

includeContent: boolean

Állítsa igaz értékre az elem tartalmát a json kérésekor. Az alapértelmezett érték hamis.

resolveHfs: boolean

Állítsa igaz értékre a Git HFS mutatófájljainak feloldásához, hogy tényleges tartalmat adjon vissza a Git HFS-ből. Az alapértelmezett érték igaz.

sanitize: boolean

Állítsa igaz értékre egy svg-fájl megtisztításához és képként való visszaadásához. Csak akkor hasznos, ha svg-fájlra van szükség. Az alapértelmezett érték hamis.

Visszatér

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>

Paraméterek

repositoryId: string

Az adattár neve vagy azonosítója.

path: string

Az elem elérési útja.

project: string

Project ID vagy project név

scopePath: string

Az elérési út hatóköre. Az alapértelmezett érték null.

recursionLevel: VersionControlRecursionType

A kérés rekurziós szintje. Az alapértelmezett érték a "nincs", nincs rekurzió.

includeContentMetadata: boolean

Állítsa igaz értékre a tartalom metaadatainak belefoglalására. Az alapértelmezett érték hamis.

latestProcessedChange: boolean

Állítsa igaz értékre, hogy tartalmazza a legújabb módosításokat. Az alapértelmezett érték hamis.

download: boolean

Állítsa igaz értékre a válasz fájlként való letöltéséhez. Az alapértelmezett érték hamis.

versionDescriptor: GitVersionDescriptor

Verzióleíró. Az alapértelmezett ág az adattár alapértelmezett ága.

includeContent: boolean

Állítsa igaz értékre az elem tartalmát a json kérésekor. Az alapértelmezett érték hamis.

resolveHfs: boolean

Állítsa igaz értékre a Git HFS mutatófájljainak feloldásához, hogy tényleges tartalmat adjon vissza a Git HFS-ből. Az alapértelmezett érték igaz.

sanitize: boolean

Állítsa igaz értékre egy svg-fájl megtisztításához és képként való visszaadásához. Csak akkor hasznos, ha svg-fájlra van szükség. Az alapértelmezett érték hamis.

Visszatér

Promise<ArrayBuffer>

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

Elem metaadatainak és/vagy tartalmának lekérése elemek gyűjteményéhez. A letöltési paraméter azt jelzi, hogy a tartalom letöltésként elérhető legyen,vagy csak streamként legyen elküldve a válaszban. Nem vonatkozik a tömörített tartalomra, amelyet mindig letöltésként ad vissza.

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

Paraméterek

repositoryId: string

Az adattár neve vagy azonosítója.

project: string

Project ID vagy project név

scopePath: string

Az elérési út hatóköre. Az alapértelmezett érték null.

recursionLevel: VersionControlRecursionType

A kérés rekurziós szintje. Az alapértelmezett érték a "nincs", nincs rekurzió.

includeContentMetadata: boolean

Állítsa igaz értékre a tartalom metaadatainak belefoglalására. Az alapértelmezett érték hamis.

latestProcessedChange: boolean

Állítsa igaz értékre, hogy tartalmazza a legújabb módosításokat. Az alapértelmezett érték hamis.

download: boolean

Állítsa igaz értékre a válasz fájlként való letöltéséhez. Az alapértelmezett érték hamis.

includeLinks: boolean

Állítsa igaz értékre, hogy elemekre mutató hivatkozásokat tartalmazzon. Az alapértelmezett érték hamis.

versionDescriptor: GitVersionDescriptor

Verzióleíró. Az alapértelmezett ág az adattár alapértelmezett ága.

zipForUnix: boolean

Állítsa igaz értékre a unix (és POSIX) rendszerek, például a végrehajtható fájlok és a symlinkek fájlengedélyeinek megőrzéséhez

Visszatér

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>

Paraméterek

repositoryId: string

Az adattár neve vagy azonosítója.

path: string

Az elem elérési útja.

project: string

Project ID vagy project név

scopePath: string

Az elérési út hatóköre. Az alapértelmezett érték null.

recursionLevel: VersionControlRecursionType

A kérés rekurziós szintje. Az alapértelmezett érték a "nincs", nincs rekurzió.

includeContentMetadata: boolean

Állítsa igaz értékre a tartalom metaadatainak belefoglalására. Az alapértelmezett érték hamis.

latestProcessedChange: boolean

Állítsa igaz értékre, hogy tartalmazza a legújabb módosításokat. Az alapértelmezett érték hamis.

download: boolean

Állítsa igaz értékre a válasz fájlként való letöltéséhez. Az alapértelmezett érték hamis.

versionDescriptor: GitVersionDescriptor

Verzióleíró. Az alapértelmezett ág az adattár alapértelmezett ága.

includeContent: boolean

Állítsa igaz értékre az elem tartalmát a json kérésekor. Az alapértelmezett érték hamis.

resolveHfs: boolean

Állítsa igaz értékre a Git HFS mutatófájljainak feloldásához, hogy tényleges tartalmat adjon vissza a Git HFS-ből. Az alapértelmezett érték igaz.

sanitize: boolean

Állítsa igaz értékre egy svg-fájl megtisztításához és képként való visszaadásához. Csak akkor hasznos, ha svg-fájlra van szükség. Az alapértelmezett érték hamis.

Visszatér

Promise<string>

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

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

Paraméterek

repositoryId: string

Az adattár neve vagy azonosítója.

path: string

Az elem elérési útja.

project: string

Project ID vagy project név

scopePath: string

Az elérési út hatóköre. Az alapértelmezett érték null.

recursionLevel: VersionControlRecursionType

A kérés rekurziós szintje. Az alapértelmezett érték a "nincs", nincs rekurzió.

includeContentMetadata: boolean

Állítsa igaz értékre a tartalom metaadatainak belefoglalására. Az alapértelmezett érték hamis.

latestProcessedChange: boolean

Állítsa igaz értékre, hogy tartalmazza a legújabb módosításokat. Az alapértelmezett érték hamis.

download: boolean

Állítsa igaz értékre a válasz fájlként való letöltéséhez. Az alapértelmezett érték hamis.

versionDescriptor: GitVersionDescriptor

Verzióleíró. Az alapértelmezett ág az adattár alapértelmezett ága.

includeContent: boolean

Állítsa igaz értékre az elem tartalmát a json kérésekor. Az alapértelmezett érték hamis.

resolveHfs: boolean

Állítsa igaz értékre a Git HFS mutatófájljainak feloldásához, hogy tényleges tartalmat adjon vissza a Git HFS-ből. Az alapértelmezett érték igaz.

sanitize: boolean

Állítsa igaz értékre egy svg-fájl megtisztításához és képként való visszaadásához. Csak akkor hasznos, ha svg-fájlra van szükség. Az alapértelmezett érték hamis.

Visszatér

Promise<ArrayBuffer>

getImportRequest(string, string, number)

Egy adott importálási kérelem lekérése.

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

Paraméterek

project: string

Project ID vagy project név

repositoryId: string

Az adattár neve vagy azonosítója.

importRequestId: number

Az importálási kérelem egyedi azonosítója.

Visszatér

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>

Paraméterek

repositoryId: string

Az adattár neve vagy azonosítója.

path: string

Az elem elérési útja.

project: string

Project ID vagy project név

scopePath: string

Az elérési út hatóköre. Az alapértelmezett érték null.

recursionLevel: VersionControlRecursionType

A kérés rekurziós szintje. Az alapértelmezett érték a "nincs", nincs rekurzió.

includeContentMetadata: boolean

Állítsa igaz értékre a tartalom metaadatainak belefoglalására. Az alapértelmezett érték hamis.

latestProcessedChange: boolean

Állítsa igaz értékre, hogy tartalmazza a legújabb módosításokat. Az alapértelmezett érték hamis.

download: boolean

Állítsa igaz értékre a válasz fájlként való letöltéséhez. Az alapértelmezett érték hamis.

versionDescriptor: GitVersionDescriptor

Verzióleíró. Az alapértelmezett ág az adattár alapértelmezett ága.

includeContent: boolean

Állítsa igaz értékre az elem tartalmát a json kérésekor. Az alapértelmezett érték hamis.

resolveLfs: boolean

Állítsa igaz értékre a Git LFS mutatófájljainak feloldásához a Git LFS-ből származó tényleges tartalom visszaadásához. Az alapértelmezett érték hamis.

sanitize: boolean

Állítsa igaz értékre egy svg-fájl megtisztításához és képként való visszaadásához. Csak akkor hasznos, ha svg-fájlra van szükség. Az alapértelmezett érték hamis.

Visszatér

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>

Paraméterek

repositoryId: string

Az adattár neve vagy azonosítója.

path: string

Az elem elérési útja.

project: string

Project ID vagy project név

scopePath: string

Az elérési út hatóköre. Az alapértelmezett érték null.

recursionLevel: VersionControlRecursionType

A kérés rekurziós szintje. Az alapértelmezett érték a "nincs", nincs rekurzió.

includeContentMetadata: boolean

Állítsa igaz értékre a tartalom metaadatainak belefoglalására. Az alapértelmezett érték hamis.

latestProcessedChange: boolean

Állítsa igaz értékre, hogy tartalmazza a legújabb módosításokat. Az alapértelmezett érték hamis.

download: boolean

Állítsa igaz értékre a válasz fájlként való letöltéséhez. Az alapértelmezett érték hamis.

versionDescriptor: GitVersionDescriptor

Verzióleíró. Az alapértelmezett ág az adattár alapértelmezett ága.

includeContent: boolean

Állítsa igaz értékre az elem tartalmát a json kérésekor. Az alapértelmezett érték hamis.

resolveLfs: boolean

Állítsa igaz értékre a Git LFS mutatófájljainak feloldásához a Git LFS-ből származó tényleges tartalom visszaadásához. Az alapértelmezett érték hamis.

sanitize: boolean

Állítsa igaz értékre egy svg-fájl megtisztításához és képként való visszaadásához. Csak akkor hasznos, ha svg-fájlra van szükség. Az alapértelmezett érték hamis.

Visszatér

Promise<ArrayBuffer>

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

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

Paraméterek

repositoryId: string

Az adattár neve vagy azonosítója.

project: string

Project ID vagy project név

scopePath: string

Az elérési út hatóköre. Az alapértelmezett érték null.

recursionLevel: VersionControlRecursionType

A kérés rekurziós szintje. Az alapértelmezett érték a "nincs", nincs rekurzió.

includeContentMetadata: boolean

Állítsa igaz értékre a tartalom metaadatainak belefoglalására. Az alapértelmezett érték hamis.

latestProcessedChange: boolean

Állítsa igaz értékre, hogy tartalmazza a legújabb módosításokat. Az alapértelmezett érték hamis.

download: boolean

Állítsa igaz értékre a válasz fájlként való letöltéséhez. Az alapértelmezett érték hamis.

includeLinks: boolean

Állítsa igaz értékre, hogy elemekre mutató hivatkozásokat tartalmazzon. Az alapértelmezett érték hamis.

versionDescriptor: GitVersionDescriptor

Verzióleíró. Az alapértelmezett ág az adattár alapértelmezett ága.

zipForUnix: boolean

Állítsa igaz értékre a unix (és POSIX) rendszerek, például a végrehajtható fájlok és a symlinkek fájlengedélyeinek megőrzéséhez

Visszatér

Promise<GitItem[]>

getItemsBatch(GitItemRequestData, string, string)

Egy adott útvonallistához vagy hosszú útvonalhoz tartozó tételeket kér egy repóban / project-ben

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

Paraméterek

requestData: GitItemRequestData

Adatattribútumok kérése: ItemDescriptors, IncludeContentMetadata, LatestProcessedChange, IncludeLinks. ItemDescriptors: Beolvasandó elemek gyűjteménye, beleértve az elérési utat, a verziót és a rekurziós szintet. IncludeContentMetadata: Az összes elem metaadatainak belefoglalása LatestProcessedChange: Azt határozza meg, hogy belefoglalja-e a sekély ref-et az egyes elemek legutóbbi módosításának véglegesítéséhez. IncludeLinks: A _links mező belefoglalása a sekély hivatkozásokba.

repositoryId: string

Az adattár neve vagy azonosítója

project: string

Project ID vagy project név

Visszatér

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>

Paraméterek

repositoryId: string

Az adattár neve vagy azonosítója.

path: string

Az elem elérési útja.

project: string

Project ID vagy project név

scopePath: string

Az elérési út hatóköre. Az alapértelmezett érték null.

recursionLevel: VersionControlRecursionType

A kérés rekurziós szintje. Az alapértelmezett érték a "nincs", nincs rekurzió.

includeContentMetadata: boolean

Állítsa igaz értékre a tartalom metaadatainak belefoglalására. Az alapértelmezett érték hamis.

latestProcessedChange: boolean

Állítsa igaz értékre, hogy tartalmazza a legújabb módosításokat. Az alapértelmezett érték hamis.

download: boolean

Állítsa igaz értékre a válasz fájlként való letöltéséhez. Az alapértelmezett érték hamis.

versionDescriptor: GitVersionDescriptor

Verzióleíró. Az alapértelmezett ág az adattár alapértelmezett ága.

includeContent: boolean

Állítsa igaz értékre az elem tartalmát a json kérésekor. Az alapértelmezett érték hamis.

resolveLfs: boolean

Állítsa igaz értékre a Git LFS mutatófájljainak feloldásához a Git LFS-ből származó tényleges tartalom visszaadásához. Az alapértelmezett érték hamis.

sanitize: boolean

Állítsa igaz értékre egy svg-fájl megtisztításához és képként való visszaadásához. Csak akkor hasznos, ha svg-fájlra van szükség. Az alapértelmezett érték hamis.

Visszatér

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>

Paraméterek

repositoryId: string

Az adattár neve vagy azonosítója.

path: string

Az elem elérési útja.

project: string

Project ID vagy project név

scopePath: string

Az elérési út hatóköre. Az alapértelmezett érték null.

recursionLevel: VersionControlRecursionType

A kérés rekurziós szintje. Az alapértelmezett érték a "nincs", nincs rekurzió.

includeContentMetadata: boolean

Állítsa igaz értékre a tartalom metaadatainak belefoglalására. Az alapértelmezett érték hamis.

latestProcessedChange: boolean

Állítsa igaz értékre, hogy tartalmazza a legújabb módosításokat. Az alapértelmezett érték hamis.

download: boolean

Állítsa igaz értékre a válasz fájlként való letöltéséhez. Az alapértelmezett érték hamis.

versionDescriptor: GitVersionDescriptor

Verzióleíró. Az alapértelmezett ág az adattár alapértelmezett ága.

includeContent: boolean

Állítsa igaz értékre az elem tartalmát a json kérésekor. Az alapértelmezett érték hamis.

resolveLfs: boolean

Állítsa igaz értékre a Git LFS mutatófájljainak feloldásához a Git LFS-ből származó tényleges tartalom visszaadásához. Az alapértelmezett érték hamis.

sanitize: boolean

Állítsa igaz értékre egy svg-fájl megtisztításához és képként való visszaadásához. Csak akkor hasznos, ha svg-fájlra van szükség. Az alapértelmezett érték hamis.

Visszatér

Promise<ArrayBuffer>

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

Kedveléseket kaphat egy megjegyzéshez.

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

Paraméterek

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

threadId: number

A megjegyzést tartalmazó szál azonosítója.

commentId: number

A megjegyzés azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<IdentityRef[]>

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

Keresse meg két véglegesítés egyesítési alapjait, opcionálisan az elágazások között. Ha az otherRepositoryId nincs megadva, az egyesítési alapokat csak a helyi adattárNameOrId környezetében számítja ki a rendszer.

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

Paraméterek

repositoryNameOrId: string

A helyi adattár azonosítója vagy neve.

commitId: string

Első véglegesítés, általában a potenciális egyesítés célágának tippje.

otherCommitId: string

Egyéb véglegesítés, általában a lehetséges egyesítés forráságának tippje.

project: string

Project ID vagy project név

otherCollectionId: string

A gyűjtemény azonosítója, ahol a többiCommitId található.

otherRepositoryId: string

Az adattár azonosítója, ahol a többiCommitId található.

Visszatér

Promise<GitCommitRef[]>

getMergeRequest(string, string, number, boolean)

Egy adott egyesítési művelet részleteinek lekérése.

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

Paraméterek

project: string

Project ID vagy project név

repositoryNameOrId: string

Az adattár neve vagy azonosítója.

mergeOperationId: number

Az egyesítési kérelem műveleti azonosítója.

includeLinks: boolean

Igaz a hivatkozások belefoglalásához

Visszatér

Promise<GitMerge>

getPermission(string, string, string)

Speciális biztonsági engedély állapota.

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

Paraméterek

projectName: string

repositoryId: string

A tároló felhasználója próbálja access

permission: string

A kért engedélynek "viewAlert" "dismissAlert" "manage" "viewEnablement" vagy "repoRead" típusúnak kell lennie.

Visszatér

Promise<boolean>

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

Lekéréses kérelem lekérése.

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

Paraméterek

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekérni kívánt lekéréses kérelem azonosítója.

project: string

Project ID vagy project név

maxCommentLength: number

Nincs használatban.

skip: number

Nincs használatban.

top: number

Nincs használatban.

includeCommits: boolean

Ha igaz, a lekéréses kérelem a társított véglegesítésekkel lesz visszaadva.

includeWorkItemRefs: boolean

Ha igaz, a lekéréses kérelmet a rendszer a társított munkaelem-hivatkozásokkal adja vissza.

Visszatér

Promise<GitPullRequest>

getPullRequestById(number, string)

Lekéréses kérelem lekérése.

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

Paraméterek

pullRequestId: number

A lekérni kívánt lekéréses kérelem azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<GitPullRequest>

getPullRequestCommits(string, number, string)

Kérje le a megadott lekéréses kérelem véglegesítéseit.

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

Paraméterek

repositoryId: string

Az adattár azonosítója vagy neve.

pullRequestId: number

A lekéréses kérelem azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<PagedList<GitCommitRef>>

getPullRequestConflict(string, number, number, string)

Egy ütközés lekérése egy lekéréses kérelemhez azonosító szerint

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

Paraméterek

repositoryId: string

pullRequestId: number

conflictId: number

project: string

Project ID vagy project név

Visszatér

Promise<GitConflict>

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

Lekéréses kérelem összes ütközésének lekérése

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

Paraméterek

repositoryId: string

A lekéréses kérelem adattára.

pullRequestId: number

A lekéréses kérelem azonosítója.

project: string

Project ID vagy project név

skip: number

Kihagyandó ütközések.

top: number

A kihagyás után visszatérni kívánt ütközések.

includeObsolete: boolean

Elavult ütközéseket tartalmaz.

excludeResolved: boolean

Kizárja a már feloldott ütközéseket.

onlyResolved: boolean

Csak a feloldott ütközéseket adja vissza.

Visszatér

Promise<GitConflict[]>

getPullRequestIteration(string, number, number, string)

Lekérheti a lekéréses kérelemhez megadott iterációt.

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

Paraméterek

repositoryId: string

Az adattár azonosítója vagy neve.

pullRequestId: number

A lekéréses kérelem azonosítója.

iterationId: number

A visszaadni kívánt lekéréses kérelem iterációjának azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<GitPullRequestIteration>

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

Lekérheti a két iteráció közötti lekéréses kérelemben végrehajtott módosításokat.

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

Paraméterek

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

iterationId: number

A lekéréses kérelem iterációjának azonosítója. br / Iteration Az első a forráság feje a lekéréses kérelem létrehozásakor, és a későbbi iterációk akkor jönnek létre, amikor leküldések vannak a forráságra. Az engedélyezett értékek 1 és a lekéréses kérelem maximális iterációja között vannak.

project: string

Project ID vagy project név

top: number

Szabadon választható. A beolvasandó módosítások száma. Az alapértelmezett érték 100, a maximális érték pedig 2000.

skip: number

Szabadon választható. A figyelmen kívül hagyandó módosítások száma. Ha például a 101–150-et szeretné beolvasni, állítsa be az 50-et, és ugorjon a 100-ra.

compareTo: number

Az összehasonlítandó lekéréses kérelem iterációjának azonosítója. Az alapértelmezett érték nulla, amely azt jelzi, hogy az összehasonlítás a forrás és a célágak közötti közös véglegesítéssel történik

Visszatér

Promise<GitPullRequestIterationChanges>

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

Lekérheti a lekéréses kérelem megadott iterációjához tartozó véglegesítéseket.

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

Paraméterek

repositoryId: string

Az adattár azonosítója vagy neve.

pullRequestId: number

A lekéréses kérelem azonosítója.

iterationId: number

Annak az iterációnak az azonosítója, amelyből lekérheti a véglegesítéseket.

project: string

Project ID vagy project név

top: number

A visszaadni kívánt véglegesítések maximális száma. A kötegenként visszaadható véglegesítések maximális száma 500.

skip: number

Kihagyandó véglegesítések száma.

Visszatér

Promise<GitCommitRef[]>

getPullRequestIterations(string, number, string, boolean)

Kérje le a megadott lekéréses kérelem iterációinak listáját.

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

Paraméterek

repositoryId: string

Az adattár azonosítója vagy neve.

pullRequestId: number

A lekéréses kérelem azonosítója.

project: string

Project ID vagy project név

includeCommits: boolean

Ha igaz, adja meg az egyes iterációkhoz társított véglegesítéseket a válaszban.

Visszatér

Promise<GitPullRequestIteration[]>

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

A lekéréses kérelem adott iterációs állapotának lekérése azonosító alapján. Az állapotazonosító minden iterációban egyedi a lekéréses kérelemben.

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

Paraméterek

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

iterationId: number

A lekéréses kérelem iterációjának azonosítója.

statusId: number

A lekéréses kérelem állapotának azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<GitPullRequestStatus>

getPullRequestIterationStatuses(string, number, number, string)

Lekérheti a lekéréses kérelmek iterációjához társított összes állapotot.

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

Paraméterek

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

iterationId: number

A lekéréses kérelem iterációjának azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<GitPullRequestStatus[]>

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

Lekéri a lekéréses kérelemhez hozzárendelt egyetlen címkét (címkét).

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

Paraméterek

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

labelIdOrName: string

A kért címke neve vagy azonosítója.

project: string

Project ID vagy project név

projectId: string

Project ID vagy project név.

Visszatér

Promise<WebApiTagDefinition>

getPullRequestLabels(string, number, string, string)

Lekérheti a lekéréses kérelemhez rendelt összes címkét (címkét).

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

Paraméterek

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

project: string

Project ID vagy project név

projectId: string

Project ID vagy project név.

Visszatér

Promise<WebApiTagDefinition[]>

getPullRequestProperties(string, number, string)

A lekéréses kérelem külső tulajdonságainak lekérése.

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

Paraméterek

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<any>

getPullRequestQuery(GitPullRequestQuery, string, string)

Ez az API az adott véglegesítéshez kapcsolódó lekéréses kérelmek megkeresésére szolgál. Használható egy adott egyesítési véglegesítést létrehozó lekéréses kérelem megkeresésére, vagy az összes lekéréses kérelem megkeresésére, amely valaha egyesít egy adott véglegesítést. A bemenet a lekérdezések listája, amelyek mindegyike a véglegesítések listáját tartalmazza. Minden olyan véglegesítéshez, amelyhez keres, visszakapja a véglegesítési kérelmek szótárát.

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

Paraméterek

queries: GitPullRequestQuery

A végrehajtandó lekérdezések listája.

repositoryId: string

Az adattár azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<GitPullRequestQuery>

getPullRequestReviewer(string, number, string, string)

Egy lekéréses kérelem adott véleményezője adatainak lekérése

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

Paraméterek

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

reviewerId: string

A véleményező azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<IdentityRefWithVote>

getPullRequestReviewers(string, number, string)

Lekéréses kérelem véleményezőinek lekérése

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

Paraméterek

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<IdentityRefWithVote[]>

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

A megadott feltételeknek megfelelő lekéréses kérelmek lekérése.

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

Paraméterek

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

searchCriteria: GitPullRequestSearchCriteria

A rendszer a keresési feltételeknek megfelelő lekéréses kérelmeket ad vissza.

project: string

Project ID vagy project név

maxCommentLength: number

Nincs használatban.

skip: number

A figyelmen kívül hagyandó lekéréses kérelmek száma. Ha például 101–150-et szeretne lekérni, állítsa a felső értéket 50-re, és ugorjon 100-ra.

top: number

A lekérendő lekéréses kérelmek száma.

Visszatér

Promise<GitPullRequest[]>

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

A megadott feltételeknek megfelelő lekéréses kérelmek lekérése.

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

Paraméterek

project: string

Project ID vagy project név

searchCriteria: GitPullRequestSearchCriteria

A rendszer a keresési feltételeknek megfelelő lekéréses kérelmeket ad vissza.

maxCommentLength: number

Nincs használatban.

skip: number

A figyelmen kívül hagyandó lekéréses kérelmek száma. Ha például 101–150-et szeretne lekérni, állítsa a felső értéket 50-re, és ugorjon 100-ra.

top: number

A lekérendő lekéréses kérelmek száma.

Visszatér

Promise<GitPullRequest[]>

getPullRequestStatus(string, number, number, string)

Az adott lekéréses kérelem állapotának lekérése azonosító alapján. Az állapotazonosító minden iterációban egyedi a lekéréses kérelemben.

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

Paraméterek

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

statusId: number

A lekéréses kérelem állapotának azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<GitPullRequestStatus>

getPullRequestStatuses(string, number, string)

Lekérheti a lekéréses kérelemhez társított összes állapotot.

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

Paraméterek

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<GitPullRequestStatus[]>

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

Szál lekérése lekéréses kérelemben.

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

Paraméterek

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

threadId: number

A szál azonosítója.

project: string

Project ID vagy project név

iteration: number

Ha meg van adva, a szál pozícióját a rendszer ezzel az iterációval követi nyomon a diff jobb oldalán.

baseIteration: number

Ha meg van adva, a rendszer ezzel az iterációval követi nyomon a szál pozícióját a diff bal oldalán.

Visszatér

Promise<GitPullRequestCommentThread>

getPullRequestWorkItemRefs(string, number, string)

Lekérheti a lekéréses kérelemhez társított munkaelemek listáját.

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

Paraméterek

repositoryId: string

Az adattár azonosítója vagy neve.

pullRequestId: number

A lekéréses kérelem azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<ResourceRef[]>

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

Lekéri az adott leküldést.

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

Paraméterek

repositoryId: string

Az adattár neve vagy azonosítója.

pushId: number

A leküldés azonosítója.

project: string

Project ID vagy project név

includeCommits: number

Az eredménybe belefoglalandó véglegesítések száma.

includeRefUpdates: boolean

Ha igaz, adja meg a leküldés által frissített refek listáját.

Visszatér

Promise<GitPush>

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

Lekérheti az adott leküldéshez társított véglegesítések listáját.

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

Paraméterek

repositoryId: string

Az adattár azonosítója vagy rövid neve. A rövid név használatához meg kell adni a projectId azonosítót is.

pushId: number

A leküldés azonosítója.

project: string

Project ID vagy project név

top: number

A visszaadandó véglegesítések maximális száma ("az első x véglegesítés lekérése").

skip: number

A kihagyandó véglegesítések száma.

includeLinks: boolean

Állítsa hamisra, hogy elkerülje az erőforrások REST URL-hivatkozásainak használatát. Alapértelmezés szerint igaz.

Visszatér

Promise<GitCommitRef[]>

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

Lekéri a megadott adattárhoz társított leküldéseket.

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

Paraméterek

repositoryId: string

Az adattár neve vagy azonosítója.

project: string

Project ID vagy project név

skip: number

Kihagyandó leküldések száma.

top: number

A visszaküldött leküldések száma.

searchCriteria: GitPushSearchCriteria

Keresési feltételek attribútumai: fromDate, toDate, pusherId, refName, includeRefUpdates vagy includeLinks. fromDate: Kezdő dátum a kereséshez. toDate: A keresett befejezési dátum. pusherId: A leküldést beküldő személy identitása. refName: Megfontolandó ágnév. includeRefUpdates: Ha igaz, adja meg a leküldés által frissített hivok listáját. includeLinks: A _links mező belefoglalása a sekély hivatkozásokba.

Visszatér

Promise<GitPush[]>

getRecycleBinRepositories(string)

Kérje le a helyreállíthatóan törölt git-adattárakat a lomtárból.

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

Paraméterek

project: string

Project ID vagy project név

Visszatér

Promise<GitDeletedRepository[]>

getRefFavorite(string, number)

Lekéri a kedvenc azonosítóhoz tartozó refs kedvencet.

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

Paraméterek

project: string

Project ID vagy project név

favoriteId: number

A kért hiv-kedvenc azonosítója.

Visszatér

Promise<GitRefFavorite>

getRefFavorites(string, string, string)

Lekéri a refs kedvenceket egy adattárhoz és egy identitáshoz.

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

Paraméterek

project: string

Project ID vagy project név

repositoryId: string

Az adattár azonosítója.

identityId: string

Annak az identitásnak az azonosítója, amelynek a kedvenceit le kell kérni. Null érték esetén a rendszer a kérelmező identitást használja.

Visszatér

Promise<GitRefFavorite[]>

getRefFavoritesForProject(string, string)

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

Paraméterek

project: string

Project ID vagy project név

identityId: string

Visszatér

Promise<GitRefFavorite[]>

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

Lekérdezi a megadott adattárat a saját adattáraihoz, és visszaadja őket.

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

Paraméterek

repositoryId: string

Az adattár neve vagy azonosítója.

project: string

Project ID vagy project név

filter: string

[nem kötelező] A refsre alkalmazandó szűrő (a következővel kezdődik).

includeLinks: boolean

[nem kötelező] Megadja, hogy a referenceLinks szerepel-e az eredményben. alapértelmezett értéke hamis.

includeStatuses: boolean

[nem kötelező] Az egyes ref-ekhez legfeljebb az első 1000 véglegesítési állapotot tartalmazza. Az alapértelmezett érték hamis.

includeMyBranches: boolean

[nem kötelező] Csak a felhasználó által birtokolt ágakat, a felhasználói kedvenceket és az alapértelmezett ágat tartalmazza. Az alapértelmezett érték hamis. Nem kombinálható a szűrőparaméterrel.

latestStatusesOnly: boolean

[opcionális] Igaz, hogy csak a tipp véglegesítési állapotát tartalmazza az egyes hivatkozásokhoz. Ennek a beállításnak igaznak kell lennie. Az alapértelmezett érték hamis.

peelTags: boolean

[nem kötelező] A jegyzetekkel ellátott címkék feltöltik a PeeledObjectId tulajdonságot. alapértelmezett értéke hamis.

filterContains: string

[nem kötelező] A refsre (tartalmazza) alkalmazandó szűrő.

includeTargetBranches: boolean

[opcionális] Tartalmazza a célágakat a pull_request_targets.yml-ben minták alapján definiálva.

Visszatér

Promise<PagedList<GitRef>>

getRepositories(string, boolean, boolean, boolean)

Git-adattárak lekérése.

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

Paraméterek

project: string

Project ID vagy project név

includeLinks: boolean

[nem kötelező] Igaz, hogy hivatkozási hivatkozásokat tartalmazzon. Az alapértelmezett érték hamis.

includeAllUrls: boolean

[nem kötelező] Igaz az összes távoli URL-cím belefoglalásához. Az alapértelmezett érték hamis.

includeHidden: boolean

[nem kötelező] Igaz, hogy rejtett adattárakat tartalmazzon. Az alapértelmezett érték hamis.

Visszatér

Promise<GitRepository[]>

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

Lekérheti a név és a lapozás szerinti szűrővel rendelkező git-adattárakat.

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

Paraméterek

projectId: string

A csapat projekt azonosítója vagy neve.

includeLinks: boolean

[nem kötelező] Igaz, hogy hivatkozási hivatkozásokat tartalmazzon. Az alapértelmezett érték hamis.

includeAllUrls: boolean

[nem kötelező] Igaz az összes távoli URL-cím belefoglalásához. Az alapértelmezett érték hamis.

includeHidden: boolean

[nem kötelező] Igaz, hogy rejtett adattárakat tartalmazzon. Az alapértelmezett érték hamis.

filterContains: string

[nem kötelező] A refsre (tartalmazza) alkalmazandó szűrő.

top: number

[nem kötelező] A visszaadandó tárházak maximális száma. Nem lehet nagyobb 500-nál. Ha nincs megadva, de a folytatásToken értéke, a felső érték alapértelmezés szerint 100 lesz.

continuationToken: string

A lapozáshoz használt folytatási jogkivonat.

Visszatér

Promise<PagedList<GitRepository>>

getRepository(string, string)

Git-adattár lekérése.

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

Paraméterek

repositoryId: string

Az adattár neve vagy azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<GitRepository>

getRepositoryWithParent(string, boolean, string)

Git-adattár lekérése.

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

Paraméterek

repositoryId: string

Az adattár neve vagy azonosítója.

includeParent: boolean

Igaz a szülőadattárba való belefoglaláshoz. Csak hitelesített hívásokban érhető el.

project: string

Project ID vagy project név

Visszatér

Promise<GitRepository>

getRevert(string, number, string)

A visszaállítási művelettel kapcsolatos információk lekérése a visszaállítási azonosító alapján.

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

Paraméterek

project: string

Project ID vagy project név

revertId: number

A visszaállítási művelet azonosítója.

repositoryId: string

Az adattár azonosítója.

Visszatér

Promise<GitRevert>

getRevertConflict(string, number, number, string)

Egy ütközés lekérése azonosító alapján történő visszaállításhoz

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

Paraméterek

repositoryId: string

revertId: number

conflictId: number

project: string

Project ID vagy project név

Visszatér

Promise<GitConflict>

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

A visszaállítás összes ütközésének lekérése

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

Paraméterek

repositoryId: string

revertId: number

project: string

Project ID vagy project név

continuationToken: string

top: number

excludeResolved: boolean

onlyResolved: boolean

includeObsolete: boolean

Visszatér

Promise<PagedList<GitConflict>>

getRevertForRefName(string, string, string)

Egy adott ág visszaállítási műveletével kapcsolatos információk lekérése.

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

Paraméterek

project: string

Project ID vagy project név

repositoryId: string

Az adattár azonosítója.

refName: string

A visszaállítási művelethez használt GitAsyncRefOperationParameters generatedRefName.

Visszatér

Promise<GitRevert>

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

A Git-véglegesítéshez társított állapotok lekérése.

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

Paraméterek

commitId: string

A Git-véglegesítés azonosítója.

repositoryId: string

Az adattár azonosítója.

project: string

Project ID vagy project név

top: number

Szabadon választható. A lekérendő állapotok száma. Az alapértelmezett érték 1000.

skip: number

Szabadon választható. A figyelmen kívül hagyandó állapotok száma. Az alapértelmezett érték 0. Ha például 101–150-et szeretne lekérni, állítsa a felső értéket 50-re, és ugorjon 100-ra.

latestOnly: boolean

A jelző azt jelzi, hogy csak a legújabb állapotokat kell-e lekérni és .

Visszatér

Promise<GitStatus[]>

getSuggestions(string, string, boolean)

Szerezz elő egy pull request javaslatot egy adott tárolóhoz vagy csapat projekthez.

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

Paraméterek

repositoryId: string

A git-adattár azonosítója.

project: string

Project ID vagy project név

preferCompareBranch: boolean

Ha igaz, a lekéréses kérelmek célágaként válassza az alapértelmezett ághoz képest az összehasonlítási ágat.

Visszatér

Promise<GitSuggestion[]>

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

Lekérheti egy lekéréses kérelem összes szálát.

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

Paraméterek

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

project: string

Project ID vagy project név

iteration: number

Ha meg van adva, a menetpozíciók nyomon lesznek követve ezzel az iterációval a diff jobb oldalán.

baseIteration: number

Ha meg van adva, a menetpozíciók nyomon lesznek követve ezzel az iterációval a diff bal oldalán.

Visszatér

Promise<GitPullRequestCommentThread[]>

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

A favégpont visszaadja a megadott fa alatti objektumok gyűjteményét. A fák a Git-adattár mappái.

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

Paraméterek

repositoryId: string

Adattár azonosítója.

sha1: string

SHA1 kivonat a faobjektumról.

project: string

Project ID vagy project név

projectId: string

Project Id.

recursive: boolean

Keresés rekurzív módon. A fa alá fákat is belefoglaljon. Az alapértelmezett érték hamis.

fileName: string

A .zip fájl visszaadásakor használandó név. Az alapértelmezett érték az objektumazonosító.

Visszatér

Promise<GitTreeRef>

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

A favégpont visszaadja a megadott fa alatti objektumok gyűjteményét. A fák a Git-adattár mappái.

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

Paraméterek

repositoryId: string

Adattár azonosítója.

sha1: string

SHA1 kivonat a faobjektumról.

project: string

Project ID vagy project név

projectId: string

Project Id.

recursive: boolean

Keresés rekurzív módon. A fa alá fákat is belefoglaljon. Az alapértelmezett érték hamis.

fileName: string

A .zip fájl visszaadásakor használandó név. Az alapértelmezett érték az objektumazonosító.

Visszatér

Promise<ArrayBuffer>

queryImportRequests(string, string, boolean)

Az adattár importálási kérelmeinek lekérése.

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

Paraméterek

project: string

Project ID vagy project név

repositoryId: string

Az adattár neve vagy azonosítója.

includeAbandoned: boolean

Igaz, hogy felhagyott importálási kérelmeket is belefoglal az eredményekbe.

Visszatér

Promise<GitImportRequest[]>

restoreRepositoryFromRecycleBin(GitRecycleBinRepositoryDetails, string, string)

Helyreállíthatóan törölt Git-adattár helyreállítása. A legutóbb törölt adattárak helyreállítható törlési állapotba kerülnek egy ideig, mielőtt azok véglegesen törlődnek, és helyreállíthatatlanná válnak.

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

Paraméterek

repositoryDetails: GitRecycleBinRepositoryDetails

project: string

Project ID vagy project név

repositoryId: string

Az adattár azonosítója.

Visszatér

Promise<GitRepository>

setEnableOnCreateHost(boolean)

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

Paraméterek

enableOnCreateHost: boolean

Visszatér

Promise<void>

setEnableOnCreateProject(string, boolean)

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

Paraméterek

enableOnCreateProjectId: string

enableOnStatus: boolean

Visszatér

Promise<void>

sharePullRequest(ShareNotificationContext, string, number, string)

E-mail-értesítést küld egy adott lekéréses kérelemről a címzettek egy csoportjának

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

Paraméterek

userMessage: ShareNotificationContext

repositoryId: string

A git-adattár azonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<void>

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

Egyesítési ütközések feloldásának frissítése

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

Paraméterek

conflict: GitConflict

repositoryId: string

cherryPickId: number

conflictId: number

project: string

Project ID vagy project név

Visszatér

Promise<GitConflict>

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

Több egyesítési ütközés feloldásának frissítése

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

Paraméterek

conflictUpdates: GitConflict[]

repositoryId: string

cherryPickId: number

project: string

Project ID vagy project név

Visszatér

Promise<GitConflictUpdateResult[]>

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

Egy adott szálhoz társított megjegyzés frissítése egy lekéréses kérelemben.

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

Paraméterek

comment: Comment

A frissíteni kívánt megjegyzéstartalom. A megjegyzések legfeljebb 150 000 karakter hosszúságúak lehetnek.

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

threadId: number

Annak a szálnak az azonosítója, amelyben a kívánt megjegyzés szerepel.

commentId: number

A frissíteni kívánt megjegyzés azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<Comment>

updateEnablementStatus(AdvSecEnablementUpdate[])

POST-engedélyezés állapota az adattárakhoz.

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

Paraméterek

enablementUpdates: AdvSecEnablementUpdate[]

Visszatér

Promise<void>

updateImportRequest(GitImportRequest, string, string, number)

Sikertelen importálási kérelem újrapróbálkozása vagy elhagyása.

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

Paraméterek

importRequestToUpdate: GitImportRequest

Az importálási kérelem frissített verziója. Jelenleg az egyetlen engedélyezett módosítás az állapot várólistára vagy elhagyva állapotra állítása.

project: string

Project ID vagy project név

repositoryId: string

Az adattár neve vagy azonosítója.

importRequestId: number

A frissíteni kívánt importálási kérelem egyedi azonosítója.

Visszatér

Promise<GitImportRequest>

updatePullRequest(GitPullRequest, string, number, string)

Lekéréses kérelem frissítése

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

Paraméterek

gitPullRequestToUpdate: GitPullRequest

A frissíteni kívánt lekéréses kérelem tartalma.

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A frissíteni kívánt lekéréses kérelem azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<GitPullRequest>

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

Egyesítési ütközések feloldásának frissítése

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

Paraméterek

conflict: GitConflict

repositoryId: string

pullRequestId: number

conflictId: number

project: string

Project ID vagy project név

Visszatér

Promise<GitConflict>

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

Több egyesítési ütközés feloldásának frissítése

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

Paraméterek

conflictUpdates: GitConflict[]

repositoryId: string

pullRequestId: number

project: string

Project ID vagy project név

Visszatér

Promise<GitConflictUpdateResult[]>

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

A lekéréses kérelem iterációs állapotainak gyűjteményének frissítése. Az egyetlen támogatott művelettípus a .

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

Paraméterek

patchDocument: JsonPatchDocument

A lekéréses kérelmek állapotára vonatkozó műveletek JSON-javítás formátumban.

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

iterationId: number

A lekéréses kérelem iterációjának azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<void>

updatePullRequestProperties(JsonPatchDocument, string, number, string)

Lekéréses kérelem külső tulajdonságainak létrehozása vagy frissítése. A javítási művelet lehet , vagy . A működéshez az elérési út üres lehet. Ha az elérési út üres, az értéknek kulcsértékpárok listájának kell lennie. Működéshez az elérési út nem lehet üres. Ha az elérési út nem létezik, a tulajdonság hozzá lesz adva a gyűjteményhez. Működéshez az elérési út nem lehet üres. Ha az elérési út nem létezik, a program nem hajt végre műveletet.

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

Paraméterek

patchDocument: JsonPatchDocument

JSON-javítás formátumban hozzáadni, cserélni vagy eltávolítani kívánt tulajdonságok.

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<any>

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

Véleményező bejegyzés szerkesztése. Ezek a mezők javíthatók: isFlagged, hasDeclined

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

Paraméterek

reviewer: IdentityRefWithVote

Véleményezői adatok.br /Ha a felülvizsgáló azonosítója szerepel itt, meg kell egyeznie a reviewerID paraméterrel.

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

reviewerId: string

A véleményező azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<IdentityRefWithVote>

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

Több véleményező szavazatának alaphelyzetbe állítása lekéréses kérelem esetén. MEGJEGYZÉS: Ez a végpont csak a szavazatok frissítését támogatja, de nem támogatja a szükséges véleményezők (szabályzat használata) vagy a megjelenített nevek frissítését.

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

Paraméterek

patchVotes: IdentityRefWithVote[]

Azoknak a véleményezőknek az azonosítói, akiknek a szavazatai nullára lesznek visszaállítva

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója

project: string

Project ID vagy project név

Visszatér

Promise<void>

updatePullRequestStatuses(JsonPatchDocument, string, number, string)

A lekéréses kérelmek állapotgyűjteményének frissítése. Az egyetlen támogatott művelettípus a .

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

Paraméterek

patchDocument: JsonPatchDocument

A lekéréses kérelmek állapotára vonatkozó műveletek JSON-javítás formátumban.

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<void>

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

Ág zárolása vagy zárolásának feloldása.

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

Paraméterek

newRefInfo: GitRefUpdate

A ref frissítési művelet (zárolás/zárolás feloldása) végrehajtása

repositoryId: string

Az adattár neve vagy azonosítója.

filter: string

A zárolni/feloldani kívánt ág neve

project: string

Project ID vagy project név

projectId: string

A csapat projekt azonosítója vagy neve. Nem kötelező, ha azonosítót ad meg az adattárhoz.

Visszatér

Promise<GitRef>

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

Refs(ágak) létrehozása, frissítése vagy törlése.

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

Paraméterek

refUpdates: GitRefUpdate[]

A végrehajtani kívánt ref-frissítések listája

repositoryId: string

Az adattár neve vagy azonosítója.

project: string

Project ID vagy project név

projectId: string

A csapat projekt azonosítója vagy neve. Nem kötelező, ha azonosítót ad meg az adattárhoz.

Visszatér

Promise<GitRefUpdateResult[]>

updateRepository(GitRepository, string, string)

Frissíti a Git-adattárat egy új adattárnévvel vagy egy új alapértelmezett ággal.

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

Paraméterek

newRepositoryInfo: GitRepository

Új adattárnév vagy az adattár új alapértelmezett ágának megadása

repositoryId: string

Az adattár azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<GitRepository>

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

Egyesítési ütközések feloldásának frissítése

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

Paraméterek

conflict: GitConflict

repositoryId: string

revertId: number

conflictId: number

project: string

Project ID vagy project név

Visszatér

Promise<GitConflict>

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

Több egyesítési ütközés feloldásának frissítése

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

Paraméterek

conflictUpdates: GitConflict[]

repositoryId: string

revertId: number

project: string

Project ID vagy project név

Visszatér

Promise<GitConflictUpdateResult[]>

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

Egy szál frissítése lekéréses kérelemben.

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

Paraméterek

commentThread: GitPullRequestCommentThread

A frissíteni kívánt száltartalom.

repositoryId: string

A lekéréses kérelem célágának adattárazonosítója.

pullRequestId: number

A lekéréses kérelem azonosítója.

threadId: number

A frissíteni kívánt szál azonosítója.

project: string

Project ID vagy project név

Visszatér

Promise<GitPullRequestCommentThread>

Visszajelzés

Hasznosnak találta ezt az oldalt?

Megosztás a következőn keresztül:

GitRestClient class

Konstruktorok

Kellékek

Módszerek

Építő részletek

GitRestClient(IVssRestClientOptions)

Paraméterek

Ingatlan részletei

RESOURCE_AREA_ID

Ingatlanérték

Módszer részletei

createAnnotatedTag(GitAnnotatedTag, string, string)

Paraméterek

Visszatér

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

Paraméterek

Visszatér

createCherryPick(GitAsyncRefOperationParameters, string, string)

Paraméterek

Visszatér

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

Paraméterek

Visszatér

createCommitStatus(GitStatus, string, string, string)

Paraméterek

Visszatér

createFavorite(GitRefFavorite, string)

Paraméterek

Visszatér

createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)

Paraméterek

Visszatér

createImportRequest(GitImportRequest, string, string)

Paraméterek

Visszatér

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

Paraméterek

Visszatér

createMergeRequest(GitMergeParameters, string, string, boolean)

Paraméterek

Visszatér

createPullRequest(GitPullRequest, string, string, boolean)

Paraméterek

Visszatér

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

Paraméterek

Visszatér

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

Paraméterek

Visszatér

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

Paraméterek

Visszatér

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

Paraméterek

Visszatér

createPullRequestStatus(GitPullRequestStatus, string, number, string)

Paraméterek

Visszatér

createPush(GitPush, string, string)

Paraméterek

Visszatér

createRepository(GitRepositoryCreateOptions, string, string)

Paraméterek

Visszatér

createRevert(GitAsyncRefOperationParameters, string, string)

Paraméterek

Visszatér

createThread(GitPullRequestCommentThread, string, number, string)

Paraméterek

Visszatér

createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)

Paraméterek

Visszatér

deleteAttachment(string, string, number, string)

Paraméterek

Visszatér

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

Paraméterek