次の方法で共有


PipelinesRestClient class

VSS REST API への要求を行うために使用する (から派生する) 基本クラス

Extends

コンストラクター

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)

特定のパイプラインの上位 1,0000 件の実行を取得します。

preview(RunPipelineParameters, string, number, number)

パイプラインのドライ ランをキューに入れ、最終的な yaml を含むオブジェクトを返します。

runPipeline(RunPipelineParameters, string, number, number)

パイプラインを実行します。

コンストラクターの詳細

PipelinesRestClient(IVssRestClientOptions)

new PipelinesRestClient(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

オプションを展開します。 既定値はなしです。

戻り値

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

オプションを展開します。 既定値はなしです。

戻り値

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

オプションを展開します。 既定値はなしです。

戻り値

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)

特定のパイプラインの上位 1,0000 件の実行を取得します。

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>