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

Microsoft.EventGrid eventSubscriptions 2021-10-15-preview

Bicep 资源定义

eventSubscriptions 资源类型是 扩展资源,这意味着你可以将其应用于另一个资源。

scope使用此资源上的 属性可设置此资源的作用域。 请参阅 在 Bicep 中设置扩展资源的范围

eventSubscriptions 资源类型可以使用面向的操作进行部署:

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

资源格式

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

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2021-10-15-preview' = {
  name: 'string'
  scope: resourceSymbolicName
  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'
  }

对于 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
    preferredBatchSizeInKilobytes: int
  }

DeliveryAttributeMapping 对象

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

对于 “动态”,请使用:

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

对于 静态,请使用:

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

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'
  ]

属性值

eventSubscriptions

名称 说明
name 资源名称 字符串 (必需)

字符限制:3-64

有效字符:
字母数字和连字符。
scope 在不同于部署范围的范围创建扩展资源时使用 。 目标资源

对于 Bicep,请将此属性设置为要应用 扩展资源的符号名称。
properties 事件订阅的属性。 EventSubscriptionProperties

EventSubscriptionProperties

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

DeadLetterDestination

名称 说明
endpointType 设置对象类型 所需的 StorageBlob ()

StorageBlobDeadLetterDestination

名称 说明
endpointType 死信目标的终结点的类型 “StorageBlob” (必需的)
properties 基于存储 Blob 的死信目标的属性 StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

名称 说明
blobContainerName 存储 Blob 容器的名称,该容器是死信事件的目标 string
ResourceId 死信事件目标的存储帐户的 Azure 资源 ID 字符串

DeadLetterWithResourceIdentity

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

EventSubscriptionIdentity

名称 说明 Value
type 使用的托管标识的类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。 “SystemAssigned”
“UserAssigned”
userAssignedIdentity 与资源关联的用户标识。 string

DeliveryWithResourceIdentity

名称 说明
destination 有关事件订阅必须传递事件的目标的信息。
使用Azure 事件网格标识来获取传递/死信期间使用的身份验证令牌。
EventSubscriptionDestination
标识 传递事件时要使用的标识。 EventSubscriptionIdentity

EventSubscriptionDestination

名称 说明
endpointType 设置对象类型 AzureFunction
EventHub
HybridConnection
PartnerDestination
ServiceBusQueue
ServiceBusTopic
StorageQueue
需要 WebHook ()

AzureFunctionEventSubscriptionDestination

名称 说明
endpointType 事件订阅目标的终结点的类型。 “AzureFunction” (必需)
properties 事件订阅目标的 Azure 函数属性。 AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

名称 说明
deliveryAttributeMappings 传递属性详细信息。 DeliveryAttributeMapping[]
maxEventsPerBatch 每个批的最大事件数。 int
preferredBatchSizeInKilobytes 首选批大小(以千字节为单位)。 int
ResourceId 表示事件订阅的 Azure 函数目标的终结点的 Azure 资源 ID。 string

DeliveryAttributeMapping

名称 说明
name 传递属性或标头的名称。 字符串
type 设置对象类型 动态
需要静态 ()

DynamicDeliveryAttributeMapping

名称 说明 Value
type 传递属性或标头名称的类型。 “动态” (必需)
properties 动态传递属性映射的属性。 DynamicDeliveryAttributeMappingProperties

DynamicDeliveryAttributeMappingProperties

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

StaticDeliveryAttributeMapping

名称 说明 Value
type 传递属性或标头名称的类型。 “Static” (必需)
properties 静态传递属性映射的属性。 StaticDeliveryAttributeMappingProperties

StaticDeliveryAttributeMappingProperties

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

EventHubEventSubscriptionDestination

名称 说明
endpointType 事件订阅目标的终结点的类型。 “EventHub” ()
properties 事件订阅目标的事件中心属性。 EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

名称 说明
deliveryAttributeMappings 传递属性详细信息。 DeliveryAttributeMapping[]
ResourceId 表示事件订阅的事件中心目标的终结点的 Azure 资源 ID。 string

HybridConnectionEventSubscriptionDestination

名称 说明
endpointType 事件订阅目标的终结点的类型。 “HybridConnection” (必需)
properties 事件订阅目标的混合连接属性。 HybridConnectionEventSubscriptionDestinationProperti...

HybridConnectionEventSubscriptionDestinationProperti...

名称 说明
deliveryAttributeMappings 传递属性详细信息。 DeliveryAttributeMapping[]
ResourceId 作为事件订阅目标的混合连接的 Azure 资源 ID。 string

PartnerEventSubscriptionDestination

名称 说明
endpointType 事件订阅目标的终结点的类型。 “PartnerDestination” (必需)
properties 事件订阅目标的合作伙伴目标属性。 PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

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

ServiceBusQueueEventSubscriptionDestination

名称 说明
endpointType 事件订阅目标的终结点的类型。 需要“ServiceBusQueue” ()
properties 事件订阅目标的服务总线属性。 ServiceBusQueueEventSubscriptionDestinationPropertie...

ServiceBusQueueEventSubscriptionDestinationPropertie...

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

ServiceBusTopicEventSubscriptionDestination

名称 说明
endpointType 事件订阅目标的终结点的类型。 “ServiceBusTopic” (必需)
properties 事件订阅目标的服务总线主题属性。 ServiceBusTopicEventSubscriptionDestinationPropertie...

ServiceBusTopicEventSubscriptionDestinationPropertie...

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

StorageQueueEventSubscriptionDestination

名称 说明
endpointType 事件订阅目标的终结点的类型。 “StorageQueue” (必需)
properties 事件订阅目标的存储队列属性。 StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

名称 说明
queueMessageTimeToLiveInSeconds 存储队列消息生存时间(以秒为单位)。 int
queueName 作为事件订阅目标的存储帐户下的存储队列的名称。 string
ResourceId 存储帐户的 Azure 资源 ID,其中包含事件订阅的目标队列。 string

WebHookEventSubscriptionDestination

名称 说明
endpointType 事件订阅目标的终结点的类型。 “WebHook” ()
properties 事件订阅目标的 WebHook 属性。 WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

名称 说明
azureActiveDirectoryApplicationIdOrUri Azure Active Directory 应用程序 ID 或 URI,用于获取将作为持有者令牌包含在传递请求中的访问令牌。 字符串
azureActiveDirectoryTenantId Azure Active Directory 租户 ID,用于获取将作为持有者令牌包含在传递请求中的访问令牌。 字符串
deliveryAttributeMappings 传递属性详细信息。 DeliveryAttributeMapping[]
endpointUrl 表示事件订阅目标终结点的 URL。 string

约束:
敏感值。 作为安全参数传入。
maxEventsPerBatch 每个批的最大事件数。 int
preferredBatchSizeInKilobytes 首选批大小(以千字节为单位)。 int

EventSubscriptionFilter

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

AdvancedFilter

名称 说明
事件中要基于其进行筛选的字段/属性。 字符串
operatorType 设置对象类型 BoolEquals
IsNotNull
IsNullOrUndefined
NumberGreaterThan
NumberGreaterThanOrEquals
NumberIn
NumberInRange
NumberLessThan
NumberLessThanOrEquals
NumberNotIn
NumberNotInRange
StringBeginsWith
StringContains
StringEndsWith
StringIn
StringNotBeginsWith
StringNotContains
StringNotEndsWith
StringNotIn (必需)

BoolEqualsAdvancedFilter

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

IsNotNullAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 需要“IsNotNull” ()

IsNullOrUndefinedAdvancedFilter

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

NumberGreaterThanAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberGreaterThan” (必需)
value 筛选器值。 int

NumberGreaterThanOrEqualsAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberGreaterThanOrEquals” (必需)
value 筛选器值。 int

NumberInAdvancedFilter

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

NumberInRangeAdvancedFilter

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

NumberLessThanAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberLessThan” (必需)
value 筛选器值。 int

NumberLessThanOrEqualsAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberLessThanOrEquals” (必需)
value 筛选器值。 int

NumberNotInAdvancedFilter

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

NumberNotInRangeAdvancedFilter

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

StringBeginsWithAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringBeginsWith” (必需)
筛选器值集。 string[]

StringContainsAdvancedFilter

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

StringEndsWithAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringEndsWith” (必需)
筛选器值集。 string[]

StringInAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringIn” (必需)
筛选器值集。 string[]

StringNotBeginsWithAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotBeginsWith” (必需)
筛选器值集。 string[]

StringNotContainsAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotContains” (必需)
筛选器值集。 string[]

StringNotEndsWithAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotEndsWith” (必需)
筛选器值集。 string[]

StringNotInAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotIn” (必需)
筛选器值集。 string[]

RetryPolicy

名称 说明
eventTimeToLiveInMinutes 活动) 生存时间 (以分钟为单位。 int
maxDeliveryAttempts 事件的最大传递重试尝试次数。 int

快速入门模板

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

模板 说明
创建Azure 事件网格自定义主题和订阅

部署到 Azure
创建Azure 事件网格自定义主题和 Webhook 订阅。 模板最初由 John Downs 创作。
使用 CloudEvents 自定义Azure 事件网格主题/订阅

部署到 Azure
创建自定义Azure 事件网格主题、具有 CloudEvents 架构的 Webhook 订阅和作为事件处理程序的逻辑应用。 模板最初由 Justin Yoo 创作。
创建事件网格自定义主题和事件中心处理程序

部署到 Azure
创建Azure 事件网格自定义主题和事件中心来处理事件。
为资源事件创建事件网格订阅

部署到 Azure
创建资源组或 Azure 订阅的事件网格订阅。
创建自定义主题和队列订阅Azure 事件网格

部署到 Azure
创建Azure 事件网格自定义主题和服务总线队列订阅。 模板最初由 Markus Meyer 创作。
创建自定义主题订阅Azure 事件网格

部署到 Azure
创建Azure 事件网格自定义主题和服务总线主题订阅。 模板最初由 Markus Meyer 创作。

ARM 模板资源定义

eventSubscriptions 资源类型是 扩展资源,这意味着你可以将其应用于其他资源。

scope使用此资源上的 属性可设置此资源的范围。 请参阅 在 ARM 模板中设置扩展资源的范围

eventSubscriptions 资源类型可以使用面向以下对象的操作进行部署:

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

资源格式

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

{
  "type": "Microsoft.EventGrid/eventSubscriptions",
  "apiVersion": "2021-10-15-preview",
  "name": "string",
  "scope": "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"
  }

对于 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",
    "preferredBatchSizeInKilobytes": "int"
  }

DeliveryAttributeMapping 对象

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

对于 Dynamic,请使用:

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

对于 静态,请使用:

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

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

属性值

eventSubscriptions

名称 说明 Value
type 资源类型 'Microsoft.EventGrid/eventSubscriptions'
apiVersion 资源 API 版本 “2021-10-15-preview”
name 资源名称 字符串 (必需)

字符限制:3-64

有效字符:
字母数字和连字符。
scope 在与部署范围不同的范围创建扩展资源时使用 。 目标资源

对于 JSON,请将值设置为要向其应用 扩展资源 的资源的全名。
properties 事件订阅的属性。 EventSubscriptionProperties

EventSubscriptionProperties

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

DeadLetterDestination

名称 说明
endpointType 设置对象类型 需要 StorageBlob ()

StorageBlobDeadLetterDestination

名称 说明
endpointType 死信目标的终结点类型 “StorageBlob” (必需)
properties 基于存储 Blob 的死信目标的属性 StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

名称 说明
blobContainerName 存储 Blob 容器的名称,该容器是死信事件的目标 字符串
ResourceId 死信事件目标的存储帐户的 Azure 资源 ID string

DeadLetterWithResourceIdentity

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

EventSubscriptionIdentity

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

DeliveryWithResourceIdentity

名称 说明
destination 有关必须为事件订阅传递事件的目标的信息。
使用Azure 事件网格的标识获取在传递/死信期间使用的身份验证令牌。
EventSubscriptionDestination
标识 传递事件时要使用的标识。 EventSubscriptionIdentity

EventSubscriptionDestination

名称 说明
endpointType 设置对象类型 AzureFunction
EventHub
HybridConnection
PartnerDestination
ServiceBusQueue
ServiceBusTopic
StorageQueue
需要 WebHook ()

AzureFunctionEventSubscriptionDestination

名称 说明
endpointType 事件订阅目标的终结点的类型。 “AzureFunction” (必需的)
properties 事件订阅目标的 Azure 函数属性。 AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

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

DeliveryAttributeMapping

名称 说明
name 传递属性或标头的名称。 字符串
type 设置对象类型 动态
需要静态 ()

DynamicDeliveryAttributeMapping

名称 说明 Value
type 传递属性或标头名称的类型。 “Dynamic” (必需)
properties 动态传递属性映射的属性。 DynamicDeliveryAttributeMappingProperties

DynamicDeliveryAttributeMappingProperties

名称 说明
sourceField 包含属性值的事件中的 JSON 路径。 string

StaticDeliveryAttributeMapping

名称 说明 Value
type 传递属性或标头名称的类型。 “Static” (必需)
properties 静态传递属性映射的属性。 StaticDeliveryAttributeMappingProperties

StaticDeliveryAttributeMappingProperties

名称 说明
isSecret 用于指示属性是否包含敏感信息 的布尔标志。 bool
value 传递属性的值。 字符串

EventHubEventSubscriptionDestination

名称 说明
endpointType 事件订阅目标的终结点的类型。 “EventHub” (必需)
properties 事件订阅目标的事件中心属性。 EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

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

HybridConnectionEventSubscriptionDestination

名称 说明
endpointType 事件订阅目标的终结点的类型。 “HybridConnection” (必需)
properties 事件订阅目标的混合连接属性。 HybridConnectionEventSubscriptionDestinationProperti...

HybridConnectionEventSubscriptionDestinationProperti...

名称 说明
deliveryAttributeMappings 传递属性详细信息。 DeliveryAttributeMapping[]
ResourceId 作为事件订阅目标的混合连接的 Azure 资源 ID。 string

PartnerEventSubscriptionDestination

名称 说明
endpointType 事件订阅目标的终结点的类型。 “PartnerDestination” (必需)
properties 事件订阅目标的合作伙伴目标属性。 PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

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

ServiceBusQueueEventSubscriptionDestination

名称 说明
endpointType 事件订阅目标的终结点的类型。 需要“ServiceBusQueue” ()
properties 事件订阅目标的服务总线属性。 ServiceBusQueueEventSubscriptionDestinationPropertie...

ServiceBusQueueEventSubscriptionDestinationPropertie...

名称 说明
deliveryAttributeMappings 传递属性详细信息。 DeliveryAttributeMapping[]
ResourceId Azure 资源 ID,表示事件订阅的服务总线目标的终结点。 string

ServiceBusTopicEventSubscriptionDestination

名称 说明
endpointType 事件订阅目标的终结点的类型。 “ServiceBusTopic” (必需)
properties 事件订阅目标的服务总线主题属性。 ServiceBusTopicEventSubscriptionDestinationPropertie...

ServiceBusTopicEventSubscriptionDestinationPropertie...

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

StorageQueueEventSubscriptionDestination

名称 说明
endpointType 事件订阅目标的终结点的类型。 “StorageQueue” (必需)
properties 事件订阅目标的存储队列属性。 StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

名称 说明
queueMessageTimeToLiveInSeconds 存储队列消息生存时间(以秒为单位)。 int
queueName 作为事件订阅目标的存储帐户下的存储队列的名称。 字符串
ResourceId 存储帐户的 Azure 资源 ID,其中包含事件订阅的目标队列。 string

WebHookEventSubscriptionDestination

名称 说明
endpointType 事件订阅目标的终结点的类型。 “WebHook” (必需)
properties 事件订阅目标的 WebHook 属性。 WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

名称 说明
azureActiveDirectoryApplicationIdOrUri Azure Active Directory 应用程序 ID 或 URI,用于获取访问令牌,该令牌将作为持有者令牌包含在传递请求中。 字符串
azureActiveDirectoryTenantId 用于获取访问令牌的 Azure Active Directory 租户 ID,该令牌将作为持有者令牌包含在传递请求中。 string
deliveryAttributeMappings 传递属性详细信息。 DeliveryAttributeMapping[]
endpointUrl 表示事件订阅目标终结点的 URL。 字符串

约束:
敏感值。 作为安全参数传入。
maxEventsPerBatch 每个批处理的最大事件数。 int
preferredBatchSizeInKilobytes 首选批大小(以千字节为单位)。 int

EventSubscriptionFilter

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

AdvancedFilter

名称 说明
要基于其进行筛选的事件中的字段/属性。 字符串
operatorType 设置对象类型 BoolEquals
IsNotNull
IsNullOrUndefined
NumberGreaterThan
NumberGreaterThanOrEquals
NumberIn
NumberInRange
NumberLessThan
NumberLessThanOrEquals
NumberNotIn
NumberNotInRange
StringBeginsWith
StringContains
StringEndsWith
StringIn
StringNotBeginsWith
StringNotContains
StringNotEndsWith
StringNotIn (必需)

BoolEqualsAdvancedFilter

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

IsNotNullAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 需要“IsNotNull” ()

IsNullOrUndefinedAdvancedFilter

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

NumberGreaterThanAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberGreaterThan” (必需)
value 筛选器值。 int

NumberGreaterThanOrEqualsAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberGreaterThanOrEquals” (必需)
value 筛选器值。 int

NumberInAdvancedFilter

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

NumberInRangeAdvancedFilter

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

NumberLessThanAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberLessThan” (必需)
value 筛选器值。 int

NumberLessThanOrEqualsAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberLessThanOrEquals” (必需)
value 筛选器值。 int

NumberNotInAdvancedFilter

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

NumberNotInRangeAdvancedFilter

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

StringBeginsWithAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringBeginsWith” (必需)
筛选器值集。 string[]

StringContainsAdvancedFilter

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

StringEndsWithAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringEndsWith” (必需)
筛选器值集。 string[]

StringInAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringIn” (必需)
筛选器值集。 string[]

StringNotBeginsWithAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotBeginsWith” (必需)
筛选器值集。 string[]

StringNotContainsAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotContains” (必需)
筛选器值集。 string[]

StringNotEndsWithAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotEndsWith” (必需)
筛选器值集。 string[]

StringNotInAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotIn” (必需)
筛选器值集。 string[]

RetryPolicy

名称 说明
eventTimeToLiveInMinutes 活动) 生存时间 (以分钟为单位。 int
maxDeliveryAttempts 事件的最大传递重试尝试次数。 int

快速入门模板

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

模板 说明
创建Azure 事件网格自定义主题和订阅

部署到 Azure
创建Azure 事件网格自定义主题和 Webhook 订阅。 模板最初由 John Downs 创作。
使用 CloudEvents 自定义Azure 事件网格主题/订阅

部署到 Azure
创建自定义Azure 事件网格主题、具有 CloudEvents 架构的 Webhook 订阅和作为事件处理程序的逻辑应用。 模板最初由 Justin Yoo 创作。
创建事件网格自定义主题和事件中心处理程序

部署到 Azure
创建Azure 事件网格自定义主题和事件中心来处理事件。
为资源事件创建事件网格订阅

部署到 Azure
创建资源组或 Azure 订阅的事件网格订阅。
创建Azure 事件网格自定义主题和队列订阅

部署到 Azure
创建Azure 事件网格自定义主题和服务总线队列订阅。 模板最初由 Markus Meyer 创作。
创建Azure 事件网格自定义主题订阅

部署到 Azure
创建Azure 事件网格自定义主题和服务总线主题订阅。 模板最初由 Markus Meyer 创作。

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

eventSubscriptions 资源类型是 扩展资源,这意味着你可以将其应用于其他资源。

parent_id使用此资源上的 属性可设置此资源的范围。

eventSubscriptions 资源类型可以使用面向以下对象的操作进行部署:

  • 资源组
  • 订阅

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/eventSubscriptions@2021-10-15-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    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"
  }

对于 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
    preferredBatchSizeInKilobytes = int
  }

DeliveryAttributeMapping 对象

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

对于 Dynamic,请使用:

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

对于 静态,请使用:

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

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

属性值

eventSubscriptions

名称 说明 Value
type 资源类型 “Microsoft.EventGrid/eventSubscriptions@2021-10-15-preview”
name 资源名称 字符串 (必需)

字符限制:3-64

有效字符:
字母数字和连字符。
parent_id 要向其应用此扩展资源的资源的 ID。 字符串 (必需)
properties 事件订阅的属性。 EventSubscriptionProperties

EventSubscriptionProperties

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

DeadLetterDestination

名称 说明
endpointType 设置对象类型 所需的 StorageBlob ()

StorageBlobDeadLetterDestination

名称 说明
endpointType 死信目标的终结点的类型 “StorageBlob” (必需)
properties 基于存储 Blob 的死信目标的属性 StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

名称 说明
blobContainerName 存储 Blob 容器的名称,该容器是死信事件的目标 字符串
ResourceId 死信事件目标的存储帐户的 Azure 资源 ID 字符串

DeadLetterWithResourceIdentity

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

EventSubscriptionIdentity

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

DeliveryWithResourceIdentity

名称 说明
destination 有关事件订阅必须传递事件的目标的信息。
使用Azure 事件网格标识来获取传递/死信期间使用的身份验证令牌。
EventSubscriptionDestination
标识 传递事件时要使用的标识。 EventSubscriptionIdentity

EventSubscriptionDestination

名称 说明
endpointType 设置对象类型 AzureFunction
EventHub
HybridConnection
PartnerDestination
ServiceBusQueue
ServiceBusTopic
StorageQueue
WebHook (必需)

AzureFunctionEventSubscriptionDestination

名称 说明
endpointType 事件订阅目标的终结点的类型。 “AzureFunction” (必需)
properties 事件订阅目标的 Azure 函数属性。 AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

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

DeliveryAttributeMapping

名称 说明
name 传递属性或标头的名称。 字符串
type 设置对象类型 动态
需要静态 ()

DynamicDeliveryAttributeMapping

名称 说明 Value
type 传递属性或标头名称的类型。 “动态” (必需)
properties 动态传递属性映射的属性。 DynamicDeliveryAttributeMappingProperties

DynamicDeliveryAttributeMappingProperties

名称 说明
sourceField 包含属性值的事件中的 JSON 路径。 string

StaticDeliveryAttributeMapping

名称 说明 Value
type 传递属性或标头名称的类型。 “Static” (必需)
properties 静态传递属性映射的属性。 StaticDeliveryAttributeMappingProperties

StaticDeliveryAttributeMappingProperties

名称 说明
isSecret 用于指示属性是否包含敏感信息 的布尔标志。 bool
value 传递属性的值。 字符串

EventHubEventSubscriptionDestination

名称 说明
endpointType 事件订阅目标的终结点的类型。 “EventHub” (必需)
properties 事件订阅目标的事件中心属性。 EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

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

HybridConnectionEventSubscriptionDestination

名称 说明
endpointType 事件订阅目标的终结点的类型。 “HybridConnection” (必需)
properties 事件订阅目标的混合连接属性。 HybridConnectionEventSubscriptionDestinationProperti...

HybridConnectionEventSubscriptionDestinationProperti...

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

PartnerEventSubscriptionDestination

名称 说明
endpointType 事件订阅目标的终结点的类型。 “PartnerDestination” (必需)
properties 事件订阅目标的合作伙伴目标属性。 PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

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

ServiceBusQueueEventSubscriptionDestination

名称 说明
endpointType 事件订阅目标的终结点的类型。 “ServiceBusQueue” (必需)
properties 事件订阅目标的服务总线属性。 ServiceBusQueueEventSubscriptionDestinationPropertie...

ServiceBusQueueEventSubscriptionDestinationPropertie...

名称 说明
deliveryAttributeMappings 传递属性详细信息。 DeliveryAttributeMapping[]
ResourceId Azure 资源 ID,表示事件订阅的服务总线目标的终结点。 string

ServiceBusTopicEventSubscriptionDestination

名称 说明
endpointType 事件订阅目标的终结点的类型。 需要“ServiceBusTopic” ()
properties 事件订阅目标的服务总线主题属性。 ServiceBusTopicEventSubscriptionDestinationPropertie...

ServiceBusTopicEventSubscriptionDestinationPropertie...

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

StorageQueueEventSubscriptionDestination

名称 说明
endpointType 事件订阅目标的终结点的类型。 “StorageQueue” (必需)
properties 事件订阅目标的存储队列属性。 StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

名称 说明
queueMessageTimeToLiveInSeconds 存储队列消息生存时间(以秒为单位)。 int
queueName 作为事件订阅目标的存储帐户下的存储队列的名称。 字符串
ResourceId 存储帐户的 Azure 资源 ID,其中包含事件订阅的目标队列。 字符串

WebHookEventSubscriptionDestination

名称 说明
endpointType 事件订阅目标的终结点的类型。 需要“WebHook” ()
properties 事件订阅目标的 WebHook 属性。 WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

名称 说明
azureActiveDirectoryApplicationIdOrUri Azure Active Directory 应用程序 ID 或 URI,用于获取访问令牌,该令牌将作为持有者令牌包含在传递请求中。 字符串
azureActiveDirectoryTenantId 用于获取访问令牌的 Azure Active Directory 租户 ID,该令牌将作为持有者令牌包含在传递请求中。 字符串
deliveryAttributeMappings 传递属性详细信息。 DeliveryAttributeMapping[]
endpointUrl 表示事件订阅目标终结点的 URL。 字符串

约束:
敏感值。 作为安全参数传入。
maxEventsPerBatch 每个批的最大事件数。 int
preferredBatchSizeInKilobytes 首选批大小(以千字节为单位)。 int

EventSubscriptionFilter

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

AdvancedFilter

名称 说明
事件中要基于其进行筛选的字段/属性。 字符串
operatorType 设置对象类型 BoolEquals
IsNotNull
IsNullOrUndefined
NumberGreaterThan
NumberGreaterThanOrEquals
NumberIn
NumberInRange
NumberLessThan
NumberLessThanOrEquals
NumberNotIn
NumberNotInRange
StringBeginsWith
StringContains
StringEndsWith
StringIn
StringNotBeginsWith
StringNotContains
StringNotEndsWith
StringNotIn (必需)

BoolEqualsAdvancedFilter

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

IsNotNullAdvancedFilter

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

IsNullOrUndefinedAdvancedFilter

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

NumberGreaterThanAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberGreaterThan” (必需)
value 筛选器值。 int

NumberGreaterThanOrEqualsAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberGreaterThanOrEquals” (必需)
value 筛选器值。 int

NumberInAdvancedFilter

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

NumberInRangeAdvancedFilter

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

NumberLessThanAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberLessThan” (必需)
value 筛选器值。 int

NumberLessThanOrEqualsAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberLessThanOrEquals” (必需)
value 筛选器值。 int

NumberNotInAdvancedFilter

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

NumberNotInRangeAdvancedFilter

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

StringBeginsWithAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringBeginsWith” (必需)
筛选器值集。 string[]

StringContainsAdvancedFilter

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

StringEndsWithAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringEndsWith” (必需)
筛选器值集。 string[]

StringInAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringIn” (必需)
筛选器值集。 string[]

StringNotBeginsWithAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotBeginsWith” (必需)
筛选器值集。 string[]

StringNotContainsAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotContains” (必需)
筛选器值集。 string[]

StringNotEndsWithAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotEndsWith” (必需)
筛选器值集。 string[]

StringNotInAdvancedFilter

名称 说明
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotIn” (必需)
筛选器值集。 string[]

RetryPolicy

名称 说明
eventTimeToLiveInMinutes 活动) 的生存时间 (以分钟为单位。 int
maxDeliveryAttempts 事件的最大传递重试次数。 int