你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

PipelineRunOperations interface

包:: @azure/synapse-artifacts

表示 PipelineRunOperations 的接口。

方法

cancelPipelineRun(string, PipelineRunCancelPipelineRunOptionalParams)	按管道运行 ID 取消管道运行。
getPipelineRun(string, PipelineRunGetPipelineRunOptionalParams)	按管道运行 ID 获取管道运行。
queryActivityRuns(string, string, RunFilterParameters, PipelineRunQueryActivityRunsOptionalParams)	查询活动基于输入筛选器条件运行。
queryPipelineRunsByWorkspace(RunFilterParameters, PipelineRunQueryPipelineRunsByWorkspaceOptionalParams)	查询管道基于输入筛选器条件在工作区中运行。

方法详细信息

cancelPipelineRun(string, PipelineRunCancelPipelineRunOptionalParams)

按管道运行 ID 取消管道运行。

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

参数

runId: string

管道运行标识符。

options: PipelineRunCancelPipelineRunOptionalParams

选项参数。

Promise<void>

getPipelineRun(string, PipelineRunGetPipelineRunOptionalParams)

按管道运行 ID 获取管道运行。

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>