Share via


EventSubscriptionFilter Class

Definition

Filter for the Event Subscription.

public class EventSubscriptionFilter
public class EventSubscriptionFilter : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.EventGrid.Models.EventSubscriptionFilter>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.EventGrid.Models.EventSubscriptionFilter>
type EventSubscriptionFilter = class
type EventSubscriptionFilter = class
    interface IJsonModel<EventSubscriptionFilter>
    interface IPersistableModel<EventSubscriptionFilter>
Public Class EventSubscriptionFilter
Public Class EventSubscriptionFilter
Implements IJsonModel(Of EventSubscriptionFilter), IPersistableModel(Of EventSubscriptionFilter)
Inheritance
EventSubscriptionFilter
Implements

Constructors

EventSubscriptionFilter()

Initializes a new instance of EventSubscriptionFilter.

Properties

AdvancedFilters

An array of advanced filters that are used for filtering event subscriptions. Please note AdvancedFilter is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include BoolEqualsAdvancedFilter, IsNotNullAdvancedFilter, IsNullOrUndefinedAdvancedFilter, NumberGreaterThanAdvancedFilter, NumberGreaterThanOrEqualsAdvancedFilter, NumberInAdvancedFilter, NumberInRangeAdvancedFilter, NumberLessThanAdvancedFilter, NumberLessThanOrEqualsAdvancedFilter, NumberNotInAdvancedFilter, NumberNotInRangeAdvancedFilter, StringBeginsWithAdvancedFilter, StringContainsAdvancedFilter, StringEndsWithAdvancedFilter, StringInAdvancedFilter, StringNotBeginsWithAdvancedFilter, StringNotContainsAdvancedFilter, StringNotEndsWithAdvancedFilter and StringNotInAdvancedFilter.

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.

IsAdvancedFilteringOnArraysEnabled

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

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.

Explicit Interface Implementations

IJsonModel<EventSubscriptionFilter>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<EventSubscriptionFilter>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<EventSubscriptionFilter>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<EventSubscriptionFilter>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<EventSubscriptionFilter>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to