你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

New-AzEventGridSystemTopicEventSubscription

使用指定的参数异步创建或更新事件订阅。 现有事件订阅将使用此 API 进行更新。

语法

New-AzEventGridSystemTopicEventSubscription
   -EventSubscriptionName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -SystemTopicName <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-AzEventGridSystemTopicEventSubscription
   -EventSubscriptionName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -SystemTopicName <String>
   -JsonString <String>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzEventGridSystemTopicEventSubscription
   -EventSubscriptionName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -SystemTopicName <String>
   -JsonFilePath <String>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzEventGridSystemTopicEventSubscription
   -EventSubscriptionName <String>
   -SystemTopicInputObject <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-AzEventGridSystemTopicEventSubscription
   -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>]

说明

使用指定的参数异步创建或更新事件订阅。 现有事件订阅将使用此 API 进行更新。

示例

示例 1:使用指定参数异步创建事件订阅。

$obj = New-AzEventGridWebHookEventSubscriptionDestinationObject -EndpointUrl "https://azpsweb.azurewebsites.net"
New-AzEventGridSystemTopicEventSubscription -EventSubscriptionName azps-evnetsub -ResourceGroupName azps_test_group_eventgrid -SystemTopicName azps-systopic -FilterIsSubjectCaseSensitive:$false -FilterSubjectBeginsWith "ExamplePrefix" -FilterSubjectEndsWith "ExampleSuffix" -Destination $obj

Name          ResourceGroupName
----          -----------------
azps-evnetsub azps_test_group_eventgrid

使用指定参数异步创建事件订阅。 现有事件订阅将使用此 API 进行更新。

参数

-AsJob

以作业身份运行命令

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Confirm

提示你在运行 cmdlet 之前进行确认。

类型:SwitchParameter
别名:cf
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-DeadLetterWithResourceIdentityType

使用的托管标识的类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-DeadLetterWithResourceIdentityUserAssignedIdentity

与资源关联的用户标识。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-DefaultProfile

DefaultProfile 参数不起作用。 如果对其他订阅执行 cmdlet,请使用 SubscriptionId 参数。

类型:PSObject
别名:AzureRMContext, AzureCredential
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-DeliveryWithResourceIdentityDestination

有关事件订阅必须传送事件的目标的信息。使用Azure 事件网格的标识来获取在传递/死信期间使用的身份验证令牌。

类型:IEventSubscriptionDestination
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-DeliveryWithResourceIdentityType

使用的托管标识的类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-DeliveryWithResourceIdentityUserAssignedIdentity

与资源关联的用户标识。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Destination

有关事件订阅必须传送事件的目标的信息。使用Azure 事件网格的标识来获取在传递/死信期间使用的身份验证令牌。

类型:IEventSubscriptionDestination
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-EventDeliverySchema

事件订阅的事件传送架构。

类型:String
别名:DeliverySchema
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-EventSubscriptionName

要创建的事件订阅的名称。 事件订阅名称长度必须介于 3 到 100 个字符之间,并且仅使用字母数字字母。

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-ExpirationTimeUtc

事件订阅的过期时间。

类型:DateTime
别名:ExpirationDate
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-FilterAdvancedFilter

用于筛选事件订阅的高级筛选器数组。

类型:IAdvancedFilter[]
别名:AdvancedFilter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-FilterEnableAdvancedFilteringOnArray

允许针对值数组(而不是期望一个单一值)评估高级筛选器。

类型:SwitchParameter
别名:AdvancedFilteringOnArray
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-FilterIncludedEventType

需要属于事件订阅的适用事件类型的列表。 如果需要订阅所有默认事件类型,请将 IncludedEventTypes 设置为 null。

类型:String[]
别名:IncludedEventType
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-FilterIsSubjectCaseSensitive

指定是否以区分大小写的方式比较筛选器的 SubjectBeginsWith 和 SubjectEndsWith 属性。

类型:SwitchParameter
别名:SubjectCaseSensitive
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-FilterSubjectBeginsWith

一个可选字符串,用于根据资源路径前缀筛选事件订阅的事件。此格式取决于事件的发布者。此路径不支持通配符。

类型:String
别名:SubjectBeginsWith
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-FilterSubjectEndsWith

一个可选字符串,用于根据资源路径后缀筛选事件订阅的事件。此路径不支持通配符。

类型:String
别名:SubjectEndsWith
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-InputObject

标识参数

类型:IEventGridIdentity
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-JsonFilePath

提供给“创建”操作的 Json 文件的路径

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-JsonString

提供给“创建”操作的 Json 字符串

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-Label

用户定义的标签列表。

类型:String[]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-NoWait

异步运行命令

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-PassThru

当命令成功时返回 true

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ResourceGroupName

用户订阅中的资源组的名称。

类型:String
别名:ResourceGroup
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-RetryPolicyEventTimeToLiveInMinute

事件生存时间(以分钟为单位)。

类型:Int32
别名:EventTtl
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-RetryPolicyMaxDeliveryAttempt

事件的最大传递重试尝试次数。

类型:Int32
别名:MaxDeliveryAttempt
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-SubscriptionId

唯一标识Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

类型:String
Position:Named
默认值:(Get-AzContext).Subscription.Id
必需:False
接受管道输入:False
接受通配符:False

-SystemTopicInputObject

标识参数

类型:IEventGridIdentity
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-SystemTopicName

系统主题的名称。

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-WhatIf

显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。

类型:SwitchParameter
别名:wi
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

输入

IEventGridIdentity

输出

IEventSubscription