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

Update-AzEventGridSubscription

  • 参考
模块:
Az.EventGrid

更新了事件网格事件订阅的属性。

语法

Update-AzEventGridSubscription
      [-EventSubscriptionName] <String>
      [[-ResourceGroupName] <String>]
      [-EndpointType <String>]
      [-Endpoint <String>]
      [-SubjectBeginsWith <String>]
      [-SubjectEndsWith <String>]
      [-IncludedEventType <String[]>]
      [-Label <String[]>]
      [-ExpirationDate <DateTime>]
      [-AdvancedFilter <Hashtable[]>]
      [-DeliveryAttributeMapping <Hashtable[]>]
      [-EventTtl <Int32>]
      [-MaxDeliveryAttempt <Int32>]
      [-DeadLetterEndpoint <String>]
      [-MaxEventsPerBatch <Int32>]
      [-PreferredBatchSizeInKiloByte <Int32>]
      [-AzureActiveDirectoryApplicationIdOrUri <String>]
      [-AzureActiveDirectoryTenantId <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzEventGridSubscription
      [-ResourceId] <String>
      [-EventSubscriptionName] <String>
      [-EndpointType <String>]
      [-Endpoint <String>]
      [-SubjectBeginsWith <String>]
      [-SubjectEndsWith <String>]
      [-IncludedEventType <String[]>]
      [-Label <String[]>]
      [-ExpirationDate <DateTime>]
      [-AdvancedFilter <Hashtable[]>]
      [-DeliveryAttributeMapping <Hashtable[]>]
      [-EventTtl <Int32>]
      [-MaxDeliveryAttempt <Int32>]
      [-DeadLetterEndpoint <String>]
      [-MaxEventsPerBatch <Int32>]
      [-PreferredBatchSizeInKiloByte <Int32>]
      [-AzureActiveDirectoryApplicationIdOrUri <String>]
      [-AzureActiveDirectoryTenantId <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzEventGridSubscription
      [-InputObject] <PSEventSubscription>
      [-EndpointType <String>]
      [-Endpoint <String>]
      [-SubjectBeginsWith <String>]
      [-SubjectEndsWith <String>]
      [-IncludedEventType <String[]>]
      [-Label <String[]>]
      [-ExpirationDate <DateTime>]
      [-AdvancedFilter <Hashtable[]>]
      [-DeliveryAttributeMapping <Hashtable[]>]
      [-EventTtl <Int32>]
      [-MaxDeliveryAttempt <Int32>]
      [-DeadLetterEndpoint <String>]
      [-MaxEventsPerBatch <Int32>]
      [-PreferredBatchSizeInKiloByte <Int32>]
      [-AzureActiveDirectoryApplicationIdOrUri <String>]
      [-AzureActiveDirectoryTenantId <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzEventGridSubscription
      [-EventSubscriptionName] <String>
      [-ResourceGroupName] <String>
      [-TopicName] <String>
      [-EndpointType <String>]
      [-Endpoint <String>]
      [-SubjectBeginsWith <String>]
      [-SubjectEndsWith <String>]
      [-IncludedEventType <String[]>]
      [-Label <String[]>]
      [-ExpirationDate <DateTime>]
      [-AdvancedFilter <Hashtable[]>]
      [-DeliveryAttributeMapping <Hashtable[]>]
      [-EventTtl <Int32>]
      [-MaxDeliveryAttempt <Int32>]
      [-DeadLetterEndpoint <String>]
      [-MaxEventsPerBatch <Int32>]
      [-PreferredBatchSizeInKiloByte <Int32>]
      [-AzureActiveDirectoryApplicationIdOrUri <String>]
      [-AzureActiveDirectoryTenantId <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzEventGridSubscription
      [-EventSubscriptionName] <String>
      [-ResourceGroupName] <String>
      [-DomainName] <String>
      [-EndpointType <String>]
      [-Endpoint <String>]
      [-SubjectBeginsWith <String>]
      [-SubjectEndsWith <String>]
      [-IncludedEventType <String[]>]
      [-Label <String[]>]
      [-ExpirationDate <DateTime>]
      [-AdvancedFilter <Hashtable[]>]
      [-DeliveryAttributeMapping <Hashtable[]>]
      [-EventTtl <Int32>]
      [-MaxDeliveryAttempt <Int32>]
      [-DeadLetterEndpoint <String>]
      [-MaxEventsPerBatch <Int32>]
      [-PreferredBatchSizeInKiloByte <Int32>]
      [-AzureActiveDirectoryApplicationIdOrUri <String>]
      [-AzureActiveDirectoryTenantId <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzEventGridSubscription
      [-EventSubscriptionName] <String>
      [-ResourceGroupName] <String>
      [-DomainName] <String>
      [-DomainTopicName] <String>
      [-EndpointType <String>]
      [-Endpoint <String>]
      [-SubjectBeginsWith <String>]
      [-SubjectEndsWith <String>]
      [-IncludedEventType <String[]>]
      [-Label <String[]>]
      [-ExpirationDate <DateTime>]
      [-AdvancedFilter <Hashtable[]>]
      [-DeliveryAttributeMapping <Hashtable[]>]
      [-EventTtl <Int32>]
      [-MaxDeliveryAttempt <Int32>]
      [-DeadLetterEndpoint <String>]
      [-MaxEventsPerBatch <Int32>]
      [-PreferredBatchSizeInKiloByte <Int32>]
      [-AzureActiveDirectoryApplicationIdOrUri <String>]
      [-AzureActiveDirectoryTenantId <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

说明

更新了事件网格事件订阅的属性。 这可用于更新现有事件订阅的筛选器、目标或标签。

示例

示例 1

Update-AzEventGridSubscription -EventSubscriptionName ES1 -TopicName Topic1 -ResourceGroup MyResourceGroupName -Endpoint https://requestb.in/1kxxoui1

汇报资源组“MyResourceGroupName”中主题“Topic1”的事件订阅“ES1”终结点到“https://requestb.in/1kxxoui1”

示例 2

Get-AzEventGridSubscription -EventSubscriptionName ES1 -TopicName Topic1 -ResourceGroup MyResourceGroupName | Update-AzEventGridSubscription -Endpoint https://requestb.in/1kxxoui1

汇报资源组“MyResourceGroupName”中主题“Topic1”的事件订阅“ES1”终结点到“https://requestb.in/1kxxoui1”

示例 3

Update-AzEventGridSubscription -EventSubscriptionName ES1 -ResourceId "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace" -Endpoint https://requestb.in/1kxxoui1 -SubjectEndsWith "jpg"

汇报 EventHub 命名空间 ContosoNamespace 的事件订阅“ES1”属性，新终结点为“https://requestb.in/1kxxoui1”，新的 SubjectEndsWith 筛选器为“jpg”

示例 4

$labels = "Finance", "HR"
Update-AzEventGridSubscription -EventSubscriptionName ES1 -ResourceGroup MyResourceGroupName -Label $labels

使用新标签$labels汇报资源组“MyResourceGroupName”的事件订阅“ES1”的属性。

参数

-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=“StringBeginsWith”; key=“Subject”;Values=@（“SubjectPrefix1”，“SubjectPrefix2”）}

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

-AzureActiveDirectoryApplicationIdOrUri

用于获取访问令牌的 Microsoft Entra 应用程序 ID 或 URI，该令牌将作为持有者令牌包含在传递请求中。仅适用于 Webhook 作为目标。

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

-AzureActiveDirectoryTenantId

用于获取将作为传递请求中的持有者令牌包含的访问令牌的 Microsoft Entra 租户 ID。仅适用于 Webhook 作为目标。

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

-Confirm

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

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

-DeadLetterEndpoint

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

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

-DefaultProfile

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

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

-DeliveryAttributeMapping

此系统主题事件订阅的传递属性映射。 每个传递属性映射应包含以下两个必填字段：名称和类型。 类型可以是“Static”或“Dynamic”。 如果类型为“Static”，则需要属性“Value”和“IsSecret”。 如果类型为“Dynamic”，则需要属性“SourceField”。 DynamicAttributeMapping 参数的示例：$DeliveryAttributeMapping=@（$DeliveryAttributeMapping 1，$DeliveryAttributeMapping 2），其中$DeliveryAttributeMapping 1=@{Name=“Name1”;Type=“Static”;Values=“value”;IsSecret=“false”} 和 $DeliveryAttributeMapping 2=@{Name=“Name2”;Type=“Dynamic”;SourceField=“data.prop1”}

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

-DomainName

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

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

-DomainTopicName

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

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

-Endpoint

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

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

-EndpointType

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

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

-EventSubscriptionName

事件订阅的名称

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

-EventTtl

事件传递的时间（以分钟为单位）。 此值必须介于 1 到 1440 之间

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

-ExpirationDate

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

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

-IncludedEventType

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

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

-InputObject

EventGridSubscription 对象。

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

-Label

事件订阅的标签

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

-MaxDeliveryAttempt

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

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

-MaxEventsPerBatch

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

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

-PreferredBatchSizeInKiloByte

首选批大小（以 KB 为单位）。 此值必须介于 1 到 1024 之间。 仅当 Endpint 类型为 Webhook 时，此参数有效。

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

-ResourceGroupName

主题的资源组。

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

-ResourceId

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

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

-SubjectBeginsWith

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

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

-SubjectEndsWith

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

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

-TopicName

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

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

-WhatIf

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

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

输入

String

PSEventSubscription

输出

PSEventSubscription