Package version:

Interface CustomEventsTrigger

Trigger that runs every time a custom event is received.

interface CustomEventsTrigger {
    annotations?: any[];
    description?: string;
    events: any[];
    pipelines?: TriggerPipelineReference[];
    runtimeState?: string;
    scope: string;
    subjectBeginsWith?: string;
    subjectEndsWith?: string;
    type: "CustomEventsTrigger";
}

Hierarchy (view full)

Properties

annotations? description? events pipelines? runtimeState? scope subjectBeginsWith? subjectEndsWith? type

Properties

Optionalannotations

annotations?: any[]

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

Optionaldescription

description?: string

Trigger description.

events

events: any[]

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

Optionalpipelines

pipelines?: TriggerPipelineReference[]

Pipelines that need to be started.

Optional ReadonlyruntimeState

runtimeState?: string

Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. NOTE: This property will not be serialized. It can only be populated by the server.

scope

scope: string

The ARM resource ID of the Azure Event Grid Topic.

OptionalsubjectBeginsWith

subjectBeginsWith?: string

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

OptionalsubjectEndsWith

subjectEndsWith?: string

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

type

type

Polymorphic discriminator, which specifies the different types this object can be

Settings

Member Visibility