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

New-AzEventGridSubscription

创建主题、Azure 资源、Azure 订阅或资源组的新Azure 事件网格事件订阅。

语法

New-AzEventGridSubscription
   [-EventSubscriptionName] <String>
   [-Endpoint] <String>
   [[-ResourceGroupName] <String>]
   [-EndpointType <String>]
   [-SubjectBeginsWith <String>]
   [-SubjectEndsWith <String>]
   [-SubjectCaseSensitive]
   [-IncludedEventType <String[]>]
   [-Label <String[]>]
   [-EventTtl <Int32>]
   [-MaxDeliveryAttempt <Int32>]
   [-DeliverySchema <String>]
   [-DeadLetterEndpoint <String>]
   [-ExpirationDate <DateTime>]
   [-AdvancedFilter <Hashtable[]>]
   [-MaxEventsPerBatch <Int32>]
   [-PreferredBatchSizeInKiloByte <Int32>]
   [-AzureActiveDirectoryTenantId <String>]
   [-AzureActiveDirectoryApplicationIdOrUri <String>]
   [-AdvancedFilteringOnArray]
   [-DeliveryAttributeMapping <String[]>]
   [-StorageQueueMessageTtl <Int64>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzEventGridSubscription
   [-ResourceId] <String>
   [-EventSubscriptionName] <String>
   [-Endpoint] <String>
   [-EndpointType <String>]
   [-SubjectBeginsWith <String>]
   [-SubjectEndsWith <String>]
   [-SubjectCaseSensitive]
   [-IncludedEventType <String[]>]
   [-Label <String[]>]
   [-EventTtl <Int32>]
   [-MaxDeliveryAttempt <Int32>]
   [-DeliverySchema <String>]
   [-DeadLetterEndpoint <String>]
   [-ExpirationDate <DateTime>]
   [-AdvancedFilter <Hashtable[]>]
   [-MaxEventsPerBatch <Int32>]
   [-PreferredBatchSizeInKiloByte <Int32>]
   [-AzureActiveDirectoryTenantId <String>]
   [-AzureActiveDirectoryApplicationIdOrUri <String>]
   [-AdvancedFilteringOnArray]
   [-DeliveryAttributeMapping <String[]>]
   [-StorageQueueMessageTtl <Int64>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzEventGridSubscription
   [-InputObject] <PSTopic>
   [-EventSubscriptionName] <String>
   [-Endpoint] <String>
   [-EndpointType <String>]
   [-SubjectBeginsWith <String>]
   [-SubjectEndsWith <String>]
   [-SubjectCaseSensitive]
   [-IncludedEventType <String[]>]
   [-Label <String[]>]
   [-EventTtl <Int32>]
   [-MaxDeliveryAttempt <Int32>]
   [-DeliverySchema <String>]
   [-DeadLetterEndpoint <String>]
   [-ExpirationDate <DateTime>]
   [-AdvancedFilter <Hashtable[]>]
   [-MaxEventsPerBatch <Int32>]
   [-PreferredBatchSizeInKiloByte <Int32>]
   [-AzureActiveDirectoryTenantId <String>]
   [-AzureActiveDirectoryApplicationIdOrUri <String>]
   [-AdvancedFilteringOnArray]
   [-DeliveryAttributeMapping <String[]>]
   [-StorageQueueMessageTtl <Int64>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzEventGridSubscription
   [-DomainInputObject] <PSDomain>
   [-EventSubscriptionName] <String>
   [-Endpoint] <String>
   [-EndpointType <String>]
   [-SubjectBeginsWith <String>]
   [-SubjectEndsWith <String>]
   [-SubjectCaseSensitive]
   [-IncludedEventType <String[]>]
   [-Label <String[]>]
   [-EventTtl <Int32>]
   [-MaxDeliveryAttempt <Int32>]
   [-DeliverySchema <String>]
   [-DeadLetterEndpoint <String>]
   [-ExpirationDate <DateTime>]
   [-AdvancedFilter <Hashtable[]>]
   [-MaxEventsPerBatch <Int32>]
   [-PreferredBatchSizeInKiloByte <Int32>]
   [-AzureActiveDirectoryTenantId <String>]
   [-AzureActiveDirectoryApplicationIdOrUri <String>]
   [-AdvancedFilteringOnArray]
   [-DeliveryAttributeMapping <String[]>]
   [-StorageQueueMessageTtl <Int64>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzEventGridSubscription
   [-DomainTopicInputObject] <PSDomainTopic>
   [-EventSubscriptionName] <String>
   [-Endpoint] <String>
   [-EndpointType <String>]
   [-SubjectBeginsWith <String>]
   [-SubjectEndsWith <String>]
   [-SubjectCaseSensitive]
   [-IncludedEventType <String[]>]
   [-Label <String[]>]
   [-EventTtl <Int32>]
   [-MaxDeliveryAttempt <Int32>]
   [-DeliverySchema <String>]
   [-DeadLetterEndpoint <String>]
   [-ExpirationDate <DateTime>]
   [-AdvancedFilter <Hashtable[]>]
   [-MaxEventsPerBatch <Int32>]
   [-PreferredBatchSizeInKiloByte <Int32>]
   [-AzureActiveDirectoryTenantId <String>]
   [-AzureActiveDirectoryApplicationIdOrUri <String>]
   [-AdvancedFilteringOnArray]
   [-DeliveryAttributeMapping <String[]>]
   [-StorageQueueMessageTtl <Int64>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzEventGridSubscription
   [-EventSubscriptionName] <String>
   [-Endpoint] <String>
   [-ResourceGroupName] <String>
   [-TopicName] <String>
   [-EndpointType <String>]
   [-SubjectBeginsWith <String>]
   [-SubjectEndsWith <String>]
   [-SubjectCaseSensitive]
   [-IncludedEventType <String[]>]
   [-Label <String[]>]
   [-EventTtl <Int32>]
   [-MaxDeliveryAttempt <Int32>]
   [-DeliverySchema <String>]
   [-DeadLetterEndpoint <String>]
   [-ExpirationDate <DateTime>]
   [-AdvancedFilter <Hashtable[]>]
   [-MaxEventsPerBatch <Int32>]
   [-PreferredBatchSizeInKiloByte <Int32>]
   [-AzureActiveDirectoryTenantId <String>]
   [-AzureActiveDirectoryApplicationIdOrUri <String>]
   [-AdvancedFilteringOnArray]
   [-DeliveryAttributeMapping <String[]>]
   [-StorageQueueMessageTtl <Int64>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzEventGridSubscription
   [-EventSubscriptionName] <String>
   [-Endpoint] <String>
   [-ResourceGroupName] <String>
   [-DomainName] <String>
   [-EndpointType <String>]
   [-SubjectBeginsWith <String>]
   [-SubjectEndsWith <String>]
   [-SubjectCaseSensitive]
   [-IncludedEventType <String[]>]
   [-Label <String[]>]
   [-EventTtl <Int32>]
   [-MaxDeliveryAttempt <Int32>]
   [-DeliverySchema <String>]
   [-DeadLetterEndpoint <String>]
   [-ExpirationDate <DateTime>]
   [-AdvancedFilter <Hashtable[]>]
   [-MaxEventsPerBatch <Int32>]
   [-PreferredBatchSizeInKiloByte <Int32>]
   [-AzureActiveDirectoryTenantId <String>]
   [-AzureActiveDirectoryApplicationIdOrUri <String>]
   [-AdvancedFilteringOnArray]
   [-DeliveryAttributeMapping <String[]>]
   [-StorageQueueMessageTtl <Int64>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzEventGridSubscription
   [-EventSubscriptionName] <String>
   [-Endpoint] <String>
   [-ResourceGroupName] <String>
   [-DomainName] <String>
   -DomainTopicName <String>
   [-EndpointType <String>]
   [-SubjectBeginsWith <String>]
   [-SubjectEndsWith <String>]
   [-SubjectCaseSensitive]
   [-IncludedEventType <String[]>]
   [-Label <String[]>]
   [-EventTtl <Int32>]
   [-MaxDeliveryAttempt <Int32>]
   [-DeliverySchema <String>]
   [-DeadLetterEndpoint <String>]
   [-ExpirationDate <DateTime>]
   [-AdvancedFilter <Hashtable[]>]
   [-MaxEventsPerBatch <Int32>]
   [-PreferredBatchSizeInKiloByte <Int32>]
   [-AzureActiveDirectoryTenantId <String>]
   [-AzureActiveDirectoryApplicationIdOrUri <String>]
   [-AdvancedFilteringOnArray]
   [-DeliveryAttributeMapping <String[]>]
   [-StorageQueueMessageTtl <Int64>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

说明

为Azure 事件网格主题、支持的 Azure 资源、Azure 订阅或资源组创建新的事件订阅。 若要创建当前所选 Azure 订阅的事件订阅,请指定事件订阅名称和目标终结点。 若要创建资源组的事件订阅,除了事件订阅名称和目标终结点之外,还指定资源组名称。 若要创建Azure 事件网格主题的事件订阅,请指定主题名称。 若要创建受支持的 Azure 资源的事件订阅,请指定资源的完整资源 ID。 若要查看受支持的类型列表,请运行 Get-AzEventGridTopicType cmdlet。

示例

示例 1

New-AzEventGridSubscription -ResourceGroup MyResourceGroup -TopicName Topic1 -Endpoint https://requestb.in/19qlscd1 -EventSubscriptionName EventSubscription1

使用 webhook 目标终结点https://requestb.in/19qlscd1在资源组“MyResourceGroupName”中创建Azure 事件网格主题“Topic1”的新事件订阅“EventSubscription1”。 此事件订阅使用默认筛选器。

示例 2

New-AzEventGridSubscription -ResourceGroup MyResourceGroupName -Endpoint https://requestb.in/19qlscd1 -EventSubscriptionName EventSubscription1

使用 Webhook 目标终结点 https://requestb.in/19qlscd1创建资源组“MyResourceGroupName”的新事件订阅“EventSubscription1”。 此事件订阅使用默认筛选器。

示例 3

New-AzEventGridSubscription -Endpoint https://requestb.in/19qlscd1 -EventSubscriptionName EventSubscription1

使用 Webhook 目标终结点 https://requestb.in/19qlscd1将新的事件订阅“EventSubscription1”创建到当前选定的 Azure 订阅。 此事件订阅使用默认筛选器。

示例 4

$includedEventTypes = "Microsoft.Resources.ResourceWriteFailure", "Microsoft.Resources.ResourceWriteSuccess"
$labels = "Finance", "HR"
New-AzEventGridSubscription -Endpoint https://requestb.in/19qlscd1 -EventSubscriptionName EventSubscription1 -SubjectBeginsWith "TestPrefix" -SubjectEndsWith "TestSuffix" -IncludedEventType $includedEventTypes -Label $labels

使用 Webhook 目标终结点 https://requestb.in/19qlscd1将新的事件订阅“EventSubscription1”创建到当前选定的 Azure 订阅。 此事件订阅指定事件类型和主题的其他筛选器,并且仅将匹配这些筛选器的事件传递到目标终结点。

示例 5

New-AzEventGridSubscription -EventSubscriptionName EventSubscription1 -EndpointType "eventhub" -Endpoint "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"

将一个新的事件订阅“EventSubscription1”创建到当前选定的 Azure 订阅,并将指定的事件中心用作事件的目标。 此事件订阅使用默认筛选器。

示例 6

New-AzEventGridSubscription -ResourceId "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace" -Endpoint https://requestb.in/19qlscd1 -EventSubscriptionName EventSubscription1

使用指定的 Webhook 目标终结点 https://requestb.in/19qlscd1创建 EventHub 命名空间的新事件订阅“EventSubscription1”。 此事件订阅使用默认筛选器。

参数

-AdvancedFilter

高级筛选器,指定用于基于属性的筛选的多个哈希表值的数组。 每个哈希表值具有以下键值信息:操作、键和值或值。 运算符可以是下列值之一:NumberIn、NumberNotIn、NumberLessThan、NumberGreaterThan、NumberLessThanOrEquals、NumberGreaterThanOrEquals、BoolEquals、StringIn、StringNotIn、StringBeginsWith、StringEndsWith 或 StringContains。 键表示应用高级筛选策略的有效负载属性。 最后,值或值表示要匹配的值或值集。 可以是相应类型或值数组的单个值。 作为高级筛选器参数的示例:$AdvancedFilters=@ ($AdvFilter 1,$AdvFilter 2) 其中$AdvFilter 1=@{operator=“NumberIn”; key=“Data.Key1”;Values=@ (1,2) } 和 $AdvFilter 2=@{operator=“StringBringsWith”; key=“Subject”;Values=@ (“SubjectPrefix1”,“SubjectPrefix2”) }

Type:Hashtable[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-AdvancedFilteringOnArray

此参数的存在表示已启用对数组的高级筛选

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

-AzureActiveDirectoryApplicationIdOrUri

Azure Active Directory (AAD) 应用程序 ID 或 URI,以获取将作为传递请求中的持有者令牌包含的访问令牌。仅适用于 Webhook 作为目标。

Type:String
Aliases:AliasAadAppIdUri
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-AzureActiveDirectoryTenantId

Azure Active Directory (AAD) 租户 ID,以获取将作为传递请求中的持有者令牌包含的访问令牌。仅适用于 Webhook 作为目标。

Type:String
Aliases:AliasAadTenantId
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

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

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

-DeadLetterEndpoint

用于存储未传递事件的终结点。 指定存储 Blob 容器的 Azure 资源 ID。 例如:/subscriptions/[SubscriptionId]/resourceGroups/[ResourceGroupName]/providers/Microsoft.Storage/storageAccounts/[StorageAccountName]/blobServices/default/containers/[ContainerName]。

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

-DefaultProfile

用于与 azure 通信的凭据、帐户、租户和订阅

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-DeliveryAttributeMapping

此系统主题事件订阅的传递属性映射

Type:String[]
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-DeliverySchema

将事件传送到目标时要使用的架构。 可能的值包括:eventgridschema、CustomInputSchema 或 cloudeventv01schema。 默认值为 CustomInputSchema。

Type:String
Accepted values:EventGridSchema, CustomInputSchema, CloudEventSchemaV1_0, EventGridSchema, CustomInputSchema, CloudEventSchemaV1_0, EventGridSchema, CustomInputSchema, CloudEventSchemaV1_0, EventGridSchema, CustomInputSchema, CloudEventSchemaV1_0
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-DomainInputObject

EventGrid 域对象。

Type:PSDomain
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-DomainName

应向其创建事件订阅的事件网格域的名称。

Type:String
Position:3
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-DomainTopicInputObject

EventGrid 域主题对象。

Type:PSDomainTopic
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-DomainTopicName

应向其创建事件订阅的域主题的名称。

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

-Endpoint

事件订阅目标终结点。 可以是 Webhook URL,也可以是 EventHub、存储队列、混合连接或服务busqueue 的 Azure 资源 ID。 例如,混合连接的资源 ID 采用以下形式:/subscriptions/[Azure 订阅 ID]/resourceGroups/[ResourceGroupName]/providers/Microsoft.Relay/namespaces/[NamespaceName]/hybridConnections/[HybridConnectionName]。 预期在执行任何事件网格 cmdlet 之前,要创建并可供使用的目标终结点。

Type:String
Position:1
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-EndpointType

终结点类型。 这可以是 webhook、eventhub、storagequeue、hybridconnection 或服务busqueue。 默认值为 webhook。

Type:String
Accepted values:webhook, eventhub, storagequeue, hybridconnection, servicebusqueue, servicebustopic, azurefunction, webhook, eventhub, storagequeue, hybridconnection, servicebusqueue, servicebustopic, azurefunction, webhook, eventhub, storagequeue, hybridconnection, servicebusqueue, servicebustopic, azurefunction, webhook, eventhub, storagequeue, hybridconnection, servicebusqueue, servicebustopic, azurefunction
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-EventSubscriptionName

事件订阅的名称

Type:String
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-EventTtl

事件传递的时间(以分钟为单位)。 此值必须介于 1 和 1440 之间

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

-ExpirationDate

确定事件订阅的到期日期时间,之后事件订阅将停用。

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

-IncludedEventType

用于指定要包含的事件类型的列表的筛选器。如果未指定,将包括所有事件类型。

Type:String[]
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

EventGrid Topic 对象。

Type:PSTopic
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-Label

事件订阅的标签

Type:String[]
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-MaxDeliveryAttempt

传递事件的最大尝试次数。 此值必须介于 1 到 30 之间

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

-MaxEventsPerBatch

批处理中事件的最大数目。 此值必须介于 1 和 5000 之间。 仅当 Endpint 类型为 webhook 时,此参数有效。

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

-PreferredBatchSizeInKiloByte

首选批大小(以千字节为单位)。 此值必须介于 1 和 1024 之间。 仅当 Endpint 类型为 webhook 时,此参数有效。

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

-ResourceGroupName

主题的资源组。

Type:String
Aliases:ResourceGroup
Position:2
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-ResourceId

应向其创建事件订阅的资源的标识符。

Type:String
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-StorageQueueMessageTtl

存储队列消息生存时间(以毫秒为单位)

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

-SubjectBeginsWith

指定仅包含与指定主题前缀匹配的事件的筛选器。 如果未指定,则包含所有主题前缀的事件。

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

-SubjectCaseSensitive

指定应以区分大小写的方式比较主题字段的筛选器。 如果未指定,主题将以不区分大小写的方式进行比较。

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

-SubjectEndsWith

指定仅包含与指定主题后缀匹配的事件的筛选器。 如果未指定,则包含所有主题后缀的事件。

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

-TopicName

应为其创建事件订阅的主题的名称。

Type:String
Position:3
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

显示在此 cmdlet 运行的情况下将会发生什么。 此 cmdlet 未运行。

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

输入

String

PSTopic

PSDomain

PSDomainTopic

String[]

Int32

输出

PSEventSubscription