PipelinesRestClient class

Pacote:

azure-devops-extension-api

Classe base que deve ser usada (derivada de) para fazer solicitações para apis REST do VSS

Extends

RestClientBase

Construtores

PipelinesRestClient(IVssRestClientOptions)

Métodos

createPipeline(CreatePipelineParameters, string)	Crie um pipeline.
getArtifact(string, number, number, string, GetArtifactExpandOptions)	Obter um artefato específico de uma execução de pipeline
getLog(string, number, number, number, GetLogExpandOptions)	Obter um log específico de uma execução de pipeline
getPipeline(string, number, number)	Obtém um pipeline, opcionalmente, na versão especificada
getRun(string, number, number)	Obtém uma execução para um pipeline específico.
listLogs(string, number, number, GetLogExpandOptions)	Obtenha uma lista de logs de uma execução de pipeline.
listPipelines(string, string, number, string)	Obtenha uma lista de pipelines.
listRuns(string, number)	Obtém as 10000 principais execuções para um pipeline específico.
preview(RunPipelineParameters, string, number, number)	Enfileira uma execução seca do pipeline e retorna um objeto que contém o yaml final.
runPipeline(RunPipelineParameters, string, number, number)	Executa um pipeline.

Detalhes do construtor

PipelinesRestClient(IVssRestClientOptions)

new PipelinesRestClient(options: IVssRestClientOptions)

Parâmetros

options

IVssRestClientOptions

Detalhes do método

createPipeline(CreatePipelineParameters, string)

Crie um pipeline.

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

Parâmetros

inputParameters

CreatePipelineParameters

Parâmetros de entrada.

project

string

ID do projeto ou nome do projeto

Retornos

Promise<Pipeline>

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

Obter um artefato específico de uma execução de pipeline

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

Parâmetros

project

string

ID do projeto ou nome do projeto

pipelineId

number

ID do pipeline.

runId

number

ID da execução desse pipeline.

artifactName

string

Nome do artefato.

expand

GetArtifactExpandOptions

Expanda opções. O padrão é None.

Retornos

Promise<Artifact>

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

Obter um log específico de uma execução de pipeline

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

Parâmetros

project

string

ID do projeto ou nome do projeto

pipelineId

number

ID do pipeline.

runId

number

ID da execução desse pipeline.

logId

number

ID do log.

expand

GetLogExpandOptions

Expanda opções. O padrão é None.

Retornos

Promise<Log>

getPipeline(string, number, number)

Obtém um pipeline, opcionalmente, na versão especificada

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

Parâmetros

project

string

ID do projeto ou nome do projeto

pipelineId

number

A ID do pipeline

pipelineVersion

number

A versão do pipeline

Retornos

Promise<Pipeline>

getRun(string, number, number)

Obtém uma execução para um pipeline específico.

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

Parâmetros

project

string

ID do projeto ou nome do projeto

pipelineId

number

A ID do pipeline

runId

number

A ID de execução

Retornos

Promise<Run>

listLogs(string, number, number, GetLogExpandOptions)

Obtenha uma lista de logs de uma execução de pipeline.

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

Parâmetros

project

string

ID do projeto ou nome do projeto

pipelineId

number

ID do pipeline.

runId

number

ID da execução desse pipeline.

expand

GetLogExpandOptions

Expanda opções. O padrão é None.

Retornos

Promise<LogCollection>

listPipelines(string, string, number, string)

Obtenha uma lista de pipelines.

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

Parâmetros

project

string

ID do projeto ou nome do projeto

orderBy

string

Uma expressão de classificação. O padrão é "name asc"

top

number

O número máximo de pipelines a serem retornados

continuationToken

string

Um token de continuação de uma solicitação anterior para recuperar a próxima página de resultados

Retornos

Promise<Pipeline[]>

listRuns(string, number)

Obtém as 10000 principais execuções para um pipeline específico.

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

Parâmetros

project

string

ID do projeto ou nome do projeto

pipelineId

number

A ID do pipeline

Retornos

Promise<Run[]>

preview(RunPipelineParameters, string, number, number)

Enfileira uma execução seca do pipeline e retorna um objeto que contém o yaml final.

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

Parâmetros

runParameters

RunPipelineParameters

Parâmetros adicionais opcionais para essa execução.

project

string

ID do projeto ou nome do projeto

pipelineId

number

A ID do pipeline.

pipelineVersion

number

A versão do pipeline.

Retornos

Promise<PreviewRun>

runPipeline(RunPipelineParameters, string, number, number)

Executa um pipeline.

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

Parâmetros

runParameters

RunPipelineParameters

Parâmetros adicionais opcionais para essa execução.

project

string

ID do projeto ou nome do projeto

pipelineId

number

A ID do pipeline.

pipelineVersion

number

A versão do pipeline.

Retornos

Promise<Run>