New-AzEventGridTopicEventSubscription
Asynchronously creates a new event subscription or updates an existing event subscription.
Syntax
New-AzEventGridTopicEventSubscription
-EventSubscriptionName <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
-TopicName <String>
[-DeadLetterWithResourceIdentityType <String>]
[-DeadLetterWithResourceIdentityUserAssignedIdentity <String>]
[-DeliveryWithResourceIdentityDestination <IEventSubscriptionDestination>]
[-DeliveryWithResourceIdentityType <String>]
[-DeliveryWithResourceIdentityUserAssignedIdentity <String>]
[-Destination <IEventSubscriptionDestination>]
[-EventDeliverySchema <String>]
[-ExpirationTimeUtc <DateTime>]
[-FilterAdvancedFilter <IAdvancedFilter[]>]
[-FilterEnableAdvancedFilteringOnArray]
[-FilterIncludedEventType <String[]>]
[-FilterIsSubjectCaseSensitive]
[-FilterSubjectBeginsWith <String>]
[-FilterSubjectEndsWith <String>]
[-Label <String[]>]
[-RetryPolicyEventTimeToLiveInMinute <Int32>]
[-RetryPolicyMaxDeliveryAttempt <Int32>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzEventGridTopicEventSubscription
-EventSubscriptionName <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
-TopicName <String>
-JsonString <String>
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzEventGridTopicEventSubscription
-EventSubscriptionName <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
-TopicName <String>
-JsonFilePath <String>
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzEventGridTopicEventSubscription
-EventSubscriptionName <String>
-TopicInputObject <IEventGridIdentity>
[-DeadLetterWithResourceIdentityType <String>]
[-DeadLetterWithResourceIdentityUserAssignedIdentity <String>]
[-DeliveryWithResourceIdentityDestination <IEventSubscriptionDestination>]
[-DeliveryWithResourceIdentityType <String>]
[-DeliveryWithResourceIdentityUserAssignedIdentity <String>]
[-Destination <IEventSubscriptionDestination>]
[-EventDeliverySchema <String>]
[-ExpirationTimeUtc <DateTime>]
[-FilterAdvancedFilter <IAdvancedFilter[]>]
[-FilterEnableAdvancedFilteringOnArray]
[-FilterIncludedEventType <String[]>]
[-FilterIsSubjectCaseSensitive]
[-FilterSubjectBeginsWith <String>]
[-FilterSubjectEndsWith <String>]
[-Label <String[]>]
[-RetryPolicyEventTimeToLiveInMinute <Int32>]
[-RetryPolicyMaxDeliveryAttempt <Int32>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzEventGridTopicEventSubscription
-InputObject <IEventGridIdentity>
[-DeadLetterWithResourceIdentityType <String>]
[-DeadLetterWithResourceIdentityUserAssignedIdentity <String>]
[-DeliveryWithResourceIdentityDestination <IEventSubscriptionDestination>]
[-DeliveryWithResourceIdentityType <String>]
[-DeliveryWithResourceIdentityUserAssignedIdentity <String>]
[-Destination <IEventSubscriptionDestination>]
[-EventDeliverySchema <String>]
[-ExpirationTimeUtc <DateTime>]
[-FilterAdvancedFilter <IAdvancedFilter[]>]
[-FilterEnableAdvancedFilteringOnArray]
[-FilterIncludedEventType <String[]>]
[-FilterIsSubjectCaseSensitive]
[-FilterSubjectBeginsWith <String>]
[-FilterSubjectEndsWith <String>]
[-Label <String[]>]
[-RetryPolicyEventTimeToLiveInMinute <Int32>]
[-RetryPolicyMaxDeliveryAttempt <Int32>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Asynchronously creates a new event subscription or updates an existing event subscription.
Examples
Example 1: Asynchronously creates a new event subscription or updates an existing event subscription.
$obj = New-AzEventGridWebHookEventSubscriptionDestinationObject -EndpointUrl "https://azpsweb.azurewebsites.net/api/updates"
New-AzEventGridTopicEventSubscription -EventSubscriptionName azps-eventsub -ResourceGroupName azps_test_group_eventgrid -TopicName azps-topic -FilterIsSubjectCaseSensitive:$false -FilterSubjectBeginsWith "ExamplePrefix" -FilterSubjectEndsWith "ExampleSuffix" -EventDeliverySchema CloudEventSchemaV1_0 -Destination $obj
Name ResourceGroupName
---- -----------------
azps-eventsub azps_test_group_eventgrid
Asynchronously creates a new event subscription or updates an existing event subscription. A usable EndpointUrl can be created from this link: https://zcusa.951200.xyz/en-us/azure/event-grid/custom-event-quickstart-powershell
Parameters
-AsJob
Run the command as a job
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeadLetterWithResourceIdentityType
The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeadLetterWithResourceIdentityUserAssignedIdentity
The user identity associated with the resource.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Type: | PSObject |
Aliases: | AzureRMContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeliveryWithResourceIdentityDestination
Information about the destination where events have to be delivered for the event subscription.Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering.
Type: | IEventSubscriptionDestination |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeliveryWithResourceIdentityType
The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeliveryWithResourceIdentityUserAssignedIdentity
The user identity associated with the resource.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Destination
Information about the destination where events have to be delivered for the event subscription.Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering.
Type: | IEventSubscriptionDestination |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-EventDeliverySchema
The event delivery schema for the event subscription.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-EventSubscriptionName
Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ExpirationTimeUtc
Expiration time of the event subscription.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-FilterAdvancedFilter
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 |
-FilterEnableAdvancedFilteringOnArray
Allows advanced filters to be evaluated against an array of values instead of expecting a singular value.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-FilterIncludedEventType
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 |
-FilterIsSubjectCaseSensitive
Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filtershould be compared in a case sensitive manner.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-FilterSubjectBeginsWith
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 |
-FilterSubjectEndsWith
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 |
-InputObject
Identity Parameter
Type: | IEventGridIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-JsonFilePath
Path of Json file supplied to the Create operation
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-JsonString
Json string supplied to the Create operation
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Label
List of user defined labels.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-NoWait
Run the command asynchronously
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PassThru
Returns true when the command succeeds
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceGroupName
The name of the resource group within the user's subscription.
Type: | String |
Aliases: | ResourceGroup |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RetryPolicyEventTimeToLiveInMinute
Time To Live (in minutes) for events.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RetryPolicyMaxDeliveryAttempt
Maximum number of delivery retry attempts for events.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SubscriptionId
Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: | String |
Position: | Named |
Default value: | (Get-AzContext).Subscription.Id |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TopicInputObject
Identity Parameter
Type: | IEventGridIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-TopicName
Name of the domain topic.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |