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.

begin_start(resource_group_name: str, factory_name: str, trigger_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
trigger_name Required	str The trigger name. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns None

Exceptions

Type	Description
HttpResponseError

begin_stop

Stops a trigger.

begin_stop(resource_group_name: str, factory_name: str, trigger_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
trigger_name Required	str The trigger name. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns None

Exceptions

Type	Description
HttpResponseError

Subscribe event trigger to events.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
trigger_name Required	str The trigger name. Required.

Returns

Type	Description
LROPoller[TriggerSubscriptionOperationStatus]	An instance of LROPoller that returns TriggerSubscriptionOperationStatus. The TriggerSubscriptionOperationStatus is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_unsubscribe_from_events

Unsubscribe event trigger from events.

begin_unsubscribe_from_events(resource_group_name: str, factory_name: str, trigger_name: str, **kwargs: Any) -> LROPoller[TriggerSubscriptionOperationStatus]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
trigger_name Required	str The trigger name. Required.

Returns

Type	Description
LROPoller[TriggerSubscriptionOperationStatus]	An instance of LROPoller that returns TriggerSubscriptionOperationStatus. The TriggerSubscriptionOperationStatus is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

create_or_update

Creates or updates a trigger.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
trigger_name Required	str The trigger name. Required.
trigger Required	TriggerResource or TriggerResource or IO[bytes] Trigger resource definition. Is either a TriggerResource type or a IO[bytes] type. Required.

Keyword-Only Parameters

Name	Description
etag	str check if resource is changed. Set None to skip checking etag. Default value is None. Default value: None
match_condition	MatchConditions The match condition to use upon the etag. Default value is None. Default value: None

Returns

Type	Description
TriggerResource	TriggerResource. The TriggerResource is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

delete

Deletes a trigger.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
trigger_name Required	str The trigger name. Required.

Returns

Type	Description
None	None

Exceptions

Type	Description
HttpResponseError

get

Gets a trigger.

get(resource_group_name: str, factory_name: str, trigger_name: str, *, etag: str | None = None, match_condition: MatchConditions | None = None, **kwargs: Any) -> TriggerResource | None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
trigger_name Required	str The trigger name. Required.

Keyword-Only Parameters

Name	Description
etag	str check if resource is changed. Set None to skip checking etag. Default value is None. Default value: None
match_condition	MatchConditions The match condition to use upon the etag. Default value is None. Default value: None

Returns

Type	Description
TriggerResource, None	TriggerResource or None. The TriggerResource is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get_event_subscription_status

Get a trigger's event subscription status.

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 name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
trigger_name Required	str The trigger name. Required.

Returns

Type	Description
TriggerSubscriptionOperationStatus	TriggerSubscriptionOperationStatus. The TriggerSubscriptionOperationStatus is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list_by_factory

Lists triggers.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.

Returns

Type	Description
ItemPaged[TriggerResource]	An iterator like instance of TriggerResource

Exceptions

Type	Description
HttpResponseError

query_by_factory

Query triggers.

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 name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
filter_parameters Required	TriggerFilterParameters or 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. The TriggerQueryResponse is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

Feedback

Was this page helpful?