BuildRestClient class

Classe di base da usare (derivata da) per effettuare richieste alle API REST vss

Costruttori

Proprietà

Metodi

addBuildTag(string, number, string)	Aggiunge un tag a una build.
addBuildTags(string[], string, number)	Aggiunge tag a una build.
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 contratti di locazione per le rotte di gasdotti.
authorizeDefinitionResources(DefinitionResourceReference[], string, number)
authorizeProjectResources(DefinitionResourceReference[], string)
createArtifact(BuildArtifact, string, number)	Associa un artefatto a una build.
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 build. NOTA: Questa API non funziona per tag con caratteri speciali. Per rimuovere tag con caratteri speciali, usa invece il metodo PATCH (nella versione 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 funziona per tag con caratteri speciali. Per rimuovere tag con caratteri speciali, usa invece il metodo PATCH (nella versione 6.0+)
deleteFolder(string, string)	Elimina una cartella delle definizioni. Anche le definizioni e le relative build verranno eliminate.
deleteRetentionLeasesById(string, number[])	Rimuove contratti di locazione specifici.
deleteTag(string, string)	Rimuove un tag dalle build, dalle definizioni e dal negozio di tag
deleteTemplate(string, string)	Elimina un template di definizione di build.
getArtifact(string, number, string)	Ottiene un artefatto specifico per una build.
getArtifactContentZip(string, number, string)	Ottiene un artefatto specifico per una build.
getArtifacts(string, number)	Ottiene tutti gli artefatti per una build.
getAttachment(string, number, string, string, string, string)	Ottiene un attaccamento specifico.
getAttachments(string, number, string)	Ottiene la lista degli accessori di un tipo specifico associati a una build.
getBadge(string, number, string)	Riceve un badge che indica lo stato della build più recente per una definizione. Nota che questa API è obsoleta. Preferisci StatusBadgeController.GetStatusBadge.
getBuild(string, number, string)	Ottiene una compilazione
getBuildBadge(string, string, string, string)	Riceve un badge che indica lo stato della build più recente per il ramo specificato.
getBuildBadgeData(string, string, string, string)	Riceve un badge che indica lo stato della build più recente per il ramo specificato.
getBuildChanges(string, number, string, number, boolean)	Ottiene i cambiamenti associati a una build
getBuildController(number)	Prende un controller
getBuildControllers(string)	Ottiene il controller, opzionalmente filtrato per nome
getBuildGeneralSettings(string)	Ottiene le impostazioni generali della pipeline.
getBuildLog(string, number, number, number, number)	Riceve un singolo file di log per una build.
getBuildLogLines(string, number, number, number, number)	Riceve un singolo file di log per una build.
getBuildLogs(string, number)	Ottiene i log per una build.
getBuildLogsZip(string, number)	Ottiene i log per una build.
getBuildLogZip(string, number, number, number, number)	Riceve un singolo file di log per una build.
getBuildOptionDefinitions(string)	Riceve tutte le opzioni di definizione delle build supportate dal sistema.
getBuildProperties(string, number, string[])	Ottiene proprietà per una build.
getBuildReport(string, number, string)	Riceve un rapporto di build.
getBuildReportHtmlContent(string, number, string)	Riceve un rapporto di build.
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 build.
getBuildStageLatestTimeline(string, number, string, number, string)	Ottiene la sequenza temporale più recente per una compilazione filtrata in base a una fase specifica.
getBuildStageTimeline(string, number, string, string, number, string)	Ottiene la sequenza temporale per una compilazione filtrata in una fase specifica.
getBuildTags(string, number)	Ottiene i tag per una build.
getBuildTimeline(string, number, string, number, string)	Ottiene i dettagli per una build
getBuildWorkItemsRefs(string, number, number)	Ottiene gli oggetti di lavoro associati a una build. Solo gli oggetti di lavoro dello stesso progetto vengono restituiti.
getBuildWorkItemsRefsFromCommits(string[], string, number, number)	Ottiene gli elementi di lavoro associati a una build, filtrati in commit specifici.
getChangesBetweenBuilds(string, number, number, number)	Riceve le modifiche apportate al repository tra due build date.
getDefinition(string, number, number, Date, string[], boolean)	Ottiene una definizione, facoltativamente in una revisione specifica.
getDefinitionMetrics(string, number, Date)	Ottiene le metriche build per una definizione.
getDefinitionProperties(string, number, string[])	Ottiene proprietà per una definizione.
getDefinitionResources(string, number)
getDefinitionRevisions(string, number)	Riceve 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, opzionalmente a una specifica revisione.
getFile(string, number, string, string, string)	Riceve un file dalla build.
getFileContents(string, string, string, string, string, string)	Ottiene il contenuto di un file nel repository del codice sorgente indicato.
getFolders(string, string, FolderQueryOrder)	Ottiene una lista delle cartelle delle definizioni di build.
getLatestBuild(string, string, string)	Ottiene la build più recente per una definizione, con ambito facoltativo per un ramo specifico.
getPathContents(string, string, string, string, string, string)	Ottiene il contenuto di una directory nel repository del codice sorgente indicato.
getProjectMetrics(string, string, Date)	Ottiene le metriche di build per un progetto.
getProjectResources(string, string, string)
getPullRequest(string, string, string, string, string)	Riceve un oggetto pull request dal fornitore di origine.
getResourceUsage()	Ottiene informazioni sulle risorse di build nel sistema.
getRetentionHistory(number)	Restituisce la cronologia di conservazione della collezione del progetto. Questo include pipeline con regole di retention personalizzate che possono impedire al lavoro di retention di ripulire, run per pipeline con tipo di retention, file associati alle pipeline di proprietà della collezione con tipo di retention e il numero di file per pipeline.
getRetentionLease(string, number)	Restituisce i dettagli del contratto di locazione con un ID del contratto di locazione.
getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])	Restituisce eventuali locazioni che corrispondono ai MinimalRetentionLeasing specificati
getRetentionLeasesByOwnerId(string, string, number, number)	Restituisce eventuali locazioni di proprietà dell'entità specificata, opzionalmente con ambito di una singola definizione e esecuzione di pipeline.
getRetentionLeasesByUserId(string, string, number, number)	Restituisce eventuali locazioni possedute dall'utente specificato, opzionalmente con ambito di definizione e esecuzione di pipeline.
getRetentionLeasesForBuild(string, number)	Ottiene tutti i contratti di retention che si applicano a una specifica costruzione.
getRetentionSettings(string)	Ottiene le impostazioni di conservazione del progetto.
getStatusBadge(string, string, string, string, string, string, string)	<p>Ottiene lo stato di build per una definizione, opzionalmente scalizzato a un ramo, stadio, lavoro e configurazione specifici.</p><p>Se ce ne sono più di uno, allora è necessario inserire un valore stageName quando si specifica un jobName, e la stessa regola si applica per entrambi se si passa un parametro di configurazione.</p>
getTags(string)	Riceve una lista di tutti i tag build del 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 oggetti di lavoro tra due build.
listBranches(string, string, string, string, string)	Ottiene un elenco dei branch per il repository del codice sorgente fornito.
listRepositories(string, string, string, string, ResultSet, boolean, string)	Ottiene una lista di repository del codice sorgente.
listSourceProviders(string)	Ottieni un elenco dei fornitori di sorgente e delle loro capacità.
listWebhooks(string, string, string, string)	Ottiene un elenco di webhook installati nel repository di 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)	Aggiorna un modello di definizione di compilazione esistente.
updateBuild(Build, string, number, boolean)	Aggiorna una compilazione.
updateBuildGeneralSettings(PipelineGeneralSettings, string)	Aggiorna le impostazioni generali della pipeline.
updateBuildProperties(JsonPatchDocument, string, number)	Aggiorna le proprietà di una build.
updateBuilds(Build[], string)	Aggiorna più compilazioni.
updateBuildSettings(BuildSettings, string)	Aggiorna le impostazioni di build.
updateBuildTags(UpdateTagParameters, string, number)	Aggiunge/Rimuove tag da una build.
updateDefinition(BuildDefinition, string, number, number, number, boolean)	Aggiorna una definizione di compilazione esistente. Affinché l'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)	Aggiorna le proprietà per una definizione.
updateDefinitionTags(UpdateTagParameters, string, number)	Aggiunge/Rimuove tag da una definizione.
updateFolder(Folder, string, string)	Aggiorna una cartella esistente al percorso esistente dato
updateRetentionLease(RetentionLeaseUpdate, string, number)	Aggiorna la durata o lo stato di protezione del gasdotto di un contratto di locazione di mantenimento.
updateRetentionSettings(UpdateProjectRetentionSettingModel, string)	Aggiorna le impostazioni di conservazione del progetto.
updateStage(UpdateStageParameters, number, string, string)	Aggiornare uno stadio di compilazione

BuildRestClient(IVssRestClientOptions)

new BuildRestClient(options: IVssRestClientOptions)

Parametri

options: IVssRestClientOptions

RESOURCE_AREA_ID

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

Valore della proprietà

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

addBuildTag(string, number, string)

Aggiunge un tag a una build.

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

Il tag da aggiungere.

Valori restituiti

Promise<string[]>

addBuildTags(string[], string, number)

Aggiunge tag a una build.

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

Parametri

tags: string[]

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

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

Valori restituiti

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

Il tag da aggiungere.

Valori restituiti

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

I tag da aggiungere.

project: string

ID progetto o nome progetto

definitionId: number

ID della definizione.

Valori restituiti

Promise<string[]>

addRetentionLeases(NewRetentionLease[], string)

Aggiunge nuovi contratti di locazione per le rotte di gasdotti.

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

Parametri

newLeases: NewRetentionLease[]

project: string

ID progetto o nome progetto

Valori restituiti

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

Valori restituiti

Promise<DefinitionResourceReference[]>

authorizeProjectResources(DefinitionResourceReference[], string)

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

Parametri

resources: DefinitionResourceReference[]

project: string

ID progetto o nome progetto

Valori restituiti

Promise<DefinitionResourceReference[]>

createArtifact(BuildArtifact, string, number)

Associa un artefatto a una build.

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

Parametri

artifact: BuildArtifact

L'artefatto.

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

Valori restituiti

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

Valori restituiti

Promise<BuildDefinition>

createFolder(Folder, string, string)

Crea una nuova cartella.

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

Parametri

folder: Folder

La cartella.

project: string

ID progetto o nome progetto

path: string

Il percorso completo della cartella.

Valori restituiti

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.

Valori restituiti

Promise<void>

deleteBuildTag(string, number, string)

Rimuove un tag da una build. NOTA: Questa API non funziona per tag con caratteri speciali. Per rimuovere tag con caratteri speciali, usa invece il metodo PATCH (nella versione 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

Il tag da rimuovere.

Valori restituiti

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.

Valori restituiti

Promise<void>

deleteDefinitionTag(string, number, string)

Rimuove un tag da una definizione. NOTA: Questa API non funziona per tag con caratteri speciali. Per rimuovere tag con caratteri speciali, usa invece il metodo PATCH (nella versione 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

Il tag da rimuovere.

Valori restituiti

Promise<string[]>

deleteFolder(string, string)

Elimina una cartella delle definizioni. Anche le definizioni e le relative build verranno eliminate.

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

Parametri

project: string

ID progetto o nome progetto

path: string

Percorso completo della cartella.

Valori restituiti

Promise<void>

deleteRetentionLeasesById(string, number[])

Rimuove contratti di locazione specifici.

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

Parametri

project: string

ID progetto o nome progetto

ids: number[]

Valori restituiti

Promise<void>

deleteTag(string, string)

Rimuove un tag dalle build, dalle definizioni e dal negozio di tag

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

Parametri

project: string

ID progetto o nome progetto

tag: string

Il tag da rimuovere.

Valori restituiti

Promise<string[]>

deleteTemplate(string, string)

Elimina un template di definizione di build.

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

Parametri

project: string

ID progetto o nome progetto

templateId: string

ID del modello.

Valori restituiti

Promise<void>

getArtifact(string, number, string)

Ottiene un artefatto specifico per una build.

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.

Valori restituiti

Promise<BuildArtifact>

getArtifactContentZip(string, number, string)

Ottiene un artefatto specifico per una build.

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.

Valori restituiti

Promise<ArrayBuffer>

getArtifacts(string, number)

Ottiene tutti gli artefatti per una build.

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

Parametri

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

Valori restituiti

Promise<BuildArtifact[]>

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

Ottiene un attaccamento 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

L'ID della sequenza temporale.

recordId: string

L'ID del registro della linea temporale.

type: string

Il tipo di attaccamento.

name: string

Nome dell'allegato.

Valori restituiti

Promise<ArrayBuffer>

getAttachments(string, number, string)

Ottiene la lista degli accessori di un tipo specifico associati a una build.

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

Valori restituiti

Promise<Attachment[]>

getBadge(string, number, string)

Riceve un badge che indica lo stato della build più recente per una definizione. Nota che questa API è obsoleta. Preferisci StatusBadgeController.GetStatusBadge.

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

Parametri

project: string

L'ID del progetto o il nome.

definitionId: number

ID della definizione.

branchName: string

Nome del ramo.

Valori restituiti

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 progetto

buildId: number

propertyFilters: string

Valori restituiti

Promise<Build>

getBuildBadge(string, string, string, string)

Riceve un badge 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 progetto

repoType: string

Il tipo di repository.

repoId: string

L'ID del repository.

branchName: string

Nome del ramo.

Valori restituiti

Promise<BuildBadge>

getBuildBadgeData(string, string, string, string)

Riceve un badge 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 progetto

repoType: string

Il tipo di repository.

repoId: string

L'ID del repository.

branchName: string

Nome del ramo.

Valori restituiti

Promise<string>

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

Ottiene i cambiamenti associati a una build

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

Parametri

project: string

ID progetto o nome progetto

buildId: number

continuationToken: string

top: number

Il numero massimo di modifiche da restituire

includeSourceChange: boolean

Valori restituiti

Promise<PagedList<Change>>

getBuildController(number)

Prende un controller

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

Parametri

controllerId: number

Valori restituiti

Promise<BuildController>

getBuildControllers(string)

Ottiene il controller, opzionalmente filtrato per nome

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

Parametri

name: string

Valori restituiti

Promise<BuildController[]>

getBuildGeneralSettings(string)

Ottiene le impostazioni generali della pipeline.

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

Parametri

project: string

ID progetto o nome progetto

Valori restituiti

Promise<PipelineGeneralSettings>

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

Riceve un singolo file di log per una build.

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

Parametri

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

logId: number

L'ID del file di registro.

startLine: number

La linea di partenza.

endLine: number

La linea finale.

Valori restituiti

Promise<string>

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

Riceve un singolo file di log per una build.

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

Parametri

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

logId: number

L'ID del file di registro.

startLine: number

La linea di partenza.

endLine: number

La linea finale.

Valori restituiti

Promise<string[]>

getBuildLogs(string, number)

Ottiene i log per una build.

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

Parametri

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

Valori restituiti

Promise<BuildLog[]>

getBuildLogsZip(string, number)

Ottiene i log per una build.

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

Parametri

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

Valori restituiti

Promise<ArrayBuffer>

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

Riceve un singolo file di log per una build.

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

Parametri

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

logId: number

L'ID del file di registro.

startLine: number

La linea di partenza.

endLine: number

La linea finale.

Valori restituiti

Promise<ArrayBuffer>

getBuildOptionDefinitions(string)

Riceve tutte le opzioni di definizione delle build supportate dal sistema.

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

Parametri

project: string

ID progetto o nome progetto

Valori restituiti

Promise<BuildOptionDefinition[]>

getBuildProperties(string, number, string[])

Ottiene proprietà per una build.

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

Parametri

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

filter: string[]

Un elenco delimitato da virgole di proprietà. Se specificato, filtra su queste proprietà specifiche.

Valori restituiti

Promise<any>

getBuildReport(string, number, string)

Riceve un rapporto di build.

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

Parametri

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

type: string

Valori restituiti

Promise<BuildReportMetadata>

getBuildReportHtmlContent(string, number, string)

Riceve un rapporto di build.

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

Parametri

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

type: string

Valori restituiti

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 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 con 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, filtra le compilazioni corrispondenti a questo motivo.

statusFilter: BuildStatus

Se specificato, filtra per la compilazione 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 compilazioni 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.

Valori restituiti

Promise<PagedList<Build>>

getBuildSettings(string)

Ottiene le impostazioni di build.

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

Parametri

project: string

ID progetto o nome progetto

Valori restituiti

Promise<BuildSettings>

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

Ottiene la sequenza temporale più recente per una compilazione filtrata in base a una fase specifica.

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

Parametri

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

stageName: string

Nome della fase in base a cui filtrare.

changeId: number

ID di modifica in base al quale filtrare.

planId: string

ID del piano.

Valori restituiti

Promise<Timeline>

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

Ottiene la sequenza temporale per una compilazione filtrata in una fase specifica.

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

Parametri

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

timelineId: string

L'ID della sequenza temporale.

stageName: string

Nome della fase in base a cui filtrare.

changeId: number

ID di modifica in base al quale filtrare.

planId: string

ID del piano.

Valori restituiti

Promise<Timeline>

getBuildTags(string, number)

Ottiene i tag per una build.

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

Parametri

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

Valori restituiti

Promise<string[]>

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

Ottiene i dettagli per una build

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

Parametri

project: string

ID progetto o nome progetto

buildId: number

timelineId: string

changeId: number

planId: string

Valori restituiti

Promise<Timeline>

getBuildWorkItemsRefs(string, number, number)

Ottiene gli oggetti di lavoro associati a una build. Solo gli oggetti di lavoro dello stesso progetto vengono restituiti.

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

Parametri

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

top: number

Il numero massimo di lavori da restituire.

Valori restituiti

Promise<ResourceRef[]>

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

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

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

Parametri

commitIds: string[]

Una lista delimitata da virgole di ID di commit.

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

top: number

Il numero massimo di elementi di lavoro da restituire, o il numero di commit da considerare se non vengono specificati ID di commit.

Valori restituiti

Promise<ResourceRef[]>

getChangesBetweenBuilds(string, number, number, number)

Riceve le modifiche apportate al repository tra due build date.

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

Parametri

project: string

ID progetto o nome progetto

fromBuildId: number

L'ID della prima build.

toBuildId: number

L'ID dell'ultima build.

top: number

Numero massimo di modifiche da restituire.

Valori restituiti

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 di proprietà da includere nei risultati.

includeLatestBuilds: boolean

Valori restituiti

Promise<BuildDefinition>

getDefinitionMetrics(string, number, Date)

Ottiene le metriche build 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

La data da cui calcolare le metriche.

Valori restituiti

Promise<BuildMetric[]>

getDefinitionProperties(string, number, string[])

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

Un elenco delimitato da virgole di proprietà. Se specificato, filtra su queste proprietà specifiche.

Valori restituiti

Promise<any>

getDefinitionResources(string, number)

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

Parametri

project: string

ID progetto o nome progetto

definitionId: number

Valori restituiti

Promise<DefinitionResourceReference[]>

getDefinitionRevisions(string, number)

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

Valori restituiti

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 del 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 con compilazioni successive a questa data.

notBuiltAfter: Date

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

includeAllProperties: boolean

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

includeLatestBuilds: boolean

Indica se restituire le build completate più recenti e più recenti 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 che corrispondono al nome file specificato. Per usare questo filtro includeAllProperties deve essere impostato su true

Valori restituiti

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, utilizza l'ultima revisione della definizione.

Valori restituiti

Promise<string[]>

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

Converte una definizione in YAML, opzionalmente a una specifica revisione.

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 di proprietà da includere nei risultati.

includeLatestBuilds: boolean

Valori restituiti

Promise<YamlBuild>

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

Riceve un file dalla build.

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

La chiave primaria del file.

fileName: string

Il nome a cui sarà impostato il file.

Valori restituiti

Promise<ArrayBuffer>

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

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

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 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 branch. Può essere omesso solo per i provider che non supportano più repository.

commitOrBranch: string

L'identificatore del commit o del branch da cui viene recuperato il contenuto di un file.

path: string

Il percorso verso il file da recuperare, rispetto alla radice del repository.

Valori restituiti

Promise<string>

getFolders(string, string, FolderQueryOrder)

Ottiene una lista delle cartelle delle definizioni di build.

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

Parametri

project: string

ID progetto o nome progetto

path: string

La strada da cui iniziare.

queryOrder: FolderQueryOrder

L'ordine in cui le cartelle devono essere restituite.

Valori restituiti

Promise<Folder[]>

getLatestBuild(string, string, string)

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

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

Parametri

project: string

ID progetto o nome progetto

definition: string

nome della 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 utilizzato il ramo predefinito.

Valori restituiti

Promise<Build>

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

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

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 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 branch. Può essere omesso solo per i provider che non supportano più repository.

commitOrBranch: string

L'identificatore del commit o del branch da cui viene recuperato il contenuto di un file.

path: string

Il contenuto del percorso da elencare rispetto alla radice del repository.

Valori restituiti

Promise<SourceRepositoryItem[]>

getProjectMetrics(string, string, Date)

Ottiene le metriche di build per un progetto.

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

Parametri

project: string

ID progetto o nome progetto

metricAggregationType: string

Il tipo di aggregazione da utilizzare (orario, giornaliero).

minMetricsTime: Date

La data da cui calcolare le metriche.

Valori restituiti

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

Valori restituiti

Promise<DefinitionResourceReference[]>

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

Riceve un oggetto pull request dal fornitore 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 pull request.

repositoryId: string

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

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.

Valori restituiti

Promise<PullRequest>

getResourceUsage()

Ottiene informazioni sulle risorse di build nel sistema.

function getResourceUsage(): Promise<BuildResourceUsage>

Valori restituiti

Promise<BuildResourceUsage>

getRetentionHistory(number)

Restituisce la cronologia di conservazione della collezione del progetto. Questo include pipeline con regole di retention personalizzate che possono impedire al lavoro di retention di ripulire, run per pipeline con tipo di retention, file associati alle pipeline di proprietà della collezione con tipo di retention e il numero di file per pipeline.

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

Parametri

daysToLookback: number

Valori restituiti

Promise<BuildRetentionHistory>

getRetentionLease(string, number)

Restituisce i dettagli del contratto di locazione con un ID del contratto di locazione.

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

Parametri

project: string

ID progetto o nome progetto

leaseId: number

Valori restituiti

Promise<RetentionLease>

getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])

Restituisce eventuali locazioni che corrispondono ai MinimalRetentionLeasing specificati

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

Parametri

project: string

ID progetto o nome progetto

leasesToFetch: MinimalRetentionLease[]

Elenco dei MinimalRetentionLeases serializzati in JSON separati da '|'

Valori restituiti

Promise<RetentionLease[]>

getRetentionLeasesByOwnerId(string, string, number, number)

Restituisce eventuali locazioni di proprietà dell'entità specificata, opzionalmente con ambito di una singola definizione e esecuzione di pipeline.

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

Parametri

project: string

ID progetto o nome progetto

ownerId: string

definitionId: number

Un parametro opzionale per limitare la ricerca a una specifica definizione di pipeline.

runId: number

Un parametro opzionale per limitare la ricerca a una singola esecuzione di pipeline. Richiede definitionId.

Valori restituiti

Promise<RetentionLease[]>

getRetentionLeasesByUserId(string, string, number, number)

Restituisce eventuali locazioni possedute dall'utente specificato, opzionalmente con ambito di definizione e esecuzione di pipeline.

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

Parametri

project: string

ID progetto o nome progetto

userOwnerId: string

L'ID utente da cercare.

definitionId: number

Un parametro opzionale per limitare la ricerca a una specifica definizione di pipeline.

runId: number

Un parametro opzionale per limitare la ricerca a una singola esecuzione di pipeline. Richiede definitionId.

Valori restituiti

Promise<RetentionLease[]>

getRetentionLeasesForBuild(string, number)

Ottiene tutti i contratti di retention che si applicano a una specifica costruzione.

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

Parametri

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

Valori restituiti

Promise<RetentionLease[]>

getRetentionSettings(string)

Ottiene le impostazioni di conservazione del progetto.

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

Parametri

project: string

ID progetto o nome progetto

Valori restituiti

Promise<ProjectRetentionSetting>

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

<p>Ottiene lo stato di build per una definizione, opzionalmente scalizzato a un ramo, stadio, lavoro e configurazione specifici.</p><p>Se ce ne sono più di uno, allora è necessario inserire un valore stageName quando si specifica un jobName, e la stessa regola si applica 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 progetto

definition: string

O il nome della definizione con il percorso opzionale della cartella iniziale, oppure l'id della definizione.

branchName: string

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

stageName: string

Usa questa fase all'interno della pipeline per visualizzare lo stato.

jobName: string

Usa questo lavoro all'interno di una fase della pipeline per visualizzare lo stato.

configuration: string

Usa questa configurazione del lavoro per renderizzare lo stato

label: string

Sostituisce il testo predefinito sul lato sinistro del badge.

Valori restituiti

Promise<string>

getTags(string)

Riceve una lista di tutti i tag build del progetto.

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

Parametri

project: string

ID progetto o nome progetto

Valori restituiti

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 progetto

templateId: string

ID del modello richiesto.

Valori restituiti

Promise<BuildDefinitionTemplate>

getTemplates(string)

Ottiene tutti i modelli di definizione.

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

Parametri

project: string

ID progetto o nome progetto

Valori restituiti

Promise<BuildDefinitionTemplate[]>

getWorkItemsBetweenBuilds(string, number, number, number)

Ottiene tutti gli oggetti di lavoro tra due build.

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

Parametri

project: string

ID progetto o nome progetto

fromBuildId: number

L'ID della prima build.

toBuildId: number

L'ID dell'ultima build.

top: number

Il numero massimo di lavori da restituire.

Valori restituiti

Promise<ResourceRef[]>

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

Ottiene un elenco dei branch per il repository del codice sorgente fornito.

function listBranches(project: string, providerName: string, serviceEndpointId?: string, repository?: string, branchName?: 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 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

L'identificatore specifico del fornitore o il nome del repository per ottenere i branch. Può essere omesso solo per i provider che non supportano più repository.

branchName: string

Se fornito, il nome della filiale da controllare specificamente.

Valori restituiti

Promise<string[]>

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

Ottiene una lista di repository del 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 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, tutti i repository vengono restituiti. Ignorato se 'repository' è impostato.

pageResults: boolean

Se impostato su vero, questo limiterà l'insieme dei risultati e restituirà un token di continuazione per continuare la query.

continuationToken: string

Quando si verifica il paging, questo è un token di continuazione, restituito da una chiamata precedente a questo metodo, che può essere usato per restituire il successivo insieme di repository.

Valori restituiti

Promise<SourceRepositories>

listSourceProviders(string)

Ottieni un elenco dei fornitori di sorgente e delle loro capacità.

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

Parametri

project: string

ID progetto o nome progetto

Valori restituiti

Promise<SourceProviderAttributes[]>

listWebhooks(string, string, string, string)

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

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

Parametri

project: string

ID progetto o nome 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.

Valori restituiti

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 progetto

ignoreWarnings: boolean

checkInTicket: string

sourceBuildId: number

definitionId: number

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

Valori restituiti

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 progetto

definitionId: number

Identificatore della definizione da ripristinare.

deleted: boolean

Se false, ripristina una definizione eliminata.

Valori restituiti

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

I tipi di trigger per ripristinare i webhook.

project: string

ID progetto o nome 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.

Valori restituiti

Promise<void>

saveTemplate(BuildDefinitionTemplate, string, string)

Aggiorna un modello di definizione di compilazione esistente.

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

Parametri

template: BuildDefinitionTemplate

La nuova versione del modello.

project: string

ID progetto o nome progetto

templateId: string

ID del modello.

Valori restituiti

Promise<BuildDefinitionTemplate>

updateBuild(Build, string, number, boolean)

Aggiorna una compilazione.

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

Parametri

build: Build

Compilazione.

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

retry: boolean

Valori restituiti

Promise<Build>

updateBuildGeneralSettings(PipelineGeneralSettings, string)

Aggiorna le impostazioni generali della pipeline.

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

Parametri

newSettings: PipelineGeneralSettings

project: string

ID progetto o nome progetto

Valori restituiti

Promise<PipelineGeneralSettings>

updateBuildProperties(JsonPatchDocument, string, number)

Aggiorna le proprietà di una build.

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

Parametri

document: JsonPatchDocument

Un documento json-patch che descrive le proprietà da aggiornare.

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

Valori restituiti

Promise<any>

updateBuilds(Build[], string)

Aggiorna più compilazioni.

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

Parametri

builds: Build[]

Compilazioni da aggiornare.

project: string

ID progetto o nome progetto

Valori restituiti

Promise<Build[]>

updateBuildSettings(BuildSettings, string)

Aggiorna le impostazioni di build.

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

Parametri

settings: BuildSettings

Le nuove impostazioni.

project: string

ID progetto o nome progetto

Valori restituiti

Promise<BuildSettings>

updateBuildTags(UpdateTagParameters, string, number)

Aggiunge/Rimuove tag da una build.

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

Parametri

updateParameters: UpdateTagParameters

I tag da aggiungere/rimuovere.

project: string

ID progetto o nome progetto

buildId: number

ID della compilazione.

Valori restituiti

Promise<string[]>

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

Aggiorna una definizione di compilazione esistente. Affinché l'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, cancelPausedBuilds?: boolean): Promise<BuildDefinition>

Parametri

definition: BuildDefinition

La nuova versione della definizione. La sua proprietà "Revision" deve corrispondere alla definizione esistente affinché l'aggiornamento venga accettato.

project: string

ID progetto o nome progetto

definitionId: number

ID della definizione.

secretsSourceDefinitionId: number

ID facoltativo della definizione da usare come origine per i segreti.

secretsSourceDefinitionRevision: number

Revisione facoltativa della definizione dell'origine dei segreti.

cancelPausedBuilds: boolean

Se true, annulla le compilazioni sospese quando la pipeline viene abilitata da uno stato sospeso o disabilitato.

Valori restituiti

Promise<BuildDefinition>

updateDefinitionProperties(JsonPatchDocument, string, number)

Aggiorna le proprietà per una definizione.

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

Parametri

document: JsonPatchDocument

Un documento json-patch che descrive le proprietà da aggiornare.

project: string

ID progetto o nome progetto

definitionId: number

ID della definizione.

Valori restituiti

Promise<any>

updateDefinitionTags(UpdateTagParameters, string, number)

Aggiunge/Rimuove tag da una definizione.

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

Parametri

updateParameters: UpdateTagParameters

I tag da aggiungere/rimuovere.

project: string

ID progetto o nome progetto

definitionId: number

ID della definizione.

Valori restituiti

Promise<string[]>

updateFolder(Folder, string, string)

Aggiorna una cartella esistente al percorso esistente dato

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

Parametri

folder: Folder

La nuova versione della cartella.

project: string

ID progetto o nome progetto

path: string

Percorso completo della cartella.

Valori restituiti

Promise<Folder>

updateRetentionLease(RetentionLeaseUpdate, string, number)

Aggiorna la durata o lo stato di protezione del gasdotto di un contratto di locazione di mantenimento.

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

Parametri

leaseUpdate: RetentionLeaseUpdate

I nuovi dati per il contratto di locazione di conservazione.

project: string

ID progetto o nome progetto

leaseId: number

L'ID del contratto di locazione da aggiornare.

Valori restituiti

Promise<RetentionLease>

updateRetentionSettings(UpdateProjectRetentionSettingModel, string)

Aggiorna le impostazioni di conservazione del progetto.

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

Parametri

updateModel: UpdateProjectRetentionSettingModel

project: string

ID progetto o nome progetto

Valori restituiti

Promise<ProjectRetentionSetting>

updateStage(UpdateStageParameters, number, string, string)

Aggiornare uno stadio 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

Valori restituiti

Promise<void>

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

Valori restituiti

addBuildTags(string[], string, number)

Parametri

Valori restituiti

addDefinitionTag(string, number, string)

Parametri

Valori restituiti

addDefinitionTags(string[], string, number)

Parametri

Valori restituiti

addRetentionLeases(NewRetentionLease[], string)

Parametri

Valori restituiti

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

Parametri

Valori restituiti

authorizeProjectResources(DefinitionResourceReference[], string)

Parametri

Valori restituiti

createArtifact(BuildArtifact, string, number)

Parametri

Valori restituiti

createDefinition(BuildDefinition, string, number, number)

Parametri

Valori restituiti

createFolder(Folder, string, string)

Parametri

Valori restituiti

deleteBuild(string, number)

Parametri

Valori restituiti

deleteBuildTag(string, number, string)

Parametri

Valori restituiti

deleteDefinition(string, number)

Parametri

Valori restituiti

deleteDefinitionTag(string, number, string)

Parametri

Valori restituiti

deleteFolder(string, string)

Parametri

Valori restituiti

deleteRetentionLeasesById(string, number[])

Parametri

Valori restituiti

deleteTag(string, string)

Parametri

Valori restituiti

deleteTemplate(string, string)

Parametri

Valori restituiti

getArtifact(string, number, string)

Parametri

Valori restituiti

getArtifactContentZip(string, number, string)

Parametri

Valori restituiti

getArtifacts(string, number)

Parametri

Valori restituiti

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

Parametri

Valori restituiti

getAttachments(string, number, string)

Parametri

Valori restituiti