PipelinesRestClient class

Paquet:

azure-devops-extension-api

Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes à des api REST VSS

Extends

RestClientBase

Constructeurs

PipelinesRestClient(IVssRestClientOptions)

Méthodes

createPipeline(CreatePipelineParameters, string)	Créer un pipeline.
getArtifact(string, number, number, string, GetArtifactExpandOptions)	Obtenir un artefact spécifique à partir d’une exécution de pipeline
getLog(string, number, number, number, GetLogExpandOptions)	Obtenir un journal spécifique à partir d’une exécution de pipeline
getPipeline(string, number, number)	Obtient un pipeline, éventuellement à la version spécifiée
getRun(string, number, number)	Obtient une exécution pour un pipeline particulier.
listLogs(string, number, number, GetLogExpandOptions)	Obtenez la liste des journaux d’une exécution de pipeline.
listPipelines(string, string, number, string)	Obtenez la liste des pipelines.
listRuns(string, number)	Obtient les 10 000 premières exécutions pour un pipeline particulier.
preview(RunPipelineParameters, string, number, number)	Met en file d’attente une exécution sèche du pipeline et retourne un objet contenant le yaml final.
runPipeline(RunPipelineParameters, string, number, number)	Exécute un pipeline.

Détails du constructeur

PipelinesRestClient(IVssRestClientOptions)

new PipelinesRestClient(options: IVssRestClientOptions)

Paramètres

options

IVssRestClientOptions

Détails de la méthode

createPipeline(CreatePipelineParameters, string)

Créer un pipeline.

function createPipeline(inputParameters: CreatePipelineParameters, project: string): Promise<Pipeline>

Paramètres

inputParameters

CreatePipelineParameters

Paramètres d’entrée.

project

string

ID de projet ou nom du projet

Retours

Promise<Pipeline>

getArtifact(string, number, number, string, GetArtifactExpandOptions)

Obtenir un artefact spécifique à partir d’une exécution de pipeline

function getArtifact(project: string, pipelineId: number, runId: number, artifactName: string, expand?: GetArtifactExpandOptions): Promise<Artifact>

Paramètres

project

string

ID de projet ou nom du projet

pipelineId

number

ID du pipeline.

runId

number

ID de l’exécution de ce pipeline.

artifactName

string

Nom de l'artefact.

expand

GetArtifactExpandOptions

Options de développement. La valeur par défaut est None.

Retours

Promise<Artifact>

getLog(string, number, number, number, GetLogExpandOptions)

Obtenir un journal spécifique à partir d’une exécution de pipeline

function getLog(project: string, pipelineId: number, runId: number, logId: number, expand?: GetLogExpandOptions): Promise<Log>

Paramètres

project

string

ID de projet ou nom du projet

pipelineId

number

ID du pipeline.

runId

number

ID de l’exécution de ce pipeline.

logId

number

ID du journal.

expand

GetLogExpandOptions

Options de développement. La valeur par défaut est None.

Retours

Promise<Log>

getPipeline(string, number, number)

Obtient un pipeline, éventuellement à la version spécifiée

function getPipeline(project: string, pipelineId: number, pipelineVersion?: number): Promise<Pipeline>

Paramètres

project

string

ID de projet ou nom du projet

pipelineId

number

ID de pipeline

pipelineVersion

number

Version du pipeline

Retours

Promise<Pipeline>

getRun(string, number, number)

Obtient une exécution pour un pipeline particulier.

function getRun(project: string, pipelineId: number, runId: number): Promise<Run>

Paramètres

project

string

ID de projet ou nom du projet

pipelineId

number

ID de pipeline

runId

number

ID d’exécution

Retours

Promise<Run>

listLogs(string, number, number, GetLogExpandOptions)

Obtenez la liste des journaux d’une exécution de pipeline.

function listLogs(project: string, pipelineId: number, runId: number, expand?: GetLogExpandOptions): Promise<LogCollection>

Paramètres

project

string

ID de projet ou nom du projet

pipelineId

number

ID du pipeline.

runId

number

ID de l’exécution de ce pipeline.

expand

GetLogExpandOptions

Options de développement. La valeur par défaut est None.

Retours

Promise<LogCollection>

listPipelines(string, string, number, string)

Obtenez la liste des pipelines.

function listPipelines(project: string, orderBy?: string, top?: number, continuationToken?: string): Promise<Pipeline[]>

Paramètres

project

string

ID de projet ou nom du projet

orderBy

string

Expression de tri. Par défaut, « name asc »

top

number

Nombre maximal de pipelines à retourner

continuationToken

string

Jeton de continuation d’une demande précédente, pour récupérer la page suivante des résultats

Retours

Promise<Pipeline[]>

listRuns(string, number)

Obtient les 10 000 premières exécutions pour un pipeline particulier.

function listRuns(project: string, pipelineId: number): Promise<Run[]>

Paramètres

project

string

ID de projet ou nom du projet

pipelineId

number

ID de pipeline

Retours

Promise<Run[]>

preview(RunPipelineParameters, string, number, number)

Met en file d’attente une exécution sèche du pipeline et retourne un objet contenant le yaml final.

function preview(runParameters: RunPipelineParameters, project: string, pipelineId: number, pipelineVersion?: number): Promise<PreviewRun>

Paramètres

runParameters

RunPipelineParameters

Paramètres supplémentaires facultatifs pour cette exécution.

project

string

ID de projet ou nom du projet

pipelineId

number

ID de pipeline.

pipelineVersion

number

Version du pipeline.

Retours

Promise<PreviewRun>

runPipeline(RunPipelineParameters, string, number, number)

Exécute un pipeline.

function runPipeline(runParameters: RunPipelineParameters, project: string, pipelineId: number, pipelineVersion?: number): Promise<Run>

Paramètres

runParameters

RunPipelineParameters

Paramètres supplémentaires facultatifs pour cette exécution.

project

string

ID de projet ou nom du projet

pipelineId

number

ID de pipeline.

pipelineVersion

number

Version du pipeline.

Retours

Promise<Run>