BuildRestClient class

Referencia

Csomag:: azure-devops-extension-api

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

Extends: RestClientBase

Konstruktorok

BuildRestClient(IVssRestClientOptions)

Tulajdonságok

RESOURCE_AREA_ID

Metódusok

addBuildTag(string, number, string)	Címkét ad hozzá 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érleteket ad hozzá a folyamatfuttatásokhoz.
authorizeDefinitionResources(DefinitionResourceReference[], string, number)
authorizeProjectResources(DefinitionResourceReference[], string)
createArtifact(BuildArtifact, string, number)	Összetevőt társít egy buildhez.
createDefinition(BuildDefinition, string, number, number)	Létrehoz egy új definíciót.
createFolder(Folder, string, string)	Létrehoz egy új mappát.
deleteBuild(string, number)	Egy build törlése.
deleteBuildTag(string, number, string)	Eltávolít egy címkét egy buildből. MEGJEGYZÉS: Ez az API nem fog működni a speciális karaktereket tartalmazó címkék esetében. Ha speciális karaktereket tartalmazó címkéket szeretne eltávolítani, használja helyette a PATCH metódust (6.0+-ban)
deleteDefinition(string, number)	Törli a definíciót és az összes társított 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 a speciális karaktereket tartalmazó címkék esetében. Ha speciális karaktereket tartalmazó címkéket szeretne eltávolítani, használja helyette a PATCH metódust (6.0+-ban)
deleteFolder(string, string)	Egy definíciómappát töröl. A definíciók és a hozzájuk tartozó buildek is törlődnek.
deleteRetentionLeasesById(string, number[])	Eltávolítja az adott adatmegőrzési bérleteket.
deleteTag(string, string)	Címke eltávolítása a buildekből, a definíciókból és a címketárolóból
deleteTemplate(string, string)	Töröl egy builddefiníciós sablont.
getArtifact(string, number, string)	Lekéri egy adott összetevőt egy buildhez.
getArtifactContentZip(string, number, string)	Lekéri egy adott összetevőt egy buildhez.
getArtifacts(string, number)	Lekéri az összes összetevőt egy buildhez.
getAttachment(string, number, string, string, string, string)	Lekér egy adott mellékletet.
getAttachments(string, number, string)	Lekéri a buildhez társított adott típusú mellékletek listáját.
getBadge(string, number, string)	Egy jelvényt kap, amely egy definíció legutóbbi buildjének állapotát jelzi. Vegye figyelembe, hogy ez az API elavult. Előnyben részesítse a StatusBadgeController.GetStatusBadge parancsot.
getBuild(string, number, string)	Build lekérése
getBuildBadge(string, string, string, string)	Lekéri a jelvényt, amely a megadott ág legutóbbi buildjének állapotát jelzi.
getBuildBadgeData(string, string, string, string)	Lekéri a jelvényt, amely a megadott ág legutóbbi buildjének állapotát jelzi.
getBuildChanges(string, number, string, number, boolean)	Lekéri a buildhez társított módosításokat
getBuildController(number)	Vezérlő beolvasása
getBuildControllers(string)	Lekéri a vezérlőt, opcionálisan név alapján szűrve
getBuildGeneralSettings(string)	Lekéri a folyamat általános beállításait.
getBuildLog(string, number, number, number, number)	Beolvas egy egyéni naplófájlt egy buildhez.
getBuildLogLines(string, number, number, number, number)	Beolvas egy egyéni naplófájlt egy buildhez.
getBuildLogs(string, number)	Lekéri egy build naplóit.
getBuildLogsZip(string, number)	Lekéri egy build naplóit.
getBuildLogZip(string, number, number, number, number)	Beolvas egy egyéni naplófájlt egy buildhez.
getBuildOptionDefinitions(string)	Lekéri a rendszer által támogatott összes builddefiníciós beállítást.
getBuildProperties(string, number, string[])	Lekéri egy build tulajdonságait.
getBuildReport(string, number, string)	Lekéri a buildjelentést.
getBuildReportHtmlContent(string, number, string)	Lekéri a buildjelentést.
getBuilds(string, number[], number[], string, Date, Date, string, BuildReason, BuildStatus, BuildResult, string[], string[], number, string, number, QueryDeletedOption, BuildQueryOrder, string, number[], string, string)	Lekéri a buildek listáját.
getBuildSettings(string)	Lekéri a buildbeállításokat.
getBuildTags(string, number)	Lekéri egy build címkéinek lekérdezése.
getBuildTimeline(string, number, string, number, string)	A build részleteinek lekérdezése
getBuildWorkItemsRefs(string, number, number)	Lekéri a buildhez társított munkaelemeket. A rendszer csak az ugyanabban a projektben lévő munkaelemeket adja vissza.
getBuildWorkItemsRefsFromCommits(string[], string, number, number)	Lekéri a buildhez társított munkaelemeket, meghatározott véglegesítésekre szűrve.
getChangesBetweenBuilds(string, number, number, number)	Lekéri az adattár két adott build közötti módosításait.
getDefinition(string, number, number, Date, string[], boolean)	Lekéri a definíciót, opcionálisan egy adott változatban.
getDefinitionMetrics(string, number, Date)	Lekéri egy definíció buildmetrikáit.
getDefinitionProperties(string, number, string[])	Lekéri egy definíció tulajdonságait.
getDefinitionResources(string, number)
getDefinitionRevisions(string, number)	Lekéri egy definíció összes változatát.
getDefinitions(string, string, string, string, DefinitionQueryOrder, number, string, Date, number[], string, Date, Date, boolean, boolean, string, number, string)	Lekéri a definíciók listáját.
getDefinitionTags(string, number, number)	Lekéri a definícióhoz tartozó címkéket.
getDefinitionYaml(string, number, number, Date, string[], boolean)	A definíciót YAML-re konvertálja, opcionálisan egy adott változatban.
getFile(string, number, string, string, string)	Lekéri a fájlt a buildből.
getFileContents(string, string, string, string, string, string)	Lekéri egy fájl tartalmát az adott forráskódtárban.
getFolders(string, string, FolderQueryOrder)	Lekéri a builddefiníciós mappák listáját.
getLatestBuild(string, string, string)	Lekéri egy definíció legújabb buildét, amely opcionálisan egy adott ágra terjed ki.
getPathContents(string, string, string, string, string, string)	Lekéri egy könyvtár tartalmát az adott forráskódtárban.
getProjectMetrics(string, string, Date)	Lekéri egy projekt buildmetrikáit.
getProjectResources(string, string, string)
getPullRequest(string, string, string, string, string)	Lekéréses kérelem objektumát kéri le a forrásszolgáltatótól.
getResourceUsage()	Információt kap a rendszerben található builderőforrásokról.
getRetentionHistory(number)	A projektgyűjtemény adatmegőrzési előzményeit adja vissza. Ide tartoznak azok a folyamatok, amelyek egyéni adatmegőrzési szabályokkal rendelkeznek, amelyek megakadályozhatják a megőrzési feladat tisztítását, folyamatonként futtathatók megőrzési típussal, a gyűjtemény tulajdonában lévő folyamatokkal társított fájlok megőrzési típussal, valamint a fájlok száma folyamatonként.
getRetentionLease(string, number)	Visszaadja a bérlet azonosítójának megadott adatmegőrzési bérlet részleteit.
getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])	A megadott MinimalRetentionLeases-nek megfelelő bérleteket ad vissza
getRetentionLeasesByOwnerId(string, string, number, number)	Visszaadja a megadott entitás tulajdonában lévő, opcionálisan egyetlen folyamatdefinícióra hatókörrel rendelkező és futtatott bérleteket.
getRetentionLeasesByUserId(string, string, number, number)	Visszaadja a megadott felhasználó tulajdonában lévő, opcionálisan egyetlen folyamatdefinícióra hatókörrel rendelkező és futtatott bérleteket.
getRetentionLeasesForBuild(string, number)	Lekéri az adott buildre vonatkozó összes adatmegőrzési bérletet.
getRetentionSettings(string)	Lekéri a projekt adatmegőrzési beállításait.
getStatusBadge(string, string, string, string, string, string, string)	<p>Lekéri egy definíció buildelési állapotát, amely opcionálisan egy adott ágra, fázisra, feladatra és konfigurációra terjed ki.< /p><p>Ha egynél több van, akkor a jobName megadásakor egy stageName értéket kell megadnia, és ugyanez a szabály vonatkozik mindkettőre, ha egy konfigurációs paramétert ad át.< /P>
getTags(string)	Lekéri a projekt összes buildcímkéjének listáját.
getTemplate(string, string)	Lekér egy adott builddefiníciós sablont.
getTemplates(string)	Lekéri az összes definíciósablont.
getWorkItemsBetweenBuilds(string, number, number, number)	Lekéri az összes munkaelemet két build között.
listBranches(string, string, string, string, string)	Lekéri az adott forráskódtár ágainak listáját.
listRepositories(string, string, string, string, ResultSet, boolean, string)	Lekéri a forráskódtárak listáját.
listSourceProviders(string)	Lekérheti a forrásszolgáltatók listáját és azok képességeit.
listWebhooks(string, string, string, string)	Lekéri az adott forráskód-adattárban telepített webhookok listáját.
queueBuild(Build, string, boolean, string, number, number)	Build várólistája
restoreDefinition(string, number, boolean)	Törölt definíció visszaállítása
restoreWebhooks(DefinitionTriggerType[], string, string, string, string)	Újra létrehozza a megadott eseményindítók webhookjait az adott forráskód-adattárban.
saveTemplate(BuildDefinitionTemplate, string, string)	Frissítések egy meglévő builddefiníciós sablont.
updateBuild(Build, string, number, boolean)	Frissítések egy buildet.
updateBuildGeneralSettings(PipelineGeneralSettings, string)	Frissítések folyamat általános beállításait.
updateBuildProperties(JsonPatchDocument, string, number)	Frissítések build tulajdonságai.
updateBuilds(Build[], string)	Frissítések több buildet.
updateBuildSettings(BuildSettings, string)	Frissítések a buildbeállításokat.
updateBuildTags(UpdateTagParameters, string, number)	Címkék hozzáadása/eltávolítása egy buildből.
updateDefinition(BuildDefinition, string, number, number, number)	Frissítések egy meglévő builddefiníciót. A művelet sikeressége érdekében a kérelemtörzs "Változat" tulajdonságának meg kell egyeznie a meglévő builddefiníció értékével. Javasoljuk, hogy a GET használatával szerezze be a meglévő builddefiníciót, szükség szerint módosítsa a builddefiníciót, majd küldje el a módosított definíciót a PUT paranccsal.
updateDefinitionProperties(JsonPatchDocument, string, number)	Frissítések definíció tulajdonságai.
updateDefinitionTags(UpdateTagParameters, string, number)	Címkék hozzáadása/eltávolítása definícióból.
updateFolder(Folder, string, string)	meglévő mappa Frissítések adott meglévő elérési úton
updateRetentionLease(RetentionLeaseUpdate, string, number)	Frissítések a megőrzési bérlet időtartamát vagy folyamatvédelmi állapotát.
updateRetentionSettings(UpdateProjectRetentionSettingModel, string)	Frissítések a projekt adatmegőrzési beállításait.
updateStage(UpdateStageParameters, number, string, string)	Buildelési fázis frissítése

Konstruktor adatai

BuildRestClient(IVssRestClientOptions)

new BuildRestClient(options: IVssRestClientOptions)

Paraméterek

options: IVssRestClientOptions

Tulajdonság adatai

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Tulajdonság értéke

string

Metódus adatai

addBuildTag(string, number, string)

Címkét ad hozzá egy buildhez.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

A build azonosítója.

tag: string

A hozzáadni kívánt címke.

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 hozzáadni kívánt címkék. A kérelemtörzs közvetlenül a felsorolt címkékből áll.

project: string

Projektazonosító vagy projektnév

buildId: number

A build 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 hozzáadni kívánt címke.

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 hozzáadni kívánt címkék.

project: string

Projektazonosító vagy projektnév

definitionId: number

A definíció azonosítója.

Válaszok

Promise<string[]>

addRetentionLeases(NewRetentionLease[], string)

Új bérleteket ad hozzá a folyamatfuttatá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)

Összetevőt társít egy buildhez.

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

Paraméterek

artifact: BuildArtifact

Az összetevő.

project: string

Projektazonosító vagy projektnév

buildId: number

A build azonosítója.

Válaszok

Promise<BuildArtifact>

createDefinition(BuildDefinition, string, number, number)

Létrehoz egy új definíciót.

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)

Létrehoz egy új mappát.

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

Paraméterek

folder: Folder

A mappa.

project: string

Projektazonosító vagy projektnév

path: string

A mappa teljes elérési útja.

Válaszok

Promise<Folder>

deleteBuild(string, number)

Egy build törlése.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

A build 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 a speciális karaktereket tartalmazó címkék esetében. Ha speciális karaktereket tartalmazó címkéket szeretne eltávolítani, használja helyette a PATCH metódust (6.0+-ban)

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

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

A build azonosítója.

tag: string

Az eltávolítandó címke.

Válaszok

Promise<string[]>

deleteDefinition(string, number)

Törli a definíciót és az összes társított 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 a speciális karaktereket tartalmazó címkék esetében. Ha speciális karaktereket tartalmazó címkéket szeretne eltávolítani, használja helyette a PATCH metódust (6.0+-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

Az eltávolítandó címke.

Válaszok

Promise<string[]>

deleteFolder(string, string)

Egy definíciómappát töröl. A definíciók és a hozzájuk tartozó buildek is törlődnek.

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

Eltávolítja az adott adatmegőrzé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)

Címke eltávolítása a buildekből, a definíciókból és a címketárolóból

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

Paraméterek

project: string

Projektazonosító vagy projektnév

tag: string

Az eltávolítandó címke.

Válaszok

Promise<string[]>

deleteTemplate(string, string)

Töröl egy builddefiní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)

Lekéri egy adott összetevőt egy buildhez.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

A build azonosítója.

artifactName: string

Az összetevő neve.

Válaszok

Promise<BuildArtifact>

getArtifactContentZip(string, number, string)

Lekéri egy adott összetevőt egy buildhez.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

A build azonosítója.

artifactName: string

Az összetevő neve.

Válaszok

Promise<ArrayBuffer>

getArtifacts(string, number)

Lekéri az összes összetevőt egy buildhez.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

A build azonosítója.

Válaszok

Promise<BuildArtifact[]>

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

Lekér egy adott mellékletet.

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

A build azonosítója.

timelineId: string

Az ütemterv azonosítója.

recordId: string

Az idősorrekord azonosítója.

type: string

A melléklet típusa.

name: string

A melléklet neve.

Válaszok

Promise<ArrayBuffer>

getAttachments(string, number, string)

Lekéri a buildhez társított adott típusú mellékletek listáját.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

A build azonosítója.

type: string

A melléklet típusa.

Válaszok

Promise<Attachment[]>

getBadge(string, number, string)

Egy jelvényt kap, amely egy definíció legutóbbi buildjének állapotát jelzi. Vegye figyelembe, hogy ez az API elavult. Előnyben részesítse a StatusBadgeController.GetStatusBadge parancsot.

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)

Build lekérése

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)

Lekéri a jelvényt, amely a megadott ág legutóbbi buildjének állapotát jelzi.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

repoType: string

Az adattár típusa.

repoId: string

Az adattár azonosítója.

branchName: string

Az ág neve.

Válaszok

Promise<BuildBadge>

getBuildBadgeData(string, string, string, string)

Lekéri a jelvényt, amely a megadott ág legutóbbi buildjének állapotát jelzi.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

repoType: string

Az adattár típusa.

repoId: string

Az adattár azonosítója.

branchName: string

Az ág neve.

Válaszok

Promise<string>

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

Lekéri a buildhez társított módosítá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 visszaadandó módosítások maximális száma

includeSourceChange: boolean

Válaszok

Promise<PagedList<Change>>

getBuildController(number)

Vezérlő beolvasása

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

Paraméterek

controllerId: number

Válaszok

Promise<BuildController>

getBuildControllers(string)

Lekéri a vezérlőt, opcionálisan név alapján szűrve

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

Paraméterek

name: string

Válaszok

Promise<BuildController[]>

getBuildGeneralSettings(string)

Lekéri a folyamat általános beállításait.

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)

Beolvas egy egyéni naplófájlt 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

A build azonosítója.

logId: number

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

startLine: number

A kezdővonal.

endLine: number

A záró vonal.

Válaszok

Promise<string>

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

Beolvas egy egyéni naplófájlt 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

A build azonosítója.

logId: number

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

startLine: number

A kezdővonal.

endLine: number

A záró vonal.

Válaszok

Promise<string[]>

getBuildLogs(string, number)

Lekéri egy build naplóit.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

A build azonosítója.

Válaszok

Promise<BuildLog[]>

getBuildLogsZip(string, number)

Lekéri egy build naplóit.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

A build azonosítója.

Válaszok

Promise<ArrayBuffer>

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

Beolvas egy egyéni naplófájlt 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

A build azonosítója.

logId: number

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

startLine: number

A kezdővonal.

endLine: number

A záró vonal.

Válaszok

Promise<ArrayBuffer>

getBuildOptionDefinitions(string)

Lekéri a rendszer által támogatott összes builddefiníciós beállítást.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<BuildOptionDefinition[]>

getBuildProperties(string, number, string[])

Lekéri egy build tulajdonságait.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

A build azonosítója.

filter: string[]

A tulajdonságok vesszővel tagolt listája. Ha meg van adva, ezekre a tulajdonságokra szűr.

Válaszok

Promise<any>

getBuildReport(string, number, string)

Lekéri a buildjelentést.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

A build azonosítója.

type: string

Válaszok

Promise<BuildReportMetadata>

getBuildReportHtmlContent(string, number, string)

Lekéri a buildjelentést.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

A build 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)

Lekéri a buildek listáját.

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

Definícióazonosítók vesszővel tagolt listája. Ha meg van adva, ezekhez a definíciókhoz szűri a buildeket.

queues: number[]

Üzenetsor-azonosítók vesszővel tagolt listája. Ha meg van adva, az ezeken az üzenetsorokon futó buildekre szűr.

buildNumber: string

Ha meg van adva, az ezen buildszámnak megfelelő buildekre szűr. Az előtagkereséshez fűzze hozzá a * elemet.

minTime: Date

Ha meg van adva, a megadott queryOrder alapján szűri azokat a buildeket, amelyek befejezték/elindították/várólistára helyezték ezt a dátumot.

maxTime: Date

Ha meg van adva, a megadott queryOrder alapján szűri azokat a buildeket, amelyek befejezték/elindították/várólistára helyezték ezt a dátumot.

requestedFor: string

Ha meg van adva, a szűrők a megadott felhasználóhoz kért buildekre szűrnek.

reasonFilter: BuildReason

Ha meg van adva, az ennek az oknak megfelelő buildekre szűr.

statusFilter: BuildStatus

Ha meg van adva, az ennek az állapotnak megfelelő buildekre szűr.

resultFilter: BuildResult

Ha meg van adva, az ennek az eredménynek megfelelő buildekre szűr.

tagFilters: string[]

Címkék vesszővel tagolt listája. Ha meg van adva, a megadott címkékkel rendelkező buildekre szűr.

properties: string[]

A lekérendő tulajdonságok vesszővel tagolt listája.

top: number

A visszaadandó buildek maximális száma.

continuationToken: string

A metódus előző hívása által visszaadott folytatási jogkivonat, amely a következő buildkészlet visszaadására használható.

maxBuildsPerDefinition: number

A definíciónként visszaadandó buildek maximális száma.

deletedFilter: QueryDeletedOption

Azt jelzi, hogy a törölt buildeket ki szeretné-e zárni, belefoglalni vagy csak visszaadni.

queryOrder: BuildQueryOrder

A buildek visszaadásához szükséges sorrend.

branchName: string

Ha meg van adva, a szűrők olyan buildekre szűrnek, amelyek az ágat megépített ágakat készítették.

buildIds: number[]

Vesszővel tagolt lista, amely meghatározza a lekérni kívánt buildek azonosítóit.

repositoryId: string

Ha meg van adva, az ebből az adattárból létrehozott buildekre szűr.

repositoryType: string

Ha meg van adva, az ilyen típusú adattárakból létrehozott buildekre szűr.

Válaszok

Promise<PagedList<Build>>

getBuildSettings(string)

Lekéri a buildbeállításokat.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<BuildSettings>

getBuildTags(string, number)

Lekéri egy build címkéinek lekérdezése.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

A build azonosítója.

Válaszok

Promise<string[]>

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

A build részleteinek lekérdezése

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)

Lekéri a buildhez társított munkaelemeket. A rendszer csak az ugyanabban a projektben lévő munkaelemeket adja vissza.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

A build azonosítója.

top: number

A visszaadandó munkaelemek maximális száma.

Válaszok

Promise<ResourceRef[]>

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

Lekéri a buildhez társított munkaelemeket, meghatározott véglegesítésekre szűrve.

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

Paraméterek

commitIds: string[]

A véglegesítési azonosítók vesszővel tagolt listája.

project: string

Projektazonosító vagy projektnév

buildId: number

A build azonosítója.

top: number

A visszaadandó munkaelemek maximális száma vagy a megfontolandó véglegesítések száma, ha nincsenek megadva véglegesítési azonosítók.

Válaszok

Promise<ResourceRef[]>

getChangesBetweenBuilds(string, number, number, number)

Lekéri az adattár két adott build közötti módosításait.

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ő build 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)

Lekéri a definíciót, opcionálisan egy adott változatban.

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 lekérendő változat száma. Ha ez nincs megadva, a rendszer a legújabb verziót adja vissza.

minMetricsTime: Date

Ha meg van adva, a metrikák belefoglalásának dátumát jelzi.

propertyFilters: string[]

Az eredményekben szerepeltetni kívánt tulajdonságok vesszővel tagolt listája.

includeLatestBuilds: boolean

Válaszok

Promise<BuildDefinition>

getDefinitionMetrics(string, number, Date)

Lekéri egy definíció buildmetrikáit.

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

A metrikák kiszámításának dátuma.

Válaszok

Promise<BuildMetric[]>

getDefinitionProperties(string, number, string[])

Lekéri egy definíció tulajdonságait.

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

A tulajdonságok vesszővel tagolt listája. Ha meg van adva, ezekre a tulajdonságokra szűr.

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)

Lekéri egy definíció összes változatát.

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)

Lekéri a definíciók listájá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 meg van adva, olyan definíciókra szűr, amelyeknek a neve megegyezik ezzel a mintával.

repositoryId: string

Az adattár azonosítója. Ha meg van adva, az ezt az adattárat használó definíciókra szűr.

repositoryType: string

Ha meg van adva, az ilyen típusú adattárral rendelkező definíciókra szűr.

queryOrder: DefinitionQueryOrder

Azt a sorrendet jelzi, amelyben a definíciókat vissza kell adni.

top: number

A visszaadandó definíciók maximális száma.

continuationToken: string

A metódus egy korábbi hívása által visszaadott folytatási jogkivonat, amely a következő definíciókészlet visszaadására használható.

minMetricsTime: Date

Ha meg van adva, a metrikák belefoglalásának dátumát jelzi.

definitionIds: number[]

Vesszővel tagolt lista, amely meghatározza a lekérni kívánt definíciók azonosítóit.

path: string

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

builtAfter: Date

Ha meg van adva, a szűrők olyan definíciókra szűrnek, amelyek a dátum után buildekkel rendelkeznek.

notBuiltAfter: Date

Ha meg van adva, olyan definíciókra szűr, amelyek nem rendelkeznek buildekkel ezen dátum után.

includeAllProperties: boolean

Azt jelzi, hogy a teljes definíciókat vissza kell-e adni. Alapértelmezés szerint a rendszer a fogalommeghatározások sekély ábrázolását adja vissza.

includeLatestBuilds: boolean

Azt jelzi, hogy a definíció legújabb és legújabb befejezett buildjei lesznek-e visszaadva.

taskIdFilter: string

Ha meg van adva, a megadott feladatot használó definíciókra szűr.

processType: number

Ha meg van adva, a megadott folyamattípussal szűr a definíciókra.

yamlFilename: string

Ha meg van adva, a megadott fájlnévnek megfelelő YAML-definíciókra szűr. A szűrő használatához az IncludeAllProperties tulajdonságot true (igaz) értékre kell állítani

Válaszok

Promise<PagedList<BuildDefinitionReference>>

getDefinitionTags(string, number, number)

Lekéri a definícióhoz tartozó címkéket.

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ó legújabb verzióját használja.

Válaszok

Promise<string[]>

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

A definíciót YAML-re konvertálja, opcionálisan egy adott változatban.

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 lekérendő változat száma. Ha ez nincs megadva, a rendszer a legújabb verziót adja vissza.

minMetricsTime: Date

Ha meg van adva, a metrikák belefoglalásának dátumát jelzi.

propertyFilters: string[]

Az eredményekben szerepeltetni kívánt tulajdonságok vesszővel tagolt listája.

includeLatestBuilds: boolean

Válaszok

Promise<YamlBuild>

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

Lekéri a fájlt 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

A build azonosítója.

artifactName: string

Az összetevő neve.

fileId: string

A fájl elsődleges kulcsa.

fileName: string

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

Válaszok

Promise<ArrayBuffer>

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

Lekéri egy fájl tartalmát az adott forráskódtárban.

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 meg van adva, a lekérdezendő szolgáltatásvégpont azonosítója. Csak olyan szolgáltatók esetében hagyható ki, amelyek nem használnak szolgáltatásvégpontokat, például TFVC vagy TFGit.

repository: string

Ha meg van adva, a szállítóspecifikus azonosító vagy az adattár neve az ágak lekéréséhez. Csak olyan szolgáltatók esetében hagyható ki, amelyek nem támogatnak több adattárat.

commitOrBranch: string

Annak a véglegesítésnek vagy ágnak az azonosítója, amelyből a fájl tartalma lekérhető.

path: string

A lekérni kívánt fájl elérési útja az adattár gyökeréhez viszonyítva.

Válaszok

Promise<string>

getFolders(string, string, FolderQueryOrder)

Lekéri a builddefiníciós 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

A kezdési útvonal.

queryOrder: FolderQueryOrder

Az a sorrend, amelyben a mappákat vissza kell adni.

Válaszok

Promise<Folder[]>

getLatestBuild(string, string, string)

Lekéri egy definíció legújabb buildét, amely opcionálisan egy adott ágra terjed ki.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

definition: string

definíció neve választható kezdőmappa-elérési úttal vagy a definícióazonosítóval

branchName: string

opcionális paraméter, amely a használni kívánt ágat jelzi. Ha nincs megadva, a rendszer az alapértelmezett ágat használja.

Válaszok

Promise<Build>

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

Lekéri egy könyvtár tartalmát az adott forráskódtárban.

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

repository: string

Ha meg van adva, a szállítóspecifikus azonosító vagy az adattár neve az ágak lekéréséhez. Csak olyan szolgáltatók esetében hagyható ki, amelyek nem támogatnak több adattárat.

commitOrBranch: string

Annak a véglegesítésnek vagy ágnak az azonosítója, amelyből a fájl tartalma lekérhető.

path: string

A listázandó elérési út tartalma az adattár gyökeréhez viszonyítva.

Válaszok

Promise<SourceRepositoryItem[]>

getProjectMetrics(string, string, Date)

Lekéri egy projekt buildmetrikáit.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

metricAggregationType: string

A használandó összesítés típusa (óránként, naponta).

minMetricsTime: Date

A metrikák kiszámításának dátuma.

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)

Lekéréses kérelem objektumát kéri le a forrásszolgáltatótól.

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 lekéréses kérelem szállítóspecifikus azonosítója.

repositoryId: string

Szállítóspecifikus azonosító vagy a lekéréses kérelmet tartalmazó adattár neve.

serviceEndpointId: string

Válaszok

Promise<PullRequest>

getResourceUsage()

Információt kap a rendszerben található builderőforrásokról.

function getResourceUsage(): Promise<BuildResourceUsage>

Válaszok

Promise<BuildResourceUsage>

getRetentionHistory(number)

A projektgyűjtemény adatmegőrzési előzményeit adja vissza. Ide tartoznak azok a folyamatok, amelyek egyéni adatmegőrzési szabályokkal rendelkeznek, amelyek megakadályozhatják a megőrzési feladat tisztítását, folyamatonként futtathatók megőrzési típussal, a gyűjtemény tulajdonában lévő folyamatokkal társított fájlok megőrzési típussal, valamint a fájlok száma folyamatonként.

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

Paraméterek

daysToLookback: number

Válaszok

Promise<BuildRetentionHistory>

getRetentionLease(string, number)

Visszaadja a bérlet azonosítójának megadott adatmegőrzési bérlet részleteit.

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

A megadott MinimalRetentionLeases-nek megfelelő bérleteket ad vissza

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

Paraméterek

project: string

Projektazonosító vagy projektnév

leasesToFetch: MinimalRetentionLease[]

A JSON-szerializált MinimalRetentionLeases listája a következővel elválasztva: |.

Válaszok

Promise<RetentionLease[]>

getRetentionLeasesByOwnerId(string, string, number, number)

Visszaadja a megadott entitás tulajdonában lévő, opcionálisan egyetlen folyamatdefinícióra hatókörrel rendelkező és futtatott bérleteket.

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

Nem kötelező paraméter, amely egy adott folyamatdefinícióra korlátozza a keresést.

runId: number

Nem kötelező paraméter, amely egyetlen folyamatfuttatásra korlátozza a keresést. Definícióazonosítót igényel.

Válaszok

Promise<RetentionLease[]>

getRetentionLeasesByUserId(string, string, number, number)

Visszaadja a megadott felhasználó tulajdonában lévő, opcionálisan egyetlen folyamatdefinícióra hatókörrel rendelkező és futtatott bérleteket.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

userOwnerId: string

A kereséshez használt felhasználói azonosító.

definitionId: number

Nem kötelező paraméter, amely egy adott folyamatdefinícióra korlátozza a keresést.

runId: number

Nem kötelező paraméter, amely egyetlen folyamatfuttatásra korlátozza a keresést. Definícióazonosítót igényel.

Válaszok

Promise<RetentionLease[]>

getRetentionLeasesForBuild(string, number)

Lekéri az adott buildre vonatkozó összes adatmegőrzési bérletet.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

buildId: number

A build azonosítója.

Válaszok

Promise<RetentionLease[]>

getRetentionSettings(string)

Lekéri a projekt adatmegőrzé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>Lekéri egy definíció buildelési állapotát, amely opcionálisan egy adott ágra, fázisra, feladatra és konfigurációra terjed ki.< /p><p>Ha egynél több van, akkor a jobName megadásakor egy stageName értéket kell megadnia, és ugyanez a szabály vonatkozik mindkettőre, ha egy konfigurációs paramétert ad át.< /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 az opcionális kezdőmappa elérési útjával, vagy a definíció azonosítója.

branchName: string

Csak az ág legújabb buildeltet érdemes figyelembe venni. Ha nincs megadva, a rendszer az alapértelmezett ágat használja.

stageName: string

Az állapot megjelenítéséhez használja ezt a fázist a folyamaton belül.

jobName: string

Ezt a feladatot a folyamat egy szakaszában használhatja az állapot megjelenítéséhez.

configuration: string

Ezzel a feladatkonfigurációval jelenítse meg az állapotot

label: string

Lecseréli a jelvény bal oldalán található alapértelmezett szöveget.

Válaszok

Promise<string>

getTags(string)

Lekéri a projekt összes buildcí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)

Lekér egy adott builddefiníciós sablont.

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)

Lekéri az összes definíciósablont.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<BuildDefinitionTemplate[]>

getWorkItemsBetweenBuilds(string, number, number, number)

Lekéri az összes munkaelemet két build között.

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ő build azonosítója.

toBuildId: number

Az utolsó build azonosítója.

top: number

A visszaadandó munkaelemek maximális száma.

Válaszok

Promise<ResourceRef[]>

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

Lekéri az adott forráskódtár á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

repository: string

A szállítóspecifikus azonosító vagy az adattár neve az ágak lekéréséhez. Csak azok a szolgáltatók hagyhatók ki, amelyek nem támogatnak több adattárat.

branchName: string

Ha meg van adva, a konkrétan ellenőrizni kívánt ág neve.

Válaszok

Promise<string[]>

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

Lekéri a forráskódtárak 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

repository: string

Ha meg van adva, a beolvasáshoz a szállítóspecifikus azonosítót vagy egy adattár nevét kell megadni.

resultSet: ResultSet

"top" a végpont szempontjából legrelevánsabb adattárakhoz. Ha nincs beállítva, a rendszer az összes adattárat visszaadja. Figyelmen kívül hagyja, ha az adattár be van állítva.

pageResults: boolean

Ha igaz értékre van állítva, ez korlátozza az eredmények készletét, és egy folytatási jogkivonatot ad vissza a lekérdezés folytatásához.

continuationToken: string

Az eredmények lapszámozásakor ez egy folytatási jogkivonat, amelyet a metódus előző hívása ad vissza, amely a következő adattárkészlet visszaadására használható.

Válaszok

Promise<SourceRepositories>

listSourceProviders(string)

Lekérheti a forrásszolgáltatók listáját és azok képességeit.

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

Paraméterek

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<SourceProviderAttributes[]>

listWebhooks(string, string, string, string)

Lekéri az adott forráskód-adattárban telepített webhookok listáját.

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

repository: string

Ha meg van adva, a webhookok lekéréséhez adja meg a szállítóspecifikus azonosítót vagy az adattár nevét. Csak azok a szolgáltatók hagyhatók ki, amelyek nem támogatnak több adattárat.

Válaszok

Promise<RepositoryWebhook[]>

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

Build várólistája

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

Nem kötelező definícióazonosító a buildek törzs nélküli várólistára helyezéséhez. Figyelmen kívül hagyva, ha van érvényes törzs

Válaszok

Promise<Build>

restoreDefinition(string, number, boolean)

Törölt definíció visszaállítása

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

Paraméterek

project: string

Projektazonosító vagy projektnév

definitionId: number

A visszaállítani kívánt definíció azonosítója.

deleted: boolean

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

Válaszok

Promise<BuildDefinition>

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

Újra létrehozza a megadott eseményindítók webhookjait az adott forráskód-adattárban.

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

Paraméterek

triggerTypes: DefinitionTriggerType[]

A webhookok visszaállítására szolgáló eseményindítók típusai.

project: string

Projektazonosító vagy projektnév

providerName: string

A forrásszolgáltató neve.

serviceEndpointId: string

repository: string

Ha meg van adva, a webhookok lekéréséhez adja meg a szállítóspecifikus azonosítót vagy az adattár nevét. Csak azok a szolgáltatók hagyhatók ki, amelyek nem támogatnak több adattárat.

Válaszok

Promise<void>

saveTemplate(BuildDefinitionTemplate, string, string)

Frissítések egy meglévő builddefiní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ítések egy 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

A build azonosítója.

retry: boolean

Válaszok

Promise<Build>

updateBuildGeneralSettings(PipelineGeneralSettings, string)

Frissítések folyamat á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ítések build tulajdonságai.

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

Paraméterek

document: JsonPatchDocument

Egy json-patch dokumentum, amely leírja a frissítendő tulajdonságokat.

project: string

Projektazonosító vagy projektnév

buildId: number

A build azonosítója.

Válaszok

Promise<any>

updateBuilds(Build[], string)

Frissítések több buildet.

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

Paraméterek

builds: Build[]

A frissítendő buildek.

project: string

Projektazonosító vagy projektnév

Válaszok

Promise<Build[]>

updateBuildSettings(BuildSettings, string)

Frissítések a buildbeá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)

Címkék hozzáadása/eltávolítása egy buildből.

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

Paraméterek

updateParameters: UpdateTagParameters

A hozzáadni/eltávolítani kívánt címkék.

project: string

Projektazonosító vagy projektnév

buildId: number

A build azonosítója.

Válaszok

Promise<string[]>

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

Frissítések egy meglévő builddefiníciót. A művelet sikeressége érdekében a kérelemtörzs "Változat" tulajdonságának meg kell egyeznie a meglévő builddefiníció értékével. Javasoljuk, hogy a GET használatával szerezze be a meglévő builddefiníciót, szükség szerint módosítsa a builddefiníciót, majd küldje el a módosított definíciót a PUT paranccsal.

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

Paraméterek

definition: BuildDefinition

A definíció új verziója. A "Revision" tulajdonságnak meg kell egyeznie a frissítés elfogadásához használt meglévő definícióval.

project: string

Projektazonosító vagy projektnév

definitionId: number

A definíció azonosítója.

secretsSourceDefinitionId: number

secretsSourceDefinitionRevision: number

Válaszok

Promise<BuildDefinition>

updateDefinitionProperties(JsonPatchDocument, string, number)

Frissítések definíció tulajdonságai.

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

Paraméterek

document: JsonPatchDocument

Egy json-patch dokumentum, amely leírja a frissítendő 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ék hozzáadása/eltávolítása definícióból.

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

Paraméterek

updateParameters: UpdateTagParameters

A hozzáadni/eltávolítani kívánt címkék.

project: string

Projektazonosító vagy projektnév

definitionId: number

A definíció azonosítója.

Válaszok

Promise<string[]>

updateFolder(Folder, string, string)

meglévő mappa Frissítések adott meglévő elérési ú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ítések a megőrzési bérlet időtartamát vagy folyamatvédelmi állapotát.

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

Paraméterek

leaseUpdate: RetentionLeaseUpdate

A megőrzési bérlet új adatai.

project: string

Projektazonosító vagy projektnév

leaseId: number

A frissítendő bérlet azonosítója.

Válaszok

Promise<RetentionLease>

updateRetentionSettings(UpdateProjectRetentionSettingModel, string)

Frissítések a projekt adatmegőrzé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)

Buildelési fázis 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>

Visszacsatolás

Hasznos volt ez az oldal?

Megosztás:

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