System Topic Event Subscriptions - Create Or Update
为系统主题创建或更新事件订阅。
使用指定的参数异步创建或更新事件订阅。 现有事件订阅将使用此 API 进行更新。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions/{eventSubscriptionName}?api-version=2025-02-15
URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
event
|
path | True |
string |
要创建的事件订阅的名称。 事件订阅名称长度必须介于 3 到 64 个字符之间,并且仅使用字母数字字母。 |
|
resource
|
path | True |
string |
用户订阅中的资源组的名称。 |
|
subscription
|
path | True |
string |
唯一标识Microsoft Azure 订阅的订阅凭据。 订阅 ID 构成了每个服务调用的 URI 的一部分。 |
|
system
|
path | True |
string |
系统主题的名称。 |
|
api-version
|
query | True |
string |
要用于客户端请求的 API 的版本。 |
请求正文
| 名称 | 类型 | 说明 |
|---|---|---|
| properties.deadLetterDestination | DeadLetterDestination: |
事件订阅的死信目标。 无法传递到其目标的任何事件都将发送到死信目标。 使用 Azure 事件网格的标识获取在传递/死信期间使用的身份验证令牌。 |
| properties.deadLetterWithResourceIdentity |
事件订阅的死信目标。 无法传递到其目标的任何事件都将发送到死信目标。 使用父资源(即主题或域)上的托管标识设置来获取在传递/死信期间使用的身份验证令牌。 |
|
| properties.deliveryWithResourceIdentity |
有关事件订阅必须传送事件的目标的信息。 使用父资源(即主题或域)上的托管标识设置来获取在传递/死信期间使用的身份验证令牌。 |
|
| properties.destination |
EventSubscriptionDestination:
|
有关事件订阅必须传送事件的目标的信息。 使用 Azure 事件网格的标识获取在传递/死信期间使用的身份验证令牌。 |
| properties.eventDeliverySchema |
事件订阅的事件传送架构。 |
|
| properties.expirationTimeUtc |
string (date-time) |
事件订阅的过期时间。 |
| properties.filter |
有关事件订阅筛选器的信息。 |
|
| properties.labels |
string[] |
用户定义的标签列表。 |
| properties.retryPolicy |
事件的重试策略。 这可用于配置事件的最大传递尝试次数和生存时间。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 201 Created |
创建 |
|
| Other Status Codes |
错误响应: ***
|
示例
SystemTopicEventSubscriptions_CreateOrUpdate
示例请求
PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic1/eventSubscriptions/exampleEventSubscriptionName1?api-version=2025-02-15
{
"properties": {
"destination": {
"endpointType": "WebHook",
"properties": {
"endpointUrl": "https://requestb.in/15ksip71"
}
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "ExamplePrefix",
"subjectEndsWith": "ExampleSuffix"
}
}
}
示例响应
{
"properties": {
"destination": {
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
},
"endpointType": "WebHook"
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "ExamplePrefix",
"subjectEndsWith": "ExampleSuffix"
},
"labels": null,
"eventDeliverySchema": "EventGridSchema",
"retryPolicy": {
"maxDeliveryAttempts": 30,
"eventTimeToLiveInMinutes": 1440
},
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic1"
},
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic1/eventSubscriptions/exampleEventSubscriptionName1",
"name": "exampleEventSubscriptionName1",
"type": "Microsoft.EventGrid/systemTopics/eventSubscriptions"
}
定义
AzureFunctionEventSubscriptionDestination
有关事件订阅的 Azure 函数目标的信息。
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| endpointType |
string:
Azure |
事件订阅目标的终结点类型。 |
|
| properties.deliveryAttributeMappings | DeliveryAttributeMapping[]: |
传递属性详细信息。 |
|
| properties.maxEventsPerBatch |
integer (int32) |
1 |
每个批处理的最大事件数。 |
| properties.preferredBatchSizeInKilobytes |
integer (int32) |
64 |
首选批大小(以千字节为单位)。 |
| properties.resourceId |
string (arm-id) |
表示事件订阅的 Azure Function 目标的终结点的 Azure 资源 ID。 |
BoolEqualsAdvancedFilter
BoolEquals 高级筛选器。
| 名称 | 类型 | 说明 |
|---|---|---|
| key |
string |
要根据要筛选的事件中的字段/属性。 |
| operatorType |
string:
Bool |
用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 |
| value |
boolean |
布尔筛选器值。 |
createdByType
创建资源的标识的类型。
| 值 | 说明 |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
DeadLetterWithResourceIdentity
有关具有资源标识的死信目标的信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| deadLetterDestination | DeadLetterDestination: |
有关事件订阅必须传送事件的目标的信息。 使用父资源(即主题或域)上的托管标识设置来获取死信期间使用的身份验证令牌。 |
| identity |
死信事件时要使用的标识。 |
DeliveryWithResourceIdentity
有关使用资源标识的事件订阅传递的信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| destination |
EventSubscriptionDestination:
|
有关事件订阅必须传送事件的目标的信息。 使用父资源(即主题或域)上的托管标识设置来获取在传递期间使用的身份验证令牌。 |
| identity |
传送事件时要使用的标识。 |
DynamicDeliveryAttributeMapping
动态传递属性映射详细信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| name |
string |
传递属性或标头的名称。 |
| properties.sourceField |
string |
包含属性值的事件中的 JSON 路径。 |
| type |
string:
Dynamic |
传递属性或标头名称的类型。 |
EventDeliverySchema
事件订阅的事件传送架构。
| 值 | 说明 |
|---|---|
| EventGridSchema | |
| CustomInputSchema | |
| CloudEventSchemaV1_0 |
EventHubEventSubscriptionDestination
有关事件订阅的事件中心目标的信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| endpointType |
string:
Event |
事件订阅目标的终结点类型。 |
| properties.deliveryAttributeMappings | DeliveryAttributeMapping[]: |
传递属性详细信息。 |
| properties.resourceId |
string (arm-id) |
表示事件订阅的事件中心目标的终结点的 Azure 资源 ID。 |
EventSubscription
事件订阅。
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| id |
string |
资源的完全限定标识符。 |
|
| name |
string |
资源的名称。 |
|
| properties.deadLetterDestination | DeadLetterDestination: |
事件订阅的死信目标。 无法传递到其目标的任何事件都将发送到死信目标。 使用 Azure 事件网格的标识获取在传递/死信期间使用的身份验证令牌。 |
|
| properties.deadLetterWithResourceIdentity |
事件订阅的死信目标。 无法传递到其目标的任何事件都将发送到死信目标。 使用父资源(即主题或域)上的托管标识设置来获取在传递/死信期间使用的身份验证令牌。 |
||
| properties.deliveryWithResourceIdentity |
有关事件订阅必须传送事件的目标的信息。 使用父资源(即主题或域)上的托管标识设置来获取在传递/死信期间使用的身份验证令牌。 |
||
| properties.destination |
EventSubscriptionDestination:
|
有关事件订阅必须传送事件的目标的信息。 使用 Azure 事件网格的标识获取在传递/死信期间使用的身份验证令牌。 |
|
| properties.eventDeliverySchema | EventGridSchema |
事件订阅的事件传送架构。 |
|
| properties.expirationTimeUtc |
string (date-time) |
事件订阅的过期时间。 |
|
| properties.filter |
有关事件订阅筛选器的信息。 |
||
| properties.labels |
string[] |
用户定义的标签列表。 |
|
| properties.provisioningState |
事件订阅的预配状态。 |
||
| properties.retryPolicy |
事件的重试策略。 这可用于配置事件的最大传递尝试次数和生存时间。 |
||
| properties.topic |
string |
事件订阅的主题的名称。 |
|
| systemData |
与事件网格资源相关的系统元数据。 |
||
| type |
string |
资源的类型。 |
EventSubscriptionFilter
筛选事件订阅。
EventSubscriptionIdentity
事件订阅的标识信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| type |
使用的托管标识的类型。 可以是“SystemAssigned”或“UserAssigned”。 |
|
| userAssignedIdentity |
string |
与资源关联的用户标识。 |
EventSubscriptionIdentityType
使用的托管标识的类型。 可以是“SystemAssigned”或“UserAssigned”。
| 值 | 说明 |
|---|---|
| SystemAssigned | |
| UserAssigned |
EventSubscriptionProvisioningState
事件订阅的预配状态。
| 值 | 说明 |
|---|---|
| Creating | |
| Updating | |
| Deleting | |
| Succeeded | |
| Canceled | |
| Failed | |
| AwaitingManualAction |
HybridConnectionEventSubscriptionDestination
有关事件订阅的 HybridConnection 目标的信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| endpointType |
string:
Hybrid |
事件订阅目标的终结点类型。 |
| properties.deliveryAttributeMappings | DeliveryAttributeMapping[]: |
传递属性详细信息。 |
| properties.resourceId |
string (arm-id) |
作为事件订阅目标的混合连接的 Azure 资源 ID。 |
IsNotNullAdvancedFilter
IsNotNull 高级筛选器。
| 名称 | 类型 | 说明 |
|---|---|---|
| key |
string |
要根据要筛选的事件中的字段/属性。 |
| operatorType |
string:
Is |
用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 |
IsNullOrUndefinedAdvancedFilter
IsNullOrUndefined 高级筛选器。
| 名称 | 类型 | 说明 |
|---|---|---|
| key |
string |
要根据要筛选的事件中的字段/属性。 |
| operatorType |
string:
Is |
用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 |
MonitorAlertEventSubscriptionDestination
有关事件订阅的监视警报目标的信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| endpointType |
string:
Monitor |
事件订阅目标的终结点类型。 |
| properties.actionGroups |
string[] (arm-id) |
将在通过此事件订阅触发的每个警报上触发的作组的 ARM ID 列表。 每个资源 ARM ID 都应遵循以下模式:/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}。 |
| properties.description |
string |
将附加到通过此事件订阅触发的每个警报的说明。 |
| properties.severity |
将附加到通过此事件订阅触发的每个警报的严重性。 必须提供此字段。 |
MonitorAlertSeverity
将附加到通过此事件订阅触发的每个警报的严重性。 必须提供此字段。
| 值 | 说明 |
|---|---|
| Sev0 | |
| Sev1 | |
| Sev2 | |
| Sev3 | |
| Sev4 |
NamespaceTopicEventSubscriptionDestination
有关事件订阅的命名空间主题目标的信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| endpointType |
string:
Namespace |
事件订阅目标的终结点类型。 |
| properties.resourceId |
string (arm-id) |
表示事件订阅的事件网格命名空间主题目标的终结点的 Azure 资源 ID。 此字段是必需的,并且列出的命名空间主题资源必须已存在。 资源 ARM ID 应遵循以下模式:/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}。 |
NumberGreaterThanAdvancedFilter
NumberGreaterThan 高级筛选器。
| 名称 | 类型 | 说明 |
|---|---|---|
| key |
string |
要根据要筛选的事件中的字段/属性。 |
| operatorType |
string:
Number |
用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 |
| value |
number (double) |
筛选器值。 |
NumberGreaterThanOrEqualsAdvancedFilter
NumberGreaterThanOrEquals 高级筛选器。
| 名称 | 类型 | 说明 |
|---|---|---|
| key |
string |
要根据要筛选的事件中的字段/属性。 |
| operatorType |
string:
Number |
用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 |
| value |
number (double) |
筛选器值。 |
NumberInAdvancedFilter
NumberIn 高级筛选器。
| 名称 | 类型 | 说明 |
|---|---|---|
| key |
string |
要根据要筛选的事件中的字段/属性。 |
| operatorType |
string:
Number |
用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 |
| values |
number[] (double) |
筛选器值集。 |
NumberInRangeAdvancedFilter
NumberInRange 高级筛选器。
| 名称 | 类型 | 说明 |
|---|---|---|
| key |
string |
要根据要筛选的事件中的字段/属性。 |
| operatorType |
string:
Number |
用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 |
| values |
number[] (double) |
筛选器值集。 |
NumberLessThanAdvancedFilter
NumberLessThan 高级筛选器。
| 名称 | 类型 | 说明 |
|---|---|---|
| key |
string |
要根据要筛选的事件中的字段/属性。 |
| operatorType |
string:
Number |
用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 |
| value |
number (double) |
筛选器值。 |
NumberLessThanOrEqualsAdvancedFilter
NumberLessThanOrEquals 高级筛选器。
| 名称 | 类型 | 说明 |
|---|---|---|
| key |
string |
要根据要筛选的事件中的字段/属性。 |
| operatorType |
string:
Number |
用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 |
| value |
number (double) |
筛选器值。 |
NumberNotInAdvancedFilter
NumberNotIn 高级筛选器。
| 名称 | 类型 | 说明 |
|---|---|---|
| key |
string |
要根据要筛选的事件中的字段/属性。 |
| operatorType |
string:
Number |
用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 |
| values |
number[] (double) |
筛选器值集。 |
NumberNotInRangeAdvancedFilter
NumberNotInRange 高级筛选器。
| 名称 | 类型 | 说明 |
|---|---|---|
| key |
string |
要根据要筛选的事件中的字段/属性。 |
| operatorType |
string:
Number |
用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 |
| values |
number[] (double) |
筛选器值集。 |
RetryPolicy
有关事件订阅的重试策略的信息。
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| eventTimeToLiveInMinutes |
integer (int32) |
1440 |
事件生存时间(以分钟为单位)。 |
| maxDeliveryAttempts |
integer (int32) |
30 |
事件的最大传递重试尝试次数。 |
ServiceBusQueueEventSubscriptionDestination
有关事件订阅的服务总线目标的信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| endpointType |
string:
Service |
事件订阅目标的终结点类型。 |
| properties.deliveryAttributeMappings | DeliveryAttributeMapping[]: |
传递属性详细信息。 |
| properties.resourceId |
string (arm-id) |
表示事件订阅的服务总线目标的终结点的 Azure 资源 ID。 |
ServiceBusTopicEventSubscriptionDestination
有关事件订阅的服务总线主题目标的信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| endpointType |
string:
Service |
事件订阅目标的终结点类型。 |
| properties.deliveryAttributeMappings | DeliveryAttributeMapping[]: |
传递属性详细信息。 |
| properties.resourceId |
string (arm-id) |
表示事件订阅的服务总线主题目标的终结点的 Azure 资源 ID。 |
StaticDeliveryAttributeMapping
静态传递属性映射详细信息。
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| name |
string |
传递属性或标头的名称。 |
|
| properties.isSecret |
boolean |
False |
指示属性是否包含敏感信息的布尔标志。 |
| properties.value |
string |
传递属性的值。 |
|
| type |
string:
Static |
传递属性或标头名称的类型。 |
StorageBlobDeadLetterDestination
有关基于存储 Blob 的死信目标的信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| endpointType |
string:
Storage |
死信目标的终结点类型 |
| properties.blobContainerName |
string |
存储 Blob 容器的名称,该容器是死信事件的目标 |
| properties.resourceId |
string (arm-id) |
存储帐户的 Azure 资源 ID,该 ID 是死信事件的目标 |
StorageQueueEventSubscriptionDestination
有关事件订阅的存储队列目标的信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| endpointType |
string:
Storage |
事件订阅目标的终结点类型。 |
| properties.queueMessageTimeToLiveInSeconds |
integer (int64) |
存储队列消息生存时间(以秒为单位)。 此值不能为零或负值,但使用 -1 指示消息的生存时间是无限的。 |
| properties.queueName |
string |
作为事件订阅目标的存储帐户下的存储队列的名称。 |
| properties.resourceId |
string (arm-id) |
包含作为事件订阅目标的队列的存储帐户的 Azure 资源 ID。 |
StringBeginsWithAdvancedFilter
StringBeginsWith 高级筛选器。
| 名称 | 类型 | 说明 |
|---|---|---|
| key |
string |
要根据要筛选的事件中的字段/属性。 |
| operatorType |
string:
String |
用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 |
| values |
string[] |
筛选器值集。 |
StringContainsAdvancedFilter
StringContains 高级筛选器。
| 名称 | 类型 | 说明 |
|---|---|---|
| key |
string |
要根据要筛选的事件中的字段/属性。 |
| operatorType |
string:
String |
用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 |
| values |
string[] |
筛选器值集。 |
StringEndsWithAdvancedFilter
StringEndsWith 高级筛选器。
| 名称 | 类型 | 说明 |
|---|---|---|
| key |
string |
要根据要筛选的事件中的字段/属性。 |
| operatorType |
string:
String |
用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 |
| values |
string[] |
筛选器值集。 |
StringInAdvancedFilter
StringIn 高级筛选器。
| 名称 | 类型 | 说明 |
|---|---|---|
| key |
string |
要根据要筛选的事件中的字段/属性。 |
| operatorType |
string:
String |
用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 |
| values |
string[] |
筛选器值集。 |
StringNotBeginsWithAdvancedFilter
StringNotBeginsWith 高级筛选器。
| 名称 | 类型 | 说明 |
|---|---|---|
| key |
string |
要根据要筛选的事件中的字段/属性。 |
| operatorType |
string:
String |
用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 |
| values |
string[] |
筛选器值集。 |
StringNotContainsAdvancedFilter
StringNotContains 高级筛选器。
| 名称 | 类型 | 说明 |
|---|---|---|
| key |
string |
要根据要筛选的事件中的字段/属性。 |
| operatorType |
string:
String |
用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 |
| values |
string[] |
筛选器值集。 |
StringNotEndsWithAdvancedFilter
StringNotEndsWith 高级筛选器。
| 名称 | 类型 | 说明 |
|---|---|---|
| key |
string |
要根据要筛选的事件中的字段/属性。 |
| operatorType |
string:
String |
用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 |
| values |
string[] |
筛选器值集。 |
StringNotInAdvancedFilter
StringNotIn 高级筛选器。
| 名称 | 类型 | 说明 |
|---|---|---|
| key |
string |
要根据要筛选的事件中的字段/属性。 |
| operatorType |
string:
String |
用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 |
| values |
string[] |
筛选器值集。 |
systemData
与创建和上次修改资源相关的元数据。
| 名称 | 类型 | 说明 |
|---|---|---|
| createdAt |
string (date-time) |
资源创建时间戳(UTC)。 |
| createdBy |
string |
创建资源的标识。 |
| createdByType |
创建资源的标识的类型。 |
|
| lastModifiedAt |
string (date-time) |
上次修改的资源时间戳(UTC) |
| lastModifiedBy |
string |
上次修改资源的标识。 |
| lastModifiedByType |
上次修改资源的标识的类型。 |
TlsVersion
允许发布到此域的发布服务器的最低 TLS 版本
| 值 | 说明 |
|---|---|
| 1.0 | |
| 1.1 | |
| 1.2 |
WebHookEventSubscriptionDestination
有关事件订阅的 Webhook 目标的信息。
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| endpointType |
string:
Web |
事件订阅目标的终结点类型。 |
|
| properties.azureActiveDirectoryApplicationIdOrUri |
string |
用于获取访问令牌的 Azure Active Directory 应用程序 ID 或 URI,该令牌将作为持有者令牌包含在传递请求中。 |
|
| properties.azureActiveDirectoryTenantId |
string |
用于获取访问令牌的 Azure Active Directory 租户 ID,该令牌将作为传递请求中的持有者令牌包含在内。 |
|
| properties.deliveryAttributeMappings | DeliveryAttributeMapping[]: |
传递属性详细信息。 |
|
| properties.endpointBaseUrl |
string |
表示事件订阅目标的终结点的基 URL。 |
|
| properties.endpointUrl |
string |
表示事件订阅目标的终结点的 URL。 |
|
| properties.maxEventsPerBatch |
integer (int32) |
1 |
每个批处理的最大事件数。 |
| properties.minimumTlsVersionAllowed |
Webhook 终结点应支持的最低 TLS 版本 |
||
| properties.preferredBatchSizeInKilobytes |
integer (int32) |
64 |
首选批大小(以千字节为单位)。 |