BuildRestClient class

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

Konstruktorok

Tulajdonságok

Metódusok

addBuildTag(string, number, string)	Hozzáad egy címkét egy buildhez.
addBuildTags(string[], string, number)	Címkéket ad hozzá egy buildhez.
addDefinitionTag(string, number, string)	Címke hozzáadása definícióhoz
addDefinitionTags(string[], string, number)	Több címkét ad hozzá egy definícióhoz.
addRetentionLeases(NewRetentionLease[], string)	Új bérleti szerződéseket ad hozzá a vezeték-futásokhoz.
authorizeDefinitionResources(DefinitionResourceReference[], string, number)
authorizeProjectResources(DefinitionResourceReference[], string)
createArtifact(BuildArtifact, string, number)	Egy ereklyét egy buildhez társít.
createDefinition(BuildDefinition, string, number, number)	Új definíciót teremt.
createFolder(Folder, string, string)	Új mappát hoz létre.
deleteBuild(string, number)	Törli az építést.
deleteBuildTag(string, number, string)	Eltávolít egy címkét egy buildből. MEGJEGYZÉS: Ez az API nem fog működni speciális karakterekkel rendelkező címkékhez. Speciális karakterekkel rendelkező címkék eltávolításához inkább a PATCH módszert használjuk (6.0+ verzióban)
deleteDefinition(string, number)	Törli a definíciót és az összes kapcsolódó buildet.
deleteDefinitionTag(string, number, string)	Eltávolít egy címkét egy definícióból. MEGJEGYZÉS: Ez az API nem fog működni speciális karakterekkel rendelkező címkékhez. Speciális karakterekkel rendelkező címkék eltávolításához inkább a PATCH módszert használjuk (6.0+ verzióban)
deleteFolder(string, string)	Törli a definíciós mappát. A definíciókat és a hozzájuk tartozó buildeket is töröljük.
deleteRetentionLeasesById(string, number[])	Megszünteti a konkrét megtartási bérleteket.
deleteTag(string, string)	Eltávolít egy címkét a build-ekből, definíciókból és a tag-tárolóból
deleteTemplate(string, string)	Törli a build definifikációs sablont.
getArtifact(string, number, string)	Egy buildhez kap egy specifikus artefaktot.
getArtifactContentZip(string, number, string)	Egy buildhez kap egy specifikus artefaktot.
getArtifacts(string, number)	Minden ereklyét megkap egy buildhez.
getAttachment(string, number, string, string, string, string)	Speciális kötődést kap.
getAttachments(string, number, string)	Megkapja a konkrét típusú kiegészítők listáját, amelyek egy buildhez kapcsolódnak.
getBadge(string, number, string)	Olyan jelvényt kap, amely jelzi a legfrissebb build állapotát egy definícióhoz. Fontos megjegyezni, hogy ez az API elavult. Preferálom a StatusBadgeController.GetStatusBadge-et.
getBuild(string, number, string)	Építkezik
getBuildBadge(string, string, string, string)	Megkap egy jelvényt, amely jelzi a megadott fiók legfrissebb build állapotát.
getBuildBadgeData(string, string, string, string)	Megkap egy jelvényt, amely jelzi a megadott fiók legfrissebb build állapotát.
getBuildChanges(string, number, string, number, boolean)	Megkapja a buildhez kapcsolódó változásokat
getBuildController(number)	Kontrollert kap
getBuildControllers(string)	Kontrollert kap, opcionálisan név szerint szűrve
getBuildGeneralSettings(string)	Megkapja a pipeline általános beállításokat.
getBuildLog(string, number, number, number, number)	Egyedi naplófájlt kap egy buildhez.
getBuildLogLines(string, number, number, number, number)	Egyedi naplófájlt kap egy buildhez.
getBuildLogs(string, number)	Megszerzi a rönköket egy építéshez.
getBuildLogsZip(string, number)	Megszerzi a rönköket egy építéshez.
getBuildLogZip(string, number, number, number, number)	Egyedi naplófájlt kap egy buildhez.
getBuildOptionDefinitions(string)	Minden rendszer által támogatott build definíciós opciót megkap.
getBuildProperties(string, number, string[])	Ingatlanokat kap egy építéshez.
getBuildReport(string, number, string)	Szerez egy build jelentést.
getBuildReportHtmlContent(string, number, string)	Szerez egy build jelentést.
getBuilds(string, number[], number[], string, Date, Date, string, BuildReason, BuildStatus, BuildResult, string[], string[], number, string, number, QueryDeletedOption, BuildQueryOrder, string, number[], string, string)	Megkap egy listát a buildekről.
getBuildSettings(string)	Megkapja a build beállításokat.
getBuildStageLatestTimeline(string, number, string, number, string)	A legfrissebb idővonalat egy adott szintre szűri.
getBuildStageTimeline(string, number, string, string, number, string)	Megkapja az építés idővonalát egy adott szintre szűrve.
getBuildTags(string, number)	Megkapja a címkéket egy buildhez.
getBuildTimeline(string, number, string, number, string)	Részleteket kap egy buildhez
getBuildWorkItemsRefs(string, number, number)	Megkapja a buildhez kapcsolódó munkatárgyakat. Csak a projekt munkatárgyait küldik vissza.
getBuildWorkItemsRefsFromCommits(string[], string, number, number)	Megkapja a buildhez kapcsolódó munkatárgyakat, amelyeket meghatározott commit-ekhez szűrnek.
getChangesBetweenBuilds(string, number, number, number)	Megkapja a változtatásokat a tárolóban két adott build között.
getDefinition(string, number, number, Date, string[], boolean)	Kap definíciót, opcionálisan egy adott verzióban.
getDefinitionMetrics(string, number, Date)	Megkapja a build metrikákat egy definícióhoz.
getDefinitionProperties(string, number, string[])	Tulajdonságokat kap egy definícióhoz.
getDefinitionResources(string, number)
getDefinitionRevisions(string, number)	Minden definíció módosítását kapja.
getDefinitions(string, string, string, string, DefinitionQueryOrder, number, string, Date, number[], string, Date, Date, boolean, boolean, string, number, string)	Tartalmaz egy definíciólistát.
getDefinitionTags(string, number, number)	Megkapja a definíció címkéit.
getDefinitionYaml(string, number, number, Date, string[], boolean)	Egy definíciót YAML-re alakít át, opcionálisan egy adott verzióval.
getFile(string, number, string, string, string)	Fájlt kap a buildből.
getFileContents(string, string, string, string, string, string)	Megkapja egy fájl tartalmát a megadott forráskód tárolóban.
getFolders(string, string, FolderQueryOrder)	Megkapja a build definiálási mappák listáját.
getLatestBuild(string, string, string)	Megkapja a legújabb verziót egy definícióhoz, opcionálisan egy adott ágra korlátozva.
getPathContents(string, string, string, string, string, string)	Megkapja a megadott forráskód tárolóban található könyvtár tartalmát.
getProjectMetrics(string, string, Date)	Megkapja a projekthez szükséges építési mutatókat.
getProjectResources(string, string, string)
getPullRequest(string, string, string, string, string)	A forrásszolgáltatótól kap egy pull request objektumot.
getResourceUsage()	Információkat kap a rendszerben lévő build erőforrásokról.
getRetentionHistory(number)	Visszaadja a projektgyűjtemény megtartási előzményeit. Ez magában foglalja a pipeline-eket, amelyek egyedi megtartási szabályokat alkalmaznak, amelyek megakadályozhatják a megtartási feladat tisztítását, a futtatók a pipeline-enként a retention típussal, a gyűjteményhez tartozó pipeline-ekhez kapcsolódó fájlok tárolási típussal, valamint a fájlok számát egy csővezetékenként.
getRetentionLease(string, number)	Visszaadja a megtartási szerződés adatait a bérleti azonosítóval.
getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])	Visszaadja azokat a bérleteket, amelyek megfelelnek a megadott MinimalRetentionLease-eknek
getRetentionLeasesByOwnerId(string, string, number, number)	Visszaadja a megadott entitás tulajdonában lévő bérleteket, opcionálisan egyetlen csővezeték-definícióra korlátozva és fut.
getRetentionLeasesByUserId(string, string, number, number)	Visszaadja a megadott felhasználó tulajdonában lévő bérleteket, opcionálisan egyetlen csővezeték-definícióra korlátozva, és futtatja.
getRetentionLeasesForBuild(string, number)	Minden megtartási szerződést kap, ami egy adott buildre vonatkozik.
getRetentionSettings(string)	Megkapja a projekt megtartási beállításait.
getStatusBadge(string, string, string, string, string, string, string)	<p>Megkapja a definíció build státuszát, opcionálisan egy adott ágra, szakaszra, feladatra és konfigurációra korlátozva.</p><p>Ha több van egy, akkor a workName megadásakor szükséges egy stageName értéket adni, és ugyanaz a szabály érvényes mindkettőre konfigurációs paraméter átadásához.</p>
getTags(string)	Megkapja a projekt összes build címkéjének listáját.
getTemplate(string, string)	Van egy speciális build definifikációs sablon.
getTemplates(string)	Minden definíciós sablont megkap.
getWorkItemsBetweenBuilds(string, number, number, number)	Két build között megkapja az összes munkatárgyat.
listBranches(string, string, string, string, string)	Megkapja a megadott forráskód tároló ágainak listáját.
listRepositories(string, string, string, string, ResultSet, boolean, string)	Megkap egy forráskód tárolók listáját.
listSourceProviders(string)	Szerezzen egy listát a forrás szolgáltatókról és azok képességeiről.
listWebhooks(string, string, string, string)	Megkap egy webhookok listáját a megadott forráskód tárolóban.
queueBuild(Build, string, boolean, string, number, number)	Sorba helyezés egy build
restoreDefinition(string, number, boolean)	Visszaállítja a törölt definíciót
restoreWebhooks(DefinitionTriggerType[], string, string, string, string)	Újrahozza a megadott triggerek webhookjait a megadott forráskód tárolóban.
saveTemplate(BuildDefinitionTemplate, string, string)	Frissít egy meglévő build definíciós sablont.
updateBuild(Build, string, number, boolean)	Frissíti a buildet.
updateBuildGeneralSettings(PipelineGeneralSettings, string)	Frissíti a pipeline általános beállításait.
updateBuildProperties(JsonPatchDocument, string, number)	Frissíti a buildhez szükséges tulajdonságokat.
updateBuilds(Build[], string)	Több buildet frissít.
updateBuildSettings(BuildSettings, string)	Frissíti a build beállításokat.
updateBuildTags(UpdateTagParameters, string, number)	Hozzáadja/eltávolítja a címkéket egy buildből.
updateDefinition(BuildDefinition, string, number, number, number, boolean)	Frissíti a meglévő build definíciót. Ahhoz, hogy ez a művelet sikeres legyen, a kéréstest "Revision" tulajdonságának értékének meg kell egyeznie a meglévő build definícióval. Ajánlott, hogy a meglévő build definíciót a GET segítségével szerezd meg, szükség szerint módosítsd a definíciót, majd add be a módosított definíciót PUT-tal.
updateDefinitionProperties(JsonPatchDocument, string, number)	Frissíti a definíció tulajdonságait.
updateDefinitionTags(UpdateTagParameters, string, number)	Címkéket ad/eltávolít egy definícióból.
updateFolder(Folder, string, string)	Egy meglévő mappát frissít adott úton
updateRetentionLease(RetentionLeaseUpdate, string, number)	Frissíti a megtartási bérleti szerződés időtartamát vagy vezetékvédelmi státuszát.
updateRetentionSettings(UpdateProjectRetentionSettingModel, string)	Frissíti a projekt megtartási beállításait.
updateStage(UpdateStageParameters, number, string, string)	Építési szakasz frissítése

BuildRestClient(IVssRestClientOptions)

new BuildRestClient(options: IVssRestClientOptions)

Paraméterek

options: IVssRestClientOptions

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: "965220d5-5bb9-42cf-8d67-9b146df2a5a4" = "965220d5-5bb9-42cf-8d67-9b146df2a5a4"

Tulajdonság értéke

"965220d5-5bb9-42cf-8d67-9b146df2a5a4"

addBuildTag(string, number, string)

Hozzáad egy címkét egy buildhez.

function addBuildTag(project: string, buildId: number, tag: string): Promise<string[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

Az építés azonosítója.

tag: string

A címkét, amit hozzá kell adni.

Válaszok

Promise<string[]>

addBuildTags(string[], string, number)

Címkéket ad hozzá egy buildhez.

function addBuildTags(tags: string[], project: string, buildId: number): Promise<string[]>

Paraméterek

tags: string[]

A címkék, amiket hozzá kell adni. A kérelmező közvetlenül felsorolt címkékből áll.

project: string

Projektazonosító vagy projektnév

buildId: number

Az építés azonosítója.

Válaszok

Promise<string[]>

addDefinitionTag(string, number, string)

Címke hozzáadása definícióhoz

function addDefinitionTag(project: string, definitionId: number, tag: string): Promise<string[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

definitionId: number

A definíció azonosítója.

tag: string

A címkét, amit hozzá kell adni.

Válaszok

Promise<string[]>

addDefinitionTags(string[], string, number)

Több címkét ad hozzá egy definícióhoz.

function addDefinitionTags(tags: string[], project: string, definitionId: number): Promise<string[]>

Paraméterek

tags: string[]

A címkék, amiket hozzá kell adni.

project: string

Projektazonosító vagy projektnév

definitionId: number

A definíció azonosítója.

Válaszok

Promise<string[]>

addRetentionLeases(NewRetentionLease[], string)

Új bérleti szerződéseket ad hozzá a vezeték-futásokhoz.

function addRetentionLeases(newLeases: NewRetentionLease[], project: string): Promise<RetentionLease[]>

Paraméterek

newLeases: NewRetentionLease[]

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<RetentionLease[]>

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

function authorizeDefinitionResources(resources: DefinitionResourceReference[], project: string, definitionId: number): Promise<DefinitionResourceReference[]>

Paraméterek

resources: DefinitionResourceReference[]

project: string

Projektazonosító vagy projektnév

definitionId: number

Válaszok

Promise<DefinitionResourceReference[]>

authorizeProjectResources(DefinitionResourceReference[], string)

function authorizeProjectResources(resources: DefinitionResourceReference[], project: string): Promise<DefinitionResourceReference[]>

Paraméterek

resources: DefinitionResourceReference[]

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<DefinitionResourceReference[]>

createArtifact(BuildArtifact, string, number)

Egy ereklyét egy buildhez társít.

function createArtifact(artifact: BuildArtifact, project: string, buildId: number): Promise<BuildArtifact>

Paraméterek

artifact: BuildArtifact

A tárgy.

project: string

Projektazonosító vagy projektnév

buildId: number

Az építés azonosítója.

Válaszok

Promise<BuildArtifact>

createDefinition(BuildDefinition, string, number, number)

Új definíciót teremt.

function createDefinition(definition: BuildDefinition, project: string, definitionToCloneId?: number, definitionToCloneRevision?: number): Promise<BuildDefinition>

Paraméterek

definition: BuildDefinition

A definíció.

project: string

Projektazonosító vagy projektnév

definitionToCloneId: number

definitionToCloneRevision: number

Válaszok

Promise<BuildDefinition>

createFolder(Folder, string, string)

Új mappát hoz létre.

function createFolder(folder: Folder, project: string, path: string): Promise<Folder>

Paraméterek

folder: Folder

A mappá.

project: string

Projektazonosító vagy projektnév

path: string

A mappa teljes útvonala.

Válaszok

Promise<Folder>

deleteBuild(string, number)

Törli az építést.

function deleteBuild(project: string, buildId: number): Promise<void>

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

Az építés azonosítója.

Válaszok

Promise<void>

deleteBuildTag(string, number, string)

Eltávolít egy címkét egy buildből. MEGJEGYZÉS: Ez az API nem fog működni speciális karakterekkel rendelkező címkékhez. Speciális karakterekkel rendelkező címkék eltávolításához inkább a PATCH módszert használjuk (6.0+ verzióban)

function deleteBuildTag(project: string, buildId: number, tag: string): Promise<string[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

Az építés azonosítója.

tag: string

A címkét, amit le kell venni.

Válaszok

Promise<string[]>

deleteDefinition(string, number)

Törli a definíciót és az összes kapcsolódó buildet.

function deleteDefinition(project: string, definitionId: number): Promise<void>

Paraméterek

project: string

Projektazonosító vagy projektnév

definitionId: number

A definíció azonosítója.

Válaszok

Promise<void>

deleteDefinitionTag(string, number, string)

Eltávolít egy címkét egy definícióból. MEGJEGYZÉS: Ez az API nem fog működni speciális karakterekkel rendelkező címkékhez. Speciális karakterekkel rendelkező címkék eltávolításához inkább a PATCH módszert használjuk (6.0+ verzióban)

function deleteDefinitionTag(project: string, definitionId: number, tag: string): Promise<string[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

definitionId: number

A definíció azonosítója.

tag: string

A címkét, amit le kell venni.

Válaszok

Promise<string[]>

deleteFolder(string, string)

Törli a definíciós mappát. A definíciókat és a hozzájuk tartozó buildeket is töröljük.

function deleteFolder(project: string, path: string): Promise<void>

Paraméterek

project: string

Projektazonosító vagy projektnév

path: string

A mappa teljes elérési útja.

Válaszok

Promise<void>

deleteRetentionLeasesById(string, number[])

Megszünteti a konkrét megtartási bérleteket.

function deleteRetentionLeasesById(project: string, ids: number[]): Promise<void>

Paraméterek

project: string

Projektazonosító vagy projektnév

ids: number[]

Válaszok

Promise<void>

deleteTag(string, string)

Eltávolít egy címkét a build-ekből, definíciókból és a tag-tárolóból

function deleteTag(project: string, tag: string): Promise<string[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

tag: string

A címkét, amit le kell venni.

Válaszok

Promise<string[]>

deleteTemplate(string, string)

Törli a build definifikációs sablont.

function deleteTemplate(project: string, templateId: string): Promise<void>

Paraméterek

project: string

Projektazonosító vagy projektnév

templateId: string

A sablon azonosítója.

Válaszok

Promise<void>

getArtifact(string, number, string)

Egy buildhez kap egy specifikus artefaktot.

function getArtifact(project: string, buildId: number, artifactName: string): Promise<BuildArtifact>

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

Az építés azonosítója.

artifactName: string

Az összetevő neve.

Válaszok

Promise<BuildArtifact>

getArtifactContentZip(string, number, string)

Egy buildhez kap egy specifikus artefaktot.

function getArtifactContentZip(project: string, buildId: number, artifactName: string): Promise<ArrayBuffer>

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

Az építés azonosítója.

artifactName: string

Az összetevő neve.

Válaszok

Promise<ArrayBuffer>

getArtifacts(string, number)

Minden ereklyét megkap egy buildhez.

function getArtifacts(project: string, buildId: number): Promise<BuildArtifact[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

Az építés azonosítója.

Válaszok

Promise<BuildArtifact[]>

getAttachment(string, number, string, string, string, string)

Speciális kötődést kap.

function getAttachment(project: string, buildId: number, timelineId: string, recordId: string, type: string, name: string): Promise<ArrayBuffer>

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

Az építés azonosítója.

timelineId: string

Az idővonal azonosítója.

recordId: string

Az idővonal nyilvántartásának azonosítója.

type: string

A kötődés típusa.

name: string

A melléklet neve.

Válaszok

Promise<ArrayBuffer>

getAttachments(string, number, string)

Megkapja a konkrét típusú kiegészítők listáját, amelyek egy buildhez kapcsolódnak.

function getAttachments(project: string, buildId: number, type: string): Promise<Attachment[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

Az építés azonosítója.

type: string

Melléklet típusa.

Válaszok

Promise<Attachment[]>

getBadge(string, number, string)

Olyan jelvényt kap, amely jelzi a legfrissebb build állapotát egy definícióhoz. Fontos megjegyezni, hogy ez az API elavult. Preferálom a StatusBadgeController.GetStatusBadge-et.

function getBadge(project: string, definitionId: number, branchName?: string): Promise<string>

Paraméterek

project: string

A projekt azonosítója vagy neve.

definitionId: number

A definíció azonosítója.

branchName: string

Az ág neve.

Válaszok

Promise<string>

getBuild(string, number, string)

Építkezik

function getBuild(project: string, buildId: number, propertyFilters?: string): Promise<Build>

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

propertyFilters: string

Válaszok

Promise<Build>

getBuildBadge(string, string, string, string)

Megkap egy jelvényt, amely jelzi a megadott fiók legfrissebb build állapotát.

function getBuildBadge(project: string, repoType: string, repoId?: string, branchName?: string): Promise<BuildBadge>

Paraméterek

project: string

Projektazonosító vagy projektnév

repoType: string

A tároló típus.

repoId: string

A tároló azonosítója.

branchName: string

Az ág neve.

Válaszok

Promise<BuildBadge>

getBuildBadgeData(string, string, string, string)

Megkap egy jelvényt, amely jelzi a megadott fiók legfrissebb build állapotát.

function getBuildBadgeData(project: string, repoType: string, repoId?: string, branchName?: string): Promise<string>

Paraméterek

project: string

Projektazonosító vagy projektnév

repoType: string

A tároló típus.

repoId: string

A tároló azonosítója.

branchName: string

Az ág neve.

Válaszok

Promise<string>

getBuildChanges(string, number, string, number, boolean)

Megkapja a buildhez kapcsolódó változásokat

function getBuildChanges(project: string, buildId: number, continuationToken?: string, top?: number, includeSourceChange?: boolean): Promise<PagedList<Change>>

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

continuationToken: string

top: number

A maximális visszatérő változtatások száma

includeSourceChange: boolean

Válaszok

Promise<PagedList<Change>>

getBuildController(number)

Kontrollert kap

function getBuildController(controllerId: number): Promise<BuildController>

Paraméterek

controllerId: number

Válaszok

Promise<BuildController>

getBuildControllers(string)

Kontrollert kap, opcionálisan név szerint szűrve

function getBuildControllers(name?: string): Promise<BuildController[]>

Paraméterek

name: string

Válaszok

Promise<BuildController[]>

getBuildGeneralSettings(string)

Megkapja a pipeline általános beállításokat.

function getBuildGeneralSettings(project: string): Promise<PipelineGeneralSettings>

Paraméterek

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<PipelineGeneralSettings>

getBuildLog(string, number, number, number, number)

Egyedi naplófájlt kap egy buildhez.

function getBuildLog(project: string, buildId: number, logId: number, startLine?: number, endLine?: number): Promise<string>

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

Az építés azonosítója.

logId: number

A naplófájl azonosítója.

startLine: number

A rajtvonal.

endLine: number

A végvonal.

Válaszok

Promise<string>

getBuildLogLines(string, number, number, number, number)

Egyedi naplófájlt kap egy buildhez.

function getBuildLogLines(project: string, buildId: number, logId: number, startLine?: number, endLine?: number): Promise<string[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

Az építés azonosítója.

logId: number

A naplófájl azonosítója.

startLine: number

A rajtvonal.

endLine: number

A végvonal.

Válaszok

Promise<string[]>

getBuildLogs(string, number)

Megszerzi a rönköket egy építéshez.

function getBuildLogs(project: string, buildId: number): Promise<BuildLog[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

Az építés azonosítója.

Válaszok

Promise<BuildLog[]>

getBuildLogsZip(string, number)

Megszerzi a rönköket egy építéshez.

function getBuildLogsZip(project: string, buildId: number): Promise<ArrayBuffer>

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

Az építés azonosítója.

Válaszok

Promise<ArrayBuffer>

getBuildLogZip(string, number, number, number, number)

Egyedi naplófájlt kap egy buildhez.

function getBuildLogZip(project: string, buildId: number, logId: number, startLine?: number, endLine?: number): Promise<ArrayBuffer>

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

Az építés azonosítója.

logId: number

A naplófájl azonosítója.

startLine: number

A rajtvonal.

endLine: number

A végvonal.

Válaszok

Promise<ArrayBuffer>

getBuildOptionDefinitions(string)

Minden rendszer által támogatott build definíciós opciót megkap.

function getBuildOptionDefinitions(project?: string): Promise<BuildOptionDefinition[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<BuildOptionDefinition[]>

getBuildProperties(string, number, string[])

Ingatlanokat kap egy építéshez.

function getBuildProperties(project: string, buildId: number, filter?: string[]): Promise<any>

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

Az építés azonosítója.

filter: string[]

Egy vesszővel határolt tulajdonságlista. Ha megadják, szűrődjenek ezekre a tulajdonságokra.

Válaszok

Promise<any>

getBuildReport(string, number, string)

Szerez egy build jelentést.

function getBuildReport(project: string, buildId: number, type?: string): Promise<BuildReportMetadata>

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

Az építés azonosítója.

type: string

Válaszok

Promise<BuildReportMetadata>

getBuildReportHtmlContent(string, number, string)

Szerez egy build jelentést.

function getBuildReportHtmlContent(project: string, buildId: number, type?: string): Promise<any>

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

Az építés azonosítója.

type: string

Válaszok

Promise<any>

getBuilds(string, number[], number[], string, Date, Date, string, BuildReason, BuildStatus, BuildResult, string[], string[], number, string, number, QueryDeletedOption, BuildQueryOrder, string, number[], string, string)

Megkap egy listát a buildekről.

function getBuilds(project: string, definitions?: number[], queues?: number[], buildNumber?: string, minTime?: Date, maxTime?: Date, requestedFor?: string, reasonFilter?: BuildReason, statusFilter?: BuildStatus, resultFilter?: BuildResult, tagFilters?: string[], properties?: string[], top?: number, continuationToken?: string, maxBuildsPerDefinition?: number, deletedFilter?: QueryDeletedOption, queryOrder?: BuildQueryOrder, branchName?: string, buildIds?: number[], repositoryId?: string, repositoryType?: string): Promise<PagedList<Build>>

Paraméterek

project: string

Projektazonosító vagy projektnév

definitions: number[]

Egy vesszővel határolt definíciós azonosítók listája. Ha megadják, szűrők a build-ekhez ezekhez a definíciókhoz.

queues: number[]

Egy vesszővel határolt sorazonosítók lista. Ha van megadva, szűrők azokra a buildekre, amelyek ezekkel a sorokkal szemben futnak.

buildNumber: string

Ha ez megadja, szűrője azokra a buildekre, amelyek megegyeznek ennek a build-számnak. A * hozzáadás, hogy előtag keresést végezzek.

minTime: Date

Ha van megadva, szűrője azokra a buildekre, amelyek ezután befejezték/indultak/sorba álltak a megadott queryOrder alapján.

maxTime: Date

Ha ez van megadva, szűrők azokra a buildekre, amelyek a dátum előtt befejeztek/elindultak/sorba álltak, a megadott queryOrder alapján.

requestedFor: string

Ha megadják, szűrők a megadott felhasználó által kért buildekre.

reasonFilter: BuildReason

Ha ez megadja, szűrők azokra az építkezésekre, amelyek megfelelnek ennek az oknak.

statusFilter: BuildStatus

Ha megadják, szűrők azokra a buildekre, amelyek megfelelnek ennek az állapotnak.

resultFilter: BuildResult

Ha megadják, szűrők azokra a buildekre, amelyek megfelelnek ennek az eredménynek.

tagFilters: string[]

A címkék vesszővel tagolt listája. Ha van megadva, szűrők azokra a buildekre, amelyekben a megadott címkék vannak.

properties: string[]

Egy vesszővel határolt lista a lekérendő tulajdonságokról.

top: number

A maximális visszatérő buildek száma.

continuationToken: string

Egy folytatási token, amelyet egy korábbi kérés adott vissza ehhez a módszerhez, és amely a következő build-készlet visszaállítására használható.

maxBuildsPerDefinition: number

A maximális visszatérő buildek száma definíció szerint.

deletedFilter: QueryDeletedOption

Jelzi, hogy kizárják, bevonják-e, vagy csak a törölt verziókat kell visszaadni.

queryOrder: BuildQueryOrder

A buildek visszaküldésének sorrendjében.

branchName: string

Ha van megadva, szűrők azokra az építményekre, amelyek az ágakat építették, amelyek ezt az ágat építették.

buildIds: number[]

Egy vesszővel elosztott lista, amely meghatározza a vissza kívánt buildek azonosítóit.

repositoryId: string

Ha megadják, szűrők azokra a buildekre, amelyek ebből a tárolóból épültek.

repositoryType: string

Ha megadják, szűrők olyan buildekre, amelyek ilyen típusú tárolók alapján épülnek.

Válaszok

Promise<PagedList<Build>>

getBuildSettings(string)

Megkapja a build beállításokat.

function getBuildSettings(project?: string): Promise<BuildSettings>

Paraméterek

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<BuildSettings>

getBuildStageLatestTimeline(string, number, string, number, string)

A legfrissebb idővonalat egy adott szintre szűri.

function getBuildStageLatestTimeline(project: string, buildId: number, stageName: string, changeId?: number, planId?: string): Promise<Timeline>

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

Az építés azonosítója.

stageName: string

A színpad neve, amire szűrni kell.

changeId: number

A váltás azonosítója, amit szűrni kell.

planId: string

A terv azonosítója.

Válaszok

Promise<Timeline>

getBuildStageTimeline(string, number, string, string, number, string)

Megkapja az építés idővonalát egy adott szintre szűrve.

function getBuildStageTimeline(project: string, buildId: number, timelineId: string, stageName: string, changeId?: number, planId?: string): Promise<Timeline>

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

Az építés azonosítója.

timelineId: string

Az idővonal azonosítója.

stageName: string

A színpad neve, amire szűrni kell.

changeId: number

A váltás azonosítója, amit szűrni kell.

planId: string

A terv azonosítója.

Válaszok

Promise<Timeline>

getBuildTags(string, number)

Megkapja a címkéket egy buildhez.

function getBuildTags(project: string, buildId: number): Promise<string[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

Az építés azonosítója.

Válaszok

Promise<string[]>

getBuildTimeline(string, number, string, number, string)

Részleteket kap egy buildhez

function getBuildTimeline(project: string, buildId: number, timelineId?: string, changeId?: number, planId?: string): Promise<Timeline>

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

timelineId: string

changeId: number

planId: string

Válaszok

Promise<Timeline>

getBuildWorkItemsRefs(string, number, number)

Megkapja a buildhez kapcsolódó munkatárgyakat. Csak a projekt munkatárgyait küldik vissza.

function getBuildWorkItemsRefs(project: string, buildId: number, top?: number): Promise<ResourceRef[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

Az építés azonosítója.

top: number

A maximális számú munkatárgy, amit vissza kell adni.

Válaszok

Promise<ResourceRef[]>

getBuildWorkItemsRefsFromCommits(string[], string, number, number)

Megkapja a buildhez kapcsolódó munkatárgyakat, amelyeket meghatározott commit-ekhez szűrnek.

function getBuildWorkItemsRefsFromCommits(commitIds: string[], project: string, buildId: number, top?: number): Promise<ResourceRef[]>

Paraméterek

commitIds: string[]

Egy vesszővel határolt lista a commit ID-kről.

project: string

Projektazonosító vagy projektnév

buildId: number

Az építés azonosítója.

top: number

A maximális munkatételek száma, amit vissza kell adni, vagy hány commitet kell figyelembe venni, ha nincs megadva commit ID.

Válaszok

Promise<ResourceRef[]>

getChangesBetweenBuilds(string, number, number, number)

Megkapja a változtatásokat a tárolóban két adott build között.

function getChangesBetweenBuilds(project: string, fromBuildId?: number, toBuildId?: number, top?: number): Promise<Change[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

fromBuildId: number

Az első építés azonosítója.

toBuildId: number

Az utolsó build azonosítója.

top: number

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

Válaszok

Promise<Change[]>

getDefinition(string, number, number, Date, string[], boolean)

Kap definíciót, opcionálisan egy adott verzióban.

function getDefinition(project: string, definitionId: number, revision?: number, minMetricsTime?: Date, propertyFilters?: string[], includeLatestBuilds?: boolean): Promise<BuildDefinition>

Paraméterek

project: string

Projektazonosító vagy projektnév

definitionId: number

A definíció azonosítója.

revision: number

A visszaszerzendő verziószám. Ha ez nincs megadva, a legfrissebb verziót visszaküldik.

minMetricsTime: Date

Ha megadja, jelzi a mutatók bevonásának dátumát.

propertyFilters: string[]

Egy vesszővel határolt tulajdonságlista, amelyet az eredményekhez kell bevonni.

includeLatestBuilds: boolean

Válaszok

Promise<BuildDefinition>

getDefinitionMetrics(string, number, Date)

Megkapja a build metrikákat egy definícióhoz.

function getDefinitionMetrics(project: string, definitionId: number, minMetricsTime?: Date): Promise<BuildMetric[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

definitionId: number

A definíció azonosítója.

minMetricsTime: Date

Az a dátum, amelyből a metrikák kiszámítják.

Válaszok

Promise<BuildMetric[]>

getDefinitionProperties(string, number, string[])

Tulajdonságokat kap egy definícióhoz.

function getDefinitionProperties(project: string, definitionId: number, filter?: string[]): Promise<any>

Paraméterek

project: string

Projektazonosító vagy projektnév

definitionId: number

A definíció azonosítója.

filter: string[]

Egy vesszővel határolt tulajdonságlista. Ha megadják, szűrődjenek ezekre a tulajdonságokra.

Válaszok

Promise<any>

getDefinitionResources(string, number)

function getDefinitionResources(project: string, definitionId: number): Promise<DefinitionResourceReference[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

definitionId: number

Válaszok

Promise<DefinitionResourceReference[]>

getDefinitionRevisions(string, number)

Minden definíció módosítását kapja.

function getDefinitionRevisions(project: string, definitionId: number): Promise<BuildDefinitionRevision[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

definitionId: number

A definíció azonosítója.

Válaszok

Promise<BuildDefinitionRevision[]>

getDefinitions(string, string, string, string, DefinitionQueryOrder, number, string, Date, number[], string, Date, Date, boolean, boolean, string, number, string)

Tartalmaz egy definíciólistát.

function getDefinitions(project: string, name?: string, repositoryId?: string, repositoryType?: string, queryOrder?: DefinitionQueryOrder, top?: number, continuationToken?: string, minMetricsTime?: Date, definitionIds?: number[], path?: string, builtAfter?: Date, notBuiltAfter?: Date, includeAllProperties?: boolean, includeLatestBuilds?: boolean, taskIdFilter?: string, processType?: number, yamlFilename?: string): Promise<PagedList<BuildDefinitionReference>>

Paraméterek

project: string

Projektazonosító vagy projektnév

name: string

Ha megadják, szűrik azokat a definíciókat, amelyek neve megegyezik ezzel a mintával.

repositoryId: string

Egy tárolóazonosító. Ha megadják, szűrje azokat a definíciókat, amelyek ezt a tárolót használják.

repositoryType: string

Ha van megadva, szűrők olyan definíciókra, amelyek rendelkeznek ilyen típusú tárattal.

queryOrder: DefinitionQueryOrder

Jelzi, hogy a definíciókat milyen sorrendben kell visszaadni.

top: number

A maximális számú definíció, amit vissza kell adni.

continuationToken: string

Egy folytatási token, amelyet egy korábbi kérés adott vissza ehhez a metódushoz, és amely a következő definíciók halmazának visszaadásához használható.

minMetricsTime: Date

Ha megadja, jelzi a mutatók bevonásának dátumát.

definitionIds: number[]

Egy vesszővel definiált lista, amely meghatározza a definíciók azonosítóit, amelyeket le kell kérni.

path: string

Ha meg van adva, az ebben a mappában lévő definíciókra szűr.

builtAfter: Date

Ha megadják, szűrje azokat a definíciókat, amelyek ezt követően épülnek fel.

notBuiltAfter: Date

Ha van megadva, szűrje azokat a definíciókat, amelyeknek nincs építésük ezen a dátum után.

includeAllProperties: boolean

Jelzi, hogy a teljes definíciókat vissza kell-e adni. Alapértelmezés szerint a definíciók sekélyes reprezentációi jelennek meg.

includeLatestBuilds: boolean

Jelzi, hogy a legfrissebb és legutóbb befejezett buildeket kell visszaküldeni ehhez a definícióhoz.

taskIdFilter: string

Ha van megadva, szűrője a meghatározott feladatot használó definíciókra.

processType: number

Ha megadják, szűrik a megadott folyamattípusú definíciókra.

yamlFilename: string

Ha van megadva, szűrők a megadott fájlnévnek megfelelő YAML definíciókra. A filterhez a includeAllProperties valóra kell állítva

Válaszok

Promise<PagedList<BuildDefinitionReference>>

getDefinitionTags(string, number, number)

Megkapja a definíció címkéit.

function getDefinitionTags(project: string, definitionId: number, revision?: number): Promise<string[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

definitionId: number

A definíció azonosítója.

revision: number

A definíció változatszáma. Ha nincs megadva, a definíció legfrissebb változatát használja.

Válaszok

Promise<string[]>

getDefinitionYaml(string, number, number, Date, string[], boolean)

Egy definíciót YAML-re alakít át, opcionálisan egy adott verzióval.

function getDefinitionYaml(project: string, definitionId: number, revision?: number, minMetricsTime?: Date, propertyFilters?: string[], includeLatestBuilds?: boolean): Promise<YamlBuild>

Paraméterek

project: string

Projektazonosító vagy projektnév

definitionId: number

A definíció azonosítója.

revision: number

A visszaszerzendő verziószám. Ha ez nincs megadva, a legfrissebb verziót visszaküldik.

minMetricsTime: Date

Ha megadja, jelzi a mutatók bevonásának dátumát.

propertyFilters: string[]

Egy vesszővel határolt tulajdonságlista, amelyet az eredményekhez kell bevonni.

includeLatestBuilds: boolean

Válaszok

Promise<YamlBuild>

getFile(string, number, string, string, string)

Fájlt kap a buildből.

function getFile(project: string, buildId: number, artifactName: string, fileId: string, fileName: string): Promise<ArrayBuffer>

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

Az építés azonosítója.

artifactName: string

Az összetevő neve.

fileId: string

A fájl elsődleges kulcsa.

fileName: string

Az a név, amelyre a fájl be lesz állítva.

Válaszok

Promise<ArrayBuffer>

getFileContents(string, string, string, string, string, string)

Megkapja egy fájl tartalmát a megadott forráskód tárolóban.

function getFileContents(project: string, providerName: string, serviceEndpointId?: string, repository?: string, commitOrBranch?: string, path?: string): Promise<string>

Paraméterek

project: string

Projektazonosító vagy projektnév

providerName: string

A forrásszolgáltató neve.

serviceEndpointId: string

Ha megadják, a lekérdezésre szolgáló szolgáltatásvégpont azonosítója. Csak azoknál a szolgáltatóknál hagyható ki, amelyek nem használnak szolgáltatási végpontokat, például TFVC vagy TFGit.

repository: string

Ha megadják, a gyártó-specifikus azonosító vagy a tároló neve az ágazások eléréséhez. Csak azoknál a szolgáltatóknál hagyhatók ki, amelyek nem támogatnak több tárolót.

commitOrBranch: string

Az a commitáció vagy ág azonosítója, amelyből a fájl tartalma visszanyerhető.

path: string

Az út a fájlhoz, amelyet a tároló gyökereihez viszonyítva lehet.

Válaszok

Promise<string>

getFolders(string, string, FolderQueryOrder)

Megkapja a build definiálási mappák listáját.

function getFolders(project: string, path?: string, queryOrder?: FolderQueryOrder): Promise<Folder[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

path: string

Az út, amivel kezdhetjük.

queryOrder: FolderQueryOrder

A mappák visszaküldésének sorrendje.

Válaszok

Promise<Folder[]>

getLatestBuild(string, string, string)

Megkapja a legújabb verziót egy definícióhoz, opcionálisan egy adott ágra korlátozva.

function getLatestBuild(project: string, definition: string, branchName?: string): Promise<Build>

Paraméterek

project: string

Projektazonosító vagy projektnév

definition: string

definíció név opcionális vezető mappáúttal, vagy a definícióazonosító

branchName: string

opcionális paraméter, amely jelzi, melyik adott ágat kell használni. Ha nincs megadva, akkor az alapértelmezett ágat használják.

Válaszok

Promise<Build>

getPathContents(string, string, string, string, string, string)

Megkapja a megadott forráskód tárolóban található könyvtár tartalmát.

function getPathContents(project: string, providerName: string, serviceEndpointId?: string, repository?: string, commitOrBranch?: string, path?: string): Promise<SourceRepositoryItem[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

providerName: string

A forrásszolgáltató neve.

serviceEndpointId: string

Ha megadják, a lekérdezésre szolgáló szolgáltatásvégpont azonosítója. Csak azoknál a szolgáltatóknál hagyható ki, amelyek nem használnak szolgáltatási végpontokat, például TFVC vagy TFGit.

repository: string

Ha megadják, a gyártó-specifikus azonosító vagy a tároló neve az ágazások eléréséhez. Csak azoknál a szolgáltatóknál hagyhatók ki, amelyek nem támogatnak több tárolót.

commitOrBranch: string

Az a commitáció vagy ág azonosítója, amelyből a fájl tartalma visszanyerhető.

path: string

Az útvonal tartalmát listázza, a tároló gyökeréhez viszonyítva.

Válaszok

Promise<SourceRepositoryItem[]>

getProjectMetrics(string, string, Date)

Megkapja a projekthez szükséges építési mutatókat.

function getProjectMetrics(project: string, metricAggregationType?: string, minMetricsTime?: Date): Promise<BuildMetric[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

metricAggregationType: string

Az aggregációs típus (óránként, napi).

minMetricsTime: Date

Az a dátum, amelyből a metrikák kiszámítják.

Válaszok

Promise<BuildMetric[]>

getProjectResources(string, string, string)

function getProjectResources(project: string, type?: string, id?: string): Promise<DefinitionResourceReference[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

type: string

id: string

Válaszok

Promise<DefinitionResourceReference[]>

getPullRequest(string, string, string, string, string)

A forrásszolgáltatótól kap egy pull request objektumot.

function getPullRequest(project: string, providerName: string, pullRequestId: string, repositoryId?: string, serviceEndpointId?: string): Promise<PullRequest>

Paraméterek

project: string

Projektazonosító vagy projektnév

providerName: string

A forrásszolgáltató neve.

pullRequestId: string

A pull request gyártó-specifikus azonosítója.

repositoryId: string

Gyártó-specifikus azonosító vagy annak a tároló neve, amely tartalmazza a pull requestet.

serviceEndpointId: string

Ha megadják, a lekérdezésre szolgáló szolgáltatásvégpont azonosítója. Csak azoknál a szolgáltatóknál hagyható ki, amelyek nem használnak szolgáltatási végpontokat, például TFVC vagy TFGit.

Válaszok

Promise<PullRequest>

getResourceUsage()

Információkat kap a rendszerben lévő build erőforrásokról.

function getResourceUsage(): Promise<BuildResourceUsage>

Válaszok

Promise<BuildResourceUsage>

getRetentionHistory(number)

Visszaadja a projektgyűjtemény megtartási előzményeit. Ez magában foglalja a pipeline-eket, amelyek egyedi megtartási szabályokat alkalmaznak, amelyek megakadályozhatják a megtartási feladat tisztítását, a futtatók a pipeline-enként a retention típussal, a gyűjteményhez tartozó pipeline-ekhez kapcsolódó fájlok tárolási típussal, valamint a fájlok számát egy csővezetékenként.

function getRetentionHistory(daysToLookback?: number): Promise<BuildRetentionHistory>

Paraméterek

daysToLookback: number

Válaszok

Promise<BuildRetentionHistory>

getRetentionLease(string, number)

Visszaadja a megtartási szerződés adatait a bérleti azonosítóval.

function getRetentionLease(project: string, leaseId: number): Promise<RetentionLease>

Paraméterek

project: string

Projektazonosító vagy projektnév

leaseId: number

Válaszok

Promise<RetentionLease>

getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])

Visszaadja azokat a bérleteket, amelyek megfelelnek a megadott MinimalRetentionLease-eknek

function getRetentionLeasesByMinimalRetentionLeases(project: string, leasesToFetch: MinimalRetentionLease[]): Promise<RetentionLease[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

leasesToFetch: MinimalRetentionLease[]

JSON-szeriázott MinimalRetentionLízikák listája, amelyeket '|' szegéllyel választanak el

Válaszok

Promise<RetentionLease[]>

getRetentionLeasesByOwnerId(string, string, number, number)

Visszaadja a megadott entitás tulajdonában lévő bérleteket, opcionálisan egyetlen csővezeték-definícióra korlátozva és fut.

function getRetentionLeasesByOwnerId(project: string, ownerId?: string, definitionId?: number, runId?: number): Promise<RetentionLease[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

ownerId: string

definitionId: number

Egy opcionális paraméter, amely a keresést egy adott csővezeték-definícióra korlátozza.

runId: number

Egy opcionális paraméter, amely egyetlen csővezetékre korlátozza a keresést. DefiniId szükséges.

Válaszok

Promise<RetentionLease[]>

getRetentionLeasesByUserId(string, string, number, number)

Visszaadja a megadott felhasználó tulajdonában lévő bérleteket, opcionálisan egyetlen csővezeték-definícióra korlátozva, és futtatja.

function getRetentionLeasesByUserId(project: string, userOwnerId: string, definitionId?: number, runId?: number): Promise<RetentionLease[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

userOwnerId: string

A felhasználó azonosítója, amit keresni.

definitionId: number

Egy opcionális paraméter, amely a keresést egy adott csővezeték-definícióra korlátozza.

runId: number

Egy opcionális paraméter, amely egyetlen csővezetékre korlátozza a keresést. DefiniId szükséges.

Válaszok

Promise<RetentionLease[]>

getRetentionLeasesForBuild(string, number)

Minden megtartási szerződést kap, ami egy adott buildre vonatkozik.

function getRetentionLeasesForBuild(project: string, buildId: number): Promise<RetentionLease[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

Az építés azonosítója.

Válaszok

Promise<RetentionLease[]>

getRetentionSettings(string)

Megkapja a projekt megtartási beállításait.

function getRetentionSettings(project: string): Promise<ProjectRetentionSetting>

Paraméterek

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<ProjectRetentionSetting>

getStatusBadge(string, string, string, string, string, string, string)

<p>Megkapja a definíció build státuszát, opcionálisan egy adott ágra, szakaszra, feladatra és konfigurációra korlátozva.</p><p>Ha több van egy, akkor a workName megadásakor szükséges egy stageName értéket adni, és ugyanaz a szabály érvényes mindkettőre konfigurációs paraméter átadásához.</p>

function getStatusBadge(project: string, definition: string, branchName?: string, stageName?: string, jobName?: string, configuration?: string, label?: string): Promise<string>

Paraméterek

project: string

Projektazonosító vagy projektnév

definition: string

Vagy a definíció neve opcionális vezető mappa úttal, vagy a definíció azonosítója.

branchName: string

Csak a legfrissebb építést vegyük figyelembe ehhez az ághoz. Ha nincs megadva, akkor az alapértelmezett ágat használják.

stageName: string

Használd ezt a szakaszt a csővezetéken az állapot megjelenítéséhez.

jobName: string

Ezt a feladatot a csővezeték egy szakaszán belül használd az állapot megjelenítéséhez.

configuration: string

Használd ezt a feladatkonfigurációt az állapot megjelenítéséhez

label: string

A jelvény bal oldalán lévő alapértelmezett szöveget cseréli.

Válaszok

Promise<string>

getTags(string)

Megkapja a projekt összes build címkéjének listáját.

function getTags(project: string): Promise<string[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<string[]>

getTemplate(string, string)

Van egy speciális build definifikációs sablon.

function getTemplate(project: string, templateId: string): Promise<BuildDefinitionTemplate>

Paraméterek

project: string

Projektazonosító vagy projektnév

templateId: string

A kért sablon azonosítója.

Válaszok

Promise<BuildDefinitionTemplate>

getTemplates(string)

Minden definíciós sablont megkap.

function getTemplates(project: string): Promise<BuildDefinitionTemplate[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<BuildDefinitionTemplate[]>

getWorkItemsBetweenBuilds(string, number, number, number)

Két build között megkapja az összes munkatárgyat.

function getWorkItemsBetweenBuilds(project: string, fromBuildId: number, toBuildId: number, top?: number): Promise<ResourceRef[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

fromBuildId: number

Az első építés azonosítója.

toBuildId: number

Az utolsó build azonosítója.

top: number

A maximális számú munkatárgy, amit vissza kell adni.

Válaszok

Promise<ResourceRef[]>

listBranches(string, string, string, string, string)

Megkapja a megadott forráskód tároló ágainak listáját.

function listBranches(project: string, providerName: string, serviceEndpointId?: string, repository?: string, branchName?: string): Promise<string[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

providerName: string

A forrásszolgáltató neve.

serviceEndpointId: string

Ha megadják, a lekérdezésre szolgáló szolgáltatásvégpont azonosítója. Csak azoknál a szolgáltatóknál hagyható ki, amelyek nem használnak szolgáltatási végpontokat, például TFVC vagy TFGit.

repository: string

A gyártó-specifikus azonosító vagy a fiókok megszerzéséhez szolgáló tárhely neve. Csak azoknál a szolgáltatóknál hagyhatók ki, amelyek nem támogatnak több tárolót.

branchName: string

Ha megadják, akkor az adott fiók neve, amit kifejezetten ellenőrizni kell.

Válaszok

Promise<string[]>

listRepositories(string, string, string, string, ResultSet, boolean, string)

Megkap egy forráskód tárolók listáját.

function listRepositories(project: string, providerName: string, serviceEndpointId?: string, repository?: string, resultSet?: ResultSet, pageResults?: boolean, continuationToken?: string): Promise<SourceRepositories>

Paraméterek

project: string

Projektazonosító vagy projektnév

providerName: string

A forrásszolgáltató neve.

serviceEndpointId: string

Ha megadják, a lekérdezésre szolgáló szolgáltatásvégpont azonosítója. Csak azoknál a szolgáltatóknál hagyható ki, amelyek nem használnak szolgáltatási végpontokat, például TFVC vagy TFGit.

repository: string

Ha meg van jelölve, akkor a gyártó-specifikus azonosító vagy egyetlen tároló neve kerül megkapásra.

resultSet: ResultSet

'top' a végponthoz legrelevánsabb tárolókhoz. Ha nincs beállítva, az összes tároló visszatér. Figyelmen kívül hagyva, ha a 'repoziórium' be van állítva.

pageResults: boolean

Ha igazra állítva állítják, ez korlátozza az eredmények halmazát, és egy folytatási tokent ad vissza a lekérdezés folytatásához.

continuationToken: string

Amikor az eredményeket lapozzanak, ez egy folytatási token, amelyet egy korábbi hívás adott vissza ehhez a módszerhez, és amellyel vissza lehet adni a következő tárolókat.

Válaszok

Promise<SourceRepositories>

listSourceProviders(string)

Szerezzen egy listát a forrás szolgáltatókról és azok képességeiről.

function listSourceProviders(project: string): Promise<SourceProviderAttributes[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<SourceProviderAttributes[]>

listWebhooks(string, string, string, string)

Megkap egy webhookok listáját a megadott forráskód tárolóban.

function listWebhooks(project: string, providerName: string, serviceEndpointId?: string, repository?: string): Promise<RepositoryWebhook[]>

Paraméterek

project: string

Projektazonosító vagy projektnév

providerName: string

A forrásszolgáltató neve.

serviceEndpointId: string

Ha megadják, a lekérdezésre szolgáló szolgáltatásvégpont azonosítója. Csak azoknál a szolgáltatóknál hagyható ki, amelyek nem használnak szolgáltatási végpontokat, például TFVC vagy TFGit.

repository: string

Ha megadják, a gyártó-specifikus azonosító vagy a tároló neve a webhookok eléréséhez. Csak azoknál a szolgáltatóknál hagyhatók ki, amelyek nem támogatnak több tárolót.

Válaszok

Promise<RepositoryWebhook[]>

queueBuild(Build, string, boolean, string, number, number)

Sorba helyezés egy build

function queueBuild(build: Build, project: string, ignoreWarnings?: boolean, checkInTicket?: string, sourceBuildId?: number, definitionId?: number): Promise<Build>

Paraméterek

build: Build

project: string

Projektazonosító vagy projektnév

ignoreWarnings: boolean

checkInTicket: string

sourceBuildId: number

definitionId: number

Opcionális definíciós id, hogy egy build teste nélküli sorba állítsák. Figyelmen kívül hagyják, ha van érvényes test

Válaszok

Promise<Build>

restoreDefinition(string, number, boolean)

Visszaállítja a törölt definíciót

function restoreDefinition(project: string, definitionId: number, deleted: boolean): Promise<BuildDefinition>

Paraméterek

project: string

Projektazonosító vagy projektnév

definitionId: number

A definíció azonosítója, amit vissza kell állítani.

deleted: boolean

Ha hamis, visszaállítja a törölt definíciót.

Válaszok

Promise<BuildDefinition>

restoreWebhooks(DefinitionTriggerType[], string, string, string, string)

Újrahozza a megadott triggerek webhookjait a megadott forráskód tárolóban.

function restoreWebhooks(triggerTypes: DefinitionTriggerType[], project: string, providerName: string, serviceEndpointId?: string, repository?: string): Promise<void>

Paraméterek

triggerTypes: DefinitionTriggerType[]

Milyen típusú triggereket lehet visszaállítani a webhookok.

project: string

Projektazonosító vagy projektnév

providerName: string

A forrásszolgáltató neve.

serviceEndpointId: string

Ha megadják, a lekérdezésre szolgáló szolgáltatásvégpont azonosítója. Csak azoknál a szolgáltatóknál hagyható ki, amelyek nem használnak szolgáltatási végpontokat, például TFVC vagy TFGit.

repository: string

Ha megadják, a gyártó-specifikus azonosító vagy a tároló neve a webhookok eléréséhez. Csak azoknál a szolgáltatóknál hagyhatók ki, amelyek nem támogatnak több tárolót.

Válaszok

Promise<void>

saveTemplate(BuildDefinitionTemplate, string, string)

Frissít egy meglévő build definíciós sablont.

function saveTemplate(template: BuildDefinitionTemplate, project: string, templateId: string): Promise<BuildDefinitionTemplate>

Paraméterek

template: BuildDefinitionTemplate

A sablon új verziója.

project: string

Projektazonosító vagy projektnév

templateId: string

A sablon azonosítója.

Válaszok

Promise<BuildDefinitionTemplate>

updateBuild(Build, string, number, boolean)

Frissíti a buildet.

function updateBuild(build: Build, project: string, buildId: number, retry?: boolean): Promise<Build>

Paraméterek

build: Build

A build.

project: string

Projektazonosító vagy projektnév

buildId: number

Az építés azonosítója.

retry: boolean

Válaszok

Promise<Build>

updateBuildGeneralSettings(PipelineGeneralSettings, string)

Frissíti a pipeline általános beállításait.

function updateBuildGeneralSettings(newSettings: PipelineGeneralSettings, project: string): Promise<PipelineGeneralSettings>

Paraméterek

newSettings: PipelineGeneralSettings

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<PipelineGeneralSettings>

updateBuildProperties(JsonPatchDocument, string, number)

Frissíti a buildhez szükséges tulajdonságokat.

function updateBuildProperties(document: JsonPatchDocument, project: string, buildId: number): Promise<any>

Paraméterek

document: JsonPatchDocument

Egy json-patch dokumentum, amely leírja a frissítésekre szükséges tulajdonságokat.

project: string

Projektazonosító vagy projektnév

buildId: number

Az építés azonosítója.

Válaszok

Promise<any>

updateBuilds(Build[], string)

Több buildet frissít.

function updateBuilds(builds: Build[], project: string): Promise<Build[]>

Paraméterek

builds: Build[]

A buildeket frissíteni.

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<Build[]>

updateBuildSettings(BuildSettings, string)

Frissíti a build beállításokat.

function updateBuildSettings(settings: BuildSettings, project?: string): Promise<BuildSettings>

Paraméterek

settings: BuildSettings

Az új beállítások.

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<BuildSettings>

updateBuildTags(UpdateTagParameters, string, number)

Hozzáadja/eltávolítja a címkéket egy buildből.

function updateBuildTags(updateParameters: UpdateTagParameters, project: string, buildId: number): Promise<string[]>

Paraméterek

updateParameters: UpdateTagParameters

A címkék, amiket hozzáadni vagy eltávolítani.

project: string

Projektazonosító vagy projektnév

buildId: number

Az építés azonosítója.

Válaszok

Promise<string[]>

updateDefinition(BuildDefinition, string, number, number, number, boolean)

Frissíti a meglévő build definíciót. Ahhoz, hogy ez a művelet sikeres legyen, a kéréstest "Revision" tulajdonságának értékének meg kell egyeznie a meglévő build definícióval. Ajánlott, hogy a meglévő build definíciót a GET segítségével szerezd meg, szükség szerint módosítsd a definíciót, majd add be a módosított definíciót PUT-tal.

function updateDefinition(definition: BuildDefinition, project: string, definitionId: number, secretsSourceDefinitionId?: number, secretsSourceDefinitionRevision?: number, cancelPausedBuilds?: boolean): Promise<BuildDefinition>

Paraméterek

definition: BuildDefinition

A definíció új változata. A "Revision" tulajdonságának meg kell felelnie a meglévő definíciónak, hogy a frissítés elfogadható legyen.

project: string

Projektazonosító vagy projektnév

definitionId: number

A definíció azonosítója.

secretsSourceDefinitionId: number

Opcionális azonosító a definícióról, amelyet titkok forrásaként használhatunk.

secretsSourceDefinitionRevision: number

Opcionális felülvizsgálat a titkos forrás definíciójának.

cancelPausedBuilds: boolean

Ha igaz, akkor a szünetelt építéseket töröli, amikor a csővezetéket egy szünetelt vagy letiltott állapotból engedélyezik.

Válaszok

Promise<BuildDefinition>

updateDefinitionProperties(JsonPatchDocument, string, number)

Frissíti a definíció tulajdonságait.

function updateDefinitionProperties(document: JsonPatchDocument, project: string, definitionId: number): Promise<any>

Paraméterek

document: JsonPatchDocument

Egy json-patch dokumentum, amely leírja a frissítésekre szükséges tulajdonságokat.

project: string

Projektazonosító vagy projektnév

definitionId: number

A definíció azonosítója.

Válaszok

Promise<any>

updateDefinitionTags(UpdateTagParameters, string, number)

Címkéket ad/eltávolít egy definícióból.

function updateDefinitionTags(updateParameters: UpdateTagParameters, project: string, definitionId: number): Promise<string[]>

Paraméterek

updateParameters: UpdateTagParameters

A címkék, amiket hozzáadni vagy eltávolítani.

project: string

Projektazonosító vagy projektnév

definitionId: number

A definíció azonosítója.

Válaszok

Promise<string[]>

updateFolder(Folder, string, string)

Egy meglévő mappát frissít adott úton

function updateFolder(folder: Folder, project: string, path: string): Promise<Folder>

Paraméterek

folder: Folder

A mappa új verziója.

project: string

Projektazonosító vagy projektnév

path: string

A mappa teljes elérési útja.

Válaszok

Promise<Folder>

updateRetentionLease(RetentionLeaseUpdate, string, number)

Frissíti a megtartási bérleti szerződés időtartamát vagy vezetékvédelmi státuszát.

function updateRetentionLease(leaseUpdate: RetentionLeaseUpdate, project: string, leaseId: number): Promise<RetentionLease>

Paraméterek

leaseUpdate: RetentionLeaseUpdate

Az új adatok a megtartási bérletről.

project: string

Projektazonosító vagy projektnév

leaseId: number

A bérleti szerződés azonosítóját frissíteni.

Válaszok

Promise<RetentionLease>

updateRetentionSettings(UpdateProjectRetentionSettingModel, string)

Frissíti a projekt megtartási beállításait.

function updateRetentionSettings(updateModel: UpdateProjectRetentionSettingModel, project: string): Promise<ProjectRetentionSetting>

Paraméterek

updateModel: UpdateProjectRetentionSettingModel

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<ProjectRetentionSetting>

updateStage(UpdateStageParameters, number, string, string)

Építési szakasz frissítése

function updateStage(updateParameters: UpdateStageParameters, buildId: number, stageRefName: string, project?: string): Promise<void>

Paraméterek

updateParameters: UpdateStageParameters

buildId: number

stageRefName: string

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<void>

BuildRestClient class

Konstruktorok

Tulajdonságok

Metódusok

Konstruktor adatai

BuildRestClient(IVssRestClientOptions)

Paraméterek

Tulajdonság adatai

RESOURCE_AREA_ID

Tulajdonság értéke

Metódus adatai

addBuildTag(string, number, string)

Paraméterek

Válaszok

addBuildTags(string[], string, number)

Paraméterek

Válaszok

addDefinitionTag(string, number, string)

Paraméterek

Válaszok

addDefinitionTags(string[], string, number)

Paraméterek

Válaszok

addRetentionLeases(NewRetentionLease[], string)

Paraméterek

Válaszok

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

Paraméterek

Válaszok

authorizeProjectResources(DefinitionResourceReference[], string)

Paraméterek

Válaszok

createArtifact(BuildArtifact, string, number)

Paraméterek

Válaszok

createDefinition(BuildDefinition, string, number, number)

Paraméterek

Válaszok

createFolder(Folder, string, string)

Paraméterek

Válaszok

deleteBuild(string, number)

Paraméterek

Válaszok

deleteBuildTag(string, number, string)

Paraméterek

Válaszok

deleteDefinition(string, number)

Paraméterek

Válaszok

deleteDefinitionTag(string, number, string)

Paraméterek

Válaszok

deleteFolder(string, string)

Paraméterek

Válaszok

deleteRetentionLeasesById(string, number[])

Paraméterek

Válaszok

deleteTag(string, string)

Paraméterek

Válaszok

deleteTemplate(string, string)

Paraméterek

Válaszok

getArtifact(string, number, string)

Paraméterek

Válaszok

getArtifactContentZip(string, number, string)

Paraméterek

Válaszok

getArtifacts(string, number)

Paraméterek

Válaszok

getAttachment(string, number, string, string, string, string)

Paraméterek

Válaszok

getAttachments(string, number, string)

Paraméterek

Válaszok