New-AzEventGridSubscription
Asynchronously create a new event subscription or create an existing event subscription based on the specified scope.
Syntax
New-AzEventGridSubscription
-Name <String>
-Scope <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-AzEventGridSubscription
-Name <String>
-Scope <String>
-JsonString <String>
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzEventGridSubscription
-Name <String>
-Scope <String>
-JsonFilePath <String>
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzEventGridSubscription
-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 create a new event subscription or create an existing event subscription based on the specified scope.
Examples
Example 1: Asynchronously creates a new event subscription or updates an existing event subscription based on the specified scope.
$obj = New-AzEventGridWebHookEventSubscriptionDestinationObject -EndpointUrl "https://azpsweb.azurewebsites.net/api/updates"
New-AzEventGridSubscription -Name azps-eventsub -Scope "subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" -Destination $obj -FilterIsSubjectCaseSensitive:$false
Name ResourceGroupName
---- -----------------
azps-eventsubAsynchronously creates a new event subscription or updates an existing event subscription based on the specified scope.
Example 2: Asynchronously creates a new event subscription or updates an existing event subscription based on the specified scope.
$obj = New-AzEventGridWebHookEventSubscriptionDestinationObject -EndpointUrl "https://azpsweb.azurewebsites.net/api/updates"
$topic = Get-AzEventGridTopic -ResourceGroupName azps_test_group_eventgrid -Name azps-topic
New-AzEventGridSubscription -Name azps-eventsub -Scope $topic.Id -Destination $obj -FilterIsSubjectCaseSensitive:$false -FilterSubjectBeginsWith "ExamplePrefix" -FilterSubjectEndsWith "ExampleSuffix"
Name ResourceGroupName
---- -----------------
azps-eventsub azps_test_group_eventgridAsynchronously creates a new event subscription or updates an existing event subscription based on the specified scope.
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 |
| Aliases: | DeliverySchema |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExpirationTimeUtc
Expiration time of the event subscription.
| Type: | DateTime |
| Aliases: | ExpirationDate |
| 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[] |
| Aliases: | AdvancedFilter |
| 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 |
| Aliases: | AdvancedFilteringOnArray |
| 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[] |
| Aliases: | IncludedEventType |
| 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 |
| Aliases: | SubjectCaseSensitive |
| 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 |
| Aliases: | SubjectBeginsWith |
| 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 |
| Aliases: | SubjectEndsWith |
| 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 |
-Name
Name of the event subscription. Event subscription names must be between 3 and 64 characters in length and should use alphanumeric letters only.
| Type: | String |
| Aliases: | EventSubscriptionName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| 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 |
-RetryPolicyEventTimeToLiveInMinute
Time To Live (in minutes) for events.
| Type: | Int32 |
| Aliases: | EventTtl |
| 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 |
| Aliases: | MaxDeliveryAttempt |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Scope
The identifier of the resource to which the event subscription needs to be created or updated. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid 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 |
Inputs
Outputs
Azure PowerShell