TriggerRunsOperations Class

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.

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

Parameters

resource_group_name

str

Required

The resource group name.

factory_name

str

Required

The factory name.

trigger_name

str

Required

The trigger name.

run_id

str

Required

The pipeline run identifier.

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

query_by_factory

Query trigger runs.

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.TriggerRunsQueryResponse

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

TriggerRunsQueryResponse, or the result of cls(response)

Return type

TriggerRunsQueryResponse

Exceptions

HttpResponseError

rerun

Rerun single trigger instance by runId.

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

Parameters

resource_group_name

str

Required

The resource group name.

factory_name

str

Required

The factory name.

trigger_name

str

Required

The trigger name.

run_id

str

Required

The pipeline run identifier.

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

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'>