CustomEventsTrigger Class

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

Inheritance

azure.mgmt.datafactory.models._models_py3.MultiplePipelineTrigger

CustomEventsTrigger

Constructor

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

Variables

additional_properties

dict[str, any]

Unmatched properties from the message are deserialized to this collection.

type

str

Required. Trigger type.Constant filled by server.

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", "Disabled".

annotations

list[any]

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[any]

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

scope

str

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