TriggersOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:triggers> attribute.

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) -> AsyncLROPoller[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.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_stop

Stops a trigger.

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

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Subscribe event trigger to events.

async begin_subscribe_to_events(resource_group_name: str, factory_name: str, trigger_name: str, **kwargs: Any) -> AsyncLROPoller[TriggerSubscriptionOperationStatus]

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.

Returns

Type	Description
AsyncLROPoller[TriggerSubscriptionOperationStatus]	An instance of AsyncLROPoller that returns either TriggerSubscriptionOperationStatus or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

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) -> AsyncLROPoller[TriggerSubscriptionOperationStatus]

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.

Returns

Type	Description
AsyncLROPoller[TriggerSubscriptionOperationStatus]	An instance of AsyncLROPoller that returns either TriggerSubscriptionOperationStatus or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

create_or_update

Creates or updates a trigger.

async create_or_update(resource_group_name: str, factory_name: str, trigger_name: str, trigger: _models.TriggerResource, if_match: str | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.TriggerResource

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.
trigger Required	TriggerResource or IO[bytes] Trigger resource definition. Is either a TriggerResource type or a IO[bytes] type. Required.
if_match	str 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. Default value: None

Returns

Type	Description
TriggerResource	TriggerResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete

Deletes a trigger.

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

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets a trigger.

async get(resource_group_name: str, factory_name: str, trigger_name: str, if_none_match: str | None = None, **kwargs: Any) -> TriggerResource | 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.
if_none_match	str 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. Default value: None

Returns

Type	Description
TriggerResource, None	TriggerResource or None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

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) -> TriggerSubscriptionOperationStatus

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.

Returns

Type	Description
TriggerSubscriptionOperationStatus	TriggerSubscriptionOperationStatus or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_factory

Lists triggers.

list_by_factory(resource_group_name: str, factory_name: str, **kwargs: Any) -> AsyncIterable[TriggerResource]

Parameters

Name	Description
resource_group_name Required	str The resource group name. Required.
factory_name Required	str The factory name. Required.

Returns

Type	Description
AsyncItemPaged[TriggerResource]	An iterator like instance of either TriggerResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

query_by_factory

Query triggers.

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

Parameters

Name	Description
resource_group_name Required	str The resource group name. Required.
factory_name Required	str The factory name. Required.
filter_parameters Required	TriggerFilterParameters or IO[bytes] Parameters to filter the triggers. Is either a TriggerFilterParameters type or a IO[bytes] type. Required.

Returns

Type	Description
TriggerQueryResponse	TriggerQueryResponse or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.datafactory.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv110\\Lib\\site-packages\\azure\\mgmt\\datafactory\\models\\__init__.py'>

Feedback

Was this page helpful?

Share via

TriggersOperations Class

Constructor

Methods

begin_start

Parameters

Returns

Exceptions

begin_stop

Parameters

Returns

Exceptions

begin_subscribe_to_events

Parameters

Returns

Exceptions

begin_unsubscribe_from_events

Parameters

Returns

Exceptions

create_or_update

Parameters

Returns

Exceptions

delete

Parameters

Returns

Exceptions

get

Parameters

Returns

Exceptions

get_event_subscription_status

Parameters

Returns

Exceptions

list_by_factory

Parameters

Returns

Exceptions

query_by_factory

Parameters

Returns

Exceptions

Attributes

models

Feedback