PipelinesRestClient class

Balíček:

azure-devops-extension-api

Základní třída, která by se měla používat (odvozená z) k vytváření požadavků na rozhraní REST api služby VSS

Extends

RestClientBase

Konstruktory

PipelinesRestClient(IVssRestClientOptions)

Metody

createPipeline(CreatePipelineParameters, string)	Vytvoření kanálu
getArtifact(string, number, number, string, GetArtifactExpandOptions)	Získání konkrétního artefaktu ze spuštění kanálu
getLog(string, number, number, number, GetLogExpandOptions)	Získání konkrétního protokolu ze spuštění kanálu
getPipeline(string, number, number)	Získá kanál, volitelně v zadané verzi.
getRun(string, number, number)	Získá spuštění pro konkrétní kanál.
listLogs(string, number, number, GetLogExpandOptions)	Získejte seznam protokolů ze spuštění kanálu.
listPipelines(string, string, number, string)	Získejte seznam kanálů.
listRuns(string, number)	Získá prvních 10000 spuštění pro konkrétní kanál.
preview(RunPipelineParameters, string, number, number)	Za fronty suché spuštění kanálu a vrátí objekt obsahující konečný yaml.
runPipeline(RunPipelineParameters, string, number, number)	Spustí kanál.

Podrobnosti konstruktoru

PipelinesRestClient(IVssRestClientOptions)

new PipelinesRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Podrobnosti metody

createPipeline(CreatePipelineParameters, string)

Vytvoření kanálu

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

Parametry

inputParameters

CreatePipelineParameters

Vstupní parametry.

project

string

ID projektu nebo název projektu

Návraty

Promise<Pipeline>

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

Získání konkrétního artefaktu ze spuštění kanálu

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

Parametry

project

string

ID projektu nebo název projektu

pipelineId

number

ID kanálu.

runId

number

ID spuštění tohoto kanálu

artifactName

string

Název artefaktu.

expand

GetArtifactExpandOptions

Rozbalit možnosti. Výchozí hodnota je Žádný.

Návraty

Promise<Artifact>

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

Získání konkrétního protokolu ze spuštění kanálu

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

Parametry

project

string

ID projektu nebo název projektu

pipelineId

number

ID kanálu.

runId

number

ID spuštění tohoto kanálu

logId

number

ID protokolu.

expand

GetLogExpandOptions

Rozbalit možnosti. Výchozí hodnota je Žádný.

Návraty

Promise<Log>

getPipeline(string, number, number)

Získá kanál, volitelně v zadané verzi.

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

Parametry

project

string

ID projektu nebo název projektu

pipelineId

number

ID kanálu

pipelineVersion

number

Verze kanálu

Návraty

Promise<Pipeline>

getRun(string, number, number)

Získá spuštění pro konkrétní kanál.

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

Parametry

project

string

ID projektu nebo název projektu

pipelineId

number

ID kanálu

runId

number

ID spuštění

Návraty

Promise<Run>

listLogs(string, number, number, GetLogExpandOptions)

Získejte seznam protokolů ze spuštění kanálu.

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

Parametry

project

string

ID projektu nebo název projektu

pipelineId

number

ID kanálu.

runId

number

ID spuštění tohoto kanálu

expand

GetLogExpandOptions

Rozbalit možnosti. Výchozí hodnota je Žádný.

Návraty

Promise<LogCollection>

listPipelines(string, string, number, string)

Získejte seznam kanálů.

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

Parametry

project

string

ID projektu nebo název projektu

orderBy

string

Výraz řazení. Výchozí hodnota je "name asc".

top

number

Maximální počet kanálů, které se mají vrátit

continuationToken

string

Token pokračování z předchozího požadavku pro načtení další stránky výsledků

Návraty

Promise<Pipeline[]>

listRuns(string, number)

Získá prvních 10000 spuštění pro konkrétní kanál.

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

Parametry

project

string

ID projektu nebo název projektu

pipelineId

number

ID kanálu

Návraty

Promise<Run[]>

preview(RunPipelineParameters, string, number, number)

Za fronty suché spuštění kanálu a vrátí objekt obsahující konečný yaml.

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

Parametry

runParameters

RunPipelineParameters

Volitelné další parametry pro toto spuštění

project

string

ID projektu nebo název projektu

pipelineId

number

ID kanálu.

pipelineVersion

number

Verze kanálu.

Návraty

Promise<PreviewRun>

runPipeline(RunPipelineParameters, string, number, number)

Spustí kanál.

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

Parametry

runParameters

RunPipelineParameters

Volitelné další parametry pro toto spuštění

project

string

ID projektu nebo název projektu

pipelineId

number

ID kanálu.

pipelineVersion

number

Verze kanálu.

Návraty

Promise<Run>