PipelinesRestClient class

Paket:

azure-devops-extension-api

Kelas dasar yang harus digunakan (berasal dari) untuk membuat permintaan ke VSS REST api

Memperluas

RestClientBase

Konstruktor

PipelinesRestClient(IVssRestClientOptions)

Metode

createPipeline(CreatePipelineParameters, string)	Membuat alur.
getArtifact(string, number, number, string, GetArtifactExpandOptions)	Mendapatkan artefak tertentu dari eksekusi alur
getLog(string, number, number, number, GetLogExpandOptions)	Mendapatkan log tertentu dari eksekusi alur
getPipeline(string, number, number)	Mendapatkan alur, secara opsional pada versi yang ditentukan
getRun(string, number, number)	Mendapatkan eksekusi untuk alur tertentu.
listLogs(string, number, number, GetLogExpandOptions)	Dapatkan daftar log dari eksekusi alur.
listPipelines(string, string, number, string)	Dapatkan daftar alur.
listRuns(string, number)	Mendapatkan 10000 eksekusi teratas untuk alur tertentu.
preview(RunPipelineParameters, string, number, number)	Mengantrekan eksekusi kering alur dan mengembalikan objek yang berisi yaml akhir.
runPipeline(RunPipelineParameters, string, number, number)	Menjalankan alur.

Detail Konstruktor

PipelinesRestClient(IVssRestClientOptions)

new PipelinesRestClient(options: IVssRestClientOptions)

Parameter

options

IVssRestClientOptions

Detail Metode

createPipeline(CreatePipelineParameters, string)

Membuat alur.

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

Parameter

inputParameters

CreatePipelineParameters

Parameter input.

project

string

ID proyek atau nama proyek

Mengembalikan

Promise<Pipeline>

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

Mendapatkan artefak tertentu dari eksekusi alur

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

Parameter

project

string

ID proyek atau nama proyek

pipelineId

number

ID alur.

runId

number

ID eksekusi alur tersebut.

artifactName

string

Nama artefak.

expand

GetArtifactExpandOptions

Perluas opsi. Defaultnya adalah Tidak Ada.

Mengembalikan

Promise<Artifact>

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

Mendapatkan log tertentu dari eksekusi alur

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

Parameter

project

string

ID proyek atau nama proyek

pipelineId

number

ID alur.

runId

number

ID eksekusi alur tersebut.

logId

number

ID log.

expand

GetLogExpandOptions

Perluas opsi. Defaultnya adalah Tidak Ada.

Mengembalikan

Promise<Log>

getPipeline(string, number, number)

Mendapatkan alur, secara opsional pada versi yang ditentukan

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

Parameter

project

string

ID proyek atau nama proyek

pipelineId

number

ID alur

pipelineVersion

number

Versi alur

Mengembalikan

Promise<Pipeline>

getRun(string, number, number)

Mendapatkan eksekusi untuk alur tertentu.

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

Parameter

project

string

ID proyek atau nama proyek

pipelineId

number

Id alur

runId

number

Id eksekusi

Mengembalikan

Promise<Run>

listLogs(string, number, number, GetLogExpandOptions)

Dapatkan daftar log dari eksekusi alur.

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

Parameter

project

string

ID proyek atau nama proyek

pipelineId

number

ID alur.

runId

number

ID eksekusi alur tersebut.

expand

GetLogExpandOptions

Perluas opsi. Defaultnya adalah Tidak Ada.

Mengembalikan

Promise<LogCollection>

listPipelines(string, string, number, string)

Dapatkan daftar alur.

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

Parameter

project

string

ID proyek atau nama proyek

orderBy

string

Ekspresi pengurutan. Default ke "nama asc"

top

number

Jumlah maksimum alur yang akan dikembalikan

continuationToken

string

Token kelanjutan dari permintaan sebelumnya, untuk mengambil halaman hasil berikutnya

Mengembalikan

Promise<Pipeline[]>

listRuns(string, number)

Mendapatkan 10000 eksekusi teratas untuk alur tertentu.

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

Parameter

project

string

ID proyek atau nama proyek

pipelineId

number

Id alur

Mengembalikan

Promise<Run[]>

preview(RunPipelineParameters, string, number, number)

Mengantrekan eksekusi kering alur dan mengembalikan objek yang berisi yaml akhir.

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

Parameter

runParameters

RunPipelineParameters

Parameter tambahan opsional untuk eksekusi ini.

project

string

ID proyek atau nama proyek

pipelineId

number

ID alur.

pipelineVersion

number

Versi alur.

Mengembalikan

Promise<PreviewRun>

runPipeline(RunPipelineParameters, string, number, number)

Menjalankan alur.

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

Parameter

runParameters

RunPipelineParameters

Parameter tambahan opsional untuk eksekusi ini.

project

string

ID proyek atau nama proyek

pipelineId

number

ID alur.

pipelineVersion

number

Versi alur.

Mengembalikan

Promise<Run>