BuildRestClient class

Reference

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

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

Extends: RestClientBase

Konstruktory

BuildRestClient(IVssRestClientOptions)

Vlastnosti

RESOURCE_AREA_ID

Metody

addBuildTag(string, number, string)	Přidá do sestavení značku.
addBuildTags(string[], string, number)	Přidá do sestavení značky.
addDefinitionTag(string, number, string)	Přidá značku do definice.
addDefinitionTags(string[], string, number)	Přidá do definice více značek.
addRetentionLeases(NewRetentionLease[], string)	Přidá nová zapůjčení pro spuštění kanálu.
authorizeDefinitionResources(DefinitionResourceReference[], string, number)
authorizeProjectResources(DefinitionResourceReference[], string)
createArtifact(BuildArtifact, string, number)	Přidruží artefakt k sestavení.
createDefinition(BuildDefinition, string, number, number)	Vytvoří novou definici.
createFolder(Folder, string, string)	Vytvoří novou složku.
deleteBuild(string, number)	Odstraní sestavení.
deleteBuildTag(string, number, string)	Odebere značku z sestavení. POZNÁMKA: Toto rozhraní API nebude fungovat pro značky se speciálními znaky. Pokud chcete odebrat značky se speciálními znaky, použijte místo toho metodu PATCH (ve verzi 6.0+).
deleteDefinition(string, number)	Odstraní definici a všechna přidružená sestavení.
deleteDefinitionTag(string, number, string)	Odebere značku z definice. POZNÁMKA: Toto rozhraní API nebude fungovat pro značky se speciálními znaky. Pokud chcete odebrat značky se speciálními znaky, použijte místo toho metodu PATCH (ve verzi 6.0+).
deleteFolder(string, string)	Odstraní složku definic. Odstraní se také definice a jejich odpovídající sestavení.
deleteRetentionLeasesById(string, number[])	Odebere konkrétní zapůjčení uchovávání informací.
deleteTag(string, string)	Odebere značku ze sestavení, definic a z úložiště značek.
deleteTemplate(string, string)	Odstraní šablonu definice sestavení.
getArtifact(string, number, string)	Získá konkrétní artefakt pro sestavení.
getArtifactContentZip(string, number, string)	Získá konkrétní artefakt pro sestavení.
getArtifacts(string, number)	Získá všechny artefakty pro sestavení.
getAttachment(string, number, string, string, string, string)	Získá konkrétní přílohu.
getAttachments(string, number, string)	Získá seznam příloh určitého typu, které jsou přidruženy k sestavení.
getBadge(string, number, string)	Získá odznáček, který označuje stav posledního sestavení pro definici. Všimněte si, že toto rozhraní API je zastaralé. Preferovat StatusBadgeController.GetStatusBadge.
getBuild(string, number, string)	Získá sestavení.
getBuildBadge(string, string, string, string)	Získá odznak, který označuje stav nejnovějšího sestavení pro zadanou větev.
getBuildBadgeData(string, string, string, string)	Získá odznak, který označuje stav nejnovějšího sestavení pro zadanou větev.
getBuildChanges(string, number, string, number, boolean)	Získá změny přidružené k sestavení.
getBuildController(number)	Získá kontroler.
getBuildControllers(string)	Získá kontroler, volitelně filtrovaný podle názvu.
getBuildGeneralSettings(string)	Získá obecné nastavení kanálu.
getBuildLog(string, number, number, number, number)	Získá individuální soubor protokolu pro sestavení.
getBuildLogLines(string, number, number, number, number)	Získá individuální soubor protokolu pro sestavení.
getBuildLogs(string, number)	Získá protokoly pro sestavení.
getBuildLogsZip(string, number)	Získá protokoly pro sestavení.
getBuildLogZip(string, number, number, number, number)	Získá individuální soubor protokolu pro sestavení.
getBuildOptionDefinitions(string)	Získá všechny možnosti definice sestavení podporované systémem.
getBuildProperties(string, number, string[])	Získá vlastnosti pro sestavení.
getBuildReport(string, number, string)	Získá sestavu sestavení.
getBuildReportHtmlContent(string, number, string)	Získá sestavu sestavení.
getBuilds(string, number[], number[], string, Date, Date, string, BuildReason, BuildStatus, BuildResult, string[], string[], number, string, number, QueryDeletedOption, BuildQueryOrder, string, number[], string, string)	Získá seznam sestavení.
getBuildSettings(string)	Získá nastavení sestavení.
getBuildTags(string, number)	Získá značky pro sestavení.
getBuildTimeline(string, number, string, number, string)	Získá podrobnosti o sestavení.
getBuildWorkItemsRefs(string, number, number)	Získá pracovní položky přidružené k sestavení. Vrátí se pouze pracovní položky ve stejném projektu.
getBuildWorkItemsRefsFromCommits(string[], string, number, number)	Získá pracovní položky přidružené k sestavení, filtrované na konkrétní potvrzení.
getChangesBetweenBuilds(string, number, number, number)	Získá změny provedené v úložišti mezi dvěma danými sestaveními.
getDefinition(string, number, number, Date, string[], boolean)	Získá definici, volitelně v konkrétní revizi.
getDefinitionMetrics(string, number, Date)	Získá metriky sestavení pro definici.
getDefinitionProperties(string, number, string[])	Získá vlastnosti pro definici.
getDefinitionResources(string, number)
getDefinitionRevisions(string, number)	Získá všechny revize definice.
getDefinitions(string, string, string, string, DefinitionQueryOrder, number, string, Date, number[], string, Date, Date, boolean, boolean, string, number, string)	Získá seznam definic.
getDefinitionTags(string, number, number)	Získá značky pro definici.
getDefinitionYaml(string, number, number, Date, string[], boolean)	Převede definici na YAML, volitelně v konkrétní revizi.
getFile(string, number, string, string, string)	Získá soubor z sestavení.
getFileContents(string, string, string, string, string, string)	Získá obsah souboru v daném úložišti zdrojového kódu.
getFolders(string, string, FolderQueryOrder)	Získá seznam složek definic sestavení.
getLatestBuild(string, string, string)	Získá nejnovější sestavení pro definici, volitelně s oborem na konkrétní větev.
getPathContents(string, string, string, string, string, string)	Získá obsah adresáře v daném úložišti zdrojového kódu.
getProjectMetrics(string, string, Date)	Získá metriky sestavení pro projekt.
getProjectResources(string, string, string)
getPullRequest(string, string, string, string, string)	Získá objekt žádosti o přijetí změn od zdrojového zprostředkovatele.
getResourceUsage()	Získá informace o prostředcích sestavení v systému.
getRetentionHistory(number)	Vrátí historii uchovávání pro kolekci projektů. Patří sem kanály, které mají vlastní pravidla uchovávání, která můžou bránit úloze uchovávání informací v jejich vyčištění, spuštění na kanál s typem uchovávání, soubory přidružené k kanálům vlastněným kolekcí s typem uchovávání a počet souborů na kanál.
getRetentionLease(string, number)	Vrátí podrobnosti o zapůjčení uchovávání informací s ID zapůjčení.
getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])	Vrátí všechna zapůjčení odpovídající zadanému MinimalRetentionLeases.
getRetentionLeasesByOwnerId(string, string, number, number)	Vrátí všechna zapůjčení vlastněná zadanou entitou, volitelně vymezená na jednu definici kanálu a spuštění.
getRetentionLeasesByUserId(string, string, number, number)	Vrátí všechna zapůjčení vlastněná zadaným uživatelem, volitelně vymezená na jednu definici kanálu a spuštění.
getRetentionLeasesForBuild(string, number)	Získá všechny zapůjčení uchovávání informací, které platí pro konkrétní sestavení.
getRetentionSettings(string)	Získá nastavení uchovávání informací projektu.
getStatusBadge(string, string, string, string, string, string, string)	<p>Získá stav sestavení pro definici, volitelně vymezenou na konkrétní větev, fázi, úlohu a konfiguraci.< /p><p p>Pokud existuje více než jeden, pak je při zadávání jobName nutné předat hodnotu stageName a stejné pravidlo pak platí pro oba při předávání konfiguračního parametru.< /P>
getTags(string)	Získá seznam všech značek sestavení v projektu.
getTemplate(string, string)	Získá konkrétní šablonu definice sestavení.
getTemplates(string)	Získá všechny šablony definic.
getWorkItemsBetweenBuilds(string, number, number, number)	Získá všechny pracovní položky mezi dvěma sestaveními.
listBranches(string, string, string, string, string)	Získá seznam větví pro dané úložiště zdrojového kódu.
listRepositories(string, string, string, string, ResultSet, boolean, string)	Získá seznam úložišť zdrojového kódu.
listSourceProviders(string)	Získejte seznam zdrojových poskytovatelů a jejich možností.
listWebhooks(string, string, string, string)	Získá seznam webhooků nainstalovaných v daném úložišti zdrojového kódu.
queueBuild(Build, string, boolean, string, number, number)	Zasadí sestavení do fronty.
restoreDefinition(string, number, boolean)	Obnoví odstraněnou definici.
restoreWebhooks(DefinitionTriggerType[], string, string, string, string)	Znovu vytvoří webhooky pro zadané triggery v daném úložišti zdrojového kódu.
saveTemplate(BuildDefinitionTemplate, string, string)	Aktualizace existující šablonu definice sestavení.
updateBuild(Build, string, number, boolean)	Aktualizace sestavení.
updateBuildGeneralSettings(PipelineGeneralSettings, string)	Aktualizace obecné nastavení kanálu.
updateBuildProperties(JsonPatchDocument, string, number)	Aktualizace vlastnosti sestavení.
updateBuilds(Build[], string)	Aktualizace více sestavení.
updateBuildSettings(BuildSettings, string)	Aktualizace nastavení sestavení.
updateBuildTags(UpdateTagParameters, string, number)	Přidá nebo odebere značky z sestavení.
updateDefinition(BuildDefinition, string, number, number, number)	Aktualizace existující definici sestavení. Aby byla tato operace úspěšná, musí hodnota vlastnosti Revision textu požadavku odpovídat definicím existujícího sestavení. Doporučujeme získat existující definici sestavení pomocí příkazu GET, upravit definici sestavení podle potřeby a pak odeslat upravenou definici pomocí PUT.
updateDefinitionProperties(JsonPatchDocument, string, number)	Aktualizace vlastnosti definice.
updateDefinitionTags(UpdateTagParameters, string, number)	Přidá nebo odebere značky z definice.
updateFolder(Folder, string, string)	Aktualizace existující složku v dané existující cestě
updateRetentionLease(RetentionLeaseUpdate, string, number)	Aktualizace dobu trvání nebo stav ochrany kanálu zapůjčení uchovávání informací.
updateRetentionSettings(UpdateProjectRetentionSettingModel, string)	Aktualizace nastavení uchovávání informací v projektu.
updateStage(UpdateStageParameters, number, string, string)	Aktualizace fáze sestavení

Podrobnosti konstruktoru

BuildRestClient(IVssRestClientOptions)

new BuildRestClient(options: IVssRestClientOptions)

Parametry

options: IVssRestClientOptions

Podrobnosti vlastnosti

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Hodnota vlastnosti

string

Podrobnosti metody

addBuildTag(string, number, string)

Přidá do sestavení značku.

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

Parametry

project: string

ID projektu nebo název projektu

buildId: number

ID sestavení.

tag: string

Značka, která se má přidat.

Návraty

Promise<string[]>

addBuildTags(string[], string, number)

Přidá do sestavení značky.

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

Parametry

tags: string[]

Značky, které chcete přidat. Text požadavku se skládá přímo z uvedených značek.

project: string

ID projektu nebo název projektu

buildId: number

ID sestavení.

Návraty

Promise<string[]>

addDefinitionTag(string, number, string)

Přidá značku do definice.

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

Parametry

project: string

ID projektu nebo název projektu

definitionId: number

ID definice.

tag: string

Značka, která se má přidat.

Návraty

Promise<string[]>

addDefinitionTags(string[], string, number)

Přidá do definice více značek.

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

Parametry

tags: string[]

Značky, které chcete přidat.

project: string

ID projektu nebo název projektu

definitionId: number

ID definice.

Návraty

Promise<string[]>

addRetentionLeases(NewRetentionLease[], string)

Přidá nová zapůjčení pro spuštění kanálu.

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

Parametry

newLeases: NewRetentionLease[]

project: string

ID projektu nebo název projektu

Návraty

Promise<RetentionLease[]>

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

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

Parametry

resources: DefinitionResourceReference[]

project: string

ID projektu nebo název projektu

definitionId: number

Návraty

Promise<DefinitionResourceReference[]>

authorizeProjectResources(DefinitionResourceReference[], string)

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

Parametry

resources: DefinitionResourceReference[]

project: string

ID projektu nebo název projektu

Návraty

Promise<DefinitionResourceReference[]>

createArtifact(BuildArtifact, string, number)

Přidruží artefakt k sestavení.

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

Parametry

artifact: BuildArtifact

Artefakt.

project: string

ID projektu nebo název projektu

buildId: number

ID sestavení.

Návraty

Promise<BuildArtifact>

createDefinition(BuildDefinition, string, number, number)

Vytvoří novou definici.

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

Parametry

definition: BuildDefinition

Definice.

project: string

ID projektu nebo název projektu

definitionToCloneId: number

definitionToCloneRevision: number

Návraty

Promise<BuildDefinition>

createFolder(Folder, string, string)

Vytvoří novou složku.

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

Parametry

folder: Folder

Složka.

project: string

ID projektu nebo název projektu

path: string

Úplná cesta ke složce.

Návraty

Promise<Folder>

deleteBuild(string, number)

Odstraní sestavení.

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

Parametry

project: string

ID projektu nebo název projektu

buildId: number

ID sestavení.

Návraty

Promise<void>

deleteBuildTag(string, number, string)

Odebere značku z sestavení. POZNÁMKA: Toto rozhraní API nebude fungovat pro značky se speciálními znaky. Pokud chcete odebrat značky se speciálními znaky, použijte místo toho metodu PATCH (ve verzi 6.0+).

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

Parametry

project: string

ID projektu nebo název projektu

buildId: number

ID sestavení.

tag: string

Značka, která se má odebrat.

Návraty

Promise<string[]>

deleteDefinition(string, number)

Odstraní definici a všechna přidružená sestavení.

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

Parametry

project: string

ID projektu nebo název projektu

definitionId: number

ID definice.

Návraty

Promise<void>

deleteDefinitionTag(string, number, string)

Odebere značku z definice. POZNÁMKA: Toto rozhraní API nebude fungovat pro značky se speciálními znaky. Pokud chcete odebrat značky se speciálními znaky, použijte místo toho metodu PATCH (ve verzi 6.0+).

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

Parametry

project: string

ID projektu nebo název projektu

definitionId: number

ID definice.

tag: string

Značka, která se má odebrat.

Návraty

Promise<string[]>

deleteFolder(string, string)

Odstraní složku definic. Odstraní se také definice a jejich odpovídající sestavení.

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

Parametry

project: string

ID projektu nebo název projektu

path: string

Úplná cesta ke složce.

Návraty

Promise<void>

deleteRetentionLeasesById(string, number[])

Odebere konkrétní zapůjčení uchovávání informací.

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

Parametry

project: string

ID projektu nebo název projektu

ids: number[]

Návraty

Promise<void>

deleteTag(string, string)

Odebere značku ze sestavení, definic a z úložiště značek.

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

Parametry

project: string

ID projektu nebo název projektu

tag: string

Značka, která se má odebrat.

Návraty

Promise<string[]>

deleteTemplate(string, string)

Odstraní šablonu definice sestavení.

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

Parametry

project: string

ID projektu nebo název projektu

templateId: string

ID šablony.

Návraty

Promise<void>

getArtifact(string, number, string)

Získá konkrétní artefakt pro sestavení.

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

Parametry

project: string

ID projektu nebo název projektu

buildId: number

ID sestavení.

artifactName: string

Název artefaktu.

Návraty

Promise<BuildArtifact>

getArtifactContentZip(string, number, string)

Získá konkrétní artefakt pro sestavení.

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

Parametry

project: string

ID projektu nebo název projektu

buildId: number

ID sestavení.

artifactName: string

Název artefaktu.

Návraty

Promise<ArrayBuffer>

getArtifacts(string, number)

Získá všechny artefakty pro sestavení.

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

Parametry

project: string

ID projektu nebo název projektu

buildId: number

ID sestavení.

Návraty

Promise<BuildArtifact[]>

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

Získá konkrétní přílohu.

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

Parametry

project: string

ID projektu nebo název projektu

buildId: number

ID sestavení.

timelineId: string

ID časové osy.

recordId: string

ID záznamu časové osy.

type: string

Typ přílohy.

name: string

Název přílohy.

Návraty

Promise<ArrayBuffer>

getAttachments(string, number, string)

Získá seznam příloh určitého typu, které jsou přidruženy k sestavení.

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

Parametry

project: string

ID projektu nebo název projektu

buildId: number

ID sestavení.

type: string

Typ přílohy.

Návraty

Promise<Attachment[]>

getBadge(string, number, string)

Získá odznáček, který označuje stav posledního sestavení pro definici. Všimněte si, že toto rozhraní API je zastaralé. Preferovat StatusBadgeController.GetStatusBadge.

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

Parametry

project: string

ID nebo název projektu.

definitionId: number

ID definice.

branchName: string

Název větve.

Návraty

Promise<string>

getBuild(string, number, string)

Získá sestavení.

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

Parametry

project: string

ID projektu nebo název projektu

buildId: number

propertyFilters: string

Návraty

Promise<Build>

getBuildBadge(string, string, string, string)

Získá odznak, který označuje stav nejnovějšího sestavení pro zadanou větev.

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

Parametry

project: string

ID projektu nebo název projektu

repoType: string

Typ úložiště.

repoId: string

ID úložiště.

branchName: string

Název větve.

Návraty

Promise<BuildBadge>

getBuildBadgeData(string, string, string, string)

Získá odznak, který označuje stav nejnovějšího sestavení pro zadanou větev.

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

Parametry

project: string

ID projektu nebo název projektu

repoType: string

Typ úložiště.

repoId: string

ID úložiště.

branchName: string

Název větve.

Návraty

Promise<string>

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

Získá změny přidružené k sestavení.

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

Parametry

project: string

ID projektu nebo název projektu

buildId: number

continuationToken: string

top: number

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

includeSourceChange: boolean

Návraty

Promise<PagedList<Change>>

getBuildController(number)

Získá kontroler.

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

Parametry

controllerId: number

Návraty

Promise<BuildController>

getBuildControllers(string)

Získá kontroler, volitelně filtrovaný podle názvu.

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

Parametry

name: string

Návraty

Promise<BuildController[]>

getBuildGeneralSettings(string)

Získá obecné nastavení kanálu.

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

Parametry

project: string

ID projektu nebo název projektu

Návraty

Promise<PipelineGeneralSettings>

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

Získá individuální soubor protokolu pro sestavení.

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

Parametry

project: string

ID projektu nebo název projektu

buildId: number

ID sestavení.

logId: number

ID souboru protokolu.

startLine: number

Počáteční řádek.

endLine: number

Koncová čára.

Návraty

Promise<string>

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

Získá individuální soubor protokolu pro sestavení.

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

Parametry

project: string

ID projektu nebo název projektu

buildId: number

ID sestavení.

logId: number

ID souboru protokolu.

startLine: number

Počáteční řádek.

endLine: number

Koncová čára.

Návraty

Promise<string[]>

getBuildLogs(string, number)

Získá protokoly pro sestavení.

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

Parametry

project: string

ID projektu nebo název projektu

buildId: number

ID sestavení.

Návraty

Promise<BuildLog[]>

getBuildLogsZip(string, number)

Získá protokoly pro sestavení.

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

Parametry

project: string

ID projektu nebo název projektu

buildId: number

ID sestavení.

Návraty

Promise<ArrayBuffer>

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

Získá individuální soubor protokolu pro sestavení.

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

Parametry

project: string

ID projektu nebo název projektu

buildId: number

ID sestavení.

logId: number

ID souboru protokolu.

startLine: number

Počáteční řádek.

endLine: number

Koncová čára.

Návraty

Promise<ArrayBuffer>

getBuildOptionDefinitions(string)

Získá všechny možnosti definice sestavení podporované systémem.

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

Parametry

project: string

ID projektu nebo název projektu

Návraty

Promise<BuildOptionDefinition[]>

getBuildProperties(string, number, string[])

Získá vlastnosti pro sestavení.

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

Parametry

project: string

ID projektu nebo název projektu

buildId: number

ID sestavení.

filter: string[]

Seznam vlastností oddělených čárkami. Pokud je zadáno, filtruje se na tyto konkrétní vlastnosti.

Návraty

Promise<any>

getBuildReport(string, number, string)

Získá sestavu sestavení.

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

Parametry

project: string

ID projektu nebo název projektu

buildId: number

ID sestavení.

type: string

Návraty

Promise<BuildReportMetadata>

getBuildReportHtmlContent(string, number, string)

Získá sestavu sestavení.

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

Parametry

project: string

ID projektu nebo název projektu

buildId: number

ID sestavení.

type: string

Návraty

Promise<any>

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

Získá seznam sestavení.

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

Parametry

project: string

ID projektu nebo název projektu

definitions: number[]

Seznam ID definic oddělených čárkami. Pokud je tato možnost zadána, filtruje pro tyto definice sestavení.

queues: number[]

Seznam ID front oddělených čárkami Pokud je tato možnost zadána, filtruje sestavení, která se spustila proti těmto frontám.

buildNumber: string

Pokud je zadáno, filtruje sestavení, která odpovídají tomuto číslu sestavení. Pokud chcete vyhledat předponu, připojte * .

minTime: Date

Pokud je zadáno, filtruje sestavení, která se dokončila/spustila/zařadila do fronty po tomto datu na základě zadaného dotazuObjednávky.

maxTime: Date

Pokud je zadáno, filtruje sestavení, která byla dokončena/spuštěna/zařazena do fronty před tímto datem, na základě zadaného dotazuObjednávky.

requestedFor: string

Pokud je zadáno, filtruje sestavení požadovaná pro zadaného uživatele.

reasonFilter: BuildReason

Pokud je zadaný, filtruje sestavení, která odpovídají tomuto důvodu.

statusFilter: BuildStatus

Pokud je tato možnost zadána, filtruje sestavení, která odpovídají tomuto stavu.

resultFilter: BuildResult

Pokud je zadáno, filtruje sestavení, která odpovídají tomuto výsledku.

tagFilters: string[]

Seznam značek oddělených čárkami Pokud je zadáno, filtruje sestavení, která mají zadané značky.

properties: string[]

Seznam vlastností oddělených čárkami, které se mají načíst.

top: number

Maximální počet buildů, které se mají vrátit.

continuationToken: string

Token pokračování vrácený předchozím voláním této metody, který lze použít k vrácení další sady sestavení.

maxBuildsPerDefinition: number

Maximální počet buildů, které se mají vrátit na definici.

deletedFilter: QueryDeletedOption

Určuje, jestli se mají vyloučit, zahrnout nebo jenom vrátit odstraněná sestavení.

queryOrder: BuildQueryOrder

Pořadí, ve kterém se mají vracet sestavení.

branchName: string

Pokud je tato možnost zadána, filtruje se na sestavení, která vytvořila větve, které vytvořily tuto větev.

buildIds: number[]

Seznam oddělený čárkami, který určuje ID sestavení, která se mají načíst.

repositoryId: string

Pokud je tato možnost zadána, filtruje sestavení sestavená z tohoto úložiště.

repositoryType: string

Pokud je tato možnost zadána, filtruje sestavení sestavená z úložišť tohoto typu.

Návraty

Promise<PagedList<Build>>

getBuildSettings(string)

Získá nastavení sestavení.

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

Parametry

project: string

ID projektu nebo název projektu

Návraty

Promise<BuildSettings>

getBuildTags(string, number)

Získá značky pro sestavení.

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

Parametry

project: string

ID projektu nebo název projektu

buildId: number

ID sestavení.

Návraty

Promise<string[]>

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

Získá podrobnosti o sestavení.

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

Parametry

project: string

ID projektu nebo název projektu

buildId: number

timelineId: string

changeId: number

planId: string

Návraty

Promise<Timeline>

getBuildWorkItemsRefs(string, number, number)

Získá pracovní položky přidružené k sestavení. Vrátí se pouze pracovní položky ve stejném projektu.

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

Parametry

project: string

ID projektu nebo název projektu

buildId: number

ID sestavení.

top: number

Maximální počet pracovních položek, které se mají vrátit.

Návraty

Promise<ResourceRef[]>

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

Získá pracovní položky přidružené k sestavení, filtrované na konkrétní potvrzení.

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

Parametry

commitIds: string[]

Seznam ID potvrzení oddělených čárkami.

project: string

ID projektu nebo název projektu

buildId: number

ID sestavení.

top: number

Maximální počet pracovních položek, které se mají vrátit, nebo počet potvrzení, která se mají zvážit, pokud nejsou zadána žádná ID potvrzení.

Návraty

Promise<ResourceRef[]>

getChangesBetweenBuilds(string, number, number, number)

Získá změny provedené v úložišti mezi dvěma danými sestaveními.

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

Parametry

project: string

ID projektu nebo název projektu

fromBuildId: number

ID prvního buildu.

toBuildId: number

ID posledního buildu.

top: number

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

Návraty

Promise<Change[]>

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

Získá definici, volitelně v konkrétní revizi.

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

Parametry

project: string

ID projektu nebo název projektu

definitionId: number

ID definice.

revision: number

Číslo revize, které se má načíst. Pokud tato hodnota není zadána, vrátí se nejnovější verze.

minMetricsTime: Date

Pokud je zadaný, označuje datum, od kterého se mají metriky zahrnout.

propertyFilters: string[]

Seznam vlastností oddělených čárkami, které se mají zahrnout do výsledků.

includeLatestBuilds: boolean

Návraty

Promise<BuildDefinition>

getDefinitionMetrics(string, number, Date)

Získá metriky sestavení pro definici.

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

Parametry

project: string

ID projektu nebo název projektu

definitionId: number

ID definice.

minMetricsTime: Date

Datum, od kterého se mají metriky vypočítat.

Návraty

Promise<BuildMetric[]>

getDefinitionProperties(string, number, string[])

Získá vlastnosti pro definici.

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

Parametry

project: string

ID projektu nebo název projektu

definitionId: number

ID definice.

filter: string[]

Seznam vlastností oddělených čárkami. Pokud je zadáno, filtruje se na tyto konkrétní vlastnosti.

Návraty

Promise<any>

getDefinitionResources(string, number)

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

Parametry

project: string

ID projektu nebo název projektu

definitionId: number

Návraty

Promise<DefinitionResourceReference[]>

getDefinitionRevisions(string, number)

Získá všechny revize definice.

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

Parametry

project: string

ID projektu nebo název projektu

definitionId: number

ID definice.

Návraty

Promise<BuildDefinitionRevision[]>

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

Získá seznam definic.

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

Parametry

project: string

ID projektu nebo název projektu

name: string

Pokud je zadáno, filtruje definice, jejichž názvy odpovídají tomuto vzoru.

repositoryId: string

ID úložiště. Pokud je tato možnost zadána, filtruje se na definice, které používají toto úložiště.

repositoryType: string

Pokud je tato možnost zadána, filtruje se na definice, které mají úložiště tohoto typu.

queryOrder: DefinitionQueryOrder

Určuje pořadí, ve kterém se mají definice vracet.

top: number

Maximální počet definic, které se mají vrátit.

continuationToken: string

Token pokračování vrácený předchozím voláním této metody, který lze použít k vrácení další sady definic.

minMetricsTime: Date

Pokud je zadaný, označuje datum, od kterého se mají metriky zahrnout.

definitionIds: number[]

Seznam oddělený čárkami, který určuje ID definic, které se mají načíst.

path: string

Pokud je tato možnost zadána, filtruje definice v této složce.

builtAfter: Date

Pokud je tato možnost zadána, filtruje se na definice, které mají sestavení po tomto datu.

notBuiltAfter: Date

Pokud je tato možnost zadána, filtruje definice, které po tomto datu nemají sestavení.

includeAllProperties: boolean

Určuje, zda mají být vráceny úplné definice. Ve výchozím nastavení se vrátí plytké reprezentace definic.

includeLatestBuilds: boolean

Určuje, zda se mají vrátit nejnovější a nejnovější dokončená sestavení pro tuto definici.

taskIdFilter: string

Pokud je zadáno, filtruje se na definice, které používají zadaný úkol.

processType: number

Pokud je tato možnost zadána, filtruje na definice s daným typem procesu.

yamlFilename: string

Pokud je zadáno, filtruje definice YAML, které odpovídají danému názvu souboru. Pokud chcete použít tento filtr includeAllProperties, musí být nastavená na hodnotu true.

Návraty

Promise<PagedList<BuildDefinitionReference>>

getDefinitionTags(string, number, number)

Získá značky pro definici.

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

Parametry

project: string

ID projektu nebo název projektu

definitionId: number

ID definice.

revision: number

Číslo revize definice. Pokud není zadáno, použije se nejnovější revize definice.

Návraty

Promise<string[]>

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

Převede definici na YAML, volitelně v konkrétní revizi.

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

Parametry

project: string

ID projektu nebo název projektu

definitionId: number

ID definice.

revision: number

Číslo revize, které se má načíst. Pokud tato hodnota není zadána, vrátí se nejnovější verze.

minMetricsTime: Date

Pokud je zadaný, označuje datum, od kterého se mají metriky zahrnout.

propertyFilters: string[]

Seznam vlastností oddělených čárkami, které se mají zahrnout do výsledků.

includeLatestBuilds: boolean

Návraty

Promise<YamlBuild>

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

Získá soubor z sestavení.

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

Parametry

project: string

ID projektu nebo název projektu

buildId: number

ID sestavení.

artifactName: string

Název artefaktu.

fileId: string

Primární klíč souboru.

fileName: string

Název, na který bude soubor nastaven.

Návraty

Promise<ArrayBuffer>

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

Získá obsah souboru v daném úložišti zdrojového kódu.

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

Parametry

project: string

ID projektu nebo název projektu

providerName: string

Název poskytovatele zdroje.

serviceEndpointId: string

Pokud je zadáno, ID koncového bodu služby, který se má dotazovat. Je možné vynechat pouze poskytovatele, kteří nepoužívají koncové body služby, například TFVC nebo TFGit.

repository: string

Pokud je zadaný, identifikátor specifický pro dodavatele nebo název úložiště pro získání větví. Tuto možnost je možné vynechat pouze u poskytovatelů, kteří nepodporují více úložišť.

commitOrBranch: string

Identifikátor potvrzení nebo větve, ze které se načítá obsah souboru.

path: string

Cesta k souboru, který se má načíst, vzhledem k kořenovému adresáři úložiště.

Návraty

Promise<string>

getFolders(string, string, FolderQueryOrder)

Získá seznam složek definic sestavení.

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

Parametry

project: string

ID projektu nebo název projektu

path: string

Cesta, kterou chcete začít.

queryOrder: FolderQueryOrder

Pořadí, ve kterém se mají složky vracet.

Návraty

Promise<Folder[]>

getLatestBuild(string, string, string)

Získá nejnovější sestavení pro definici, volitelně s oborem na konkrétní větev.

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

Parametry

project: string

ID projektu nebo název projektu

definition: string

název definice s volitelnou úvodní cestou ke složce nebo ID definice

branchName: string

volitelný parametr označující konkrétní větev, která se má použít. Pokud není zadána, použije se výchozí větev.

Návraty

Promise<Build>

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

Získá obsah adresáře v daném úložišti zdrojového kódu.

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

Parametry

project: string

ID projektu nebo název projektu

providerName: string

Název poskytovatele zdroje.

serviceEndpointId: string

Pokud je zadáno, ID koncového bodu služby, který se má dotazovat. Je možné vynechat pouze poskytovatele, kteří nepoužívají koncové body služby, například TFVC nebo TFGit.

repository: string

commitOrBranch: string

Identifikátor potvrzení nebo větve, ze které se načítá obsah souboru.

path: string

Obsah cesty k seznamu vzhledem ke kořenovému adresáři úložiště

Návraty

Promise<SourceRepositoryItem[]>

getProjectMetrics(string, string, Date)

Získá metriky sestavení pro projekt.

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

Parametry

project: string

ID projektu nebo název projektu

metricAggregationType: string

Typ agregace, který se má použít (hodinově, denně).

minMetricsTime: Date

Datum, od kterého se mají metriky vypočítat.

Návraty

Promise<BuildMetric[]>

getProjectResources(string, string, string)

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

Parametry

project: string

ID projektu nebo název projektu

type: string

id: string

Návraty

Promise<DefinitionResourceReference[]>

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

Získá objekt žádosti o přijetí změn od zdrojového zprostředkovatele.

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

Parametry

project: string

ID projektu nebo název projektu

providerName: string

Název poskytovatele zdroje.

pullRequestId: string

ID žádosti o přijetí změn specifické pro dodavatele

repositoryId: string

Identifikátor specifický pro dodavatele nebo název úložiště, které obsahuje žádost o přijetí změn.

serviceEndpointId: string

Pokud je zadáno, ID koncového bodu služby, který se má dotazovat. Je možné vynechat pouze poskytovatele, kteří nepoužívají koncové body služby, například TFVC nebo TFGit.

Návraty

Promise<PullRequest>

getResourceUsage()

Získá informace o prostředcích sestavení v systému.

function getResourceUsage(): Promise<BuildResourceUsage>

Návraty

Promise<BuildResourceUsage>

getRetentionHistory(number)

Vrátí historii uchovávání pro kolekci projektů. Patří sem kanály, které mají vlastní pravidla uchovávání, která můžou bránit úloze uchovávání informací v jejich vyčištění, spuštění na kanál s typem uchovávání, soubory přidružené k kanálům vlastněným kolekcí s typem uchovávání a počet souborů na kanál.

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

Parametry

daysToLookback: number

Návraty

Promise<BuildRetentionHistory>

getRetentionLease(string, number)

Vrátí podrobnosti o zapůjčení uchovávání informací s ID zapůjčení.

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

Parametry

project: string

ID projektu nebo název projektu

leaseId: number

Návraty

Promise<RetentionLease>

getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])

Vrátí všechna zapůjčení odpovídající zadanému MinimalRetentionLeases.

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

Parametry

project: string

ID projektu nebo název projektu

leasesToFetch: MinimalRetentionLease[]

Seznam serializovaných minimalretentionLeases ve formátu JSON oddělených znakem |

Návraty

Promise<RetentionLease[]>

getRetentionLeasesByOwnerId(string, string, number, number)

Vrátí všechna zapůjčení vlastněná zadanou entitou, volitelně vymezená na jednu definici kanálu a spuštění.

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

Parametry

project: string

ID projektu nebo název projektu

ownerId: string

definitionId: number

Volitelný parametr pro omezení vyhledávání na konkrétní definici kanálu.

runId: number

Volitelný parametr pro omezení hledání na jedno spuštění kanálu. Vyžaduje definitionId.

Návraty

Promise<RetentionLease[]>

getRetentionLeasesByUserId(string, string, number, number)

Vrátí všechna zapůjčení vlastněná zadaným uživatelem, volitelně vymezená na jednu definici kanálu a spuštění.

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

Parametry

project: string

ID projektu nebo název projektu

userOwnerId: string

ID uživatele, které chcete vyhledat.

definitionId: number

Volitelný parametr pro omezení vyhledávání na konkrétní definici kanálu.

runId: number

Volitelný parametr pro omezení hledání na jedno spuštění kanálu. Vyžaduje definitionId.

Návraty

Promise<RetentionLease[]>

getRetentionLeasesForBuild(string, number)

Získá všechny zapůjčení uchovávání informací, které platí pro konkrétní sestavení.

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

Parametry

project: string

ID projektu nebo název projektu

buildId: number

ID sestavení.

Návraty

Promise<RetentionLease[]>

getRetentionSettings(string)

Získá nastavení uchovávání informací projektu.

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

Parametry

project: string

ID projektu nebo název projektu

Návraty

Promise<ProjectRetentionSetting>

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

<p>Získá stav sestavení pro definici, volitelně vymezenou na konkrétní větev, fázi, úlohu a konfiguraci.< /p><p p>Pokud existuje více než jeden, pak je při zadávání jobName nutné předat hodnotu stageName a stejné pravidlo pak platí pro oba při předávání konfiguračního parametru.< /P>

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

Parametry

project: string

ID projektu nebo název projektu

definition: string

Buď název definice s volitelnou úvodní cestou ke složce, nebo ID definice.

branchName: string

Zvažte pouze nejnovější build pro tuto větev. Pokud není zadána, použije se výchozí větev.

stageName: string

Tuto fázi použijte v rámci kanálu k vykreslení stavu.

jobName: string

Tuto úlohu použijte ve fázi kanálu k vykreslení stavu.

configuration: string

Pomocí této konfigurace úlohy vykreslíte stav.

label: string

Nahradí výchozí text na levé straně odznáčku.

Návraty

Promise<string>

getTags(string)

Získá seznam všech značek sestavení v projektu.

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

Parametry

project: string

ID projektu nebo název projektu

Návraty

Promise<string[]>

getTemplate(string, string)

Získá konkrétní šablonu definice sestavení.

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

Parametry

project: string

ID projektu nebo název projektu

templateId: string

ID požadované šablony.

Návraty

Promise<BuildDefinitionTemplate>

getTemplates(string)

Získá všechny šablony definic.

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

Parametry

project: string

ID projektu nebo název projektu

Návraty

Promise<BuildDefinitionTemplate[]>

getWorkItemsBetweenBuilds(string, number, number, number)

Získá všechny pracovní položky mezi dvěma sestaveními.

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

Parametry

project: string

ID projektu nebo název projektu

fromBuildId: number

ID prvního buildu.

toBuildId: number

ID posledního buildu.

top: number

Maximální počet pracovních položek, které se mají vrátit.

Návraty

Promise<ResourceRef[]>

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

Získá seznam větví pro dané úložiště zdrojového kódu.

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

Parametry

project: string

ID projektu nebo název projektu

providerName: string

Název poskytovatele zdroje.

serviceEndpointId: string

Pokud je zadáno, ID koncového bodu služby, který se má dotazovat. Je možné vynechat pouze poskytovatele, kteří nepoužívají koncové body služby, například TFVC nebo TFGit.

repository: string

Identifikátor specifický pro dodavatele nebo název úložiště pro získání větví. Tuto možnost je možné vynechat pouze u poskytovatelů, kteří nepodporují více úložišť.

branchName: string

Pokud je zadaný, název větve, která se má konkrétně zkontrolovat.

Návraty

Promise<string[]>

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

Získá seznam úložišť zdrojového kódu.

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

Parametry

project: string

ID projektu nebo název projektu

providerName: string

Název poskytovatele zdroje.

serviceEndpointId: string

Pokud je zadáno, ID koncového bodu služby, který se má dotazovat. Je možné vynechat pouze poskytovatele, kteří nepoužívají koncové body služby, například TFVC nebo TFGit.

repository: string

Pokud je zadaný, identifikátor specifický pro dodavatele nebo název jednoho úložiště, který chcete získat.

resultSet: ResultSet

"top" pro úložiště, která jsou pro koncový bod nejrelevantní. Pokud není nastavená, vrátí se všechna úložiště. Ignorováno, pokud je nastaveno úložiště.

pageResults: boolean

Pokud je nastavená hodnota true, omezí se tím sada výsledků a vrátí se token pokračování pro pokračování dotazu.

continuationToken: string

Při stránkování výsledků se jedná o pokračovací token vrácený předchozím voláním této metody, který lze použít k vrácení další sady úložišť.

Návraty

Promise<SourceRepositories>

listSourceProviders(string)

Získejte seznam zdrojových poskytovatelů a jejich možností.

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

Parametry

project: string

ID projektu nebo název projektu

Návraty

Promise<SourceProviderAttributes[]>

listWebhooks(string, string, string, string)

Získá seznam webhooků nainstalovaných v daném úložišti zdrojového kódu.

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

Parametry

project: string

ID projektu nebo název projektu

providerName: string

Název poskytovatele zdroje.

serviceEndpointId: string

Pokud je zadáno, ID koncového bodu služby, který se má dotazovat. Je možné vynechat pouze poskytovatele, kteří nepoužívají koncové body služby, například TFVC nebo TFGit.

repository: string

Pokud je zadaný, identifikátor specifický pro dodavatele nebo název úložiště pro získání webhooků. Tuto možnost je možné vynechat pouze u poskytovatelů, kteří nepodporují více úložišť.

Návraty

Promise<RepositoryWebhook[]>

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

Zasadí sestavení do fronty.

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

Parametry

build: Build

project: string

ID projektu nebo název projektu

ignoreWarnings: boolean

checkInTicket: string

sourceBuildId: number

definitionId: number

Volitelné ID definice pro sestavení bez textu do fronty. Ignorováno, pokud existuje platné tělo

Návraty

Promise<Build>

restoreDefinition(string, number, boolean)

Obnoví odstraněnou definici.

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

Parametry

project: string

ID projektu nebo název projektu

definitionId: number

Identifikátor definice, která se má obnovit.

deleted: boolean

Pokud je false, obnoví odstraněnou definici.

Návraty

Promise<BuildDefinition>

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

Znovu vytvoří webhooky pro zadané triggery v daném úložišti zdrojového kódu.

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

Parametry

triggerTypes: DefinitionTriggerType[]

Typy triggerů pro obnovení webhooků

project: string

ID projektu nebo název projektu

providerName: string

Název poskytovatele zdroje.

serviceEndpointId: string

Pokud je zadáno, ID koncového bodu služby, který se má dotazovat. Je možné vynechat pouze poskytovatele, kteří nepoužívají koncové body služby, například TFVC nebo TFGit.

repository: string

Návraty

Promise<void>

saveTemplate(BuildDefinitionTemplate, string, string)

Aktualizace existující šablonu definice sestavení.

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

Parametry

template: BuildDefinitionTemplate

Nová verze šablony.

project: string

ID projektu nebo název projektu

templateId: string

ID šablony.

Návraty

Promise<BuildDefinitionTemplate>

updateBuild(Build, string, number, boolean)

Aktualizace sestavení.

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

Parametry

build: Build

Sestavení.

project: string

ID projektu nebo název projektu

buildId: number

ID sestavení.

retry: boolean

Návraty

Promise<Build>

updateBuildGeneralSettings(PipelineGeneralSettings, string)

Aktualizace obecné nastavení kanálu.

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

Parametry

newSettings: PipelineGeneralSettings

project: string

ID projektu nebo název projektu

Návraty

Promise<PipelineGeneralSettings>

updateBuildProperties(JsonPatchDocument, string, number)

Aktualizace vlastnosti sestavení.

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

Parametry

document: JsonPatchDocument

Dokument json-patch popisující vlastnosti, které se mají aktualizovat.

project: string

ID projektu nebo název projektu

buildId: number

ID sestavení.

Návraty

Promise<any>

updateBuilds(Build[], string)

Aktualizace více sestavení.

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

Parametry

builds: Build[]

Buildy, které se mají aktualizovat.

project: string

ID projektu nebo název projektu

Návraty

Promise<Build[]>

updateBuildSettings(BuildSettings, string)

Aktualizace nastavení sestavení.

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

Parametry

settings: BuildSettings

Nové nastavení.

project: string

ID projektu nebo název projektu

Návraty

Promise<BuildSettings>

updateBuildTags(UpdateTagParameters, string, number)

Přidá nebo odebere značky z sestavení.

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

Parametry

updateParameters: UpdateTagParameters

Značky, které chcete přidat nebo odebrat.

project: string

ID projektu nebo název projektu

buildId: number

ID sestavení.

Návraty

Promise<string[]>

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

Aktualizace existující definici sestavení. Aby byla tato operace úspěšná, musí hodnota vlastnosti Revision textu požadavku odpovídat definicím existujícího sestavení. Doporučujeme získat existující definici sestavení pomocí příkazu GET, upravit definici sestavení podle potřeby a pak odeslat upravenou definici pomocí PUT.

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

Parametry

definition: BuildDefinition

Nová verze definice. Jeho vlastnost Revision se musí shodovat s existující definicí, aby byla aktualizace přijata.

project: string

ID projektu nebo název projektu

definitionId: number

ID definice.

secretsSourceDefinitionId: number

secretsSourceDefinitionRevision: number

Návraty

Promise<BuildDefinition>

updateDefinitionProperties(JsonPatchDocument, string, number)

Aktualizace vlastnosti definice.

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

Parametry

document: JsonPatchDocument

Dokument json-patch popisující vlastnosti, které se mají aktualizovat.

project: string

ID projektu nebo název projektu

definitionId: number

ID definice.

Návraty

Promise<any>

updateDefinitionTags(UpdateTagParameters, string, number)

Přidá nebo odebere značky z definice.

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

Parametry

updateParameters: UpdateTagParameters

Značky, které chcete přidat nebo odebrat.

project: string

ID projektu nebo název projektu

definitionId: number

ID definice.

Návraty

Promise<string[]>

updateFolder(Folder, string, string)

Aktualizace existující složku v dané existující cestě

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

Parametry

folder: Folder

Nová verze složky.

project: string

ID projektu nebo název projektu

path: string

Úplná cesta ke složce.

Návraty

Promise<Folder>

updateRetentionLease(RetentionLeaseUpdate, string, number)

Aktualizace dobu trvání nebo stav ochrany kanálu zapůjčení uchovávání informací.

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

Parametry

leaseUpdate: RetentionLeaseUpdate

Nová data pro zapůjčení uchovávání informací.

project: string

ID projektu nebo název projektu

leaseId: number

ID zapůjčení, které se má aktualizovat.

Návraty

Promise<RetentionLease>

updateRetentionSettings(UpdateProjectRetentionSettingModel, string)

Aktualizace nastavení uchovávání informací v projektu.

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

Parametry

updateModel: UpdateProjectRetentionSettingModel

project: string

ID projektu nebo název projektu

Návraty

Promise<ProjectRetentionSetting>

updateStage(UpdateStageParameters, number, string, string)

Aktualizace fáze sestavení

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

Parametry

updateParameters: UpdateStageParameters

buildId: number

stageRefName: string

project: string

ID projektu nebo název projektu

Návraty

Promise<void>

Sdílet prostřednictvím

BuildRestClient class

Konstruktory

Vlastnosti

Metody

Podrobnosti konstruktoru

BuildRestClient(IVssRestClientOptions)

Parametry

Podrobnosti vlastnosti

RESOURCE_AREA_ID

Hodnota vlastnosti

Podrobnosti metody

addBuildTag(string, number, string)

Parametry

Návraty

addBuildTags(string[], string, number)

Parametry

Návraty

addDefinitionTag(string, number, string)

Parametry

Návraty

addDefinitionTags(string[], string, number)

Parametry

Návraty

addRetentionLeases(NewRetentionLease[], string)

Parametry

Návraty

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

Parametry

Návraty

authorizeProjectResources(DefinitionResourceReference[], string)

Parametry

Návraty

createArtifact(BuildArtifact, string, number)

Parametry

Návraty

createDefinition(BuildDefinition, string, number, number)

Parametry

Návraty

createFolder(Folder, string, string)

Parametry

Návraty

deleteBuild(string, number)

Parametry

Návraty

deleteBuildTag(string, number, string)

Parametry

Návraty

deleteDefinition(string, number)

Parametry

Návraty

deleteDefinitionTag(string, number, string)

Parametry

Návraty

deleteFolder(string, string)

Parametry

Návraty

deleteRetentionLeasesById(string, number[])

Parametry

Návraty

deleteTag(string, string)

Parametry

Návraty

deleteTemplate(string, string)

Parametry

Návraty

getArtifact(string, number, string)

Parametry

Návraty

getArtifactContentZip(string, number, string)

Parametry

Návraty

getArtifacts(string, number)

Parametry

Návraty

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

Parametry

Návraty

getAttachments(string, number, string)

Parametry