PipelinesRestClient class

Paket:

azure-devops-extension-api

VSS REST api'lerine istekte bulunmak için kullanılması gereken (türetilen) temel sınıf

Extends

RestClientBase

Oluşturucular

PipelinesRestClient(IVssRestClientOptions)

Yöntemler

createPipeline(CreatePipelineParameters, string)	İşlem hattı oluşturma.
getArtifact(string, number, number, string, GetArtifactExpandOptions)	İşlem hattı çalıştırmasından belirli bir yapıtı alma
getLog(string, number, number, number, GetLogExpandOptions)	İşlem hattı çalıştırmasından belirli bir günlüğü alma
getPipeline(string, number, number)	İsteğe bağlı olarak belirtilen sürümde bir işlem hattı alır
getRun(string, number, number)	Belirli bir işlem hattı için çalıştırma alır.
listLogs(string, number, number, GetLogExpandOptions)	İşlem hattı çalıştırmasından günlüklerin listesini alın.
listPipelines(string, string, number, string)	İşlem hatlarının listesini alın.
listRuns(string, number)	Belirli bir işlem hattı için ilk 10000 çalıştırmayı alır.
preview(RunPipelineParameters, string, number, number)	İşlem hattının bir kuru çalıştırmasını kuyruğa alır ve son yaml değerini içeren bir nesne döndürür.
runPipeline(RunPipelineParameters, string, number, number)	bir işlem hattı çalıştırır.

Oluşturucu Ayrıntıları

PipelinesRestClient(IVssRestClientOptions)

new PipelinesRestClient(options: IVssRestClientOptions)

Parametreler

options

IVssRestClientOptions

Yöntem Ayrıntıları

createPipeline(CreatePipelineParameters, string)

İşlem hattı oluşturma.

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

Parametreler

inputParameters

CreatePipelineParameters

Giriş parametreleri.

project

string

Proje kimliği veya proje adı

Döndürülenler

Promise<Pipeline>

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

İşlem hattı çalıştırmasından belirli bir yapıtı alma

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

Parametreler

project

string

Proje kimliği veya proje adı

pipelineId

number

İşlem hattının kimliği.

runId

number

Bu işlem hattının çalıştırmasının kimliği.

artifactName

string

Yapıtın adı.

expand

GetArtifactExpandOptions

Seçenekleri genişletin. Varsayılan değer Yok'tır.

Döndürülenler

Promise<Artifact>

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

İşlem hattı çalıştırmasından belirli bir günlüğü alma

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

Parametreler

project

string

Proje kimliği veya proje adı

pipelineId

number

İşlem hattının kimliği.

runId

number

Bu işlem hattının çalıştırmasının kimliği.

logId

number

Günlüğün kimliği.

expand

GetLogExpandOptions

Seçenekleri genişletin. Varsayılan değer Yok'tır.

Döndürülenler

Promise<Log>

getPipeline(string, number, number)

İsteğe bağlı olarak belirtilen sürümde bir işlem hattı alır

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

Parametreler

project

string

Proje kimliği veya proje adı

pipelineId

number

İşlem hattı kimliği

pipelineVersion

number

İşlem hattı sürümü

Döndürülenler

Promise<Pipeline>

getRun(string, number, number)

Belirli bir işlem hattı için çalıştırma alır.

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

Parametreler

project

string

Proje kimliği veya proje adı

pipelineId

number

İşlem hattı kimliği

runId

number

Çalıştırma kimliği

Döndürülenler

Promise<Run>

listLogs(string, number, number, GetLogExpandOptions)

İşlem hattı çalıştırmasından günlüklerin listesini alın.

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

Parametreler

project

string

Proje kimliği veya proje adı

pipelineId

number

İşlem hattının kimliği.

runId

number

Bu işlem hattının çalıştırmasının kimliği.

expand

GetLogExpandOptions

Seçenekleri genişletin. Varsayılan değer Yok'tır.

Döndürülenler

Promise<LogCollection>

listPipelines(string, string, number, string)

İşlem hatlarının listesini alın.

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

Parametreler

project

string

Proje kimliği veya proje adı

orderBy

string

Sıralama ifadesi. Varsayılan olarak "name asc" olarak adlandırılır

top

number

Döndürülecek işlem hattı sayısı üst sınırı

continuationToken

string

Sonuçların sonraki sayfasını almak için önceki bir istekten devam belirteci

Döndürülenler

Promise<Pipeline[]>

listRuns(string, number)

Belirli bir işlem hattı için ilk 10000 çalıştırmayı alır.

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

Parametreler

project

string

Proje kimliği veya proje adı

pipelineId

number

İşlem hattı kimliği

Döndürülenler

Promise<Run[]>

preview(RunPipelineParameters, string, number, number)

İşlem hattının bir kuru çalıştırmasını kuyruğa alır ve son yaml değerini içeren bir nesne döndürür.

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

Parametreler

runParameters

RunPipelineParameters

Bu çalıştırma için isteğe bağlı ek parametreler.

project

string

Proje kimliği veya proje adı

pipelineId

number

İşlem hattı kimliği.

pipelineVersion

number

İşlem hattı sürümü.

Döndürülenler

Promise<PreviewRun>

runPipeline(RunPipelineParameters, string, number, number)

bir işlem hattı çalıştırır.

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

Parametreler

runParameters

RunPipelineParameters

Bu çalıştırma için isteğe bağlı ek parametreler.

project

string

Proje kimliği veya proje adı

pipelineId

number

İşlem hattı kimliği.

pipelineVersion

number

İşlem hattı sürümü.

Döndürülenler

Promise<Run>