Microsoft.EventGrid event订阅 2023-12-15-preview

• 最近的
• 2025-04-01-预览版
• 2025-02-15
• 2024-12-15-预览版
• 2024-06-01-预览版
• 2023-12-15-预览版
• 2023-06-01-预览版
• 2022-06-15
• 2021-12-01
• 2021-10-15-预览版
• 2021-06-01-预览版
• 2020-10-15-预览版
• 2020-06-01
• 2020-04-01-预览版
• 2020-01-01-预览版
• 2019-06-01
• 2019-02-01-预览版
• 2019-01-01
• 2018-09-15-预览版
• 2018-05-01-预览版
• 2018-01-01
• 2017-09-15-预览版
• 2017-06-15-预览版

Bicep 资源定义

可以使用目标作部署 eventSubscriptions 资源类型：

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

资源格式

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

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2023-12-15-preview' = {
  scope: resourceSymbolicName or scope
  name: 'string'
  properties: {
    deadLetterDestination: {
      endpointType: 'string'
      // For remaining properties, see DeadLetterDestination objects
    }
    deadLetterWithResourceIdentity: {
      deadLetterDestination: {
        endpointType: 'string'
        // For remaining properties, see DeadLetterDestination objects
      }
      identity: {
        type: 'string'
        userAssignedIdentity: 'string'
      }
    }
    deliveryWithResourceIdentity: {
      destination: {
        endpointType: 'string'
        // For remaining properties, see EventSubscriptionDestination objects
      }
      identity: {
        type: 'string'
        userAssignedIdentity: 'string'
      }
    }
    destination: {
      endpointType: 'string'
      // For remaining properties, see EventSubscriptionDestination objects
    }
    eventDeliverySchema: 'string'
    expirationTimeUtc: 'string'
    filter: {
      advancedFilters: [
        {
          key: 'string'
          operatorType: 'string'
          // For remaining properties, see AdvancedFilter objects
        }
      ]
      enableAdvancedFilteringOnArrays: bool
      includedEventTypes: [
        'string'
      ]
      isSubjectCaseSensitive: bool
      subjectBeginsWith: 'string'
      subjectEndsWith: 'string'
    }
    labels: [
      'string'
    ]
    retryPolicy: {
      eventTimeToLiveInMinutes: int
      maxDeliveryAttempts: int
    }
  }
}

DeadLetterDestination 对象

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

对于 StorageBlob，请使用：

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

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
  }
}

DeliveryAttributeMapping 对象

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

对于 Dynamic，请使用：

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

对于 静态，请使用：

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

AdvancedFilter 对象

设置 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'
  ]
}

属性值

Microsoft.EventGrid/eventSubscriptions

名称	DESCRIPTION	价值
姓名	资源名称	string （必需）
属性	事件订阅的属性。	EventSubscriptionProperties
作用域	在与部署范围不同的范围内创建资源时使用。	将此属性设置为要应用 扩展资源的资源的符号名称。

高级过滤器

名称	DESCRIPTION	价值
关键值	要根据要筛选的事件中的字段/属性。	字符串
运算符类型	对于 BoolEqualsAdvancedFilter，设置为“BoolEquals”。 对于 IsNotNullAdvancedFilter 类型，设置为“IsNotNull”。 对于 类型 IsNullOrUndefinedAdvancedFilter，设置为“IsNullOrUndefined”。 对于 NumberGreaterThanAdvancedFilter，请设置为“NumberGreaterThan”。 对于 NumberGreaterThanOrEquals 类型，设置为“NumberGreaterThanOrEqualsAdvancedFilter”。 设置为 NumberInAdvancedFilter 类型的“NumberIn”。 设置为 NumberInRangeAdvancedFilter 类型的“NumberInRange”。 设置为 NumberLessThanAdvancedFilter 类型的“NumberLessThan”。 对于 NumberLessThanOrEqualsAdvancedFilter，设置为“NumberLessThanOrEquals”。 设置为 NumberNotInAdvancedFilter 类型的“NumberNotIn”。 对于 NumberNotInRangeAdvancedFilter，请设置为“NumberNotInRange”。 设置为 StringBeginsWith 类型的“StringBeginsWithAdvancedFilter”。 对于 stringContainsAdvancedFilter，请设置为 “StringContains”类型。 设置为 StringEndsWith 类型的“StringEndsWithAdvancedFilter”。 设置为 StringInAdvancedFilter 类型的“StringIn”。 对于 StringNotBeginsWithAdvancedFilter，设置为“StringNotBeginsWith”。 对于 StringNotContainsAdvancedFilter，设置为“StringNotContains”。 对于 StringNotEndsWithAdvancedFilter，设置为“StringNotEndsWith”。 对于 stringNotInAdvancedFilter类型，请设置为“StringNotIn”。	“BoolEquals” “IsNotNull” “IsNullOrUndefined” “NumberGreaterThan” “NumberGreaterThanOrEquals” “NumberIn” “NumberInRange” “NumberLessThan” “NumberLessThanOrEquals” “NumberNotIn” “NumberNotInRange” “StringBeginsWith” “StringContains” “StringEndsWith” “StringIn” “StringNotBeginsWith” “StringNotContains” “StringNotEndsWith” “StringNotIn”（必需）

AzureFunctionEventSubscriptionDestination

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

AzureFunctionEventSubscriptionDestinationProperties

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

BoolEqualsAdvancedFilter

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

死信目标

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

DeadLetterWithResourceIdentity

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

DeliveryAttributeMapping

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

DeliveryWithResourceIdentity

名称	DESCRIPTION	价值
目标	有关事件订阅必须传送事件的目标的信息。 使用 Azure 事件网格的标识获取在传递/死信期间使用的身份验证令牌。	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”（必需）

EventSubscriptionFilter

名称	DESCRIPTION	价值
高级过滤器	用于筛选事件订阅的高级筛选器数组。	高级过滤器[]
enableAdvancedFilteringOnArrays	允许针对值数组（而不是期望一个单一值）评估高级筛选器。	布尔
includedEventTypes	需要属于事件订阅的适用事件类型的列表。 如果需要订阅所有默认事件类型，请将 IncludedEventTypes 设置为 null。	字符串[]
isSubjectCaseSensitive 区分大小写	指定筛选器的 SubjectBeginsWith 和 SubjectEndsWith 属性 应以区分大小写的方式进行比较。	布尔
subjectBeginsWith	一个可选字符串，用于根据资源路径前缀筛选事件订阅的事件。 此格式取决于事件的发布者。 此路径不支持通配符。	字符串
subjectEndsWith	一个可选字符串，用于根据资源路径后缀筛选事件订阅的事件。 此路径不支持通配符。	字符串

EventSubscriptionIdentity

名称	DESCRIPTION	价值
类型	使用的托管标识的类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。	“SystemAssigned” “UserAssigned”
userAssignedIdentity	与资源关联的用户标识。	字符串

EventSubscriptionProperties

名称	DESCRIPTION	价值
deadLetterDestination 的	事件订阅的死信目标。 无法传递到其目标的任何事件都将发送到死信目标。 使用 Azure 事件网格的标识获取在传递/死信期间使用的身份验证令牌。	死信目标
deadLetterWithResourceIdentity	事件订阅的死信目标。 无法传递到其目标的任何事件都将发送到死信目标。 使用父资源（即主题或域）上的托管标识设置来获取在传递/死信期间使用的身份验证令牌。	DeadLetterWithResourceIdentity
deliveryWithResourceIdentity	有关事件订阅必须传送事件的目标的信息。 使用父资源（即主题或域）上的托管标识设置来获取在传递/死信期间使用的身份验证令牌。	DeliveryWithResourceIdentity
目标	有关事件订阅必须传送事件的目标的信息。 使用 Azure 事件网格的标识获取在传递/死信期间使用的身份验证令牌。	EventSubscriptionDestination 事件订阅目标
eventDeliverySchema 事件交付架构	事件订阅的事件传送架构。	“CloudEventSchemaV1_0” “CustomInputSchema” “EventGridSchema”
过期时间 UTC	事件订阅的过期时间。	字符串
筛选器	有关事件订阅筛选器的信息。	EventSubscriptionFilter
标签	用户定义的标签列表。	字符串[]
retryPolicy	事件的重试策略。 这可用于配置事件的最大传递尝试次数和生存时间。	重试策略

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperties

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

IsNotNullAdvancedFilter

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

IsNullOrUndefinedAdvancedFilter

名称	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”（必需）
属性	事件订阅目标的命名空间主题属性。	NamespaceTopicEventSubscriptionDestinationProperties

NamespaceTopicEventSubscriptionDestinationProperties

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

NumberGreaterThanAdvancedFilter

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

NumberGreaterThanOrEqualsAdvancedFilter

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

NumberInAdvancedFilter

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

NumberInRangeAdvancedFilter

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

NumberLessThanAdvancedFilter

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

NumberLessThanOrEqualsAdvancedFilter

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

NumberNotInAdvancedFilter

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

NumberNotInRangeAdvancedFilter

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

PartnerEventSubscriptionDestination

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

PartnerEventSubscriptionDestinationProperties

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

重试策略

名称	DESCRIPTION	价值
eventTimeToLiveInMinutes 事件时间	事件生存时间（以分钟为单位）。	整数 (int)
maxDeliveryAttempts	事件的最大传递重试尝试次数。	整数 (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。	字符串

StringBeginsWithAdvancedFilter

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

StringContainsAdvancedFilter

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

StringEndsWithAdvancedFilter

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

StringInAdvancedFilter

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

StringNotBeginsWithAdvancedFilter

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

StringNotContainsAdvancedFilter

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

StringNotEndsWithAdvancedFilter

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

StringNotInAdvancedFilter

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

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

名称	DESCRIPTION	价值
azureActiveDirectoryApplicationIdOrUri	用于获取访问令牌的 Azure Active Directory 应用程序 ID 或 URI，该令牌将作为持有者令牌包含在传递请求中。	字符串
azureActiveDirectoryTenantId	用于获取访问令牌的 Azure Active Directory 租户 ID，该令牌将作为传递请求中的持有者令牌包含在内。	字符串
deliveryAttributeMappings	传递属性详细信息。	DeliveryAttributeMapping[]
端点 Url	表示事件订阅目标的终结点的 URL。	字符串 约束： 敏感值。 以安全参数的形式传入。
maxEventsPerBatch	每个批处理的最大事件数。	整数 (int)
minimumTlsVersionAllowed	Webhook 终结点应支持的最低 TLS 版本	'1.0' '1.1' '1.2'
preferredBatchSizeInKilobytes	首选批大小（以千字节为单位）。	整数 (int)

用法示例

Azure 快速入门示例

以下 Azure 快速入门模板 包含用于部署此资源类型的 Bicep 示例。

Bicep 文件	DESCRIPTION
创建 Azure 事件网格自定义主题和队列订阅	创建 Azure 事件网格自定义主题和服务总线队列订阅。 模板最初由 Markus Meyer 创作。
创建 Azure 事件网格自定义主题和订阅	创建 Azure 事件网格自定义主题和 Webhook 订阅。 模板最初由 John Downs 创作。

ARM 模板资源定义

可以使用目标作部署 eventSubscriptions 资源类型：

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

资源格式

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

{
  "type": "Microsoft.EventGrid/eventSubscriptions",
  "apiVersion": "2023-12-15-preview",
  "name": "string",
  "properties": {
    "deadLetterDestination": {
      "endpointType": "string"
      // For remaining properties, see DeadLetterDestination objects
    },
    "deadLetterWithResourceIdentity": {
      "deadLetterDestination": {
        "endpointType": "string"
        // For remaining properties, see DeadLetterDestination objects
      },
      "identity": {
        "type": "string",
        "userAssignedIdentity": "string"
      }
    },
    "deliveryWithResourceIdentity": {
      "destination": {
        "endpointType": "string"
        // For remaining properties, see EventSubscriptionDestination objects
      },
      "identity": {
        "type": "string",
        "userAssignedIdentity": "string"
      }
    },
    "destination": {
      "endpointType": "string"
      // For remaining properties, see EventSubscriptionDestination objects
    },
    "eventDeliverySchema": "string",
    "expirationTimeUtc": "string",
    "filter": {
      "advancedFilters": [ {
        "key": "string",
        "operatorType": "string"
        // For remaining properties, see AdvancedFilter objects
      } ],
      "enableAdvancedFilteringOnArrays": "bool",
      "includedEventTypes": [ "string" ],
      "isSubjectCaseSensitive": "bool",
      "subjectBeginsWith": "string",
      "subjectEndsWith": "string"
    },
    "labels": [ "string" ],
    "retryPolicy": {
      "eventTimeToLiveInMinutes": "int",
      "maxDeliveryAttempts": "int"
    }
  }
}

DeadLetterDestination 对象

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

对于 StorageBlob，请使用：

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

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"
  }
}

DeliveryAttributeMapping 对象

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

对于 Dynamic，请使用：

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

对于 静态，请使用：

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

AdvancedFilter 对象

设置 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" ]
}

属性值

Microsoft.EventGrid/eventSubscriptions

名称	DESCRIPTION	价值
apiVersion	API 版本	“2023-12-15-预览”
姓名	资源名称	string （必需）
属性	事件订阅的属性。	EventSubscriptionProperties
类型	资源类型	“Microsoft.EventGrid/eventSubscriptions”

高级过滤器

名称	DESCRIPTION	价值
关键值	要根据要筛选的事件中的字段/属性。	字符串
运算符类型	对于 BoolEqualsAdvancedFilter，设置为“BoolEquals”。 对于 IsNotNullAdvancedFilter 类型，设置为“IsNotNull”。 对于 类型 IsNullOrUndefinedAdvancedFilter，设置为“IsNullOrUndefined”。 对于 NumberGreaterThanAdvancedFilter，请设置为“NumberGreaterThan”。 对于 NumberGreaterThanOrEquals 类型，设置为“NumberGreaterThanOrEqualsAdvancedFilter”。 设置为 NumberInAdvancedFilter 类型的“NumberIn”。 设置为 NumberInRangeAdvancedFilter 类型的“NumberInRange”。 设置为 NumberLessThanAdvancedFilter 类型的“NumberLessThan”。 对于 NumberLessThanOrEqualsAdvancedFilter，设置为“NumberLessThanOrEquals”。 设置为 NumberNotInAdvancedFilter 类型的“NumberNotIn”。 对于 NumberNotInRangeAdvancedFilter，请设置为“NumberNotInRange”。 设置为 StringBeginsWith 类型的“StringBeginsWithAdvancedFilter”。 对于 stringContainsAdvancedFilter，请设置为 “StringContains”类型。 设置为 StringEndsWith 类型的“StringEndsWithAdvancedFilter”。 设置为 StringInAdvancedFilter 类型的“StringIn”。 对于 StringNotBeginsWithAdvancedFilter，设置为“StringNotBeginsWith”。 对于 StringNotContainsAdvancedFilter，设置为“StringNotContains”。 对于 StringNotEndsWithAdvancedFilter，设置为“StringNotEndsWith”。 对于 stringNotInAdvancedFilter类型，请设置为“StringNotIn”。	“BoolEquals” “IsNotNull” “IsNullOrUndefined” “NumberGreaterThan” “NumberGreaterThanOrEquals” “NumberIn” “NumberInRange” “NumberLessThan” “NumberLessThanOrEquals” “NumberNotIn” “NumberNotInRange” “StringBeginsWith” “StringContains” “StringEndsWith” “StringIn” “StringNotBeginsWith” “StringNotContains” “StringNotEndsWith” “StringNotIn”（必需）

AzureFunctionEventSubscriptionDestination

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

AzureFunctionEventSubscriptionDestinationProperties

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

BoolEqualsAdvancedFilter

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

死信目标

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

DeadLetterWithResourceIdentity

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

DeliveryAttributeMapping

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

DeliveryWithResourceIdentity

名称	DESCRIPTION	价值
目标	有关事件订阅必须传送事件的目标的信息。 使用 Azure 事件网格的标识获取在传递/死信期间使用的身份验证令牌。	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”（必需）

EventSubscriptionFilter

名称	DESCRIPTION	价值
高级过滤器	用于筛选事件订阅的高级筛选器数组。	高级过滤器[]
enableAdvancedFilteringOnArrays	允许针对值数组（而不是期望一个单一值）评估高级筛选器。	布尔
includedEventTypes	需要属于事件订阅的适用事件类型的列表。 如果需要订阅所有默认事件类型，请将 IncludedEventTypes 设置为 null。	字符串[]
isSubjectCaseSensitive 区分大小写	指定筛选器的 SubjectBeginsWith 和 SubjectEndsWith 属性 应以区分大小写的方式进行比较。	布尔
subjectBeginsWith	一个可选字符串，用于根据资源路径前缀筛选事件订阅的事件。 此格式取决于事件的发布者。 此路径不支持通配符。	字符串
subjectEndsWith	一个可选字符串，用于根据资源路径后缀筛选事件订阅的事件。 此路径不支持通配符。	字符串

EventSubscriptionIdentity

名称	DESCRIPTION	价值
类型	使用的托管标识的类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。	“SystemAssigned” “UserAssigned”
userAssignedIdentity	与资源关联的用户标识。	字符串

EventSubscriptionProperties

名称	DESCRIPTION	价值
deadLetterDestination 的	事件订阅的死信目标。 无法传递到其目标的任何事件都将发送到死信目标。 使用 Azure 事件网格的标识获取在传递/死信期间使用的身份验证令牌。	死信目标
deadLetterWithResourceIdentity	事件订阅的死信目标。 无法传递到其目标的任何事件都将发送到死信目标。 使用父资源（即主题或域）上的托管标识设置来获取在传递/死信期间使用的身份验证令牌。	DeadLetterWithResourceIdentity
deliveryWithResourceIdentity	有关事件订阅必须传送事件的目标的信息。 使用父资源（即主题或域）上的托管标识设置来获取在传递/死信期间使用的身份验证令牌。	DeliveryWithResourceIdentity
目标	有关事件订阅必须传送事件的目标的信息。 使用 Azure 事件网格的标识获取在传递/死信期间使用的身份验证令牌。	EventSubscriptionDestination 事件订阅目标
eventDeliverySchema 事件交付架构	事件订阅的事件传送架构。	“CloudEventSchemaV1_0” “CustomInputSchema” “EventGridSchema”
过期时间 UTC	事件订阅的过期时间。	字符串
筛选器	有关事件订阅筛选器的信息。	EventSubscriptionFilter
标签	用户定义的标签列表。	字符串[]
retryPolicy	事件的重试策略。 这可用于配置事件的最大传递尝试次数和生存时间。	重试策略

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperties

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

IsNotNullAdvancedFilter

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

IsNullOrUndefinedAdvancedFilter

名称	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”（必需）
属性	事件订阅目标的命名空间主题属性。	NamespaceTopicEventSubscriptionDestinationProperties

NamespaceTopicEventSubscriptionDestinationProperties

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

NumberGreaterThanAdvancedFilter

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

NumberGreaterThanOrEqualsAdvancedFilter

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

NumberInAdvancedFilter

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

NumberInRangeAdvancedFilter

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

NumberLessThanAdvancedFilter

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

NumberLessThanOrEqualsAdvancedFilter

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

NumberNotInAdvancedFilter

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

NumberNotInRangeAdvancedFilter

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

PartnerEventSubscriptionDestination

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

PartnerEventSubscriptionDestinationProperties

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

重试策略

名称	DESCRIPTION	价值
eventTimeToLiveInMinutes 事件时间	事件生存时间（以分钟为单位）。	整数 (int)
maxDeliveryAttempts	事件的最大传递重试尝试次数。	整数 (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。	字符串

StringBeginsWithAdvancedFilter

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

StringContainsAdvancedFilter

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

StringEndsWithAdvancedFilter

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

StringInAdvancedFilter

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

StringNotBeginsWithAdvancedFilter

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

StringNotContainsAdvancedFilter

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

StringNotEndsWithAdvancedFilter

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

StringNotInAdvancedFilter

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

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

名称	DESCRIPTION	价值
azureActiveDirectoryApplicationIdOrUri	用于获取访问令牌的 Azure Active Directory 应用程序 ID 或 URI，该令牌将作为持有者令牌包含在传递请求中。	字符串
azureActiveDirectoryTenantId	用于获取访问令牌的 Azure Active Directory 租户 ID，该令牌将作为传递请求中的持有者令牌包含在内。	字符串
deliveryAttributeMappings	传递属性详细信息。	DeliveryAttributeMapping[]
端点 Url	表示事件订阅目标的终结点的 URL。	字符串 约束： 敏感值。 以安全参数的形式传入。
maxEventsPerBatch	每个批处理的最大事件数。	整数 (int)
minimumTlsVersionAllowed	Webhook 终结点应支持的最低 TLS 版本	'1.0' '1.1' '1.2'
preferredBatchSizeInKilobytes	首选批大小（以千字节为单位）。	整数 (int)

用法示例

Azure 快速入门模板

以下 Azure 快速入门模板 部署此资源类型。

模板	DESCRIPTION
创建 Azure 事件网格自定义主题和队列订阅	创建 Azure 事件网格自定义主题和服务总线队列订阅。 模板最初由 Markus Meyer 创作。
创建 Azure 事件网格自定义主题和订阅	创建 Azure 事件网格自定义主题和 Webhook 订阅。 模板最初由 John Downs 创作。
创建 Azure 事件网格自定义主题订阅	创建 Azure 事件网格自定义主题和服务总线主题订阅。 模板最初由 Markus Meyer 创作。
创建事件网格自定义主题和事件中心处理程序	创建 Azure 事件网格自定义主题和事件中心来处理事件。
为资源事件创建事件网格订阅	创建资源组或 Azure 订阅的事件网格订阅。
使用 CloudEvents 的自定义 Azure 事件网格主题/订阅	创建自定义 Azure 事件网格主题、具有 CloudEvents 架构的 Webhook 订阅和逻辑应用作为事件处理程序。 模板最初由 Justin Yoo 创作。

Terraform （AzAPI 提供程序）资源定义

可以使用目标作部署 eventSubscriptions 资源类型：

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/eventSubscriptions@2023-12-15-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      deadLetterDestination = {
        endpointType = "string"
        // For remaining properties, see DeadLetterDestination objects
      }
      deadLetterWithResourceIdentity = {
        deadLetterDestination = {
          endpointType = "string"
          // For remaining properties, see DeadLetterDestination objects
        }
        identity = {
          type = "string"
          userAssignedIdentity = "string"
        }
      }
      deliveryWithResourceIdentity = {
        destination = {
          endpointType = "string"
          // For remaining properties, see EventSubscriptionDestination objects
        }
        identity = {
          type = "string"
          userAssignedIdentity = "string"
        }
      }
      destination = {
        endpointType = "string"
        // For remaining properties, see EventSubscriptionDestination objects
      }
      eventDeliverySchema = "string"
      expirationTimeUtc = "string"
      filter = {
        advancedFilters = [
          {
            key = "string"
            operatorType = "string"
            // For remaining properties, see AdvancedFilter objects
          }
        ]
        enableAdvancedFilteringOnArrays = bool
        includedEventTypes = [
          "string"
        ]
        isSubjectCaseSensitive = bool
        subjectBeginsWith = "string"
        subjectEndsWith = "string"
      }
      labels = [
        "string"
      ]
      retryPolicy = {
        eventTimeToLiveInMinutes = int
        maxDeliveryAttempts = int
      }
    }
  }
}

DeadLetterDestination 对象

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

对于 StorageBlob，请使用：

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

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
  }
}

DeliveryAttributeMapping 对象

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

对于 Dynamic，请使用：

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

对于 静态，请使用：

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

AdvancedFilter 对象

设置 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"
  ]
}

属性值

Microsoft.EventGrid/eventSubscriptions

名称	DESCRIPTION	价值
姓名	资源名称	string （必需）
parent_id	要向其应用此扩展资源的资源的 ID。	string （必需）
属性	事件订阅的属性。	EventSubscriptionProperties
类型	资源类型	“Microsoft.EventGrid/eventSubscriptions@2023-12-15-preview”

高级过滤器

名称	DESCRIPTION	价值
关键值	要根据要筛选的事件中的字段/属性。	字符串
运算符类型	对于 BoolEqualsAdvancedFilter，设置为“BoolEquals”。 对于 IsNotNullAdvancedFilter 类型，设置为“IsNotNull”。 对于 类型 IsNullOrUndefinedAdvancedFilter，设置为“IsNullOrUndefined”。 对于 NumberGreaterThanAdvancedFilter，请设置为“NumberGreaterThan”。 对于 NumberGreaterThanOrEquals 类型，设置为“NumberGreaterThanOrEqualsAdvancedFilter”。 设置为 NumberInAdvancedFilter 类型的“NumberIn”。 设置为 NumberInRangeAdvancedFilter 类型的“NumberInRange”。 设置为 NumberLessThanAdvancedFilter 类型的“NumberLessThan”。 对于 NumberLessThanOrEqualsAdvancedFilter，设置为“NumberLessThanOrEquals”。 设置为 NumberNotInAdvancedFilter 类型的“NumberNotIn”。 对于 NumberNotInRangeAdvancedFilter，请设置为“NumberNotInRange”。 设置为 StringBeginsWith 类型的“StringBeginsWithAdvancedFilter”。 对于 stringContainsAdvancedFilter，请设置为 “StringContains”类型。 设置为 StringEndsWith 类型的“StringEndsWithAdvancedFilter”。 设置为 StringInAdvancedFilter 类型的“StringIn”。 对于 StringNotBeginsWithAdvancedFilter，设置为“StringNotBeginsWith”。 对于 StringNotContainsAdvancedFilter，设置为“StringNotContains”。 对于 StringNotEndsWithAdvancedFilter，设置为“StringNotEndsWith”。 对于 stringNotInAdvancedFilter类型，请设置为“StringNotIn”。	“BoolEquals” “IsNotNull” “IsNullOrUndefined” “NumberGreaterThan” “NumberGreaterThanOrEquals” “NumberIn” “NumberInRange” “NumberLessThan” “NumberLessThanOrEquals” “NumberNotIn” “NumberNotInRange” “StringBeginsWith” “StringContains” “StringEndsWith” “StringIn” “StringNotBeginsWith” “StringNotContains” “StringNotEndsWith” “StringNotIn”（必需）

AzureFunctionEventSubscriptionDestination

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

AzureFunctionEventSubscriptionDestinationProperties

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

BoolEqualsAdvancedFilter

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

死信目标

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

DeadLetterWithResourceIdentity

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

DeliveryAttributeMapping

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

DeliveryWithResourceIdentity

名称	DESCRIPTION	价值
目标	有关事件订阅必须传送事件的目标的信息。 使用 Azure 事件网格的标识获取在传递/死信期间使用的身份验证令牌。	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”（必需）

EventSubscriptionFilter

名称	DESCRIPTION	价值
高级过滤器	用于筛选事件订阅的高级筛选器数组。	高级过滤器[]
enableAdvancedFilteringOnArrays	允许针对值数组（而不是期望一个单一值）评估高级筛选器。	布尔
includedEventTypes	需要属于事件订阅的适用事件类型的列表。 如果需要订阅所有默认事件类型，请将 IncludedEventTypes 设置为 null。	字符串[]
isSubjectCaseSensitive 区分大小写	指定筛选器的 SubjectBeginsWith 和 SubjectEndsWith 属性 应以区分大小写的方式进行比较。	布尔
subjectBeginsWith	一个可选字符串，用于根据资源路径前缀筛选事件订阅的事件。 此格式取决于事件的发布者。 此路径不支持通配符。	字符串
subjectEndsWith	一个可选字符串，用于根据资源路径后缀筛选事件订阅的事件。 此路径不支持通配符。	字符串

EventSubscriptionIdentity

名称	DESCRIPTION	价值
类型	使用的托管标识的类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。	“SystemAssigned” “UserAssigned”
userAssignedIdentity	与资源关联的用户标识。	字符串

EventSubscriptionProperties

名称	DESCRIPTION	价值
deadLetterDestination 的	事件订阅的死信目标。 无法传递到其目标的任何事件都将发送到死信目标。 使用 Azure 事件网格的标识获取在传递/死信期间使用的身份验证令牌。	死信目标
deadLetterWithResourceIdentity	事件订阅的死信目标。 无法传递到其目标的任何事件都将发送到死信目标。 使用父资源（即主题或域）上的托管标识设置来获取在传递/死信期间使用的身份验证令牌。	DeadLetterWithResourceIdentity
deliveryWithResourceIdentity	有关事件订阅必须传送事件的目标的信息。 使用父资源（即主题或域）上的托管标识设置来获取在传递/死信期间使用的身份验证令牌。	DeliveryWithResourceIdentity
目标	有关事件订阅必须传送事件的目标的信息。 使用 Azure 事件网格的标识获取在传递/死信期间使用的身份验证令牌。	EventSubscriptionDestination 事件订阅目标
eventDeliverySchema 事件交付架构	事件订阅的事件传送架构。	“CloudEventSchemaV1_0” “CustomInputSchema” “EventGridSchema”
过期时间 UTC	事件订阅的过期时间。	字符串
筛选器	有关事件订阅筛选器的信息。	EventSubscriptionFilter
标签	用户定义的标签列表。	字符串[]
retryPolicy	事件的重试策略。 这可用于配置事件的最大传递尝试次数和生存时间。	重试策略

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperties

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

IsNotNullAdvancedFilter

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

IsNullOrUndefinedAdvancedFilter

名称	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”（必需）
属性	事件订阅目标的命名空间主题属性。	NamespaceTopicEventSubscriptionDestinationProperties

NamespaceTopicEventSubscriptionDestinationProperties

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

NumberGreaterThanAdvancedFilter

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

NumberGreaterThanOrEqualsAdvancedFilter

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

NumberInAdvancedFilter

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

NumberInRangeAdvancedFilter

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

NumberLessThanAdvancedFilter

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

NumberLessThanOrEqualsAdvancedFilter

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

NumberNotInAdvancedFilter

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

NumberNotInRangeAdvancedFilter

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

PartnerEventSubscriptionDestination

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

PartnerEventSubscriptionDestinationProperties

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

重试策略

名称	DESCRIPTION	价值
eventTimeToLiveInMinutes 事件时间	事件生存时间（以分钟为单位）。	整数 (int)
maxDeliveryAttempts	事件的最大传递重试尝试次数。	整数 (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。	字符串

StringBeginsWithAdvancedFilter

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

StringContainsAdvancedFilter

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

StringEndsWithAdvancedFilter

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

StringInAdvancedFilter

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

StringNotBeginsWithAdvancedFilter

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

StringNotContainsAdvancedFilter

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

StringNotEndsWithAdvancedFilter

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

StringNotInAdvancedFilter

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

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

名称	DESCRIPTION	价值
azureActiveDirectoryApplicationIdOrUri	用于获取访问令牌的 Azure Active Directory 应用程序 ID 或 URI，该令牌将作为持有者令牌包含在传递请求中。	字符串
azureActiveDirectoryTenantId	用于获取访问令牌的 Azure Active Directory 租户 ID，该令牌将作为传递请求中的持有者令牌包含在内。	字符串
deliveryAttributeMappings	传递属性详细信息。	DeliveryAttributeMapping[]
端点 Url	表示事件订阅目标的终结点的 URL。	字符串 约束： 敏感值。 以安全参数的形式传入。
maxEventsPerBatch	每个批处理的最大事件数。	整数 (int)
minimumTlsVersionAllowed	Webhook 终结点应支持的最低 TLS 版本	'1.0' '1.1' '1.2'
preferredBatchSizeInKilobytes	首选批大小（以千字节为单位）。	整数 (int)