Share via

TriggerRunsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

DataFactoryManagementClient's

<xref:trigger_runs> attribute.

Inheritance
builtins.object
TriggerRunsOperations

Constructor

TriggerRunsOperations(*args, **kwargs)

Methods

cancel

Cancel a single trigger instance by runId.
query_by_factory

Query trigger runs.
rerun

Rerun single trigger instance by runId.

cancel

Cancel a single trigger instance by runId.

cancel(resource_group_name: str, factory_name: str, trigger_name: str, run_id: str, **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

The resource group name. Required.
factory_name
Required
str

The factory name. Required.
trigger_name
Required
str

The trigger name. Required.
run_id
Required
str

The pipeline run identifier. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

query_by_factory

Query trigger runs.

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

Parameters

Name Description
resource_group_name
Required
str

The resource group name. Required.
factory_name
Required
str

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

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

Returns

Type Description
TriggerRunsQueryResponse

TriggerRunsQueryResponse or the result of cls(response)

Exceptions

Type Description
HttpResponseError

rerun

Rerun single trigger instance by runId.

rerun(resource_group_name: str, factory_name: str, trigger_name: str, run_id: str, **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

The resource group name. Required.
factory_name
Required
str

The factory name. Required.
trigger_name
Required
str

The trigger name. Required.
run_id
Required
str

The pipeline run identifier. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

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