PipelineRunOperations interface
PipelineRunOperations を表すインターフェイス。
メソッド
| cancel |
実行 ID で実行されるパイプラインを取り消します。 |
| get |
実行 ID で実行されるパイプラインを取得します。 |
| query |
クエリ アクティビティは、入力フィルター条件に基づいて実行されます。 |
| query |
クエリ パイプラインは、入力フィルター条件に基づいてワークスペースで実行されます。 |
メソッドの詳細
cancelPipelineRun(string, PipelineRunCancelPipelineRunOptionalParams)
実行 ID で実行されるパイプラインを取り消します。
function cancelPipelineRun(runId: string, options?: PipelineRunCancelPipelineRunOptionalParams): Promise<void>パラメーター
- runId
-
string
パイプライン実行識別子。
オプション パラメーター。
戻り値
Promise<void>
getPipelineRun(string, PipelineRunGetPipelineRunOptionalParams)
実行 ID で実行されるパイプラインを取得します。
function getPipelineRun(runId: string, options?: PipelineRunGetPipelineRunOptionalParams): Promise<PipelineRun>パラメーター
- runId
-
string
パイプライン実行識別子。
オプション パラメーター。
戻り値
Promise<PipelineRun>
queryActivityRuns(string, string, RunFilterParameters, PipelineRunQueryActivityRunsOptionalParams)
クエリ アクティビティは、入力フィルター条件に基づいて実行されます。
function queryActivityRuns(pipelineName: string, runId: string, filterParameters: RunFilterParameters, options?: PipelineRunQueryActivityRunsOptionalParams): Promise<ActivityRunsQueryResponse>パラメーター
- pipelineName
-
string
パイプライン名。
- runId
-
string
パイプライン実行識別子。
- filterParameters
- RunFilterParameters
アクティビティの実行をフィルター処理するためのパラメーター。
オプション パラメーター。
戻り値
Promise<ActivityRunsQueryResponse>
queryPipelineRunsByWorkspace(RunFilterParameters, PipelineRunQueryPipelineRunsByWorkspaceOptionalParams)
クエリ パイプラインは、入力フィルター条件に基づいてワークスペースで実行されます。
function queryPipelineRunsByWorkspace(filterParameters: RunFilterParameters, options?: PipelineRunQueryPipelineRunsByWorkspaceOptionalParams): Promise<PipelineRunsQueryResponse>パラメーター
- filterParameters
- RunFilterParameters
パイプラインの実行をフィルター処理するパラメーター。
オプション パラメーター。
戻り値
Promise<PipelineRunsQueryResponse>
