Share via

CustomEventsTrigger Class

  • Reference

Trigger that runs every time a custom event is received.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Inheritance
azure.mgmt.datafactory.models._models_py3.MultiplePipelineTrigger
CustomEventsTrigger

Constructor

CustomEventsTrigger(*, events: List[MutableMapping[str, Any]], scope: str, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description: str | None = None, annotations: List[MutableMapping[str, Any]] | None = None, pipelines: List[_models.TriggerPipelineReference] | None = None, subject_begins_with: str | None = None, subject_ends_with: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
additional_properties
dict[str, <xref:JSON>]

Unmatched properties from the message are deserialized to this collection.
description
str

Trigger description.
annotations
list[<xref:JSON>]

List of tags that can be used for describing the trigger.
pipelines
list[TriggerPipelineReference]

Pipelines that need to be started.
subject_begins_with
str

The event subject must begin with the pattern provided for trigger to fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith.
subject_ends_with
str

The event subject must end with the pattern provided for trigger to fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith.
events
list[<xref:JSON>]

The list of event types that cause this trigger to fire. Required.
scope
str

The ARM resource ID of the Azure Event Grid Topic. Required.

Variables

Name Description
additional_properties
dict[str, <xref:JSON>]

Unmatched properties from the message are deserialized to this collection.
type
str

Trigger type. Required.
description
str

Trigger description.
runtime_state
str or TriggerRuntimeState

Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. Known values are: "Started", "Stopped", and "Disabled".
annotations
list[<xref:JSON>]

List of tags that can be used for describing the trigger.
pipelines
list[TriggerPipelineReference]

Pipelines that need to be started.
subject_begins_with
str

The event subject must begin with the pattern provided for trigger to fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith.
subject_ends_with
str

The event subject must end with the pattern provided for trigger to fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith.
events
list[<xref:JSON>]

The list of event types that cause this trigger to fire. Required.
scope
str

The ARM resource ID of the Azure Event Grid Topic. Required.