Edit

Share via

New-AzEventGridEventSubscriptionFilterObject

  • Reference
Module:
Az.EventGrid

Create an in-memory object for EventSubscriptionFilter.

Syntax

New-AzEventGridEventSubscriptionFilterObject
   [-AdvancedFilter <IAdvancedFilter[]>]
   [-EnableAdvancedFilteringOnArray <Boolean>]
   [-IncludedEventType <String[]>]
   [-IsSubjectCaseSensitive <Boolean>]
   [-SubjectBeginsWith <String>]
   [-SubjectEndsWith <String>]
   [<CommonParameters>]

Description

Create an in-memory object for EventSubscriptionFilter.

Examples

Example 1: Create an in-memory object for EventSubscriptionFilter.

$adviceObj = New-AzEventGridBoolEqualsAdvancedFilterObject -Key "testKey" -Value:$true
New-AzEventGridEventSubscriptionFilterObject -AdvancedFilter $adviceObj -EnableAdvancedFilteringOnArray:$true -IncludedEventType "test" -IsSubjectCaseSensitive:$true -SubjectBeginsWith "startTest" -SubjectEndsWith "endTest"

EnableAdvancedFilteringOnArray IsSubjectCaseSensitive SubjectBeginsWith SubjectEndsWith
------------------------------ ---------------------- ----------------- ---------------
True                           True                   startTest         endTest

Create an in-memory object for EventSubscriptionFilter.

Parameters

-AdvancedFilter

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

Type:IAdvancedFilter[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EnableAdvancedFilteringOnArray

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

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IncludedEventType

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.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IsSubjectCaseSensitive

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

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

EventSubscriptionFilter