PipelineRunsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

DataFactoryManagementClient's

<xref:pipeline_runs> attribute.

Inheritance

builtins.object

PipelineRunsOperations

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.

async cancel(resource_group_name: str, factory_name: str, run_id: str, is_recursive: Optional[bool] = None, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

The resource group name.

factory_name

str

Required

The factory name.

run_id

str

Required

The pipeline run identifier.

is_recursive

bool

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get

Get a pipeline run by its run ID.

async get(resource_group_name: str, factory_name: str, run_id: str, **kwargs: Any) -> azure.mgmt.datafactory.models._models_py3.PipelineRun

Parameters

resource_group_name

str

Required

The resource group name.

factory_name

str

Required

The factory name.

run_id

str

Required

The pipeline run identifier.

cls

callable

A custom type or function that will be passed the direct response

Returns

PipelineRun, or the result of cls(response)

Return type

PipelineRun

Exceptions

HttpResponseError

query_by_factory

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

async query_by_factory(resource_group_name: str, factory_name: str, filter_parameters: azure.mgmt.datafactory.models._models_py3.RunFilterParameters, **kwargs: Any) -> azure.mgmt.datafactory.models._models_py3.PipelineRunsQueryResponse

Parameters

resource_group_name

str

Required

The resource group name.

factory_name

str

Required

The factory name.

filter_parameters

RunFilterParameters

Required

Parameters to filter the pipeline run.

cls

callable

A custom type or function that will be passed the direct response

Returns

PipelineRunsQueryResponse, or the result of cls(response)

Return type

PipelineRunsQueryResponse

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.datafactory.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\datafactory\\models\\__init__.py'>