BuildRestClient class

Riferimento

Pacchetto:: azure-devops-extension-api

Classe di base che deve essere usata (derivata da) per effettuare richieste alle API REST di VSS

Extends: RestClientBase

Costruttori

BuildRestClient(IVssRestClientOptions)

Proprietà

RESOURCE_AREA_ID

Metodi

addBuildTag(string, number, string)	Aggiunge un tag a una compilazione.
addBuildTags(string[], string, number)	Aggiunge tag a una compilazione.
addDefinitionTag(string, number, string)	Aggiunge un tag a una definizione
addDefinitionTags(string[], string, number)	Aggiunge più tag a una definizione.
addRetentionLeases(NewRetentionLease[], string)	Aggiunge nuovi lease per le esecuzioni della pipeline.
authorizeDefinitionResources(DefinitionResourceReference[], string, number)
authorizeProjectResources(DefinitionResourceReference[], string)
createArtifact(BuildArtifact, string, number)	Associa un artefatto a una compilazione.
createDefinition(BuildDefinition, string, number, number)	Crea una nuova definizione.
createFolder(Folder, string, string)	Crea una nuova cartella.
deleteBuild(string, number)	Elimina una compilazione.
deleteBuildTag(string, number, string)	Rimuove un tag da una compilazione. NOTA: questa API non funzionerà per i tag con caratteri speciali. Per rimuovere i tag con caratteri speciali, usare invece il metodo PATCH (in 6.0+)
deleteDefinition(string, number)	Elimina una definizione e tutte le compilazioni associate.
deleteDefinitionTag(string, number, string)	Rimuove un tag da una definizione. NOTA: questa API non funzionerà per i tag con caratteri speciali. Per rimuovere i tag con caratteri speciali, usare invece il metodo PATCH (in 6.0+)
deleteFolder(string, string)	Elimina una cartella di definizione. Le definizioni e le compilazioni corrispondenti verranno eliminate anche.
deleteRetentionLeasesById(string, number[])	Rimuove lease di conservazione specifici.
deleteTag(string, string)	Rimuove un tag da compilazioni, definizioni e dall'archivio tag
deleteTemplate(string, string)	Elimina un modello di definizione di compilazione.
getArtifact(string, number, string)	Ottiene un artefatto specifico per una compilazione.
getArtifactContentZip(string, number, string)	Ottiene un artefatto specifico per una compilazione.
getArtifacts(string, number)	Ottiene tutti gli artefatti per una compilazione.
getAttachment(string, number, string, string, string, string)	Ottiene un allegato specifico.
getAttachments(string, number, string)	Ottiene l'elenco di allegati di un tipo specifico associato a una compilazione.
getBadge(string, number, string)	Ottiene un badge che indica lo stato della compilazione più recente per una definizione. Si noti che questa API è deprecata. Preferisce StatusBadgeController.GetStatusBadge.
getBuild(string, number, string)	Ottiene una compilazione
getBuildBadge(string, string, string, string)	Ottiene una notifica che indica lo stato della build più recente per il ramo specificato.
getBuildBadgeData(string, string, string, string)	Ottiene una notifica che indica lo stato della build più recente per il ramo specificato.
getBuildChanges(string, number, string, number, boolean)	Ottiene le modifiche associate a una compilazione
getBuildController(number)	Ottiene un controller
getBuildControllers(string)	Ottiene il controller, filtrato facoltativamente in base al nome
getBuildGeneralSettings(string)	Ottiene le impostazioni generali della pipeline.
getBuildLog(string, number, number, number, number)	Ottiene un singolo file di log per una compilazione.
getBuildLogLines(string, number, number, number, number)	Ottiene un singolo file di log per una compilazione.
getBuildLogs(string, number)	Ottiene i log per una compilazione.
getBuildLogsZip(string, number)	Ottiene i log per una compilazione.
getBuildLogZip(string, number, number, number, number)	Ottiene un singolo file di log per una compilazione.
getBuildOptionDefinitions(string)	Ottiene tutte le opzioni di definizione di compilazione supportate dal sistema.
getBuildProperties(string, number, string[])	Ottiene le proprietà per una compilazione.
getBuildReport(string, number, string)	Ottiene un report di compilazione.
getBuildReportHtmlContent(string, number, string)	Ottiene un report di compilazione.
getBuilds(string, number[], number[], string, Date, Date, string, BuildReason, BuildStatus, BuildResult, string[], string[], number, string, number, QueryDeletedOption, BuildQueryOrder, string, number[], string, string)	Ottiene un elenco di compilazioni.
getBuildSettings(string)	Ottiene le impostazioni di compilazione.
getBuildTags(string, number)	Ottiene i tag per una compilazione.
getBuildTimeline(string, number, string, number, string)	Ottiene i dettagli per una compilazione
getBuildWorkItemsRefs(string, number, number)	Ottiene gli elementi di lavoro associati a una compilazione. Vengono restituiti solo gli elementi di lavoro nello stesso progetto.
getBuildWorkItemsRefsFromCommits(string[], string, number, number)	Ottiene gli elementi di lavoro associati a una compilazione, filtrati in base a commit specifici.
getChangesBetweenBuilds(string, number, number, number)	Ottiene le modifiche apportate al repository tra due compilazioni date.
getDefinition(string, number, number, Date, string[], boolean)	Ottiene una definizione, facoltativamente in una revisione specifica.
getDefinitionMetrics(string, number, Date)	Ottiene le metriche di compilazione per una definizione.
getDefinitionProperties(string, number, string[])	Ottiene le proprietà per una definizione.
getDefinitionResources(string, number)
getDefinitionRevisions(string, number)	Ottiene tutte le revisioni di una definizione.
getDefinitions(string, string, string, string, DefinitionQueryOrder, number, string, Date, number[], string, Date, Date, boolean, boolean, string, number, string)	Ottiene un elenco di definizioni.
getDefinitionTags(string, number, number)	Ottiene i tag per una definizione.
getDefinitionYaml(string, number, number, Date, string[], boolean)	Converte una definizione in YAML, facoltativamente in una revisione specifica.
getFile(string, number, string, string, string)	Ottiene un file dalla compilazione.
getFileContents(string, string, string, string, string, string)	Ottiene il contenuto di un file nel repository del codice sorgente specificato.
getFolders(string, string, FolderQueryOrder)	Ottiene un elenco di cartelle di definizione di compilazione.
getLatestBuild(string, string, string)	Ottiene la build più recente per una definizione, facoltativamente con ambito in un ramo specifico.
getPathContents(string, string, string, string, string, string)	Ottiene il contenuto di una directory nel repository del codice sorgente specificato.
getProjectMetrics(string, string, Date)	Ottiene le metriche di compilazione per un progetto.
getProjectResources(string, string, string)
getPullRequest(string, string, string, string, string)	Ottiene un oggetto richiesta pull dal provider di origine.
getResourceUsage()	Ottiene informazioni sulla compilazione delle risorse nel sistema.
getRetentionHistory(number)	Restituisce la cronologia di conservazione per la raccolta di progetti. Sono incluse le pipeline con regole di conservazione personalizzate che potrebbero impedire al processo di conservazione di pulirle, le esecuzioni per pipeline con tipo di conservazione, i file associati alle pipeline di proprietà della raccolta con il tipo di conservazione e il numero di file per pipeline.
getRetentionLease(string, number)	Restituisce i dettagli del lease di conservazione in base a un ID lease.
getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])	Restituisce tutti i lease corrispondenti all'oggetto MinimalRetentionLeases specificato
getRetentionLeasesByOwnerId(string, string, number, number)	Restituisce tutti i lease di proprietà dell'entità specificata, facoltativamente con ambito a una singola definizione di pipeline ed esecuzione.
getRetentionLeasesByUserId(string, string, number, number)	Restituisce tutti i lease di proprietà dell'utente specificato, facoltativamente con ambito a una singola definizione di pipeline ed esecuzione.
getRetentionLeasesForBuild(string, number)	Ottiene tutti i lease di conservazione applicabili a una compilazione specifica.
getRetentionSettings(string)	Ottiene le impostazioni di conservazione del progetto.
getStatusBadge(string, string, string, string, string, string, string)	<p>Ottiene lo stato di compilazione per una definizione, con ambito facoltativo per un ramo, una fase, un processo e una configurazione specifici.< /p><p>Se sono presenti più di uno, è necessario passare un valore stageName quando si specifica un jobName e la stessa regola viene quindi applicata per entrambi se si passa un parametro di configurazione.< /P>
getTags(string)	Ottiene un elenco di tutti i tag di compilazione nel progetto.
getTemplate(string, string)	Ottiene un modello di definizione di compilazione specifico.
getTemplates(string)	Ottiene tutti i modelli di definizione.
getWorkItemsBetweenBuilds(string, number, number, number)	Ottiene tutti gli elementi di lavoro tra due compilazioni.
listBranches(string, string, string, string, string)	Ottiene un elenco di rami per il repository di codice sorgente specificato.
listRepositories(string, string, string, string, ResultSet, boolean, string)	Ottiene un elenco di repository di codice sorgente.
listSourceProviders(string)	Ottenere un elenco di provider di origine e le relative funzionalità.
listWebhooks(string, string, string, string)	Ottiene un elenco di webhook installati nel repository del codice sorgente specificato.
queueBuild(Build, string, boolean, string, number, number)	Accoda una compilazione
restoreDefinition(string, number, boolean)	Ripristina una definizione eliminata
restoreWebhooks(DefinitionTriggerType[], string, string, string, string)	Ricrea i webhook per i trigger specificati nel repository del codice sorgente specificato.
saveTemplate(BuildDefinitionTemplate, string, string)	Aggiornamenti un modello di definizione di compilazione esistente.
updateBuild(Build, string, number, boolean)	Aggiornamenti una compilazione.
updateBuildGeneralSettings(PipelineGeneralSettings, string)	Aggiornamenti impostazioni generali della pipeline.
updateBuildProperties(JsonPatchDocument, string, number)	Aggiornamenti proprietà per una compilazione.
updateBuilds(Build[], string)	Aggiornamenti più compilazioni.
updateBuildSettings(BuildSettings, string)	Aggiornamenti le impostazioni di compilazione.
updateBuildTags(UpdateTagParameters, string, number)	Aggiunge/Rimuove i tag da una compilazione.
updateDefinition(BuildDefinition, string, number, number, number)	Aggiornamenti una definizione di compilazione esistente. Affinché questa operazione abbia esito positivo, il valore della proprietà "Revision" del corpo della richiesta deve corrispondere alla definizione di compilazione esistente. È consigliabile ottenere la definizione di compilazione esistente usando GET, modificare la definizione di compilazione in base alle esigenze e quindi inviare la definizione modificata con PUT.
updateDefinitionProperties(JsonPatchDocument, string, number)	Aggiornamenti proprietà per una definizione.
updateDefinitionTags(UpdateTagParameters, string, number)	Aggiunge/Rimuove i tag da una definizione.
updateFolder(Folder, string, string)	Aggiornamenti una cartella esistente nel percorso esistente
updateRetentionLease(RetentionLeaseUpdate, string, number)	Aggiornamenti la durata o lo stato di protezione della pipeline di un lease di conservazione.
updateRetentionSettings(UpdateProjectRetentionSettingModel, string)	Aggiornamenti le impostazioni di conservazione del progetto.
updateStage(UpdateStageParameters, number, string, string)	Aggiornare una fase di compilazione

Dettagli costruttore

BuildRestClient(IVssRestClientOptions)

new BuildRestClient(options: IVssRestClientOptions)

Parametri

options: IVssRestClientOptions

Dettagli proprietà

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valore della proprietà

string

Dettagli metodo

addBuildTag(string, number, string)

Aggiunge un tag a una compilazione.

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

Parametri

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

tag: string

Tag da aggiungere.

Restituisce

Promise<string[]>

addBuildTags(string[], string, number)

Aggiunge tag a una compilazione.

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

Parametri

tags: string[]

Tag da aggiungere. Il corpo della richiesta è composto direttamente dai tag elencati.

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

Restituisce

Promise<string[]>

addDefinitionTag(string, number, string)

Aggiunge un tag a una definizione

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

Parametri

project: string

ID progetto o nome progetto

definitionId: number

ID della definizione.

tag: string

Tag da aggiungere.

Restituisce

Promise<string[]>

addDefinitionTags(string[], string, number)

Aggiunge più tag a una definizione.

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

Parametri

tags: string[]

Tag da aggiungere.

project: string

ID progetto o nome progetto

definitionId: number

ID della definizione.

Restituisce

Promise<string[]>

addRetentionLeases(NewRetentionLease[], string)

Aggiunge nuovi lease per le esecuzioni della pipeline.

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

Parametri

newLeases: NewRetentionLease[]

project: string

ID progetto o nome progetto

Restituisce

Promise<RetentionLease[]>

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

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

Parametri

resources: DefinitionResourceReference[]

project: string

ID progetto o nome progetto

definitionId: number

Restituisce

Promise<DefinitionResourceReference[]>

authorizeProjectResources(DefinitionResourceReference[], string)

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

Parametri

resources: DefinitionResourceReference[]

project: string

ID progetto o nome progetto

Restituisce

Promise<DefinitionResourceReference[]>

createArtifact(BuildArtifact, string, number)

Associa un artefatto a una compilazione.

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

Parametri

artifact: BuildArtifact

Artefatto.

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

Restituisce

Promise<BuildArtifact>

createDefinition(BuildDefinition, string, number, number)

Crea una nuova definizione.

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

Parametri

definition: BuildDefinition

Definizione.

project: string

ID progetto o nome progetto

definitionToCloneId: number

definitionToCloneRevision: number

Restituisce

Promise<BuildDefinition>

createFolder(Folder, string, string)

Crea una nuova cartella.

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

Parametri

folder: Folder

Cartella.

project: string

ID progetto o nome progetto

path: string

Percorso completo della cartella.

Restituisce

Promise<Folder>

deleteBuild(string, number)

Elimina una compilazione.

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

Parametri

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

Restituisce

Promise<void>

deleteBuildTag(string, number, string)

Rimuove un tag da una compilazione. NOTA: questa API non funzionerà per i tag con caratteri speciali. Per rimuovere i tag con caratteri speciali, usare invece il metodo PATCH (in 6.0+)

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

Parametri

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

tag: string

Tag da rimuovere.

Restituisce

Promise<string[]>

deleteDefinition(string, number)

Elimina una definizione e tutte le compilazioni associate.

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

Parametri

project: string

ID progetto o nome progetto

definitionId: number

ID della definizione.

Restituisce

Promise<void>

deleteDefinitionTag(string, number, string)

Rimuove un tag da una definizione. NOTA: questa API non funzionerà per i tag con caratteri speciali. Per rimuovere i tag con caratteri speciali, usare invece il metodo PATCH (in 6.0+)

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

Parametri

project: string

ID progetto o nome progetto

definitionId: number

ID della definizione.

tag: string

Tag da rimuovere.

Restituisce

Promise<string[]>

deleteFolder(string, string)

Elimina una cartella di definizione. Le definizioni e le compilazioni corrispondenti verranno eliminate anche.

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

Parametri

project: string

ID progetto o nome progetto

path: string

Percorso completo della cartella.

Restituisce

Promise<void>

deleteRetentionLeasesById(string, number[])

Rimuove lease di conservazione specifici.

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

Parametri

project: string

ID progetto o nome progetto

ids: number[]

Restituisce

Promise<void>

deleteTag(string, string)

Rimuove un tag da compilazioni, definizioni e dall'archivio tag

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

Parametri

project: string

ID progetto o nome progetto

tag: string

Tag da rimuovere.

Restituisce

Promise<string[]>

deleteTemplate(string, string)

Elimina un modello di definizione di compilazione.

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

Parametri

project: string

ID progetto o nome progetto

templateId: string

ID del modello.

Restituisce

Promise<void>

getArtifact(string, number, string)

Ottiene un artefatto specifico per una compilazione.

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

Parametri

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

artifactName: string

Nome dell'artefatto.

Restituisce

Promise<BuildArtifact>

getArtifactContentZip(string, number, string)

Ottiene un artefatto specifico per una compilazione.

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

Parametri

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

artifactName: string

Nome dell'artefatto.

Restituisce

Promise<ArrayBuffer>

getArtifacts(string, number)

Ottiene tutti gli artefatti per una compilazione.

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

Parametri

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

Restituisce

Promise<BuildArtifact[]>

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

Ottiene un allegato specifico.

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

Parametri

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

timelineId: string

ID della sequenza temporale.

recordId: string

ID del record della sequenza temporale.

type: string

Tipo dell'allegato.

name: string

Nome dell'allegato.

Restituisce

Promise<ArrayBuffer>

getAttachments(string, number, string)

Ottiene l'elenco di allegati di un tipo specifico associato a una compilazione.

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

Parametri

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

type: string

Tipo di allegato.

Restituisce

Promise<Attachment[]>

getBadge(string, number, string)

Ottiene un badge che indica lo stato della compilazione più recente per una definizione. Si noti che questa API è deprecata. Preferisce StatusBadgeController.GetStatusBadge.

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

Parametri

project: string

ID progetto o nome.

definitionId: number

ID della definizione.

branchName: string

Nome del ramo.

Restituisce

Promise<string>

getBuild(string, number, string)

Ottiene una compilazione

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

Parametri

project: string

ID progetto o nome del progetto

buildId: number

propertyFilters: string

Restituisce

Promise<Build>

getBuildBadge(string, string, string, string)

Ottiene una notifica che indica lo stato della build più recente per il ramo specificato.

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

Parametri

project: string

ID progetto o nome del progetto

repoType: string

Tipo di repository.

repoId: string

ID repository.

branchName: string

Nome del ramo.

Restituisce

Promise<BuildBadge>

getBuildBadgeData(string, string, string, string)

Ottiene una notifica che indica lo stato della build più recente per il ramo specificato.

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

Parametri

project: string

ID progetto o nome del progetto

repoType: string

Tipo di repository.

repoId: string

ID repository.

branchName: string

Nome del ramo.

Restituisce

Promise<string>

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

Ottiene le modifiche associate a una compilazione

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

Parametri

project: string

ID progetto o nome del progetto

buildId: number

continuationToken: string

top: number

Numero massimo di modifiche da restituire

includeSourceChange: boolean

Restituisce

Promise<PagedList<Change>>

getBuildController(number)

Ottiene un controller

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

Parametri

controllerId: number

Restituisce

Promise<BuildController>

getBuildControllers(string)

Ottiene il controller, filtrato facoltativamente in base al nome

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

Parametri

name: string

Restituisce

Promise<BuildController[]>

getBuildGeneralSettings(string)

Ottiene le impostazioni generali della pipeline.

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

Parametri

project: string

ID progetto o nome del progetto

Restituisce

Promise<PipelineGeneralSettings>

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

Ottiene un singolo file di log per una compilazione.

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

Parametri

project: string

ID progetto o nome del progetto

buildId: number

ID della compilazione.

logId: number

ID del file di log.

startLine: number

Riga iniziale.

endLine: number

Riga finale.

Restituisce

Promise<string>

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

Ottiene un singolo file di log per una compilazione.

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

Parametri

project: string

ID progetto o nome del progetto

buildId: number

ID della compilazione.

logId: number

ID del file di log.

startLine: number

Riga iniziale.

endLine: number

Riga finale.

Restituisce

Promise<string[]>

getBuildLogs(string, number)

Ottiene i log per una compilazione.

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

Parametri

project: string

ID progetto o nome del progetto

buildId: number

ID della compilazione.

Restituisce

Promise<BuildLog[]>

getBuildLogsZip(string, number)

Ottiene i log per una compilazione.

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

Parametri

project: string

ID progetto o nome del progetto

buildId: number

ID della compilazione.

Restituisce

Promise<ArrayBuffer>

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

Ottiene un singolo file di log per una compilazione.

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

Parametri

project: string

ID progetto o nome del progetto

buildId: number

ID della compilazione.

logId: number

ID del file di log.

startLine: number

Riga iniziale.

endLine: number

Riga finale.

Restituisce

Promise<ArrayBuffer>

getBuildOptionDefinitions(string)

Ottiene tutte le opzioni di definizione di compilazione supportate dal sistema.

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

Parametri

project: string

ID progetto o nome del progetto

Restituisce

Promise<BuildOptionDefinition[]>

getBuildProperties(string, number, string[])

Ottiene le proprietà per una compilazione.

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

Parametri

project: string

ID progetto o nome del progetto

buildId: number

ID della compilazione.

filter: string[]

Elenco delimitato da virgole di proprietà. Se specificato, filtra queste proprietà specifiche.

Restituisce

Promise<any>

getBuildReport(string, number, string)

Ottiene un report di compilazione.

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

Parametri

project: string

ID progetto o nome del progetto

buildId: number

ID della compilazione.

type: string

Restituisce

Promise<BuildReportMetadata>

getBuildReportHtmlContent(string, number, string)

Ottiene un report di compilazione.

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

Parametri

project: string

ID progetto o nome del progetto

buildId: number

ID della compilazione.

type: string

Restituisce

Promise<any>

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

Ottiene un elenco di compilazioni.

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

Parametri

project: string

ID progetto o nome del progetto

definitions: number[]

Elenco delimitato da virgole di ID di definizione. Se specificato, filtra per le compilazioni per queste definizioni.

queues: number[]

Elenco delimitato da virgole di ID coda. Se specificato, filtra le compilazioni eseguite su queste code.

buildNumber: string

Se specificato, filtra le compilazioni che corrispondono a questo numero di build. Aggiungere * per eseguire una ricerca di prefisso.

minTime: Date

Se specificato, filtra le compilazioni completate/avviate/accodate dopo questa data in base all'oggetto queryOrder specificato.

maxTime: Date

Se specificato, filtra le compilazioni completate/avviate/accodate prima di questa data in base all'oggetto queryOrder specificato.

requestedFor: string

Se specificato, filtra le compilazioni richieste per l'utente specificato.

reasonFilter: BuildReason

Se specificato, i filtri per le compilazioni corrispondono a questo motivo.

statusFilter: BuildStatus

Se specificato, filtra le compilazioni che corrispondono a questo stato.

resultFilter: BuildResult

Se specificato, filtra le compilazioni che corrispondono a questo risultato.

tagFilters: string[]

Elenco delimitato da virgole di tag. Se specificato, filtra le compilazioni con i tag specificati.

properties: string[]

Elenco delimitato da virgole di proprietà da recuperare.

top: number

Numero massimo di compilazioni da restituire.

continuationToken: string

Token di continuazione, restituito da una chiamata precedente a questo metodo, che può essere usato per restituire il set successivo di compilazioni.

maxBuildsPerDefinition: number

Numero massimo di compilazioni da restituire per definizione.

deletedFilter: QueryDeletedOption

Indica se escludere, includere o restituire solo build eliminate.

queryOrder: BuildQueryOrder

Ordine in cui devono essere restituite le compilazioni.

branchName: string

Se specificato, filtra per compilare i rami compilati che hanno compilato questo ramo.

buildIds: number[]

Elenco delimitato da virgole che specifica gli ID delle compilazioni da recuperare.

repositoryId: string

Se specificato, filtra le compilazioni compilate da questo repository.

repositoryType: string

Se specificato, filtra le compilazioni compilate dai repository di questo tipo.

Restituisce

Promise<PagedList<Build>>

getBuildSettings(string)

Ottiene le impostazioni di compilazione.

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

Parametri

project: string

ID progetto o nome del progetto

Restituisce

Promise<BuildSettings>

getBuildTags(string, number)

Ottiene i tag per una compilazione.

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

Parametri

project: string

ID progetto o nome del progetto

buildId: number

ID della compilazione.

Restituisce

Promise<string[]>

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

Ottiene i dettagli per una compilazione

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

Parametri

project: string

ID progetto o nome del progetto

buildId: number

timelineId: string

changeId: number

planId: string

Restituisce

Promise<Timeline>

getBuildWorkItemsRefs(string, number, number)

Ottiene gli elementi di lavoro associati a una compilazione. Vengono restituiti solo gli elementi di lavoro nello stesso progetto.

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

Parametri

project: string

ID progetto o nome del progetto

buildId: number

ID della compilazione.

top: number

Numero massimo di elementi di lavoro da restituire.

Restituisce

Promise<ResourceRef[]>

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

Ottiene gli elementi di lavoro associati a una compilazione, filtrati in base a commit specifici.

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

Parametri

commitIds: string[]

Elenco delimitato da virgole di ID commit.

project: string

ID progetto o nome del progetto

buildId: number

ID della compilazione.

top: number

Numero massimo di elementi di lavoro da restituire o numero di commit da considerare se non sono specificati ID commit.

Restituisce

Promise<ResourceRef[]>

getChangesBetweenBuilds(string, number, number, number)

Ottiene le modifiche apportate al repository tra due compilazioni date.

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

Parametri

project: string

ID progetto o nome progetto

fromBuildId: number

ID della prima compilazione.

toBuildId: number

ID dell'ultima compilazione.

top: number

Numero massimo di modifiche da restituire.

Restituisce

Promise<Change[]>

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

Ottiene una definizione, facoltativamente in una revisione specifica.

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

Parametri

project: string

ID progetto o nome progetto

definitionId: number

ID della definizione.

revision: number

Numero di revisione da recuperare. Se non viene specificato, verrà restituita la versione più recente.

minMetricsTime: Date

Se specificato, indica la data da cui includere le metriche.

propertyFilters: string[]

Elenco delimitato da virgole delle proprietà da includere nei risultati.

includeLatestBuilds: boolean

Restituisce

Promise<BuildDefinition>

getDefinitionMetrics(string, number, Date)

Ottiene le metriche di compilazione per una definizione.

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

Parametri

project: string

ID progetto o nome progetto

definitionId: number

ID della definizione.

minMetricsTime: Date

Data da cui calcolare le metriche.

Restituisce

Promise<BuildMetric[]>

getDefinitionProperties(string, number, string[])

Ottiene le proprietà per una definizione.

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

Parametri

project: string

ID progetto o nome progetto

definitionId: number

ID della definizione.

filter: string[]

Elenco delimitato da virgole delle proprietà. Se specificato, filtra queste proprietà specifiche.

Restituisce

Promise<any>

getDefinitionResources(string, number)

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

Parametri

project: string

ID progetto o nome progetto

definitionId: number

Restituisce

Promise<DefinitionResourceReference[]>

getDefinitionRevisions(string, number)

Ottiene tutte le revisioni di una definizione.

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

Parametri

project: string

ID progetto o nome progetto

definitionId: number

ID della definizione.

Restituisce

Promise<BuildDefinitionRevision[]>

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

Ottiene un elenco di definizioni.

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

Parametri

project: string

ID progetto o nome progetto

name: string

Se specificato, filtra le definizioni i cui nomi corrispondono a questo modello.

repositoryId: string

ID repository. Se specificato, filtra le definizioni che usano questo repository.

repositoryType: string

Se specificato, filtra le definizioni con un repository di questo tipo.

queryOrder: DefinitionQueryOrder

Indica l'ordine in cui devono essere restituite le definizioni.

top: number

Numero massimo di definizioni da restituire.

continuationToken: string

Token di continuazione restituito da una chiamata precedente a questo metodo, che può essere usato per restituire il set successivo di definizioni.

minMetricsTime: Date

Se specificato, indica la data da cui includere le metriche.

definitionIds: number[]

Elenco delimitato da virgole che specifica gli ID delle definizioni da recuperare.

path: string

Se specificato, filtra le definizioni in questa cartella.

builtAfter: Date

Se specificato, filtra le definizioni che hanno compilazioni dopo questa data.

notBuiltAfter: Date

Se specificato, filtra le definizioni che non hanno compilazioni dopo questa data.

includeAllProperties: boolean

Indica se le definizioni complete devono essere restituite. Per impostazione predefinita, vengono restituite rappresentazioni superficiali delle definizioni.

includeLatestBuilds: boolean

Indica se restituire le build più recenti e completate per questa definizione.

taskIdFilter: string

Se specificato, filtra le definizioni che usano l'attività specificata.

processType: number

Se specificato, filtra le definizioni con il tipo di processo specificato.

yamlFilename: string

Se specificato, filtra le definizioni YAML corrispondenti al nome file specificato. Per usare questo filtro includeAllProperties, deve essere impostato su true

Restituisce

Promise<PagedList<BuildDefinitionReference>>

getDefinitionTags(string, number, number)

Ottiene i tag per una definizione.

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

Parametri

project: string

ID progetto o nome progetto

definitionId: number

ID della definizione.

revision: number

Numero di revisione della definizione. Se non specificato, usa la revisione più recente della definizione.

Restituisce

Promise<string[]>

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

Converte una definizione in YAML, facoltativamente in una revisione specifica.

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

Parametri

project: string

ID progetto o nome progetto

definitionId: number

ID della definizione.

revision: number

Numero di revisione da recuperare. Se non viene specificato, verrà restituita la versione più recente.

minMetricsTime: Date

Se specificato, indica la data da cui includere le metriche.

propertyFilters: string[]

Elenco delimitato da virgole delle proprietà da includere nei risultati.

includeLatestBuilds: boolean

Restituisce

Promise<YamlBuild>

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

Ottiene un file dalla compilazione.

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

Parametri

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

artifactName: string

Nome dell'artefatto.

fileId: string

Chiave primaria per il file.

fileName: string

Nome su cui verrà impostato il file.

Restituisce

Promise<ArrayBuffer>

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

Ottiene il contenuto di un file nel repository del codice sorgente specificato.

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

Parametri

project: string

ID progetto o nome progetto

providerName: string

Nome del provider di origine.

serviceEndpointId: string

Se specificato, l'ID dell'endpoint del servizio da eseguire una query. Può essere omesso solo per i provider che non usano endpoint di servizio, ad esempio TFVC o TFGit.

repository: string

Se specificato, l'identificatore specifico del fornitore o il nome del repository per ottenere rami. Può essere omesso solo per i provider che non supportano più repository.

commitOrBranch: string

Identificatore del commit o del ramo da cui viene recuperato il contenuto di un file.

path: string

Percorso del file da recuperare, rispetto alla radice del repository.

Restituisce

Promise<string>

getFolders(string, string, FolderQueryOrder)

Ottiene un elenco di cartelle di definizione di compilazione.

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

Parametri

project: string

ID progetto o nome progetto

path: string

Percorso da iniziare.

queryOrder: FolderQueryOrder

Ordine in cui devono essere restituite le cartelle.

Restituisce

Promise<Folder[]>

getLatestBuild(string, string, string)

Ottiene la build più recente per una definizione, facoltativamente con ambito in un ramo specifico.

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

Parametri

project: string

ID progetto o nome progetto

definition: string

nome di definizione con percorso di cartella iniziale facoltativo o ID definizione

branchName: string

parametro facoltativo che indica il ramo specifico da usare. Se non specificato, viene usato il ramo predefinito.

Restituisce

Promise<Build>

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

Ottiene il contenuto di una directory nel repository del codice sorgente specificato.

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

Parametri

project: string

ID progetto o nome progetto

providerName: string

Nome del provider di origine.

serviceEndpointId: string

Se specificato, l'ID dell'endpoint del servizio da eseguire una query. Può essere omesso solo per i provider che non usano endpoint di servizio, ad esempio TFVC o TFGit.

repository: string

Se specificato, l'identificatore specifico del fornitore o il nome del repository per ottenere rami. Può essere omesso solo per i provider che non supportano più repository.

commitOrBranch: string

Identificatore del commit o del ramo da cui viene recuperato il contenuto di un file.

path: string

Contenuto del percorso da elencare, rispetto alla radice del repository.

Restituisce

Promise<SourceRepositoryItem[]>

getProjectMetrics(string, string, Date)

Ottiene le metriche di compilazione per un progetto.

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

Parametri

project: string

ID progetto o nome progetto

metricAggregationType: string

Tipo di aggregazione da usare (oraria, giornaliera).

minMetricsTime: Date

Data da cui calcolare le metriche.

Restituisce

Promise<BuildMetric[]>

getProjectResources(string, string, string)

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

Parametri

project: string

ID progetto o nome progetto

type: string

id: string

Restituisce

Promise<DefinitionResourceReference[]>

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

Ottiene un oggetto richiesta pull dal provider di origine.

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

Parametri

project: string

ID progetto o nome progetto

providerName: string

Nome del provider di origine.

pullRequestId: string

ID specifico del fornitore della richiesta pull.

repositoryId: string

Identificatore specifico del fornitore o nome del repository che contiene la richiesta pull.

serviceEndpointId: string

Se specificato, l'ID dell'endpoint di servizio su cui eseguire una query. Può essere omesso solo per i provider che non usano endpoint di servizio, ad esempio TFVC o TFGit.

Restituisce

Promise<PullRequest>

getResourceUsage()

Ottiene informazioni sulla compilazione delle risorse nel sistema.

function getResourceUsage(): Promise<BuildResourceUsage>

Restituisce

Promise<BuildResourceUsage>

getRetentionHistory(number)

Restituisce la cronologia di conservazione per la raccolta di progetti. Sono incluse le pipeline con regole di conservazione personalizzate che potrebbero impedire al processo di conservazione di pulirle, le esecuzioni per pipeline con tipo di conservazione, i file associati alle pipeline di proprietà della raccolta con il tipo di conservazione e il numero di file per pipeline.

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

Parametri

daysToLookback: number

Restituisce

Promise<BuildRetentionHistory>

getRetentionLease(string, number)

Restituisce i dettagli del lease di conservazione in base a un ID lease.

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

Parametri

project: string

ID progetto o nome del progetto

leaseId: number

Restituisce

Promise<RetentionLease>

getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])

Restituisce tutti i lease corrispondenti all'oggetto MinimalRetentionLeases specificato

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

Parametri

project: string

ID progetto o nome del progetto

leasesToFetch: MinimalRetentionLease[]

Elenco di elementi MinimalRetentionLeas serializzati JSON separati da '|'

Restituisce

Promise<RetentionLease[]>

getRetentionLeasesByOwnerId(string, string, number, number)

Restituisce tutti i lease di proprietà dell'entità specificata, facoltativamente con ambito a una singola definizione di pipeline ed esecuzione.

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

Parametri

project: string

ID progetto o nome del progetto

ownerId: string

definitionId: number

Parametro facoltativo per limitare la ricerca a una definizione di pipeline specifica.

runId: number

Parametro facoltativo per limitare la ricerca a una singola esecuzione della pipeline. Richiede definitionId.

Restituisce

Promise<RetentionLease[]>

getRetentionLeasesByUserId(string, string, number, number)

Restituisce tutti i lease di proprietà dell'utente specificato, facoltativamente con ambito a una singola definizione di pipeline ed esecuzione.

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

Parametri

project: string

ID progetto o nome del progetto

userOwnerId: string

ID utente da cercare.

definitionId: number

Parametro facoltativo per limitare la ricerca a una definizione di pipeline specifica.

runId: number

Parametro facoltativo per limitare la ricerca a una singola esecuzione della pipeline. Richiede definitionId.

Restituisce

Promise<RetentionLease[]>

getRetentionLeasesForBuild(string, number)

Ottiene tutti i lease di conservazione applicabili a una compilazione specifica.

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

Parametri

project: string

ID progetto o nome del progetto

buildId: number

ID della compilazione.

Restituisce

Promise<RetentionLease[]>

getRetentionSettings(string)

Ottiene le impostazioni di conservazione del progetto.

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

Parametri

project: string

ID progetto o nome del progetto

Restituisce

Promise<ProjectRetentionSetting>

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

<p>Ottiene lo stato di compilazione per una definizione, con ambito facoltativo per un ramo, una fase, un processo e una configurazione specifici.< /p><p>Se sono presenti più di uno, è necessario passare un valore stageName quando si specifica un jobName e la stessa regola viene quindi applicata per entrambi se si passa un parametro di configurazione.< /P>

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

Parametri

project: string

ID progetto o nome del progetto

definition: string

Nome della definizione con percorso di cartella iniziale facoltativo o ID definizione.

branchName: string

Si consideri solo la build più recente per questo ramo. Se non specificato, viene utilizzato il ramo predefinito.

stageName: string

Usare questa fase all'interno della pipeline per eseguire il rendering dello stato.

jobName: string

Usare questo processo all'interno di una fase della pipeline per eseguire il rendering dello stato.

configuration: string

Usare questa configurazione del processo per eseguire il rendering dello stato

label: string

Sostituisce il testo predefinito sul lato sinistro del badge.

Restituisce

Promise<string>

getTags(string)

Ottiene un elenco di tutti i tag di compilazione nel progetto.

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

Parametri

project: string

ID progetto o nome del progetto

Restituisce

Promise<string[]>

getTemplate(string, string)

Ottiene un modello di definizione di compilazione specifico.

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

Parametri

project: string

ID progetto o nome del progetto

templateId: string

ID del modello richiesto.

Restituisce

Promise<BuildDefinitionTemplate>

getTemplates(string)

Ottiene tutti i modelli di definizione.

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

Parametri

project: string

ID progetto o nome del progetto

Restituisce

Promise<BuildDefinitionTemplate[]>

getWorkItemsBetweenBuilds(string, number, number, number)

Ottiene tutti gli elementi di lavoro tra due compilazioni.

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

Parametri

project: string

ID progetto o nome del progetto

fromBuildId: number

ID della prima compilazione.

toBuildId: number

ID dell'ultima compilazione.

top: number

Numero massimo di elementi di lavoro da restituire.

Restituisce

Promise<ResourceRef[]>

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

Ottiene un elenco di rami per il repository di codice sorgente specificato.

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

Parametri

project: string

ID progetto o nome del progetto

providerName: string

Nome del provider di origine.

serviceEndpointId: string

Se specificato, l'ID dell'endpoint di servizio su cui eseguire una query. Può essere omesso solo per i provider che non usano endpoint di servizio, ad esempio TFVC o TFGit.

repository: string

Identificatore specifico del fornitore o nome del repository per ottenere rami. Può essere omesso solo per i provider che non supportano più repository.

branchName: string

Se specificato, il nome del ramo da verificare in modo specifico.

Restituisce

Promise<string[]>

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

Ottiene un elenco di repository di codice sorgente.

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

Parametri

project: string

ID progetto o nome del progetto

providerName: string

Nome del provider di origine.

serviceEndpointId: string

Se specificato, l'ID dell'endpoint di servizio su cui eseguire una query. Può essere omesso solo per i provider che non usano endpoint di servizio, ad esempio TFVC o TFGit.

repository: string

Se specificato, l'identificatore specifico del fornitore o il nome di un singolo repository da ottenere.

resultSet: ResultSet

'top' per i repository più rilevanti per l'endpoint. Se non impostato, vengono restituiti tutti i repository. Ignorato se 'repository' è impostato.

pageResults: boolean

Se impostato su true, il set di risultati verrà limitato e restituirà un token di continuazione per continuare la query.

continuationToken: string

Quando si esegue il paging dei risultati, si tratta di un token di continuazione, restituito da una chiamata precedente a questo metodo, che può essere usato per restituire il set successivo di repository.

Restituisce

Promise<SourceRepositories>

listSourceProviders(string)

Ottenere un elenco di provider di origine e le relative funzionalità.

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

Parametri

project: string

ID progetto o nome del progetto

Restituisce

Promise<SourceProviderAttributes[]>

listWebhooks(string, string, string, string)

Ottiene un elenco di webhook installati nel repository del codice sorgente specificato.

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

Parametri

project: string

ID progetto o nome del progetto

providerName: string

Nome del provider di origine.

serviceEndpointId: string

Se specificato, l'ID dell'endpoint di servizio su cui eseguire una query. Può essere omesso solo per i provider che non usano endpoint di servizio, ad esempio TFVC o TFGit.

repository: string

Se specificato, l'identificatore specifico del fornitore o il nome del repository per ottenere i webhook. Può essere omesso solo per i provider che non supportano più repository.

Restituisce

Promise<RepositoryWebhook[]>

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

Accoda una compilazione

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

Parametri

build: Build

project: string

ID progetto o nome del progetto

ignoreWarnings: boolean

checkInTicket: string

sourceBuildId: number

definitionId: number

ID definizione facoltativo per accodare una compilazione senza corpo. Ignorato se è presente un corpo valido

Restituisce

Promise<Build>

restoreDefinition(string, number, boolean)

Ripristina una definizione eliminata

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

Parametri

project: string

ID progetto o nome del progetto

definitionId: number

Identificatore della definizione da ripristinare.

deleted: boolean

Se false, ripristina una definizione eliminata.

Restituisce

Promise<BuildDefinition>

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

Ricrea i webhook per i trigger specificati nel repository del codice sorgente specificato.

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

Parametri

triggerTypes: DefinitionTriggerType[]

Tipi di trigger per cui ripristinare i webhook.

project: string

ID progetto o nome del progetto

providerName: string

Nome del provider di origine.

serviceEndpointId: string

Se specificato, l'ID dell'endpoint di servizio su cui eseguire una query. Può essere omesso solo per i provider che non usano endpoint di servizio, ad esempio TFVC o TFGit.

repository: string

Se specificato, l'identificatore specifico del fornitore o il nome del repository per ottenere i webhook. Può essere omesso solo per i provider che non supportano più repository.

Restituisce

Promise<void>

saveTemplate(BuildDefinitionTemplate, string, string)

Aggiornamenti un modello di definizione di compilazione esistente.

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

Parametri

template: BuildDefinitionTemplate

Nuova versione del modello.

project: string

ID progetto o nome del progetto

templateId: string

ID del modello.

Restituisce

Promise<BuildDefinitionTemplate>

updateBuild(Build, string, number, boolean)

Aggiornamenti una compilazione.

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

Parametri

build: Build

Compilazione.

project: string

ID progetto o nome del progetto

buildId: number

ID della compilazione.

retry: boolean

Restituisce

Promise<Build>

updateBuildGeneralSettings(PipelineGeneralSettings, string)

Aggiornamenti impostazioni generali della pipeline.

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

Parametri

newSettings: PipelineGeneralSettings

project: string

ID progetto o nome progetto

Restituisce

Promise<PipelineGeneralSettings>

updateBuildProperties(JsonPatchDocument, string, number)

Aggiornamenti proprietà per una compilazione.

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

Parametri

document: JsonPatchDocument

Documento json-patch che descrive le proprietà da aggiornare.

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

Restituisce

Promise<any>

updateBuilds(Build[], string)

Aggiornamenti più compilazioni.

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

Parametri

builds: Build[]

Compilazioni da aggiornare.

project: string

ID progetto o nome progetto

Restituisce

Promise<Build[]>

updateBuildSettings(BuildSettings, string)

Aggiornamenti le impostazioni di compilazione.

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

Parametri

settings: BuildSettings

Nuove impostazioni.

project: string

ID progetto o nome progetto

Restituisce

Promise<BuildSettings>

updateBuildTags(UpdateTagParameters, string, number)

Aggiunge/Rimuove i tag da una compilazione.

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

Parametri

updateParameters: UpdateTagParameters

Tag da aggiungere/rimuovere.

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

Restituisce

Promise<string[]>

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

Aggiornamenti una definizione di compilazione esistente. Affinché questa operazione abbia esito positivo, il valore della proprietà "Revision" del corpo della richiesta deve corrispondere alla definizione di compilazione esistente. È consigliabile ottenere la definizione di compilazione esistente usando GET, modificare la definizione di compilazione in base alle esigenze e quindi inviare la definizione modificata con PUT.

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

Parametri

definition: BuildDefinition

Nuova versione della definizione. La proprietà "Revision" deve corrispondere alla definizione esistente per l'aggiornamento da accettare.

project: string

ID progetto o nome progetto

definitionId: number

ID della definizione.

secretsSourceDefinitionId: number

secretsSourceDefinitionRevision: number

Restituisce

Promise<BuildDefinition>

updateDefinitionProperties(JsonPatchDocument, string, number)

Aggiornamenti proprietà per una definizione.

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

Parametri

document: JsonPatchDocument

Documento json-patch che descrive le proprietà da aggiornare.

project: string

ID progetto o nome progetto

definitionId: number

ID della definizione.

Restituisce

Promise<any>

updateDefinitionTags(UpdateTagParameters, string, number)

Aggiunge/Rimuove i tag da una definizione.

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

Parametri

updateParameters: UpdateTagParameters

Tag da aggiungere/rimuovere.

project: string

ID progetto o nome progetto

definitionId: number

ID della definizione.

Restituisce

Promise<string[]>

updateFolder(Folder, string, string)

Aggiornamenti una cartella esistente nel percorso esistente

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

Parametri

folder: Folder

Nuova versione della cartella.

project: string

ID progetto o nome progetto

path: string

Percorso completo della cartella.

Restituisce

Promise<Folder>

updateRetentionLease(RetentionLeaseUpdate, string, number)

Aggiornamenti la durata o lo stato di protezione della pipeline di un lease di conservazione.

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

Parametri

leaseUpdate: RetentionLeaseUpdate

Nuovi dati per il lease di conservazione.

project: string

ID progetto o nome progetto

leaseId: number

ID del lease da aggiornare.

Restituisce

Promise<RetentionLease>

updateRetentionSettings(UpdateProjectRetentionSettingModel, string)

Aggiornamenti le impostazioni di conservazione del progetto.

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

Parametri

updateModel: UpdateProjectRetentionSettingModel

project: string

ID progetto o nome progetto

Restituisce

Promise<ProjectRetentionSetting>

updateStage(UpdateStageParameters, number, string, string)

Aggiornare una fase di compilazione

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

Parametri

updateParameters: UpdateStageParameters

buildId: number

stageRefName: string

project: string

ID progetto o nome progetto

Restituisce

Promise<void>

Condividi tramite

BuildRestClient class

Costruttori

Proprietà

Metodi

Dettagli costruttore

BuildRestClient(IVssRestClientOptions)

Parametri

Dettagli proprietà

RESOURCE_AREA_ID

Valore della proprietà

Dettagli metodo

addBuildTag(string, number, string)

Parametri

Restituisce

addBuildTags(string[], string, number)

Parametri

Restituisce

addDefinitionTag(string, number, string)

Parametri

Restituisce

addDefinitionTags(string[], string, number)

Parametri

Restituisce

addRetentionLeases(NewRetentionLease[], string)

Parametri

Restituisce

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

Parametri

Restituisce

authorizeProjectResources(DefinitionResourceReference[], string)

Parametri

Restituisce

createArtifact(BuildArtifact, string, number)

Parametri

Restituisce

createDefinition(BuildDefinition, string, number, number)

Parametri

Restituisce

createFolder(Folder, string, string)

Parametri

Restituisce

deleteBuild(string, number)

Parametri

Restituisce

deleteBuildTag(string, number, string)

Parametri

Restituisce

deleteDefinition(string, number)

Parametri

Restituisce

deleteDefinitionTag(string, number, string)

Parametri

Restituisce

deleteFolder(string, string)

Parametri

Restituisce

deleteRetentionLeasesById(string, number[])

Parametri

Restituisce

deleteTag(string, string)

Parametri

Restituisce

deleteTemplate(string, string)

Parametri

Restituisce

getArtifact(string, number, string)

Parametri

Restituisce

getArtifactContentZip(string, number, string)

Parametri

Restituisce

getArtifacts(string, number)

Parametri

Restituisce

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

Parametri

Restituisce

getAttachments(string, number, string)

Parametri