CustomEventsTrigger interface

Package:

@azure/arm-datafactory

Trigger that runs every time a custom event is received.

Extends

MultiplePipelineTrigger

Properties

events	The list of event types that cause this trigger to fire.
scope	The ARM resource ID of the Azure Event Grid Topic.
subjectBeginsWith	The event subject must begin with the pattern provided for trigger to fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith.
subjectEndsWith	The event subject must end with the pattern provided for trigger to fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith.
type	Trigger type.

Inherited Properties

additionalProperties	Additional properties
annotations	List of tags that can be used for describing the trigger.
description	Trigger description.
pipelines	Pipelines that need to be started.
runtimeState	Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger.

Property Details

events

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

events: any[]

Property Value

any[]

scope

The ARM resource ID of the Azure Event Grid Topic.

scope: string

Property Value

string

subjectBeginsWith

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

subjectBeginsWith?: string

Property Value

string

subjectEndsWith

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

subjectEndsWith?: string

Property Value

string

type

Trigger type.

type: "CustomEventsTrigger"

Property Value

"CustomEventsTrigger"

Inherited Property Details

additionalProperties

Additional properties

additionalProperties?: Record<string, any>

Property Value

Record<string, any>

Inherited From MultiplePipelineTrigger.additionalProperties

annotations

List of tags that can be used for describing the trigger.

annotations?: any[]

Property Value

any[]

Inherited From MultiplePipelineTrigger.annotations

description

Trigger description.

description?: string

Property Value

string

Inherited From MultiplePipelineTrigger.description

pipelines

Pipelines that need to be started.

pipelines?: TriggerPipelineReference[]

Property Value

TriggerPipelineReference[]

Inherited From MultiplePipelineTrigger.pipelines

runtimeState

Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger.

runtimeState?: string

Property Value

string

Inherited From MultiplePipelineTrigger.runtimeState