PipelineRunOperations interface

Package:

@azure/synapse-artifacts

Interface representing a PipelineRunOperations.

Methods

cancelPipelineRun(string, PipelineRunCancelPipelineRunOptionalParams)	Cancel a pipeline run by its run ID.
getPipelineRun(string, PipelineRunGetPipelineRunOptionalParams)	Get a pipeline run by its run ID.
queryActivityRuns(string, string, RunFilterParameters, PipelineRunQueryActivityRunsOptionalParams)	Query activity runs based on input filter conditions.
queryPipelineRunsByWorkspace(RunFilterParameters, PipelineRunQueryPipelineRunsByWorkspaceOptionalParams)	Query pipeline runs in the workspace based on input filter conditions.

Method Details

cancelPipelineRun(string, PipelineRunCancelPipelineRunOptionalParams)

Cancel a pipeline run by its run ID.

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

Parameters

runId

string

The pipeline run identifier.

options

PipelineRunCancelPipelineRunOptionalParams

The options parameters.

Returns

Promise<void>

getPipelineRun(string, PipelineRunGetPipelineRunOptionalParams)

Get a pipeline run by its run ID.

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

Parameters

runId

string

The pipeline run identifier.

options

PipelineRunGetPipelineRunOptionalParams

The options parameters.

Returns

Promise<PipelineRun>

queryActivityRuns(string, string, RunFilterParameters, PipelineRunQueryActivityRunsOptionalParams)

Query activity runs based on input filter conditions.

function queryActivityRuns(pipelineName: string, runId: string, filterParameters: RunFilterParameters, options?: PipelineRunQueryActivityRunsOptionalParams): Promise<ActivityRunsQueryResponse>

Parameters

pipelineName

string

The pipeline name.

runId

string

The pipeline run identifier.

filterParameters

RunFilterParameters

Parameters to filter the activity runs.

options

PipelineRunQueryActivityRunsOptionalParams

The options parameters.

Returns

Promise<ActivityRunsQueryResponse>

queryPipelineRunsByWorkspace(RunFilterParameters, PipelineRunQueryPipelineRunsByWorkspaceOptionalParams)

Query pipeline runs in the workspace based on input filter conditions.

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

Parameters

filterParameters

RunFilterParameters

Parameters to filter the pipeline run.

options

PipelineRunQueryPipelineRunsByWorkspaceOptionalParams

The options parameters.

Returns

Promise<PipelineRunsQueryResponse>