Share via

EventSubscriptionFilter interface

Package:
@azure/arm-eventgrid

Filter for the Event Subscription.

Properties

advancedFilters

An array of advanced filters that are used for filtering event subscriptions.
enableAdvancedFilteringOnArrays

Allows advanced filters to be evaluated against an array of values instead of expecting a singular value.
includedEventTypes

A list of applicable event types that need to be part of the event subscription. If it is desired to subscribe to all default event types, set the IncludedEventTypes to null.
isSubjectCaseSensitive

Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner.
subjectBeginsWith

An optional string to filter events for an event subscription based on a resource path prefix. The format of this depends on the publisher of the events. Wildcard characters are not supported in this path.
subjectEndsWith

An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path.

Property Details

advancedFilters

An array of advanced filters that are used for filtering event subscriptions.

advancedFilters?: AdvancedFilterUnion[]

Property Value

AdvancedFilterUnion[]

enableAdvancedFilteringOnArrays

Allows advanced filters to be evaluated against an array of values instead of expecting a singular value.

enableAdvancedFilteringOnArrays?: boolean

Property Value

boolean

includedEventTypes

A list of applicable event types that need to be part of the event subscription. If it is desired to subscribe to all default event types, set the IncludedEventTypes to null.

includedEventTypes?: string[]

Property Value

string[]

isSubjectCaseSensitive

Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner.

isSubjectCaseSensitive?: boolean

Property Value

boolean

subjectBeginsWith

An optional string to filter events for an event subscription based on a resource path prefix. The format of this depends on the publisher of the events. Wildcard characters are not supported in this path.

subjectBeginsWith?: string

Property Value

string

subjectEndsWith

An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path.

subjectEndsWith?: string

Property Value

string