TriggersOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

DataFactoryManagementClient's

<xref:triggers> attribute.

Inheritance
builtins.object
TriggersOperations

Constructor

TriggersOperations(*args, **kwargs)

Methods

begin_start

Starts a trigger.

begin_stop

Stops a trigger.

begin_subscribe_to_events

Subscribe event trigger to events.

begin_unsubscribe_from_events

Unsubscribe event trigger from events.

create_or_update

Creates or updates a trigger.

delete

Deletes a trigger.

get

Gets a trigger.

get_event_subscription_status

Get a trigger's event subscription status.

list_by_factory

Lists triggers.

query_by_factory

Query triggers.

begin_start

Starts a trigger.

async begin_start(resource_group_name: str, factory_name: str, trigger_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[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.

cls
callable

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

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

Exceptions

begin_stop

Stops a trigger.

async begin_stop(resource_group_name: str, factory_name: str, trigger_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[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.

cls
callable

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

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

Exceptions

begin_subscribe_to_events

Subscribe event trigger to events.

async begin_subscribe_to_events(resource_group_name: str, factory_name: str, trigger_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.datafactory.models._models_py3.TriggerSubscriptionOperationStatus]

Parameters

resource_group_name
str
Required

The resource group name.

factory_name
str
Required

The factory name.

trigger_name
str
Required

The trigger name.

cls
callable

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

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either TriggerSubscriptionOperationStatus or the result of cls(response)

Return type

Exceptions

begin_unsubscribe_from_events

Unsubscribe event trigger from events.

async begin_unsubscribe_from_events(resource_group_name: str, factory_name: str, trigger_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.datafactory.models._models_py3.TriggerSubscriptionOperationStatus]

Parameters

resource_group_name
str
Required

The resource group name.

factory_name
str
Required

The factory name.

trigger_name
str
Required

The trigger name.

cls
callable

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

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either TriggerSubscriptionOperationStatus or the result of cls(response)

Return type

Exceptions

create_or_update

Creates or updates a trigger.

async create_or_update(resource_group_name: str, factory_name: str, trigger_name: str, trigger: azure.mgmt.datafactory.models._models_py3.TriggerResource, if_match: Optional[str] = None, **kwargs: Any) -> azure.mgmt.datafactory.models._models_py3.TriggerResource

Parameters

resource_group_name
str
Required

The resource group name.

factory_name
str
Required

The factory name.

trigger_name
str
Required

The trigger name.

trigger
TriggerResource
Required

Trigger resource definition.

if_match
str
Required

ETag of the trigger entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. Default value is None.

cls
callable

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

Returns

TriggerResource, or the result of cls(response)

Return type

Exceptions

delete

Deletes a trigger.

async delete(resource_group_name: str, factory_name: str, trigger_name: 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.

cls
callable

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

Returns

None, or the result of cls(response)

Return type

Exceptions

get

Gets a trigger.

async get(resource_group_name: str, factory_name: str, trigger_name: str, if_none_match: Optional[str] = None, **kwargs: Any) -> Optional[azure.mgmt.datafactory.models._models_py3.TriggerResource]

Parameters

resource_group_name
str
Required

The resource group name.

factory_name
str
Required

The factory name.

trigger_name
str
Required

The trigger name.

if_none_match
str
Required

ETag of the trigger entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. Default value is None.

cls
callable

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

Returns

TriggerResource, or the result of cls(response)

Return type

Exceptions

get_event_subscription_status

Get a trigger's event subscription status.

async get_event_subscription_status(resource_group_name: str, factory_name: str, trigger_name: str, **kwargs: Any) -> azure.mgmt.datafactory.models._models_py3.TriggerSubscriptionOperationStatus

Parameters

resource_group_name
str
Required

The resource group name.

factory_name
str
Required

The factory name.

trigger_name
str
Required

The trigger name.

cls
callable

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

Returns

TriggerSubscriptionOperationStatus, or the result of cls(response)

Return type

Exceptions

list_by_factory

Lists triggers.

list_by_factory(resource_group_name: str, factory_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.datafactory.models._models_py3.TriggerListResponse]

Parameters

resource_group_name
str
Required

The resource group name.

factory_name
str
Required

The factory name.

cls
callable

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

Returns

An iterator like instance of either TriggerListResponse or the result of cls(response)

Return type

Exceptions

query_by_factory

Query triggers.

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

Parameters

resource_group_name
str
Required

The resource group name.

factory_name
str
Required

The factory name.

filter_parameters
TriggerFilterParameters
Required

Parameters to filter the triggers.

cls
callable

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

Returns

TriggerQueryResponse, or the result of cls(response)

Return type

Exceptions

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