PipelineRunsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

DataFactoryManagementClient's

<xref:pipeline_runs> attribute.

Constructor

PipelineRunsOperations(*args, **kwargs)

Methods

cancel

Cancel a pipeline run by its run ID.
get

Get a pipeline run by its run ID.
query_by_factory

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

cancel

Cancel a pipeline run by its run ID.

cancel(resource_group_name: str, factory_name: str, run_id: str, *, is_recursive: bool | None = None, **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
factory_name
Required
str

Required.
run_id
Required
str

The pipeline run identifier. Required.

Keyword-Only Parameters

Name Description
is_recursive
bool

If true, cancel all the Child pipelines that are triggered by the current pipeline. Default value is None.

Default value: None

Returns

Type Description
None

None

Exceptions

Type Description
HttpResponseError

get

Get a pipeline run by its run ID.

get(resource_group_name: str, factory_name: str, run_id: str, **kwargs: Any) -> PipelineRun

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
factory_name
Required
str

Required.
run_id
Required
str

The pipeline run identifier. Required.

Returns

Type Description
PipelineRun

PipelineRun. The PipelineRun is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

query_by_factory

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

query_by_factory(resource_group_name: str, factory_name: str, filter_parameters: _models.RunFilterParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PipelineRunsQueryResponse

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
factory_name
Required
str

The factory name. Required.
filter_parameters
Required
RunFilterParameters or RunFilterParameters or IO[bytes]

Parameters to filter the pipeline run. Is either a RunFilterParameters type or a IO[bytes] type. Required.

Returns

Type Description
PipelineRunsQueryResponse

PipelineRunsQueryResponse. The PipelineRunsQueryResponse is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError