PipelinesRestClient class

Pakiet:

azure-devops-extension-api

Klasa bazowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS

Extends

RestClientBase

Konstruktory

PipelinesRestClient(IVssRestClientOptions)

Metody

createPipeline(CreatePipelineParameters, string)	Tworzenie potoku.
getArtifact(string, number, number, string, GetArtifactExpandOptions)	Pobieranie określonego artefaktu z uruchomienia potoku
getLog(string, number, number, number, GetLogExpandOptions)	Pobieranie określonego dziennika z uruchomienia potoku
getPipeline(string, number, number)	Pobiera potok, opcjonalnie w określonej wersji
getRun(string, number, number)	Pobiera przebieg dla określonego potoku.
listLogs(string, number, number, GetLogExpandOptions)	Pobierz listę dzienników z uruchomienia potoku.
listPipelines(string, string, number, string)	Pobieranie listy potoków.
listRuns(string, number)	Pobiera 10000 pierwszych przebiegów dla określonego potoku.
preview(RunPipelineParameters, string, number, number)	Kolejkuje suchy przebieg potoku i zwraca obiekt zawierający końcowy plik yaml.
runPipeline(RunPipelineParameters, string, number, number)	Uruchamia potok.

Szczegóły konstruktora

PipelinesRestClient(IVssRestClientOptions)

new PipelinesRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Szczegóły metody

createPipeline(CreatePipelineParameters, string)

Tworzenie potoku.

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

Parametry

inputParameters

CreatePipelineParameters

Parametry wejściowe.

project

string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<Pipeline>

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

Pobieranie określonego artefaktu z uruchomienia potoku

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

pipelineId

number

Identyfikator potoku.

runId

number

Identyfikator uruchomienia tego potoku.

artifactName

string

Nazwa artefaktu.

expand

GetArtifactExpandOptions

Rozwiń opcje. Wartość domyślna to Brak.

Zwraca

Promise<Artifact>

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

Pobieranie określonego dziennika z uruchomienia potoku

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

pipelineId

number

Identyfikator potoku.

runId

number

Identyfikator uruchomienia tego potoku.

logId

number

Identyfikator dziennika.

expand

GetLogExpandOptions

Rozwiń opcje. Wartość domyślna to Brak.

Zwraca

Promise<Log>

getPipeline(string, number, number)

Pobiera potok, opcjonalnie w określonej wersji

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

pipelineId

number

Identyfikator potoku

pipelineVersion

number

Wersja potoku

Zwraca

Promise<Pipeline>

getRun(string, number, number)

Pobiera przebieg dla określonego potoku.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

pipelineId

number

Identyfikator potoku

runId

number

Identyfikator przebiegu

Zwraca

Promise<Run>

listLogs(string, number, number, GetLogExpandOptions)

Pobierz listę dzienników z uruchomienia potoku.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

pipelineId

number

Identyfikator potoku.

runId

number

Identyfikator uruchomienia tego potoku.

expand

GetLogExpandOptions

Rozwiń opcje. Wartość domyślna to Brak.

Zwraca

Promise<LogCollection>

listPipelines(string, string, number, string)

Pobieranie listy potoków.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

orderBy

string

Wyrażenie sortowania. Wartość domyślna to "name asc"

top

number

Maksymalna liczba potoków do zwrócenia

continuationToken

string

Token kontynuacji z poprzedniego żądania w celu pobrania następnej strony wyników

Zwraca

Promise<Pipeline[]>

listRuns(string, number)

Pobiera 10000 pierwszych przebiegów dla określonego potoku.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

pipelineId

number

Identyfikator potoku

Zwraca

Promise<Run[]>

preview(RunPipelineParameters, string, number, number)

Kolejkuje suchy przebieg potoku i zwraca obiekt zawierający końcowy plik yaml.

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

Parametry

runParameters

RunPipelineParameters

Opcjonalne dodatkowe parametry dla tego przebiegu.

project

string

Identyfikator projektu lub nazwa projektu

pipelineId

number

Identyfikator potoku.

pipelineVersion

number

Wersja potoku.

Zwraca

Promise<PreviewRun>

runPipeline(RunPipelineParameters, string, number, number)

Uruchamia potok.

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

Parametry

runParameters

RunPipelineParameters

Opcjonalne dodatkowe parametry dla tego przebiegu.

project

string

Identyfikator projektu lub nazwa projektu

pipelineId

number

Identyfikator potoku.

pipelineVersion

number

Wersja potoku.

Zwraca

Promise<Run>