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

Microsoft.EventGrid 命名空间/topics/eventSubscriptions 2025-04-01-preview

Bicep 资源定义

可以使用目标作部署命名空间/topics/eventSubscriptions 资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.EventGrid/namespaces/topics/eventSubscriptions 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2025-04-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    deliveryConfiguration: {
      deliveryMode: 'string'
      push: {
        deadLetterDestinationWithResourceIdentity: {
          deadLetterDestination: {
            endpointType: 'string'
            // For remaining properties, see DeadLetterDestination objects
          }
          identity: {
            federatedIdentityCredentialInfo: {
              federatedClientId: 'string'
            }
            type: 'string'
            userAssignedIdentity: 'string'
          }
        }
        deliveryWithResourceIdentity: {
          destination: {
            endpointType: 'string'
            // For remaining properties, see EventSubscriptionDestination objects
          }
          identity: {
            federatedIdentityCredentialInfo: {
              federatedClientId: 'string'
            }
            type: 'string'
            userAssignedIdentity: 'string'
          }
        }
        destination: {
          endpointType: 'string'
          // For remaining properties, see EventSubscriptionDestination objects
        }
        eventTimeToLive: 'string'
        maxDeliveryCount: int
      }
      queue: {
        deadLetterDestinationWithResourceIdentity: {
          deadLetterDestination: {
            endpointType: 'string'
            // For remaining properties, see DeadLetterDestination objects
          }
          identity: {
            federatedIdentityCredentialInfo: {
              federatedClientId: 'string'
            }
            type: 'string'
            userAssignedIdentity: 'string'
          }
        }
        eventTimeToLive: 'string'
        maxDeliveryCount: int
        receiveLockDurationInSeconds: int
      }
    }
    eventDeliverySchema: 'string'
    expirationTimeUtc: 'string'
    filtersConfiguration: {
      filters: [
        {
          key: 'string'
          operatorType: 'string'
          // For remaining properties, see Filter objects
        }
      ]
      includedEventTypes: [
        'string'
      ]
    }
    tags: {
      {customized property}: 'string'
    }
  }
}

DeadLetterDestination 对象

设置 endpointType 属性以指定对象的类型。

对于 StorageBlob,请使用:

{
  endpointType: 'StorageBlob'
  properties: {
    blobContainerName: 'string'
    resourceId: 'string'
  }
}

筛选对象

设置 operatorType 属性以指定对象的类型。

对于 BoolEquals,请使用:

{
  operatorType: 'BoolEquals'
  value: bool
}

对于 IsNotNull,请使用:

{
  operatorType: 'IsNotNull'
}

对于 IsNullOrUndefined,请使用:

{
  operatorType: 'IsNullOrUndefined'
}

对于 NumberGreaterThan,请使用:

{
  operatorType: 'NumberGreaterThan'
  value: int
}

对于 NumberGreaterThanOrEquals,请使用:

{
  operatorType: 'NumberGreaterThanOrEquals'
  value: int
}

对于 NumberIn,请使用:

{
  operatorType: 'NumberIn'
  values: [
    int
  ]
}

对于 NumberInRange,请使用:

{
  operatorType: 'NumberInRange'
  values: [
    [
      int
    ]
  ]
}

对于 NumberLessThan,请使用:

{
  operatorType: 'NumberLessThan'
  value: int
}

对于 NumberLessThanOrEquals,请使用:

{
  operatorType: 'NumberLessThanOrEquals'
  value: int
}

对于 NumberNotIn,请使用:

{
  operatorType: 'NumberNotIn'
  values: [
    int
  ]
}

对于 NumberNotInRange,请使用:

{
  operatorType: 'NumberNotInRange'
  values: [
    [
      int
    ]
  ]
}

对于 StringBeginsWith,请使用:

{
  operatorType: 'StringBeginsWith'
  values: [
    'string'
  ]
}

对于 StringContains,请使用:

{
  operatorType: 'StringContains'
  values: [
    'string'
  ]
}

对于 StringEndsWith,请使用:

{
  operatorType: 'StringEndsWith'
  values: [
    'string'
  ]
}

对于 StringIn,请使用:

{
  operatorType: 'StringIn'
  values: [
    'string'
  ]
}

对于 StringNotBeginsWith,请使用:

{
  operatorType: 'StringNotBeginsWith'
  values: [
    'string'
  ]
}

对于 StringNotContains,请使用:

{
  operatorType: 'StringNotContains'
  values: [
    'string'
  ]
}

对于 StringNotEndsWith,请使用:

{
  operatorType: 'StringNotEndsWith'
  values: [
    'string'
  ]
}

对于 StringNotIn,请使用:

{
  operatorType: 'StringNotIn'
  values: [
    'string'
  ]
}

DeliveryAttributeMapping 对象

设置 类型 属性以指定对象的类型。

对于 Dynamic,请使用:

{
  properties: {
    sourceField: 'string'
  }
  type: 'Dynamic'
}

对于 静态,请使用:

{
  properties: {
    isSecret: bool
    value: 'string'
  }
  type: 'Static'
}

EventSubscriptionDestination 对象

设置 endpointType 属性以指定对象的类型。

对于 azureFunction,请使用:

{
  endpointType: 'AzureFunction'
  properties: {
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    maxEventsPerBatch: int
    preferredBatchSizeInKilobytes: int
    resourceId: 'string'
  }
}

对于 EventHub,请使用:

{
  endpointType: 'EventHub'
  properties: {
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId: 'string'
  }
}

对于 HybridConnection,请使用:

{
  endpointType: 'HybridConnection'
  properties: {
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId: 'string'
  }
}

对于 MonitorAlert,请使用:

{
  endpointType: 'MonitorAlert'
  properties: {
    actionGroups: [
      'string'
    ]
    description: 'string'
    severity: 'string'
  }
}

对于 NamespaceTopic,请使用:

{
  endpointType: 'NamespaceTopic'
  properties: {
    resourceId: 'string'
  }
}

对于 PartnerDestination,请使用:

{
  endpointType: 'PartnerDestination'
  properties: {
    resourceId: 'string'
  }
}

对于 ServiceBusQueue,请使用:

{
  endpointType: 'ServiceBusQueue'
  properties: {
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId: 'string'
  }
}

对于 ServiceBusTopic,请使用:

{
  endpointType: 'ServiceBusTopic'
  properties: {
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId: 'string'
  }
}

对于 StorageQueue,请使用:

{
  endpointType: 'StorageQueue'
  properties: {
    queueMessageTimeToLiveInSeconds: int
    queueName: 'string'
    resourceId: 'string'
  }
}

对于 WebHook,请使用:

{
  endpointType: 'WebHook'
  properties: {
    azureActiveDirectoryApplicationIdOrUri: 'string'
    azureActiveDirectoryTenantId: 'string'
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    endpointUrl: 'string'
    maxEventsPerBatch: int
    minimumTlsVersionAllowed: 'string'
    preferredBatchSizeInKilobytes: int
  }
}

属性值

Microsoft.EventGrid/namespaces/topics/eventSubscriptions

名称 DESCRIPTION 价值
姓名 资源名称 字符串

约束:
最小长度 = 3
最大长度 = 50
模式 = ^[a-zA-Z0-9-]*$ (必需)
父级 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源外部的子资源
类型资源的符号名称: namespaces/topics
属性 事件订阅的属性。 SubscriptionProperties

AzureFunctionEventSubscriptionDestination

名称 DESCRIPTION 价值
endpoint类型 事件订阅目标的终结点类型。 “AzureFunction”(必需)
属性 事件订阅目标的 Azure 函数属性。 AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

名称 DESCRIPTION 价值
deliveryAttributeMappings 传递属性详细信息。 DeliveryAttributeMapping[]
maxEventsPerBatch 每个批处理的最大事件数。 整数 (int)
preferredBatchSizeInKilobytes 首选批大小(以千字节为单位)。 整数 (int)
资源ID 表示事件订阅的 Azure Function 目标的终结点的 Azure 资源 ID。 字符串

BoolEqualsFilter (布尔等于过滤器)

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “BoolEquals”(必需)
价值 布尔筛选器值。 布尔

死信目标

名称 DESCRIPTION 价值
endpoint类型 设置为 StorageBlobDeadLetterDestination 类型的“StorageBlob”。 “StorageBlob”(必需)

DeadLetterWithResourceIdentity

名称 DESCRIPTION 价值
deadLetterDestination 的 有关事件订阅必须传送事件的目标的信息。
使用父资源(即主题或域)上的托管标识设置来获取死信期间使用的身份验证令牌。
死信目标
标识 死信事件时要使用的标识。 EventSubscriptionIdentity

DeliveryAttributeMapping

名称 DESCRIPTION 价值
姓名 传递属性或标头的名称。 字符串
类型 设置为“ DynamicDeliveryAttributeMapping”类型的“Dynamic”。 设置为 StaticDeliveryAttributeMapping 类型的“Static”。 “Dynamic”
“Static”(必需)

DeliveryConfiguration

名称 DESCRIPTION 价值
deliveryMode 交付模式 事件订阅的传递模式。 “Push”
“Queue”
推送 当 deliveryMode 推送并表示有关推送订阅的信息时,应填充此属性。 推送信息
队列 当 deliveryMode 为队列并表示有关队列订阅的信息时,应填充此属性。 队列信息

DeliveryWithResourceIdentity

名称 DESCRIPTION 价值
目标 有关事件订阅必须传送事件的目标的信息。
使用父资源(即主题或域)上的托管标识设置来获取在传递期间使用的身份验证令牌。
EventSubscriptionDestination 事件订阅目标
标识 传送事件时要使用的标识。 EventSubscriptionIdentity

DynamicDeliveryAttributeMapping

名称 DESCRIPTION 价值
属性 动态传递属性映射的属性。 DynamicDeliveryAttributeMappingProperties
类型 传递属性或标头名称的类型。 “Dynamic”(必需)

DynamicDeliveryAttributeMappingProperties

名称 DESCRIPTION 价值
sourceField 包含属性值的事件中的 JSON 路径。 字符串

EventHubEventSubscriptionDestination 事件订阅目标

名称 DESCRIPTION 价值
endpoint类型 事件订阅目标的终结点类型。 “EventHub”(必需)
属性 事件订阅目标的事件中心属性。 EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

名称 DESCRIPTION 价值
deliveryAttributeMappings 传递属性详细信息。 DeliveryAttributeMapping[]
资源ID 表示事件订阅的事件中心目标的终结点的 Azure 资源 ID。 字符串

EventSubscriptionDestination 事件订阅目标

名称 DESCRIPTION 价值
endpoint类型 设置为 AzureFunctionEventSubscriptionDestination 类型的“AzureFunction”。 设置为 EventHubEventSubscriptionDestination 类型的“EventHub”。 对于 HybridConnectionEventSubscriptionDestination,设置为“HybridConnection”。 设置为 MonitorAlertEventSubscriptionDestination 类型的“MonitorAlert”。 对于 NamespaceTopicEventSubscriptionDestination,设置为“NamespaceTopic”。 设置为 PartnerEventSubscriptionDestination 类型的“PartnerDestination”。 设置为 ServiceBusQueueEventSubscriptionDestination 类型的“ServiceBusQueue”。 对于 ServiceBusTopicEventSubscriptionDestination,设置为“ServiceBusTopic”。 设置为 StorageQueueEventSubscriptionDestination 类型的“StorageQueue”。 对于 WebHookEventSubscriptionDestination,设置为“WebHook”。 “AzureFunction”
“EventHub”
“HybridConnection”
“MonitorAlert”
“NamespaceTopic”
“PartnerDestination”
“ServiceBusQueue”
“ServiceBusTopic”
“StorageQueue”
“WebHook”(必需)

EventSubscriptionIdentity

名称 DESCRIPTION 价值
federatedIdentityCredentialInfo 用于资源传递的联合标识凭据(FIC)的详细信息。 FederatedIdentityCredentialInfo
类型 使用的托管标识的类型。 可以是“SystemAssigned”或“UserAssigned”。 “SystemAssigned”
“UserAssigned”
userAssignedIdentity 与资源关联的用户标识。 字符串

FederatedIdentityCredentialInfo

名称 DESCRIPTION 价值
federatedClientId 与联合身份凭证 (FIC) 关联的多租户 Microsoft Entra ID 应用程序。 字符串

约束:
最小长度 = 36
最大长度 = 36
模式 = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ (必需)

过滤器

名称 DESCRIPTION 价值
关键值 要根据要筛选的事件中的字段/属性。 字符串
运算符类型 对于 BoolEqualsFilter 类型,设置为“BoolEquals”。 对于 IsNotNullFilter 类型,设置为“IsNotNull”。 设置为 IsNullOrUndefined 类型的“IsNullOrUndefinedFilter”。 对于 NumberGreaterThanFilter 类型,设置为“NumberGreaterThan”。 设置为 Type NumberGreaterThanOrEquals 的“NumberGreaterThanOrEquals”。 设置为 NumberInFilter 类型的“NumberIn”。 设置为 NumberInRangeFilter 类型的“NumberInRange”。 对于 NumberLessThanFilter 类型,设置为“NumberLessThanThan”。 对于 NumberLessThanOrEqualsFilter,设置为“NumberLessThanOrEquals”。 设置为 NumberNotInFilter 类型的“NumberNotIn”。 对于 NumberNotInRangeFilter 类型,设置为“NumberNotInRange”。 对于 StringBeginsWithFilter,设置为“StringBeginsWith”。 设置为 StringContainsFilter 类型的“StringContains”。 对于 StringEndsWithFilter 类型,设置为“StringEndsWithWith”。 设置为 StringInFilter 类型的“StringIn”。 设置为 StringNotBeginsWith 类型的“StringNotBeginsWithFilter”。 对于 StringNotContainsFilter,设置为“StringNotContains”。 对于 StringNotEndsWithFilter,设置为“StringNotEndsWith”。 设置为 StringNotInFilter 类型的“StringNotIn”。 “BoolEquals”
“IsNotNull”
“IsNullOrUndefined”
“NumberGreaterThan”
“NumberGreaterThanOrEquals”
“NumberIn”
“NumberInRange”
“NumberLessThan”
“NumberLessThanOrEquals”
“NumberNotIn”
“NumberNotInRange”
“StringBeginsWith”
“StringContains”
“StringEndsWith”
“StringIn”
“StringNotBeginsWith”
“StringNotContains”
“StringNotEndsWith”
“StringNotIn”(必需)

FiltersConfiguration

名称 DESCRIPTION 价值
筛选器 用于筛选事件订阅的筛选器数组。 筛选器[]
includedEventTypes 需要属于事件订阅的适用事件类型的列表。 如果需要订阅所有默认事件类型,请将 IncludedEventTypes 设置为 null。 字符串[]

HybridConnectionEventSubscriptionDestination

名称 DESCRIPTION 价值
endpoint类型 事件订阅目标的终结点类型。 “HybridConnection”(必需)
属性 事件订阅目标的混合连接属性。 HybridConnectionEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestinationProperties

名称 DESCRIPTION 价值
deliveryAttributeMappings 传递属性详细信息。 DeliveryAttributeMapping[]
资源ID 作为事件订阅目标的混合连接的 Azure 资源 ID。 字符串

IsNotNullFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “IsNotNull”(必需)

IsNullOrUndefinedFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “IsNullOrUndefined”(必需)

监视器警报事件订阅目标

名称 DESCRIPTION 价值
endpoint类型 事件订阅目标的终结点类型。 “MonitorAlert”(必需)
属性 监视事件订阅目标的警报属性。 MonitorAlertEventSubscriptionDestinationProperties

MonitorAlertEventSubscriptionDestinationProperties

名称 DESCRIPTION 价值
作组 将在通过此事件订阅触发的每个警报上触发的操作组的 ARM ID 列表。
每个资源 ARM ID 都应遵循以下模式:/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}。
字符串[]
描述 将附加到通过此事件订阅触发的每个警报的说明。 字符串
严重性 将附加到通过此事件订阅触发的每个警报的严重性。
必须提供此字段。
“Sev0”
“Sev1”
“Sev2”
“Sev3”
“Sev4”

NamespaceTopicEventSubscriptionDestination

名称 DESCRIPTION 价值
endpoint类型 事件订阅目标的终结点类型。 “NamespaceTopic”(必需)
属性 Namespace事件订阅目标的主题属性。 NamespaceTopicEventSubscriptionDestinationProperties

NamespaceTopicEventSubscriptionDestinationProperties

名称 DESCRIPTION 价值
资源ID 表示事件订阅的事件网格Namespace主题目标的终结点的 Azure 资源 ID。
此字段是必需的,并且列出的Namespace主题资源必须已存在。
资源 ARM ID 应遵循以下模式:/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}。
字符串

NumberGreaterThanFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberGreaterThan”(必需)
价值 筛选器值。 整数 (int)

NumberGreaterThanOrEqualsFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberGreaterThanOrEquals”(必需)
价值 筛选器值。 整数 (int)

NumberInFilter (数字筛选)

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberIn”(必需)
价值, 价值观 筛选器值集。 int[]

NumberInRangeFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberInRange”(必需)
价值, 价值观 筛选器值集。 int[][]

NumberLessThanFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberLessThan”(必需)
价值 筛选器值。 整数 (int)

NumberLessThanOrEqualsFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberLessThanOrEquals”(必需)
价值 筛选器值。 整数 (int)

NumberNotInFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberNotIn”(必需)
价值, 价值观 筛选器值集。 int[]

NumberNotInRangeFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberNotInRange”(必需)
价值, 价值观 筛选器值集。 int[][]

PartnerEventSubscriptionDestination

名称 DESCRIPTION 价值
endpoint类型 事件订阅目标的终结点类型。 “PartnerDestination”(必需)
属性 事件订阅目标的合作伙伴目标属性。 PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

名称 DESCRIPTION 价值
资源ID 表示事件订阅合作伙伴目标的终结点的 Azure 资源 ID。 字符串

推送信息

名称 DESCRIPTION 价值
deadLetterDestinationWithResourceIdentity 事件订阅的死信目标。 无法传递到其目标的任何事件都将发送到死信目标。
使用父资源(即命名空间)上的托管标识设置来获取死信期间使用的身份验证令牌。
DeadLetterWithResourceIdentity
deliveryWithResourceIdentity 有关事件订阅必须传送事件的目标的信息。
使用父资源(即主题或域)上的托管标识设置来获取在传递期间使用的身份验证令牌。
DeliveryWithResourceIdentity
目标 有关事件订阅必须传送事件的目标的信息。
使用 Azure 事件网格的标识获取在传递期间使用的身份验证令牌。
EventSubscriptionDestination 事件订阅目标
eventTimeToLive ISO 8601 格式的时间跨度持续时间,用于确定消息发布后订阅可用的消息时长。
此持续时间值使用以下格式表示:“P(n)Y(n)M(n)DT(n)H(n)M(n)M(n)S',其中:
- (n) 被后跟 (n) 的每次元素的值替换。
- P 是持续时间(或句点)设计器,始终放置在持续时间的开头。
- Y 是年份设计者,它遵循年份的值。
- M 是月份设计者,它遵循月份数的值。
- W 是周指示符,它遵循周数的值。
- D 是日期指示符,它遵循天数的值。
- T 是时间指示符,它位于时间组件之前。
- H 是小时指示符,它遵循小时数的值。
- M 是分钟指示符,它遵循分钟数的值。
- S 是第二个指示符,它遵循秒数的值。
无法设置此持续时间值大于主题的 EventRetentionInDays。 它是一个可选字段,其最小值为 1 分钟,并且其最大值已确定
按主题的 EventRetentionInDays 值。 下面是有效值的示例:
- “P0DT23H12M”或“PT23H12M”:持续时间为 23 小时 12 分钟。
- “P1D”或“P1DT0H0M0S”:持续时间为 1 天。
字符串
maxDeliveryCount 事件的最大传递计数。 整数 (int)

队列信息

名称 DESCRIPTION 价值
deadLetterDestinationWithResourceIdentity 事件订阅的死信目标。 无法传递到其目标的任何事件都将发送到死信目标。
使用父资源(即主题)上的托管标识设置来获取在传递/死信期间使用的身份验证令牌。
DeadLetterWithResourceIdentity
eventTimeToLive ISO 8601 格式的时间跨度持续时间,用于确定消息发布后订阅可用的消息时长。
此持续时间值使用以下格式表示:“P(n)Y(n)M(n)DT(n)H(n)M(n)M(n)S',其中:
- (n) 被后跟 (n) 的每次元素的值替换。
- P 是持续时间(或句点)设计器,始终放置在持续时间的开头。
- Y 是年份设计者,它遵循年份的值。
- M 是月份设计者,它遵循月份数的值。
- W 是周指示符,它遵循周数的值。
- D 是日期指示符,它遵循天数的值。
- T 是时间指示符,它位于时间组件之前。
- H 是小时指示符,它遵循小时数的值。
- M 是分钟指示符,它遵循分钟数的值。
- S 是第二个指示符,它遵循秒数的值。
无法设置此持续时间值大于主题的 EventRetentionInDays。 它是一个可选字段,其最小值为 1 分钟,并且其最大值已确定
按主题的 EventRetentionInDays 值。 下面是有效值的示例:
- “P0DT23H12M”或“PT23H12M”:持续时间为 23 小时 12 分钟。
- “P1D”或“P1DT0H0M0S”:持续时间为 1 天。
字符串
maxDeliveryCount 事件的最大传递计数。 整数 (int)
receiveLockDurationInSeconds 消息处于接收状态并等待接受、释放或拒绝的最大时间段(以秒为单位)。
如果在客户端收到消息后未转换到已接受(未处理)、释放或拒绝,则此时间已过,
消息可用于重新传送。 这是一个可选字段,默认值为 60 秒,最小值为 60 秒,最大值为 300 秒。
整数 (int)

ServiceBusQueueEventSubscriptionDestination

名称 DESCRIPTION 价值
endpoint类型 事件订阅目标的终结点类型。 “ServiceBusQueue”(必需)
属性 事件订阅目标的服务总线属性。 ServiceBusQueueEventSubscriptionDestinationProperties

ServiceBusQueueEventSubscriptionDestinationProperties

名称 DESCRIPTION 价值
deliveryAttributeMappings 传递属性详细信息。 DeliveryAttributeMapping[]
资源ID 表示事件订阅的服务总线目标的终结点的 Azure 资源 ID。 字符串

ServiceBusTopicEventSubscriptionDestination

名称 DESCRIPTION 价值
endpoint类型 事件订阅目标的终结点类型。 “ServiceBusTopic”(必需)
属性 事件订阅目标的服务总线主题属性。 ServiceBusTopicEventSubscriptionDestinationProperties

ServiceBusTopicEventSubscriptionDestinationProperties

名称 DESCRIPTION 价值
deliveryAttributeMappings 传递属性详细信息。 DeliveryAttributeMapping[]
资源ID 表示事件订阅的服务总线主题目标的终结点的 Azure 资源 ID。 字符串

StaticDeliveryAttributeMapping

名称 DESCRIPTION 价值
属性 静态传递属性映射的属性。 StaticDeliveryAttributeMappingProperties
类型 传递属性或标头名称的类型。 “Static”(必需)

StaticDeliveryAttributeMappingProperties

名称 DESCRIPTION 价值
isSecret 的 指示属性是否包含敏感信息的布尔标志。 布尔
价值 传递属性的值。 字符串

StorageBlobDeadLetterDestination

名称 DESCRIPTION 价值
endpoint类型 死信目标的终结点类型 “StorageBlob”(必需)
属性 基于存储 Blob 的死信目标的属性 StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

名称 DESCRIPTION 价值
blobContainerName (斑点容器名称) 存储 Blob 容器的名称,该容器是死信事件的目标 字符串
资源ID 存储帐户的 Azure 资源 ID,该 ID 是死信事件的目标 字符串

StorageQueueEventSubscriptionDestination

名称 DESCRIPTION 价值
endpoint类型 事件订阅目标的终结点类型。 “StorageQueue”(必需)
属性 事件订阅目标的存储队列属性。 StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

名称 DESCRIPTION 价值
queueMessageTimeToLiveInSeconds 存储队列消息生存时间(以秒为单位)。 此值不能为零或负值,但使用 -1 指示消息的生存时间是无限的。 整数 (int)
队列名称 作为事件订阅目标的存储帐户下的存储队列的名称。 字符串
资源ID 包含作为事件订阅目标的队列的存储帐户的 Azure 资源 ID。 字符串

StringBeginsWithFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringBeginsWith”(必需)
价值, 价值观 筛选器值集。 字符串[]

StringContainsFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringContains”(必需)
价值, 价值观 筛选器值集。 字符串[]

StringEndsWithFilter (字符串结束与过滤器)

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringEndsWith”(必需)
价值, 价值观 筛选器值集。 字符串[]

StringInFilter (字符串过滤器)

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringIn”(必需)
价值, 价值观 筛选器值集。 字符串[]

StringNotBeginsWithFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotBeginsWith”(必需)
价值, 价值观 筛选器值集。 字符串[]

StringNotContains过滤器

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotContains”(必需)
价值, 价值观 筛选器值集。 字符串[]

StringNotEndsWithFilter (字符串不结束与过滤器)

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotEndsWith”(必需)
价值, 价值观 筛选器值集。 字符串[]

StringNotInFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotIn”(必需)
价值, 价值观 筛选器值集。 字符串[]

SubscriptionProperties

名称 DESCRIPTION 价值
deliveryConfiguration 有关事件订阅的传递配置的信息。 DeliveryConfiguration
eventDeliverySchema 事件交付架构 事件订阅的事件传送架构。 “CloudEventSchemaV1_0”
过期时间 UTC 事件订阅的过期时间。 字符串
filtersConfiguration 有关事件订阅筛选器的信息。 FiltersConfiguration
标签 与事件订阅资源相关的标记。 SubscriptionProperties标签

SubscriptionProperties标签

名称 DESCRIPTION 价值

WebHookEventSubscriptionDestination

名称 DESCRIPTION 价值
endpoint类型 事件订阅目标的终结点类型。 “WebHook”(必需)
属性 事件订阅目标的 WebHook 属性。 WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

名称 DESCRIPTION 价值
azureActiveDirectoryApplicationIdOrUri Microsoft Entra ID 应用程序 ID 或 URI,用于获取将作为不记名令牌包含在投放请求中的访问令牌。 字符串
azureActiveDirectoryTenantId Microsoft Entra ID 租户 ID,用于获取将作为不记名令牌包含在投放请求中的访问令牌。 字符串
deliveryAttributeMappings 传递属性详细信息。 DeliveryAttributeMapping[]
端点URL 表示事件订阅目标的终结点的 URL。 字符串

约束:
敏感值。 以安全参数的形式传入。
maxEventsPerBatch 每个批处理的最大事件数。 整数 (int)
minimumTlsVersionAllowed Webhook 终结点应支持的最低 TLS 版本 '1.0'
'1.1'
'1.2'
preferredBatchSizeInKilobytes 首选批大小(以千字节为单位)。 整数 (int)

ARM 模板资源定义

可以使用目标作部署命名空间/topics/eventSubscriptions 资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.EventGrid/namespaces/topics/eventSubscriptions 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.EventGrid/namespaces/topics/eventSubscriptions",
  "apiVersion": "2025-04-01-preview",
  "name": "string",
  "properties": {
    "deliveryConfiguration": {
      "deliveryMode": "string",
      "push": {
        "deadLetterDestinationWithResourceIdentity": {
          "deadLetterDestination": {
            "endpointType": "string"
            // For remaining properties, see DeadLetterDestination objects
          },
          "identity": {
            "federatedIdentityCredentialInfo": {
              "federatedClientId": "string"
            },
            "type": "string",
            "userAssignedIdentity": "string"
          }
        },
        "deliveryWithResourceIdentity": {
          "destination": {
            "endpointType": "string"
            // For remaining properties, see EventSubscriptionDestination objects
          },
          "identity": {
            "federatedIdentityCredentialInfo": {
              "federatedClientId": "string"
            },
            "type": "string",
            "userAssignedIdentity": "string"
          }
        },
        "destination": {
          "endpointType": "string"
          // For remaining properties, see EventSubscriptionDestination objects
        },
        "eventTimeToLive": "string",
        "maxDeliveryCount": "int"
      },
      "queue": {
        "deadLetterDestinationWithResourceIdentity": {
          "deadLetterDestination": {
            "endpointType": "string"
            // For remaining properties, see DeadLetterDestination objects
          },
          "identity": {
            "federatedIdentityCredentialInfo": {
              "federatedClientId": "string"
            },
            "type": "string",
            "userAssignedIdentity": "string"
          }
        },
        "eventTimeToLive": "string",
        "maxDeliveryCount": "int",
        "receiveLockDurationInSeconds": "int"
      }
    },
    "eventDeliverySchema": "string",
    "expirationTimeUtc": "string",
    "filtersConfiguration": {
      "filters": [ {
        "key": "string",
        "operatorType": "string"
        // For remaining properties, see Filter objects
      } ],
      "includedEventTypes": [ "string" ]
    },
    "tags": {
      "{customized property}": "string"
    }
  }
}

DeadLetterDestination 对象

设置 endpointType 属性以指定对象的类型。

对于 StorageBlob,请使用:

{
  "endpointType": "StorageBlob",
  "properties": {
    "blobContainerName": "string",
    "resourceId": "string"
  }
}

筛选对象

设置 operatorType 属性以指定对象的类型。

对于 BoolEquals,请使用:

{
  "operatorType": "BoolEquals",
  "value": "bool"
}

对于 IsNotNull,请使用:

{
  "operatorType": "IsNotNull"
}

对于 IsNullOrUndefined,请使用:

{
  "operatorType": "IsNullOrUndefined"
}

对于 NumberGreaterThan,请使用:

{
  "operatorType": "NumberGreaterThan",
  "value": "int"
}

对于 NumberGreaterThanOrEquals,请使用:

{
  "operatorType": "NumberGreaterThanOrEquals",
  "value": "int"
}

对于 NumberIn,请使用:

{
  "operatorType": "NumberIn",
  "values": [ "int" ]
}

对于 NumberInRange,请使用:

{
  "operatorType": "NumberInRange",
  "values": [
    [ "int" ]
  ]
}

对于 NumberLessThan,请使用:

{
  "operatorType": "NumberLessThan",
  "value": "int"
}

对于 NumberLessThanOrEquals,请使用:

{
  "operatorType": "NumberLessThanOrEquals",
  "value": "int"
}

对于 NumberNotIn,请使用:

{
  "operatorType": "NumberNotIn",
  "values": [ "int" ]
}

对于 NumberNotInRange,请使用:

{
  "operatorType": "NumberNotInRange",
  "values": [
    [ "int" ]
  ]
}

对于 StringBeginsWith,请使用:

{
  "operatorType": "StringBeginsWith",
  "values": [ "string" ]
}

对于 StringContains,请使用:

{
  "operatorType": "StringContains",
  "values": [ "string" ]
}

对于 StringEndsWith,请使用:

{
  "operatorType": "StringEndsWith",
  "values": [ "string" ]
}

对于 StringIn,请使用:

{
  "operatorType": "StringIn",
  "values": [ "string" ]
}

对于 StringNotBeginsWith,请使用:

{
  "operatorType": "StringNotBeginsWith",
  "values": [ "string" ]
}

对于 StringNotContains,请使用:

{
  "operatorType": "StringNotContains",
  "values": [ "string" ]
}

对于 StringNotEndsWith,请使用:

{
  "operatorType": "StringNotEndsWith",
  "values": [ "string" ]
}

对于 StringNotIn,请使用:

{
  "operatorType": "StringNotIn",
  "values": [ "string" ]
}

DeliveryAttributeMapping 对象

设置 类型 属性以指定对象的类型。

对于 Dynamic,请使用:

{
  "properties": {
    "sourceField": "string"
  },
  "type": "Dynamic"
}

对于 静态,请使用:

{
  "properties": {
    "isSecret": "bool",
    "value": "string"
  },
  "type": "Static"
}

EventSubscriptionDestination 对象

设置 endpointType 属性以指定对象的类型。

对于 azureFunction,请使用:

{
  "endpointType": "AzureFunction",
  "properties": {
    "deliveryAttributeMappings": [ {
      "name": "string",
      "type": "string"
      // For remaining properties, see DeliveryAttributeMapping objects
    } ],
    "maxEventsPerBatch": "int",
    "preferredBatchSizeInKilobytes": "int",
    "resourceId": "string"
  }
}

对于 EventHub,请使用:

{
  "endpointType": "EventHub",
  "properties": {
    "deliveryAttributeMappings": [ {
      "name": "string",
      "type": "string"
      // For remaining properties, see DeliveryAttributeMapping objects
    } ],
    "resourceId": "string"
  }
}

对于 HybridConnection,请使用:

{
  "endpointType": "HybridConnection",
  "properties": {
    "deliveryAttributeMappings": [ {
      "name": "string",
      "type": "string"
      // For remaining properties, see DeliveryAttributeMapping objects
    } ],
    "resourceId": "string"
  }
}

对于 MonitorAlert,请使用:

{
  "endpointType": "MonitorAlert",
  "properties": {
    "actionGroups": [ "string" ],
    "description": "string",
    "severity": "string"
  }
}

对于 NamespaceTopic,请使用:

{
  "endpointType": "NamespaceTopic",
  "properties": {
    "resourceId": "string"
  }
}

对于 PartnerDestination,请使用:

{
  "endpointType": "PartnerDestination",
  "properties": {
    "resourceId": "string"
  }
}

对于 ServiceBusQueue,请使用:

{
  "endpointType": "ServiceBusQueue",
  "properties": {
    "deliveryAttributeMappings": [ {
      "name": "string",
      "type": "string"
      // For remaining properties, see DeliveryAttributeMapping objects
    } ],
    "resourceId": "string"
  }
}

对于 ServiceBusTopic,请使用:

{
  "endpointType": "ServiceBusTopic",
  "properties": {
    "deliveryAttributeMappings": [ {
      "name": "string",
      "type": "string"
      // For remaining properties, see DeliveryAttributeMapping objects
    } ],
    "resourceId": "string"
  }
}

对于 StorageQueue,请使用:

{
  "endpointType": "StorageQueue",
  "properties": {
    "queueMessageTimeToLiveInSeconds": "int",
    "queueName": "string",
    "resourceId": "string"
  }
}

对于 WebHook,请使用:

{
  "endpointType": "WebHook",
  "properties": {
    "azureActiveDirectoryApplicationIdOrUri": "string",
    "azureActiveDirectoryTenantId": "string",
    "deliveryAttributeMappings": [ {
      "name": "string",
      "type": "string"
      // For remaining properties, see DeliveryAttributeMapping objects
    } ],
    "endpointUrl": "string",
    "maxEventsPerBatch": "int",
    "minimumTlsVersionAllowed": "string",
    "preferredBatchSizeInKilobytes": "int"
  }
}

属性值

Microsoft.EventGrid/namespaces/topics/eventSubscriptions

名称 DESCRIPTION 价值
apiVersion API 版本 “2025-04-01-预览”
姓名 资源名称 字符串

约束:
最小长度 = 3
最大长度 = 50
模式 = ^[a-zA-Z0-9-]*$ (必需)
属性 事件订阅的属性。 SubscriptionProperties
类型 资源类型 “Microsoft.EventGrid/namespaces/topics/eventSubscriptions”

AzureFunctionEventSubscriptionDestination

名称 DESCRIPTION 价值
endpoint类型 事件订阅目标的终结点类型。 “AzureFunction”(必需)
属性 事件订阅目标的 Azure 函数属性。 AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

名称 DESCRIPTION 价值
deliveryAttributeMappings 传递属性详细信息。 DeliveryAttributeMapping[]
maxEventsPerBatch 每个批处理的最大事件数。 整数 (int)
preferredBatchSizeInKilobytes 首选批大小(以千字节为单位)。 整数 (int)
资源ID 表示事件订阅的 Azure Function 目标的终结点的 Azure 资源 ID。 字符串

BoolEqualsFilter (布尔等于过滤器)

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “BoolEquals”(必需)
价值 布尔筛选器值。 布尔

死信目标

名称 DESCRIPTION 价值
endpoint类型 设置为 StorageBlobDeadLetterDestination 类型的“StorageBlob”。 “StorageBlob”(必需)

DeadLetterWithResourceIdentity

名称 DESCRIPTION 价值
deadLetterDestination 的 有关事件订阅必须传送事件的目标的信息。
使用父资源(即主题或域)上的托管标识设置来获取死信期间使用的身份验证令牌。
死信目标
标识 死信事件时要使用的标识。 EventSubscriptionIdentity

DeliveryAttributeMapping

名称 DESCRIPTION 价值
姓名 传递属性或标头的名称。 字符串
类型 设置为“ DynamicDeliveryAttributeMapping”类型的“Dynamic”。 设置为 StaticDeliveryAttributeMapping 类型的“Static”。 “Dynamic”
“Static”(必需)

DeliveryConfiguration

名称 DESCRIPTION 价值
deliveryMode 交付模式 事件订阅的传递模式。 “Push”
“Queue”
推送 当 deliveryMode 推送并表示有关推送订阅的信息时,应填充此属性。 推送信息
队列 当 deliveryMode 为队列并表示有关队列订阅的信息时,应填充此属性。 队列信息

DeliveryWithResourceIdentity

名称 DESCRIPTION 价值
目标 有关事件订阅必须传送事件的目标的信息。
使用父资源(即主题或域)上的托管标识设置来获取在传递期间使用的身份验证令牌。
EventSubscriptionDestination 事件订阅目标
标识 传送事件时要使用的标识。 EventSubscriptionIdentity

DynamicDeliveryAttributeMapping

名称 DESCRIPTION 价值
属性 动态传递属性映射的属性。 DynamicDeliveryAttributeMappingProperties
类型 传递属性或标头名称的类型。 “Dynamic”(必需)

DynamicDeliveryAttributeMappingProperties

名称 DESCRIPTION 价值
sourceField 包含属性值的事件中的 JSON 路径。 字符串

EventHubEventSubscriptionDestination 事件订阅目标

名称 DESCRIPTION 价值
endpoint类型 事件订阅目标的终结点类型。 “EventHub”(必需)
属性 事件订阅目标的事件中心属性。 EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

名称 DESCRIPTION 价值
deliveryAttributeMappings 传递属性详细信息。 DeliveryAttributeMapping[]
资源ID 表示事件订阅的事件中心目标的终结点的 Azure 资源 ID。 字符串

EventSubscriptionDestination 事件订阅目标

名称 DESCRIPTION 价值
endpoint类型 设置为 AzureFunctionEventSubscriptionDestination 类型的“AzureFunction”。 设置为 EventHubEventSubscriptionDestination 类型的“EventHub”。 对于 HybridConnectionEventSubscriptionDestination,设置为“HybridConnection”。 设置为 MonitorAlertEventSubscriptionDestination 类型的“MonitorAlert”。 对于 NamespaceTopicEventSubscriptionDestination,设置为“NamespaceTopic”。 设置为 PartnerEventSubscriptionDestination 类型的“PartnerDestination”。 设置为 ServiceBusQueueEventSubscriptionDestination 类型的“ServiceBusQueue”。 对于 ServiceBusTopicEventSubscriptionDestination,设置为“ServiceBusTopic”。 设置为 StorageQueueEventSubscriptionDestination 类型的“StorageQueue”。 对于 WebHookEventSubscriptionDestination,设置为“WebHook”。 “AzureFunction”
“EventHub”
“HybridConnection”
“MonitorAlert”
“NamespaceTopic”
“PartnerDestination”
“ServiceBusQueue”
“ServiceBusTopic”
“StorageQueue”
“WebHook”(必需)

EventSubscriptionIdentity

名称 DESCRIPTION 价值
federatedIdentityCredentialInfo 用于资源传递的联合标识凭据(FIC)的详细信息。 FederatedIdentityCredentialInfo
类型 使用的托管标识的类型。 可以是“SystemAssigned”或“UserAssigned”。 “SystemAssigned”
“UserAssigned”
userAssignedIdentity 与资源关联的用户标识。 字符串

FederatedIdentityCredentialInfo

名称 DESCRIPTION 价值
federatedClientId 与联合身份凭证 (FIC) 关联的多租户 Microsoft Entra ID 应用程序。 字符串

约束:
最小长度 = 36
最大长度 = 36
模式 = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ (必需)

过滤器

名称 DESCRIPTION 价值
关键值 要根据要筛选的事件中的字段/属性。 字符串
运算符类型 对于 BoolEqualsFilter 类型,设置为“BoolEquals”。 对于 IsNotNullFilter 类型,设置为“IsNotNull”。 设置为 IsNullOrUndefined 类型的“IsNullOrUndefinedFilter”。 对于 NumberGreaterThanFilter 类型,设置为“NumberGreaterThan”。 设置为 Type NumberGreaterThanOrEquals 的“NumberGreaterThanOrEquals”。 设置为 NumberInFilter 类型的“NumberIn”。 设置为 NumberInRangeFilter 类型的“NumberInRange”。 对于 NumberLessThanFilter 类型,设置为“NumberLessThanThan”。 对于 NumberLessThanOrEqualsFilter,设置为“NumberLessThanOrEquals”。 设置为 NumberNotInFilter 类型的“NumberNotIn”。 对于 NumberNotInRangeFilter 类型,设置为“NumberNotInRange”。 对于 StringBeginsWithFilter,设置为“StringBeginsWith”。 设置为 StringContainsFilter 类型的“StringContains”。 对于 StringEndsWithFilter 类型,设置为“StringEndsWithWith”。 设置为 StringInFilter 类型的“StringIn”。 设置为 StringNotBeginsWith 类型的“StringNotBeginsWithFilter”。 对于 StringNotContainsFilter,设置为“StringNotContains”。 对于 StringNotEndsWithFilter,设置为“StringNotEndsWith”。 设置为 StringNotInFilter 类型的“StringNotIn”。 “BoolEquals”
“IsNotNull”
“IsNullOrUndefined”
“NumberGreaterThan”
“NumberGreaterThanOrEquals”
“NumberIn”
“NumberInRange”
“NumberLessThan”
“NumberLessThanOrEquals”
“NumberNotIn”
“NumberNotInRange”
“StringBeginsWith”
“StringContains”
“StringEndsWith”
“StringIn”
“StringNotBeginsWith”
“StringNotContains”
“StringNotEndsWith”
“StringNotIn”(必需)

FiltersConfiguration

名称 DESCRIPTION 价值
筛选器 用于筛选事件订阅的筛选器数组。 筛选器[]
includedEventTypes 需要属于事件订阅的适用事件类型的列表。 如果需要订阅所有默认事件类型,请将 IncludedEventTypes 设置为 null。 字符串[]

HybridConnectionEventSubscriptionDestination

名称 DESCRIPTION 价值
endpoint类型 事件订阅目标的终结点类型。 “HybridConnection”(必需)
属性 事件订阅目标的混合连接属性。 HybridConnectionEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestinationProperties

名称 DESCRIPTION 价值
deliveryAttributeMappings 传递属性详细信息。 DeliveryAttributeMapping[]
资源ID 作为事件订阅目标的混合连接的 Azure 资源 ID。 字符串

IsNotNullFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “IsNotNull”(必需)

IsNullOrUndefinedFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “IsNullOrUndefined”(必需)

监视器警报事件订阅目标

名称 DESCRIPTION 价值
endpoint类型 事件订阅目标的终结点类型。 “MonitorAlert”(必需)
属性 监视事件订阅目标的警报属性。 MonitorAlertEventSubscriptionDestinationProperties

MonitorAlertEventSubscriptionDestinationProperties

名称 DESCRIPTION 价值
作组 将在通过此事件订阅触发的每个警报上触发的操作组的 ARM ID 列表。
每个资源 ARM ID 都应遵循以下模式:/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}。
字符串[]
描述 将附加到通过此事件订阅触发的每个警报的说明。 字符串
严重性 将附加到通过此事件订阅触发的每个警报的严重性。
必须提供此字段。
“Sev0”
“Sev1”
“Sev2”
“Sev3”
“Sev4”

NamespaceTopicEventSubscriptionDestination

名称 DESCRIPTION 价值
endpoint类型 事件订阅目标的终结点类型。 “NamespaceTopic”(必需)
属性 Namespace事件订阅目标的主题属性。 NamespaceTopicEventSubscriptionDestinationProperties

NamespaceTopicEventSubscriptionDestinationProperties

名称 DESCRIPTION 价值
资源ID 表示事件订阅的事件网格Namespace主题目标的终结点的 Azure 资源 ID。
此字段是必需的,并且列出的Namespace主题资源必须已存在。
资源 ARM ID 应遵循以下模式:/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}。
字符串

NumberGreaterThanFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberGreaterThan”(必需)
价值 筛选器值。 整数 (int)

NumberGreaterThanOrEqualsFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberGreaterThanOrEquals”(必需)
价值 筛选器值。 整数 (int)

NumberInFilter (数字筛选)

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberIn”(必需)
价值, 价值观 筛选器值集。 int[]

NumberInRangeFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberInRange”(必需)
价值, 价值观 筛选器值集。 int[][]

NumberLessThanFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberLessThan”(必需)
价值 筛选器值。 整数 (int)

NumberLessThanOrEqualsFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberLessThanOrEquals”(必需)
价值 筛选器值。 整数 (int)

NumberNotInFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberNotIn”(必需)
价值, 价值观 筛选器值集。 int[]

NumberNotInRangeFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberNotInRange”(必需)
价值, 价值观 筛选器值集。 int[][]

PartnerEventSubscriptionDestination

名称 DESCRIPTION 价值
endpoint类型 事件订阅目标的终结点类型。 “PartnerDestination”(必需)
属性 事件订阅目标的合作伙伴目标属性。 PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

名称 DESCRIPTION 价值
资源ID 表示事件订阅合作伙伴目标的终结点的 Azure 资源 ID。 字符串

推送信息

名称 DESCRIPTION 价值
deadLetterDestinationWithResourceIdentity 事件订阅的死信目标。 无法传递到其目标的任何事件都将发送到死信目标。
使用父资源(即命名空间)上的托管标识设置来获取死信期间使用的身份验证令牌。
DeadLetterWithResourceIdentity
deliveryWithResourceIdentity 有关事件订阅必须传送事件的目标的信息。
使用父资源(即主题或域)上的托管标识设置来获取在传递期间使用的身份验证令牌。
DeliveryWithResourceIdentity
目标 有关事件订阅必须传送事件的目标的信息。
使用 Azure 事件网格的标识获取在传递期间使用的身份验证令牌。
EventSubscriptionDestination 事件订阅目标
eventTimeToLive ISO 8601 格式的时间跨度持续时间,用于确定消息发布后订阅可用的消息时长。
此持续时间值使用以下格式表示:“P(n)Y(n)M(n)DT(n)H(n)M(n)M(n)S',其中:
- (n) 被后跟 (n) 的每次元素的值替换。
- P 是持续时间(或句点)设计器,始终放置在持续时间的开头。
- Y 是年份设计者,它遵循年份的值。
- M 是月份设计者,它遵循月份数的值。
- W 是周指示符,它遵循周数的值。
- D 是日期指示符,它遵循天数的值。
- T 是时间指示符,它位于时间组件之前。
- H 是小时指示符,它遵循小时数的值。
- M 是分钟指示符,它遵循分钟数的值。
- S 是第二个指示符,它遵循秒数的值。
无法设置此持续时间值大于主题的 EventRetentionInDays。 它是一个可选字段,其最小值为 1 分钟,并且其最大值已确定
按主题的 EventRetentionInDays 值。 下面是有效值的示例:
- “P0DT23H12M”或“PT23H12M”:持续时间为 23 小时 12 分钟。
- “P1D”或“P1DT0H0M0S”:持续时间为 1 天。
字符串
maxDeliveryCount 事件的最大传递计数。 整数 (int)

队列信息

名称 DESCRIPTION 价值
deadLetterDestinationWithResourceIdentity 事件订阅的死信目标。 无法传递到其目标的任何事件都将发送到死信目标。
使用父资源(即主题)上的托管标识设置来获取在传递/死信期间使用的身份验证令牌。
DeadLetterWithResourceIdentity
eventTimeToLive ISO 8601 格式的时间跨度持续时间,用于确定消息发布后订阅可用的消息时长。
此持续时间值使用以下格式表示:“P(n)Y(n)M(n)DT(n)H(n)M(n)M(n)S',其中:
- (n) 被后跟 (n) 的每次元素的值替换。
- P 是持续时间(或句点)设计器,始终放置在持续时间的开头。
- Y 是年份设计者,它遵循年份的值。
- M 是月份设计者,它遵循月份数的值。
- W 是周指示符,它遵循周数的值。
- D 是日期指示符,它遵循天数的值。
- T 是时间指示符,它位于时间组件之前。
- H 是小时指示符,它遵循小时数的值。
- M 是分钟指示符,它遵循分钟数的值。
- S 是第二个指示符,它遵循秒数的值。
无法设置此持续时间值大于主题的 EventRetentionInDays。 它是一个可选字段,其最小值为 1 分钟,并且其最大值已确定
按主题的 EventRetentionInDays 值。 下面是有效值的示例:
- “P0DT23H12M”或“PT23H12M”:持续时间为 23 小时 12 分钟。
- “P1D”或“P1DT0H0M0S”:持续时间为 1 天。
字符串
maxDeliveryCount 事件的最大传递计数。 整数 (int)
receiveLockDurationInSeconds 消息处于接收状态并等待接受、释放或拒绝的最大时间段(以秒为单位)。
如果在客户端收到消息后未转换到已接受(未处理)、释放或拒绝,则此时间已过,
消息可用于重新传送。 这是一个可选字段,默认值为 60 秒,最小值为 60 秒,最大值为 300 秒。
整数 (int)

ServiceBusQueueEventSubscriptionDestination

名称 DESCRIPTION 价值
endpoint类型 事件订阅目标的终结点类型。 “ServiceBusQueue”(必需)
属性 事件订阅目标的服务总线属性。 ServiceBusQueueEventSubscriptionDestinationProperties

ServiceBusQueueEventSubscriptionDestinationProperties

名称 DESCRIPTION 价值
deliveryAttributeMappings 传递属性详细信息。 DeliveryAttributeMapping[]
资源ID 表示事件订阅的服务总线目标的终结点的 Azure 资源 ID。 字符串

ServiceBusTopicEventSubscriptionDestination

名称 DESCRIPTION 价值
endpoint类型 事件订阅目标的终结点类型。 “ServiceBusTopic”(必需)
属性 事件订阅目标的服务总线主题属性。 ServiceBusTopicEventSubscriptionDestinationProperties

ServiceBusTopicEventSubscriptionDestinationProperties

名称 DESCRIPTION 价值
deliveryAttributeMappings 传递属性详细信息。 DeliveryAttributeMapping[]
资源ID 表示事件订阅的服务总线主题目标的终结点的 Azure 资源 ID。 字符串

StaticDeliveryAttributeMapping

名称 DESCRIPTION 价值
属性 静态传递属性映射的属性。 StaticDeliveryAttributeMappingProperties
类型 传递属性或标头名称的类型。 “Static”(必需)

StaticDeliveryAttributeMappingProperties

名称 DESCRIPTION 价值
isSecret 的 指示属性是否包含敏感信息的布尔标志。 布尔
价值 传递属性的值。 字符串

StorageBlobDeadLetterDestination

名称 DESCRIPTION 价值
endpoint类型 死信目标的终结点类型 “StorageBlob”(必需)
属性 基于存储 Blob 的死信目标的属性 StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

名称 DESCRIPTION 价值
blobContainerName (斑点容器名称) 存储 Blob 容器的名称,该容器是死信事件的目标 字符串
资源ID 存储帐户的 Azure 资源 ID,该 ID 是死信事件的目标 字符串

StorageQueueEventSubscriptionDestination

名称 DESCRIPTION 价值
endpoint类型 事件订阅目标的终结点类型。 “StorageQueue”(必需)
属性 事件订阅目标的存储队列属性。 StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

名称 DESCRIPTION 价值
queueMessageTimeToLiveInSeconds 存储队列消息生存时间(以秒为单位)。 此值不能为零或负值,但使用 -1 指示消息的生存时间是无限的。 整数 (int)
队列名称 作为事件订阅目标的存储帐户下的存储队列的名称。 字符串
资源ID 包含作为事件订阅目标的队列的存储帐户的 Azure 资源 ID。 字符串

StringBeginsWithFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringBeginsWith”(必需)
价值, 价值观 筛选器值集。 字符串[]

StringContainsFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringContains”(必需)
价值, 价值观 筛选器值集。 字符串[]

StringEndsWithFilter (字符串结束与过滤器)

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringEndsWith”(必需)
价值, 价值观 筛选器值集。 字符串[]

StringInFilter (字符串过滤器)

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringIn”(必需)
价值, 价值观 筛选器值集。 字符串[]

StringNotBeginsWithFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotBeginsWith”(必需)
价值, 价值观 筛选器值集。 字符串[]

StringNotContains过滤器

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotContains”(必需)
价值, 价值观 筛选器值集。 字符串[]

StringNotEndsWithFilter (字符串不结束与过滤器)

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotEndsWith”(必需)
价值, 价值观 筛选器值集。 字符串[]

StringNotInFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotIn”(必需)
价值, 价值观 筛选器值集。 字符串[]

SubscriptionProperties

名称 DESCRIPTION 价值
deliveryConfiguration 有关事件订阅的传递配置的信息。 DeliveryConfiguration
eventDeliverySchema 事件交付架构 事件订阅的事件传送架构。 “CloudEventSchemaV1_0”
过期时间 UTC 事件订阅的过期时间。 字符串
filtersConfiguration 有关事件订阅筛选器的信息。 FiltersConfiguration
标签 与事件订阅资源相关的标记。 SubscriptionProperties标签

SubscriptionProperties标签

名称 DESCRIPTION 价值

WebHookEventSubscriptionDestination

名称 DESCRIPTION 价值
endpoint类型 事件订阅目标的终结点类型。 “WebHook”(必需)
属性 事件订阅目标的 WebHook 属性。 WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

名称 DESCRIPTION 价值
azureActiveDirectoryApplicationIdOrUri Microsoft Entra ID 应用程序 ID 或 URI,用于获取将作为不记名令牌包含在投放请求中的访问令牌。 字符串
azureActiveDirectoryTenantId Microsoft Entra ID 租户 ID,用于获取将作为不记名令牌包含在投放请求中的访问令牌。 字符串
deliveryAttributeMappings 传递属性详细信息。 DeliveryAttributeMapping[]
端点URL 表示事件订阅目标的终结点的 URL。 字符串

约束:
敏感值。 以安全参数的形式传入。
maxEventsPerBatch 每个批处理的最大事件数。 整数 (int)
minimumTlsVersionAllowed Webhook 终结点应支持的最低 TLS 版本 '1.0'
'1.1'
'1.2'
preferredBatchSizeInKilobytes 首选批大小(以千字节为单位)。 整数 (int)

用法示例

Terraform (AzAPI 提供程序)资源定义

可以使用目标作部署命名空间/topics/eventSubscriptions 资源类型:

  • 资源组

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.EventGrid/namespaces/topics/eventSubscriptions 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2025-04-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      deliveryConfiguration = {
        deliveryMode = "string"
        push = {
          deadLetterDestinationWithResourceIdentity = {
            deadLetterDestination = {
              endpointType = "string"
              // For remaining properties, see DeadLetterDestination objects
            }
            identity = {
              federatedIdentityCredentialInfo = {
                federatedClientId = "string"
              }
              type = "string"
              userAssignedIdentity = "string"
            }
          }
          deliveryWithResourceIdentity = {
            destination = {
              endpointType = "string"
              // For remaining properties, see EventSubscriptionDestination objects
            }
            identity = {
              federatedIdentityCredentialInfo = {
                federatedClientId = "string"
              }
              type = "string"
              userAssignedIdentity = "string"
            }
          }
          destination = {
            endpointType = "string"
            // For remaining properties, see EventSubscriptionDestination objects
          }
          eventTimeToLive = "string"
          maxDeliveryCount = int
        }
        queue = {
          deadLetterDestinationWithResourceIdentity = {
            deadLetterDestination = {
              endpointType = "string"
              // For remaining properties, see DeadLetterDestination objects
            }
            identity = {
              federatedIdentityCredentialInfo = {
                federatedClientId = "string"
              }
              type = "string"
              userAssignedIdentity = "string"
            }
          }
          eventTimeToLive = "string"
          maxDeliveryCount = int
          receiveLockDurationInSeconds = int
        }
      }
      eventDeliverySchema = "string"
      expirationTimeUtc = "string"
      filtersConfiguration = {
        filters = [
          {
            key = "string"
            operatorType = "string"
            // For remaining properties, see Filter objects
          }
        ]
        includedEventTypes = [
          "string"
        ]
      }
      tags = {
        {customized property} = "string"
      }
    }
  }
}

DeadLetterDestination 对象

设置 endpointType 属性以指定对象的类型。

对于 StorageBlob,请使用:

{
  endpointType = "StorageBlob"
  properties = {
    blobContainerName = "string"
    resourceId = "string"
  }
}

筛选对象

设置 operatorType 属性以指定对象的类型。

对于 BoolEquals,请使用:

{
  operatorType = "BoolEquals"
  value = bool
}

对于 IsNotNull,请使用:

{
  operatorType = "IsNotNull"
}

对于 IsNullOrUndefined,请使用:

{
  operatorType = "IsNullOrUndefined"
}

对于 NumberGreaterThan,请使用:

{
  operatorType = "NumberGreaterThan"
  value = int
}

对于 NumberGreaterThanOrEquals,请使用:

{
  operatorType = "NumberGreaterThanOrEquals"
  value = int
}

对于 NumberIn,请使用:

{
  operatorType = "NumberIn"
  values = [
    int
  ]
}

对于 NumberInRange,请使用:

{
  operatorType = "NumberInRange"
  values = [
    [
      int
    ]
  ]
}

对于 NumberLessThan,请使用:

{
  operatorType = "NumberLessThan"
  value = int
}

对于 NumberLessThanOrEquals,请使用:

{
  operatorType = "NumberLessThanOrEquals"
  value = int
}

对于 NumberNotIn,请使用:

{
  operatorType = "NumberNotIn"
  values = [
    int
  ]
}

对于 NumberNotInRange,请使用:

{
  operatorType = "NumberNotInRange"
  values = [
    [
      int
    ]
  ]
}

对于 StringBeginsWith,请使用:

{
  operatorType = "StringBeginsWith"
  values = [
    "string"
  ]
}

对于 StringContains,请使用:

{
  operatorType = "StringContains"
  values = [
    "string"
  ]
}

对于 StringEndsWith,请使用:

{
  operatorType = "StringEndsWith"
  values = [
    "string"
  ]
}

对于 StringIn,请使用:

{
  operatorType = "StringIn"
  values = [
    "string"
  ]
}

对于 StringNotBeginsWith,请使用:

{
  operatorType = "StringNotBeginsWith"
  values = [
    "string"
  ]
}

对于 StringNotContains,请使用:

{
  operatorType = "StringNotContains"
  values = [
    "string"
  ]
}

对于 StringNotEndsWith,请使用:

{
  operatorType = "StringNotEndsWith"
  values = [
    "string"
  ]
}

对于 StringNotIn,请使用:

{
  operatorType = "StringNotIn"
  values = [
    "string"
  ]
}

DeliveryAttributeMapping 对象

设置 类型 属性以指定对象的类型。

对于 Dynamic,请使用:

{
  properties = {
    sourceField = "string"
  }
  type = "Dynamic"
}

对于 静态,请使用:

{
  properties = {
    isSecret = bool
    value = "string"
  }
  type = "Static"
}

EventSubscriptionDestination 对象

设置 endpointType 属性以指定对象的类型。

对于 azureFunction,请使用:

{
  endpointType = "AzureFunction"
  properties = {
    deliveryAttributeMappings = [
      {
        name = "string"
        type = "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    maxEventsPerBatch = int
    preferredBatchSizeInKilobytes = int
    resourceId = "string"
  }
}

对于 EventHub,请使用:

{
  endpointType = "EventHub"
  properties = {
    deliveryAttributeMappings = [
      {
        name = "string"
        type = "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId = "string"
  }
}

对于 HybridConnection,请使用:

{
  endpointType = "HybridConnection"
  properties = {
    deliveryAttributeMappings = [
      {
        name = "string"
        type = "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId = "string"
  }
}

对于 MonitorAlert,请使用:

{
  endpointType = "MonitorAlert"
  properties = {
    actionGroups = [
      "string"
    ]
    description = "string"
    severity = "string"
  }
}

对于 NamespaceTopic,请使用:

{
  endpointType = "NamespaceTopic"
  properties = {
    resourceId = "string"
  }
}

对于 PartnerDestination,请使用:

{
  endpointType = "PartnerDestination"
  properties = {
    resourceId = "string"
  }
}

对于 ServiceBusQueue,请使用:

{
  endpointType = "ServiceBusQueue"
  properties = {
    deliveryAttributeMappings = [
      {
        name = "string"
        type = "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId = "string"
  }
}

对于 ServiceBusTopic,请使用:

{
  endpointType = "ServiceBusTopic"
  properties = {
    deliveryAttributeMappings = [
      {
        name = "string"
        type = "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId = "string"
  }
}

对于 StorageQueue,请使用:

{
  endpointType = "StorageQueue"
  properties = {
    queueMessageTimeToLiveInSeconds = int
    queueName = "string"
    resourceId = "string"
  }
}

对于 WebHook,请使用:

{
  endpointType = "WebHook"
  properties = {
    azureActiveDirectoryApplicationIdOrUri = "string"
    azureActiveDirectoryTenantId = "string"
    deliveryAttributeMappings = [
      {
        name = "string"
        type = "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    endpointUrl = "string"
    maxEventsPerBatch = int
    minimumTlsVersionAllowed = "string"
    preferredBatchSizeInKilobytes = int
  }
}

属性值

Microsoft.EventGrid/namespaces/topics/eventSubscriptions

名称 DESCRIPTION 价值
姓名 资源名称 字符串

约束:
最小长度 = 3
最大长度 = 50
模式 = ^[a-zA-Z0-9-]*$ (必需)
parent_id 此资源的父资源的 ID。 类型资源的 ID: 命名空间/主题
属性 事件订阅的属性。 SubscriptionProperties
类型 资源类型 “Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2025-04-01-preview”

AzureFunctionEventSubscriptionDestination

名称 DESCRIPTION 价值
endpoint类型 事件订阅目标的终结点类型。 “AzureFunction”(必需)
属性 事件订阅目标的 Azure 函数属性。 AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

名称 DESCRIPTION 价值
deliveryAttributeMappings 传递属性详细信息。 DeliveryAttributeMapping[]
maxEventsPerBatch 每个批处理的最大事件数。 整数 (int)
preferredBatchSizeInKilobytes 首选批大小(以千字节为单位)。 整数 (int)
资源ID 表示事件订阅的 Azure Function 目标的终结点的 Azure 资源 ID。 字符串

BoolEqualsFilter (布尔等于过滤器)

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “BoolEquals”(必需)
价值 布尔筛选器值。 布尔

死信目标

名称 DESCRIPTION 价值
endpoint类型 设置为 StorageBlobDeadLetterDestination 类型的“StorageBlob”。 “StorageBlob”(必需)

DeadLetterWithResourceIdentity

名称 DESCRIPTION 价值
deadLetterDestination 的 有关事件订阅必须传送事件的目标的信息。
使用父资源(即主题或域)上的托管标识设置来获取死信期间使用的身份验证令牌。
死信目标
标识 死信事件时要使用的标识。 EventSubscriptionIdentity

DeliveryAttributeMapping

名称 DESCRIPTION 价值
姓名 传递属性或标头的名称。 字符串
类型 设置为“ DynamicDeliveryAttributeMapping”类型的“Dynamic”。 设置为 StaticDeliveryAttributeMapping 类型的“Static”。 “Dynamic”
“Static”(必需)

DeliveryConfiguration

名称 DESCRIPTION 价值
deliveryMode 交付模式 事件订阅的传递模式。 “Push”
“Queue”
推送 当 deliveryMode 推送并表示有关推送订阅的信息时,应填充此属性。 推送信息
队列 当 deliveryMode 为队列并表示有关队列订阅的信息时,应填充此属性。 队列信息

DeliveryWithResourceIdentity

名称 DESCRIPTION 价值
目标 有关事件订阅必须传送事件的目标的信息。
使用父资源(即主题或域)上的托管标识设置来获取在传递期间使用的身份验证令牌。
EventSubscriptionDestination 事件订阅目标
标识 传送事件时要使用的标识。 EventSubscriptionIdentity

DynamicDeliveryAttributeMapping

名称 DESCRIPTION 价值
属性 动态传递属性映射的属性。 DynamicDeliveryAttributeMappingProperties
类型 传递属性或标头名称的类型。 “Dynamic”(必需)

DynamicDeliveryAttributeMappingProperties

名称 DESCRIPTION 价值
sourceField 包含属性值的事件中的 JSON 路径。 字符串

EventHubEventSubscriptionDestination 事件订阅目标

名称 DESCRIPTION 价值
endpoint类型 事件订阅目标的终结点类型。 “EventHub”(必需)
属性 事件订阅目标的事件中心属性。 EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

名称 DESCRIPTION 价值
deliveryAttributeMappings 传递属性详细信息。 DeliveryAttributeMapping[]
资源ID 表示事件订阅的事件中心目标的终结点的 Azure 资源 ID。 字符串

EventSubscriptionDestination 事件订阅目标

名称 DESCRIPTION 价值
endpoint类型 设置为 AzureFunctionEventSubscriptionDestination 类型的“AzureFunction”。 设置为 EventHubEventSubscriptionDestination 类型的“EventHub”。 对于 HybridConnectionEventSubscriptionDestination,设置为“HybridConnection”。 设置为 MonitorAlertEventSubscriptionDestination 类型的“MonitorAlert”。 对于 NamespaceTopicEventSubscriptionDestination,设置为“NamespaceTopic”。 设置为 PartnerEventSubscriptionDestination 类型的“PartnerDestination”。 设置为 ServiceBusQueueEventSubscriptionDestination 类型的“ServiceBusQueue”。 对于 ServiceBusTopicEventSubscriptionDestination,设置为“ServiceBusTopic”。 设置为 StorageQueueEventSubscriptionDestination 类型的“StorageQueue”。 对于 WebHookEventSubscriptionDestination,设置为“WebHook”。 “AzureFunction”
“EventHub”
“HybridConnection”
“MonitorAlert”
“NamespaceTopic”
“PartnerDestination”
“ServiceBusQueue”
“ServiceBusTopic”
“StorageQueue”
“WebHook”(必需)

EventSubscriptionIdentity

名称 DESCRIPTION 价值
federatedIdentityCredentialInfo 用于资源传递的联合标识凭据(FIC)的详细信息。 FederatedIdentityCredentialInfo
类型 使用的托管标识的类型。 可以是“SystemAssigned”或“UserAssigned”。 “SystemAssigned”
“UserAssigned”
userAssignedIdentity 与资源关联的用户标识。 字符串

FederatedIdentityCredentialInfo

名称 DESCRIPTION 价值
federatedClientId 与联合身份凭证 (FIC) 关联的多租户 Microsoft Entra ID 应用程序。 字符串

约束:
最小长度 = 36
最大长度 = 36
模式 = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ (必需)

过滤器

名称 DESCRIPTION 价值
关键值 要根据要筛选的事件中的字段/属性。 字符串
运算符类型 对于 BoolEqualsFilter 类型,设置为“BoolEquals”。 对于 IsNotNullFilter 类型,设置为“IsNotNull”。 设置为 IsNullOrUndefined 类型的“IsNullOrUndefinedFilter”。 对于 NumberGreaterThanFilter 类型,设置为“NumberGreaterThan”。 设置为 Type NumberGreaterThanOrEquals 的“NumberGreaterThanOrEquals”。 设置为 NumberInFilter 类型的“NumberIn”。 设置为 NumberInRangeFilter 类型的“NumberInRange”。 对于 NumberLessThanFilter 类型,设置为“NumberLessThanThan”。 对于 NumberLessThanOrEqualsFilter,设置为“NumberLessThanOrEquals”。 设置为 NumberNotInFilter 类型的“NumberNotIn”。 对于 NumberNotInRangeFilter 类型,设置为“NumberNotInRange”。 对于 StringBeginsWithFilter,设置为“StringBeginsWith”。 设置为 StringContainsFilter 类型的“StringContains”。 对于 StringEndsWithFilter 类型,设置为“StringEndsWithWith”。 设置为 StringInFilter 类型的“StringIn”。 设置为 StringNotBeginsWith 类型的“StringNotBeginsWithFilter”。 对于 StringNotContainsFilter,设置为“StringNotContains”。 对于 StringNotEndsWithFilter,设置为“StringNotEndsWith”。 设置为 StringNotInFilter 类型的“StringNotIn”。 “BoolEquals”
“IsNotNull”
“IsNullOrUndefined”
“NumberGreaterThan”
“NumberGreaterThanOrEquals”
“NumberIn”
“NumberInRange”
“NumberLessThan”
“NumberLessThanOrEquals”
“NumberNotIn”
“NumberNotInRange”
“StringBeginsWith”
“StringContains”
“StringEndsWith”
“StringIn”
“StringNotBeginsWith”
“StringNotContains”
“StringNotEndsWith”
“StringNotIn”(必需)

FiltersConfiguration

名称 DESCRIPTION 价值
筛选器 用于筛选事件订阅的筛选器数组。 筛选器[]
includedEventTypes 需要属于事件订阅的适用事件类型的列表。 如果需要订阅所有默认事件类型,请将 IncludedEventTypes 设置为 null。 字符串[]

HybridConnectionEventSubscriptionDestination

名称 DESCRIPTION 价值
endpoint类型 事件订阅目标的终结点类型。 “HybridConnection”(必需)
属性 事件订阅目标的混合连接属性。 HybridConnectionEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestinationProperties

名称 DESCRIPTION 价值
deliveryAttributeMappings 传递属性详细信息。 DeliveryAttributeMapping[]
资源ID 作为事件订阅目标的混合连接的 Azure 资源 ID。 字符串

IsNotNullFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “IsNotNull”(必需)

IsNullOrUndefinedFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “IsNullOrUndefined”(必需)

监视器警报事件订阅目标

名称 DESCRIPTION 价值
endpoint类型 事件订阅目标的终结点类型。 “MonitorAlert”(必需)
属性 监视事件订阅目标的警报属性。 MonitorAlertEventSubscriptionDestinationProperties

MonitorAlertEventSubscriptionDestinationProperties

名称 DESCRIPTION 价值
作组 将在通过此事件订阅触发的每个警报上触发的操作组的 ARM ID 列表。
每个资源 ARM ID 都应遵循以下模式:/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}。
字符串[]
描述 将附加到通过此事件订阅触发的每个警报的说明。 字符串
严重性 将附加到通过此事件订阅触发的每个警报的严重性。
必须提供此字段。
“Sev0”
“Sev1”
“Sev2”
“Sev3”
“Sev4”

NamespaceTopicEventSubscriptionDestination

名称 DESCRIPTION 价值
endpoint类型 事件订阅目标的终结点类型。 “NamespaceTopic”(必需)
属性 Namespace事件订阅目标的主题属性。 NamespaceTopicEventSubscriptionDestinationProperties

NamespaceTopicEventSubscriptionDestinationProperties

名称 DESCRIPTION 价值
资源ID 表示事件订阅的事件网格Namespace主题目标的终结点的 Azure 资源 ID。
此字段是必需的,并且列出的Namespace主题资源必须已存在。
资源 ARM ID 应遵循以下模式:/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}。
字符串

NumberGreaterThanFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberGreaterThan”(必需)
价值 筛选器值。 整数 (int)

NumberGreaterThanOrEqualsFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberGreaterThanOrEquals”(必需)
价值 筛选器值。 整数 (int)

NumberInFilter (数字筛选)

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberIn”(必需)
价值, 价值观 筛选器值集。 int[]

NumberInRangeFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberInRange”(必需)
价值, 价值观 筛选器值集。 int[][]

NumberLessThanFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberLessThan”(必需)
价值 筛选器值。 整数 (int)

NumberLessThanOrEqualsFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberLessThanOrEquals”(必需)
价值 筛选器值。 整数 (int)

NumberNotInFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberNotIn”(必需)
价值, 价值观 筛选器值集。 int[]

NumberNotInRangeFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberNotInRange”(必需)
价值, 价值观 筛选器值集。 int[][]

PartnerEventSubscriptionDestination

名称 DESCRIPTION 价值
endpoint类型 事件订阅目标的终结点类型。 “PartnerDestination”(必需)
属性 事件订阅目标的合作伙伴目标属性。 PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

名称 DESCRIPTION 价值
资源ID 表示事件订阅合作伙伴目标的终结点的 Azure 资源 ID。 字符串

推送信息

名称 DESCRIPTION 价值
deadLetterDestinationWithResourceIdentity 事件订阅的死信目标。 无法传递到其目标的任何事件都将发送到死信目标。
使用父资源(即命名空间)上的托管标识设置来获取死信期间使用的身份验证令牌。
DeadLetterWithResourceIdentity
deliveryWithResourceIdentity 有关事件订阅必须传送事件的目标的信息。
使用父资源(即主题或域)上的托管标识设置来获取在传递期间使用的身份验证令牌。
DeliveryWithResourceIdentity
目标 有关事件订阅必须传送事件的目标的信息。
使用 Azure 事件网格的标识获取在传递期间使用的身份验证令牌。
EventSubscriptionDestination 事件订阅目标
eventTimeToLive ISO 8601 格式的时间跨度持续时间,用于确定消息发布后订阅可用的消息时长。
此持续时间值使用以下格式表示:“P(n)Y(n)M(n)DT(n)H(n)M(n)M(n)S',其中:
- (n) 被后跟 (n) 的每次元素的值替换。
- P 是持续时间(或句点)设计器,始终放置在持续时间的开头。
- Y 是年份设计者,它遵循年份的值。
- M 是月份设计者,它遵循月份数的值。
- W 是周指示符,它遵循周数的值。
- D 是日期指示符,它遵循天数的值。
- T 是时间指示符,它位于时间组件之前。
- H 是小时指示符,它遵循小时数的值。
- M 是分钟指示符,它遵循分钟数的值。
- S 是第二个指示符,它遵循秒数的值。
无法设置此持续时间值大于主题的 EventRetentionInDays。 它是一个可选字段,其最小值为 1 分钟,并且其最大值已确定
按主题的 EventRetentionInDays 值。 下面是有效值的示例:
- “P0DT23H12M”或“PT23H12M”:持续时间为 23 小时 12 分钟。
- “P1D”或“P1DT0H0M0S”:持续时间为 1 天。
字符串
maxDeliveryCount 事件的最大传递计数。 整数 (int)

队列信息

名称 DESCRIPTION 价值
deadLetterDestinationWithResourceIdentity 事件订阅的死信目标。 无法传递到其目标的任何事件都将发送到死信目标。
使用父资源(即主题)上的托管标识设置来获取在传递/死信期间使用的身份验证令牌。
DeadLetterWithResourceIdentity
eventTimeToLive ISO 8601 格式的时间跨度持续时间,用于确定消息发布后订阅可用的消息时长。
此持续时间值使用以下格式表示:“P(n)Y(n)M(n)DT(n)H(n)M(n)M(n)S',其中:
- (n) 被后跟 (n) 的每次元素的值替换。
- P 是持续时间(或句点)设计器,始终放置在持续时间的开头。
- Y 是年份设计者,它遵循年份的值。
- M 是月份设计者,它遵循月份数的值。
- W 是周指示符,它遵循周数的值。
- D 是日期指示符,它遵循天数的值。
- T 是时间指示符,它位于时间组件之前。
- H 是小时指示符,它遵循小时数的值。
- M 是分钟指示符,它遵循分钟数的值。
- S 是第二个指示符,它遵循秒数的值。
无法设置此持续时间值大于主题的 EventRetentionInDays。 它是一个可选字段,其最小值为 1 分钟,并且其最大值已确定
按主题的 EventRetentionInDays 值。 下面是有效值的示例:
- “P0DT23H12M”或“PT23H12M”:持续时间为 23 小时 12 分钟。
- “P1D”或“P1DT0H0M0S”:持续时间为 1 天。
字符串
maxDeliveryCount 事件的最大传递计数。 整数 (int)
receiveLockDurationInSeconds 消息处于接收状态并等待接受、释放或拒绝的最大时间段(以秒为单位)。
如果在客户端收到消息后未转换到已接受(未处理)、释放或拒绝,则此时间已过,
消息可用于重新传送。 这是一个可选字段,默认值为 60 秒,最小值为 60 秒,最大值为 300 秒。
整数 (int)

ServiceBusQueueEventSubscriptionDestination

名称 DESCRIPTION 价值
endpoint类型 事件订阅目标的终结点类型。 “ServiceBusQueue”(必需)
属性 事件订阅目标的服务总线属性。 ServiceBusQueueEventSubscriptionDestinationProperties

ServiceBusQueueEventSubscriptionDestinationProperties

名称 DESCRIPTION 价值
deliveryAttributeMappings 传递属性详细信息。 DeliveryAttributeMapping[]
资源ID 表示事件订阅的服务总线目标的终结点的 Azure 资源 ID。 字符串

ServiceBusTopicEventSubscriptionDestination

名称 DESCRIPTION 价值
endpoint类型 事件订阅目标的终结点类型。 “ServiceBusTopic”(必需)
属性 事件订阅目标的服务总线主题属性。 ServiceBusTopicEventSubscriptionDestinationProperties

ServiceBusTopicEventSubscriptionDestinationProperties

名称 DESCRIPTION 价值
deliveryAttributeMappings 传递属性详细信息。 DeliveryAttributeMapping[]
资源ID 表示事件订阅的服务总线主题目标的终结点的 Azure 资源 ID。 字符串

StaticDeliveryAttributeMapping

名称 DESCRIPTION 价值
属性 静态传递属性映射的属性。 StaticDeliveryAttributeMappingProperties
类型 传递属性或标头名称的类型。 “Static”(必需)

StaticDeliveryAttributeMappingProperties

名称 DESCRIPTION 价值
isSecret 的 指示属性是否包含敏感信息的布尔标志。 布尔
价值 传递属性的值。 字符串

StorageBlobDeadLetterDestination

名称 DESCRIPTION 价值
endpoint类型 死信目标的终结点类型 “StorageBlob”(必需)
属性 基于存储 Blob 的死信目标的属性 StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

名称 DESCRIPTION 价值
blobContainerName (斑点容器名称) 存储 Blob 容器的名称,该容器是死信事件的目标 字符串
资源ID 存储帐户的 Azure 资源 ID,该 ID 是死信事件的目标 字符串

StorageQueueEventSubscriptionDestination

名称 DESCRIPTION 价值
endpoint类型 事件订阅目标的终结点类型。 “StorageQueue”(必需)
属性 事件订阅目标的存储队列属性。 StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

名称 DESCRIPTION 价值
queueMessageTimeToLiveInSeconds 存储队列消息生存时间(以秒为单位)。 此值不能为零或负值,但使用 -1 指示消息的生存时间是无限的。 整数 (int)
队列名称 作为事件订阅目标的存储帐户下的存储队列的名称。 字符串
资源ID 包含作为事件订阅目标的队列的存储帐户的 Azure 资源 ID。 字符串

StringBeginsWithFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringBeginsWith”(必需)
价值, 价值观 筛选器值集。 字符串[]

StringContainsFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringContains”(必需)
价值, 价值观 筛选器值集。 字符串[]

StringEndsWithFilter (字符串结束与过滤器)

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringEndsWith”(必需)
价值, 价值观 筛选器值集。 字符串[]

StringInFilter (字符串过滤器)

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringIn”(必需)
价值, 价值观 筛选器值集。 字符串[]

StringNotBeginsWithFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotBeginsWith”(必需)
价值, 价值观 筛选器值集。 字符串[]

StringNotContains过滤器

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotContains”(必需)
价值, 价值观 筛选器值集。 字符串[]

StringNotEndsWithFilter (字符串不结束与过滤器)

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotEndsWith”(必需)
价值, 价值观 筛选器值集。 字符串[]

StringNotInFilter

名称 DESCRIPTION 价值
运算符类型 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotIn”(必需)
价值, 价值观 筛选器值集。 字符串[]

SubscriptionProperties

名称 DESCRIPTION 价值
deliveryConfiguration 有关事件订阅的传递配置的信息。 DeliveryConfiguration
eventDeliverySchema 事件交付架构 事件订阅的事件传送架构。 “CloudEventSchemaV1_0”
过期时间 UTC 事件订阅的过期时间。 字符串
filtersConfiguration 有关事件订阅筛选器的信息。 FiltersConfiguration
标签 与事件订阅资源相关的标记。 SubscriptionProperties标签

SubscriptionProperties标签

名称 DESCRIPTION 价值

WebHookEventSubscriptionDestination

名称 DESCRIPTION 价值
endpoint类型 事件订阅目标的终结点类型。 “WebHook”(必需)
属性 事件订阅目标的 WebHook 属性。 WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

名称 DESCRIPTION 价值
azureActiveDirectoryApplicationIdOrUri Microsoft Entra ID 应用程序 ID 或 URI,用于获取将作为不记名令牌包含在投放请求中的访问令牌。 字符串
azureActiveDirectoryTenantId Microsoft Entra ID 租户 ID,用于获取将作为不记名令牌包含在投放请求中的访问令牌。 字符串
deliveryAttributeMappings 传递属性详细信息。 DeliveryAttributeMapping[]
端点URL 表示事件订阅目标的终结点的 URL。 字符串

约束:
敏感值。 以安全参数的形式传入。
maxEventsPerBatch 每个批处理的最大事件数。 整数 (int)
minimumTlsVersionAllowed Webhook 终结点应支持的最低 TLS 版本 '1.0'
'1.1'
'1.2'
preferredBatchSizeInKilobytes 首选批大小(以千字节为单位)。 整数 (int)