PipelinesRestClient class

Paket:

azure-devops-extension-api

Basklass som ska användas (härledd från) för att göra begäranden till VSS REST API:erna

Extends

RestClientBase

Konstruktorer

PipelinesRestClient(IVssRestClientOptions)

Metoder

createPipeline(CreatePipelineParameters, string)	Skapa en pipeline.
getArtifact(string, number, number, string, GetArtifactExpandOptions)	Hämta en specifik artefakt från en pipelinekörning
getLog(string, number, number, number, GetLogExpandOptions)	Hämta en specifik logg från en pipelinekörning
getPipeline(string, number, number)	Hämtar en pipeline, om du vill i den angivna versionen
getRun(string, number, number)	Hämtar en körning för en viss pipeline.
listLogs(string, number, number, GetLogExpandOptions)	Hämta en lista över loggar från en pipelinekörning.
listPipelines(string, string, number, string)	Hämta en lista över pipelines.
listRuns(string, number)	Hämtar de 1 0000 främsta körningarna för en viss pipeline.
preview(RunPipelineParameters, string, number, number)	Köar en torr körning av pipelinen och returnerar ett objekt som innehåller den slutliga yaml-filen.
runPipeline(RunPipelineParameters, string, number, number)	Kör en pipeline.

Konstruktorinformation

PipelinesRestClient(IVssRestClientOptions)

new PipelinesRestClient(options: IVssRestClientOptions)

Parametrar

options

IVssRestClientOptions

Metodinformation

createPipeline(CreatePipelineParameters, string)

Skapa en pipeline.

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

Parametrar

inputParameters

CreatePipelineParameters

Indataparametrar.

project

string

Projekt-ID eller projektnamn

Returer

Promise<Pipeline>

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

Hämta en specifik artefakt från en pipelinekörning

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

Parametrar

project

string

Projekt-ID eller projektnamn

pipelineId

number

ID för pipelinen.

runId

number

ID för körningen av pipelinen.

artifactName

string

Artefaktens namn.

expand

GetArtifactExpandOptions

Expandera alternativ. Standardvärdet är Ingen.

Returer

Promise<Artifact>

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

Hämta en specifik logg från en pipelinekörning

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

Parametrar

project

string

Projekt-ID eller projektnamn

pipelineId

number

ID för pipelinen.

runId

number

ID för körningen av pipelinen.

logId

number

ID för loggen.

expand

GetLogExpandOptions

Expandera alternativ. Standardvärdet är Ingen.

Returer

Promise<Log>

getPipeline(string, number, number)

Hämtar en pipeline, om du vill i den angivna versionen

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

Parametrar

project

string

Projekt-ID eller projektnamn

pipelineId

number

Pipeline-ID:t

pipelineVersion

number

Pipelineversionen

Returer

Promise<Pipeline>

getRun(string, number, number)

Hämtar en körning för en viss pipeline.

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

Parametrar

project

string

Projekt-ID eller projektnamn

pipelineId

number

Pipeline-ID:t

runId

number

Körnings-ID:t

Returer

Promise<Run>

listLogs(string, number, number, GetLogExpandOptions)

Hämta en lista över loggar från en pipelinekörning.

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

Parametrar

project

string

Projekt-ID eller projektnamn

pipelineId

number

ID för pipelinen.

runId

number

ID för körningen av pipelinen.

expand

GetLogExpandOptions

Expandera alternativ. Standardvärdet är Ingen.

Returer

Promise<LogCollection>

listPipelines(string, string, number, string)

Hämta en lista över pipelines.

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

Parametrar

project

string

Projekt-ID eller projektnamn

orderBy

string

Ett sorteringsuttryck. Standardvärdet är "name asc"

top

number

Det maximala antalet pipelines som ska returneras

continuationToken

string

En fortsättningstoken från en tidigare begäran för att hämta nästa resultatsida

Returer

Promise<Pipeline[]>

listRuns(string, number)

Hämtar de 1 0000 främsta körningarna för en viss pipeline.

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

Parametrar

project

string

Projekt-ID eller projektnamn

pipelineId

number

Pipeline-ID:t

Returer

Promise<Run[]>

preview(RunPipelineParameters, string, number, number)

Köar en torr körning av pipelinen och returnerar ett objekt som innehåller den slutliga yaml-filen.

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

Parametrar

runParameters

RunPipelineParameters

Valfria ytterligare parametrar för den här körningen.

project

string

Projekt-ID eller projektnamn

pipelineId

number

Pipeline-ID:t.

pipelineVersion

number

Pipelineversionen.

Returer

Promise<PreviewRun>

runPipeline(RunPipelineParameters, string, number, number)

Kör en pipeline.

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

Parametrar

runParameters

RunPipelineParameters

Valfria ytterligare parametrar för den här körningen.

project

string

Projekt-ID eller projektnamn

pipelineId

number

Pipeline-ID:t.

pipelineVersion

number

Pipelineversionen.

Returer

Promise<Run>