Update-AzEventGridTopicEventSubscription
update an existing event subscription for a topic.
Update-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>]
Update-AzEventGridTopicEventSubscription
-EventSubscriptionName <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
-TopicName <String>
-JsonString <String>
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzEventGridTopicEventSubscription
-EventSubscriptionName <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
-TopicName <String>
-JsonFilePath <String>
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-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>]
Update-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>]
update an existing event subscription for a topic.
$obj = New-AzEventGridWebHookEventSubscriptionDestinationObject -EndpointUrl "https://azpsweb.azurewebsites.net/api/updates"
Update-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
Update an existing event subscription for a topic.
Run the command as a job
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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 |
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 |
The user identity associated with the resource.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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 |
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 |
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 |
The user identity associated with the resource.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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 |
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 |
Name of the event subscription to be updated.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Information about the expiration time for the event subscription.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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 |
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 |
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 |
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 |
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 |
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 |
Identity Parameter
Type: | IEventGridIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Path of Json file supplied to the Update operation
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Json string supplied to the Update operation
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
List of user defined labels.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Run the command asynchronously
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Returns true when the command succeeds
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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 |
Time To Live (in minutes) for events.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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 |
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 |
Identity Parameter
Type: | IEventGridIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Name of the domain.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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 |