New-AzEventGridPartnerTopicEventSubscription

  • Reference
Module:
Az.EventGrid

Asynchronously creates or updates an event subscription of a partner topic with the specified parameters. Existing event subscriptions will be updated with this API.

Syntax

New-AzEventGridPartnerTopicEventSubscription
   -EventSubscriptionName <String>
   -PartnerTopicName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <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-AzEventGridPartnerTopicEventSubscription
   -EventSubscriptionName <String>
   -PartnerTopicName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -JsonString <String>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzEventGridPartnerTopicEventSubscription
   -EventSubscriptionName <String>
   -PartnerTopicName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -JsonFilePath <String>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzEventGridPartnerTopicEventSubscription
   -EventSubscriptionName <String>
   -PartnerTopicInputObject <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-AzEventGridPartnerTopicEventSubscription
   -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 or updates an event subscription of a partner topic with the specified parameters. Existing event subscriptions will be updated with this API.

Examples

Example 1: Asynchronously Create an event subscription of a partner topic with the specified parameters.

$obj = New-AzEventGridWebHookEventSubscriptionDestinationObject -EndpointUrl "https://azpsweb.azurewebsites.net"
New-AzEventGridPartnerTopicEventSubscription -EventSubscriptionName azps-eventsub -ResourceGroupName azps_test_group_eventgrid -PartnerTopicName default -FilterIsSubjectCaseSensitive:$false -FilterSubjectBeginsWith "ExamplePrefix" -FilterSubjectEndsWith "ExampleSuffix" -EventDeliverySchema CloudEventSchemaV1_0 -Destination $obj

Name              ResourceGroupName
----              -----------------
azps-eventsubname azps_test_group_eventgrid

Asynchronously Create an event subscription of a partner topic with the specified parameters. Existing event subscriptions will be updated with this API.

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

-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
Aliases:Name
Position:Named
Default value:None
Required:True
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

-NoWait

Run the command asynchronously

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

-PartnerTopicInputObject

Identity Parameter

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

-PartnerTopicName

Name of the partner topic.

Type:String
Position:Named
Default value:None
Required:True
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
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

-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

-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

IEventGridIdentity

Outputs

IEventSubscription