PipelinesRestClient class

包:

azure-devops-extension-api

应使用的基类 (派生自) 以向 VSS REST API 发出请求

Extends

RestClientBase

构造函数

PipelinesRestClient(IVssRestClientOptions)

方法

createPipeline(CreatePipelineParameters, string)	创建管道。
getArtifact(string, number, number, string, GetArtifactExpandOptions)	从管道运行获取特定项目
getLog(string, number, number, number, GetLogExpandOptions)	从管道运行中获取特定日志
getPipeline(string, number, number)	获取指定版本的管道（可选）
getRun(string, number, number)	获取特定管道的运行。
listLogs(string, number, number, GetLogExpandOptions)	从管道运行中获取日志列表。
listPipelines(string, string, number, string)	获取管道列表。
listRuns(string, number)	获取特定管道的前 10000 个运行。
preview(RunPipelineParameters, string, number, number)	将管道的试运行排入队列，并返回包含最终 yaml 的对象。
runPipeline(RunPipelineParameters, string, number, number)	运行管道。

构造函数详细信息

PipelinesRestClient(IVssRestClientOptions)

new PipelinesRestClient(options: IVssRestClientOptions)

参数

options

IVssRestClientOptions

方法详细信息

createPipeline(CreatePipelineParameters, string)

创建管道。

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

参数

inputParameters

CreatePipelineParameters

输入参数。

project

string

项目 ID 或项目名称

返回

Promise<Pipeline>

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

从管道运行获取特定项目

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

参数

project

string

项目 ID 或项目名称

pipelineId

number

管道的 ID。

runId

number

该管道运行的 ID。

artifactName

string

项目的名称。

expand

GetArtifactExpandOptions

展开选项。 默认值为 None。

返回

Promise<Artifact>

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

从管道运行中获取特定日志

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

参数

project

string

项目 ID 或项目名称

pipelineId

number

管道的 ID。

runId

number

该管道运行的 ID。

logId

number

日志的 ID。

expand

GetLogExpandOptions

展开选项。 默认值为 None。

返回

Promise<Log>

getPipeline(string, number, number)

获取指定版本的管道（可选）

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

参数

project

string

项目 ID 或项目名称

pipelineId

number

管道 ID

pipelineVersion

number

管道版本

返回

Promise<Pipeline>

getRun(string, number, number)

获取特定管道的运行。

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

参数

project

string

项目 ID 或项目名称

pipelineId

number

管道 ID

runId

number

运行 ID

返回

Promise<Run>

listLogs(string, number, number, GetLogExpandOptions)

从管道运行中获取日志列表。

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

参数

project

string

项目 ID 或项目名称

pipelineId

number

管道的 ID。

runId

number

该管道运行的 ID。

expand

GetLogExpandOptions

展开选项。 默认值为 None。

返回

Promise<LogCollection>

listPipelines(string, string, number, string)

获取管道列表。

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

参数

project

string

项目 ID 或项目名称

orderBy

string

排序表达式。 默认为“name asc”

top

number

要返回的最大管道数

continuationToken

string

上一个请求中的延续标记，用于检索下一页结果

返回

Promise<Pipeline[]>

listRuns(string, number)

获取特定管道的前 10000 个运行。

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

参数

project

string

项目 ID 或项目名称

pipelineId

number

管道 ID

返回

Promise<Run[]>

preview(RunPipelineParameters, string, number, number)

将管道的试运行排入队列，并返回包含最终 yaml 的对象。

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

参数

runParameters

RunPipelineParameters

此运行的可选附加参数。

project

string

项目 ID 或项目名称

pipelineId

number

管道 ID。

pipelineVersion

number

管道版本。

返回

Promise<PreviewRun>

runPipeline(RunPipelineParameters, string, number, number)

运行管道。

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

参数

runParameters

RunPipelineParameters

此运行的可选附加参数。

project

string

项目 ID 或项目名称

pipelineId

number

管道 ID。

pipelineVersion

number

管道版本。

返回

Promise<Run>