PipelineRunOperations interface

套件:

@azure/synapse-artifacts

代表 PipelineRunOperations 的介面。

方法

cancelPipelineRun(string, PipelineRunCancelPipelineRunOptionalParams)	依管線的執行標識碼取消執行。
getPipelineRun(string, PipelineRunGetPipelineRunOptionalParams)	依管線的執行標識碼取得管線執行。
queryActivityRuns(string, string, RunFilterParameters, PipelineRunQueryActivityRunsOptionalParams)	查詢活動會根據輸入篩選條件執行。
queryPipelineRunsByWorkspace(RunFilterParameters, PipelineRunQueryPipelineRunsByWorkspaceOptionalParams)	查詢管線會根據輸入篩選條件在工作區中執行。

方法詳細資料

cancelPipelineRun(string, PipelineRunCancelPipelineRunOptionalParams)

依管線的執行標識碼取消執行。

function cancelPipelineRun(runId: string, options?: PipelineRunCancelPipelineRunOptionalParams): Promise<void>

參數

runId

string

管線執行標識碼。

options

PipelineRunCancelPipelineRunOptionalParams

選項參數。

傳回

Promise<void>

getPipelineRun(string, PipelineRunGetPipelineRunOptionalParams)

依管線的執行標識碼取得管線執行。

function getPipelineRun(runId: string, options?: PipelineRunGetPipelineRunOptionalParams): Promise<PipelineRun>

參數

runId

string

管線執行標識碼。

options

PipelineRunGetPipelineRunOptionalParams

選項參數。

傳回

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

篩選活動執行的參數。

options

PipelineRunQueryActivityRunsOptionalParams

選項參數。

傳回

Promise<ActivityRunsQueryResponse>

queryPipelineRunsByWorkspace(RunFilterParameters, PipelineRunQueryPipelineRunsByWorkspaceOptionalParams)

查詢管線會根據輸入篩選條件在工作區中執行。

function queryPipelineRunsByWorkspace(filterParameters: RunFilterParameters, options?: PipelineRunQueryPipelineRunsByWorkspaceOptionalParams): Promise<PipelineRunsQueryResponse>

參數

filterParameters

RunFilterParameters

篩選管線執行的參數。

options

PipelineRunQueryPipelineRunsByWorkspaceOptionalParams

選項參數。

傳回

Promise<PipelineRunsQueryResponse>