PipelinesRestClient class

Pacote:

azure-devops-extension-api

Classe base que deve ser utilizada (derivada de) para fazer pedidos às apis REST do VSS

Extends

RestClientBase

Construtores

PipelinesRestClient(IVssRestClientOptions)

Métodos

createPipeline(CreatePipelineParameters, string)	Criar um pipeline.
getArtifact(string, number, number, string, GetArtifactExpandOptions)	Obter um artefacto específico de uma execução de pipeline
getLog(string, number, number, number, GetLogExpandOptions)	Obter um registo específico a partir 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 determinado pipeline.
listLogs(string, number, number, GetLogExpandOptions)	Obtenha uma lista de registos de uma execução de pipeline.
listPipelines(string, string, number, string)	Obtenha uma lista de pipelines.
listRuns(string, number)	Obtém as 10000 melhores execuções para um determinado pipeline.
preview(RunPipelineParameters, string, number, number)	Coloca em fila uma execução seca do pipeline e devolve 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 de Método

createPipeline(CreatePipelineParameters, string)

Criar 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

Devoluções

Promise<Pipeline>

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

Obter um artefacto 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 artefacto.

expand

GetArtifactExpandOptions

Expandir opções. A predefinição é Nenhuma.

Devoluções

Promise<Artifact>

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

Obter um registo específico a partir 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 registo.

expand

GetLogExpandOptions

Expandir opções. A predefinição é Nenhuma.

Devoluções

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

O ID do pipeline

pipelineVersion

number

A versão do pipeline

Devoluções

Promise<Pipeline>

getRun(string, number, number)

Obtém uma execução para um determinado pipeline.

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

Parâmetros

project

string

ID do Projeto ou nome do projeto

pipelineId

number

O ID do pipeline

runId

number

O ID de execução

Devoluções

Promise<Run>

listLogs(string, number, number, GetLogExpandOptions)

Obtenha uma lista de registos 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

Expandir opções. A predefinição é Nenhuma.

Devoluções

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 ordenação. Predefinições para "name asc"

top

number

O número máximo de pipelines a devolver

continuationToken

string

Um token de continuação de um pedido anterior, para obter a página seguinte dos resultados

Devoluções

Promise<Pipeline[]>

listRuns(string, number)

Obtém as 10000 melhores execuções para um determinado pipeline.

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

Parâmetros

project

string

ID do Projeto ou nome do projeto

pipelineId

number

O ID do pipeline

Devoluções

Promise<Run[]>

preview(RunPipelineParameters, string, number, number)

Coloca em fila uma execução seca do pipeline e devolve 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 esta execução.

project

string

ID do Projeto ou nome do projeto

pipelineId

number

O ID do pipeline.

pipelineVersion

number

A versão do pipeline.

Devoluções

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 esta execução.

project

string

ID do Projeto ou nome do projeto

pipelineId

number

O ID do pipeline.

pipelineVersion

number

A versão do pipeline.

Devoluções

Promise<Run>