PipelinesRestClient class
應該用來對 VSS REST API 提出要求的基類（衍生自）
- Extends
方法
| create |
建立管線。 |
| get |
從管線執行取得特定成品 |
| get |
從管線執行取得特定記錄 |
| get |
取得管線，選擇性地在指定的版本 |
| get |
取得特定管線的執行。 |
| list |
從管線執行取得記錄清單。 |
| list |
取得管線清單。 |
| list |
取得特定管線的前 10000 次執行。 |
| preview(Run |
將管線的試執行排入佇列，並傳回包含最終 yaml 的物件。 |
| run |
執行管線。 |
建構函式詳細資料
PipelinesRestClient(IVssRestClientOptions)
方法詳細資料
createPipeline(CreatePipelineParameters, string)
建立管線。
function createPipeline(inputParameters: CreatePipelineParameters, project: string): Promise<Pipeline>參數
- inputParameters
- CreatePipelineParameters
輸入參數。
- project
-
string
項目識別碼或項目名稱
傳回
Promise<Pipeline>
getArtifact(string, number, number, string, GetArtifactExpandOptions)
從管線執行取得特定成品
function getArtifact(project: string, pipelineId: number, runId: number, artifactName: string, expand?: GetArtifactExpandOptions): Promise<Artifact>參數
- project
-
string
項目識別碼或項目名稱
- pipelineId
-
number
管線的標識碼。
- runId
-
number
該管線執行的識別碼。
- 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
項目識別碼或項目名稱
- pipelineId
-
number
管線的標識碼。
- runId
-
number
該管線執行的識別碼。
- logId
-
number
記錄的 ID。
- expand
- GetLogExpandOptions
展開選項。 預設值為「無」。
傳回
Promise<Log>
getPipeline(string, number, number)
取得管線，選擇性地在指定的版本
function getPipeline(project: string, pipelineId: number, pipelineVersion?: number): Promise<Pipeline>參數
- project
-
string
項目識別碼或項目名稱
- pipelineId
-
number
管線識別碼
- pipelineVersion
-
number
管線版本
傳回
Promise<Pipeline>
getRun(string, number, number)
取得特定管線的執行。
function getRun(project: string, pipelineId: number, runId: number): Promise<Run>參數
- project
-
string
項目識別碼或項目名稱
- pipelineId
-
number
管線識別碼
- runId
-
number
執行識別碼
傳回
Promise<Run>
listLogs(string, number, number, GetLogExpandOptions)
從管線執行取得記錄清單。
function listLogs(project: string, pipelineId: number, runId: number, expand?: GetLogExpandOptions): Promise<LogCollection>參數
- project
-
string
項目識別碼或項目名稱
- pipelineId
-
number
管線的標識碼。
- runId
-
number
該管線執行的識別碼。
- expand
- GetLogExpandOptions
展開選項。 預設值為「無」。
傳回
Promise<LogCollection>
listPipelines(string, string, number, string)
取得管線清單。
function listPipelines(project: string, orderBy?: string, top?: number, continuationToken?: string): Promise<Pipeline[]>參數
- project
-
string
項目識別碼或項目名稱
- orderBy
-
string
排序運算式。 預設為「name asc」
- top
-
number
要傳回的管線數目上限
- continuationToken
-
string
上一個請求的接續權杖，用於擷取下一頁結果
傳回
Promise<Pipeline[]>
listRuns(string, number)
取得特定管線的前 10000 次執行。
function listRuns(project: string, pipelineId: number): Promise<Run[]>參數
- project
-
string
項目識別碼或項目名稱
- pipelineId
-
number
管線識別碼
傳回
Promise<Run[]>
preview(RunPipelineParameters, string, number, number)
將管線的試執行排入佇列，並傳回包含最終 yaml 的物件。
function preview(runParameters: RunPipelineParameters, project: string, pipelineId: number, pipelineVersion?: number): Promise<PreviewRun>參數
- runParameters
- RunPipelineParameters
此執行的選用其他參數。
- project
-
string
項目識別碼或項目名稱
- pipelineId
-
number
管線識別碼。
- 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
項目識別碼或項目名稱
- pipelineId
-
number
管線識別碼。
- pipelineVersion
-
number
管線版本。
傳回
Promise<Run>