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

Microsoft.EventGrid eventSubscriptions 2019-01-01

项目
01/14/2024

Bicep 资源定义

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

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

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

资源组 - 请参阅资源组部署命令
订阅 - 请参阅订阅部署命令

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

资源格式

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

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2019-01-01' = {
  name: 'string'
  scope: resourceSymbolicName
  properties: {
    deadLetterDestination: {
      endpointType: 'string'
      // For remaining properties, see DeadLetterDestination objects
    }
    destination: {
      endpointType: 'string'
      // For remaining properties, see EventSubscriptionDestination objects
    }
    filter: {
      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 属性以指定对象的类型。

对于 EventHub，请使用：

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

对于 HybridConnection，请使用：

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

对于 StorageQueue，请使用：

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

对于 WebHook，请使用：

  endpointType: 'WebHook'
  properties: {
    endpointUrl: 'string'
  }

属性值

eventSubscriptions

名称	说明	值
name	资源名称	字符串 (必需) 字符限制：3-64 有效字符：字母数字和连字符。
scope	在不同于部署范围的范围创建扩展资源时使用。	目标资源对于 Bicep，请将此属性设置为要应用扩展资源的符号名称。
properties	事件订阅的属性	EventSubscriptionProperties

EventSubscriptionProperties

名称	说明	值
deadLetterDestination	事件订阅的 DeadLetter 目标。	DeadLetterDestination
destination	有关必须为事件订阅传递事件的目标的信息。	EventSubscriptionDestination
filter	有关事件订阅筛选器的信息。	EventSubscriptionFilter
标签	用户定义的标签列表。	string[]
retryPolicy	事件的重试策略。这可用于配置事件的最大传递尝试次数和生存时间。	RetryPolicy

DeadLetterDestination

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

StorageBlobDeadLetterDestination

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

StorageBlobDeadLetterDestinationProperties

名称	说明	值
blobContainerName	存储 Blob 容器的名称，该容器是死信事件的目标	string
ResourceId	死信事件目标的存储帐户的 Azure 资源 ID。例如：/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/microsoft。Storage/storageAccounts/{StorageAccountName}	字符串

EventSubscriptionDestination

名称	说明	值
endpointType	设置对象类型	EventHub HybridConnection StorageQueue 需要 WebHook ()

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

名称	说明	值
ResourceId	表示事件订阅的事件中心目标的终结点的 Azure 资源 ID。	string

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperti...

名称	说明	值
ResourceId	作为事件订阅目标的混合连接的 Azure 资源 ID。	字符串

StorageQueueEventSubscriptionDestination

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

StorageQueueEventSubscriptionDestinationProperties

名称	说明	值
queueName	作为事件订阅目标的存储帐户下的存储队列的名称。	string
ResourceId	包含事件订阅目标的队列的存储帐户的 Azure 资源 ID。	字符串

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

名称	说明	值
endpointUrl	表示事件订阅目标终结点的 URL。	字符串

EventSubscriptionFilter

名称	说明	值
includedEventTypes	需要作为事件订阅一部分的适用事件类型的列表。如果需要订阅所有事件类型，则需要将字符串“all”指定为此列表中的元素。	string[]
isSubjectCaseSensitive	指定筛选器的 SubjectBeginsWith 和 SubjectEndsWith 属性是否应以区分大小写的方式进行比较。	bool
subjectBeginsWith	一个可选字符串，用于根据资源路径前缀筛选事件订阅的事件。其格式取决于事件的发布者。此路径不支持通配符。	字符串
subjectEndsWith	一个可选字符串，用于根据资源路径后缀筛选事件订阅的事件。此路径不支持通配符。	字符串

RetryPolicy

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

快速入门模板

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

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

ARM 模板资源定义

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

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

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

资源组 - 请参阅资源组部署命令
订阅 - 请参阅订阅部署命令

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

资源格式

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

{
  "type": "Microsoft.EventGrid/eventSubscriptions",
  "apiVersion": "2019-01-01",
  "name": "string",
  "scope": "string",
  "properties": {
    "deadLetterDestination": {
      "endpointType": "string"
      // For remaining properties, see DeadLetterDestination objects
    },
    "destination": {
      "endpointType": "string"
      // For remaining properties, see EventSubscriptionDestination objects
    },
    "filter": {
      "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 属性以指定对象的类型。

对于 EventHub，请使用：

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

对于 HybridConnection，请使用：

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

对于 StorageQueue，请使用：

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

对于 WebHook，请使用：

  "endpointType": "WebHook",
  "properties": {
    "endpointUrl": "string"
  }

属性值

eventSubscriptions

名称	说明	Value
type	资源类型	'Microsoft.EventGrid/eventSubscriptions'
apiVersion	资源 API 版本	'2019-01-01'
name	资源名称	字符串 (必需) 字符限制：3-64 有效字符：字母数字和连字符。
scope	在不同于部署范围的范围创建扩展资源时使用。	目标资源对于 JSON，请将值设置为要向其应用扩展资源的资源的全名。
properties	事件订阅的属性	EventSubscriptionProperties

EventSubscriptionProperties

名称	说明	值
deadLetterDestination	事件订阅的 DeadLetter 目标。	DeadLetterDestination
destination	有关必须为事件订阅传递事件的目标的信息。	EventSubscriptionDestination
filter	有关事件订阅的筛选器的信息。	EventSubscriptionFilter
标签	用户定义的标签列表。	string[]
retryPolicy	事件的重试策略。这可用于配置事件的最大传递尝试次数和生存时间。	RetryPolicy

DeadLetterDestination

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

StorageBlobDeadLetterDestination

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

StorageBlobDeadLetterDestinationProperties

名称	说明	值
blobContainerName	存储 Blob 容器的名称，该容器是死信事件的目标	string
ResourceId	死信事件目标的存储帐户的 Azure 资源 ID。例如：/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/microsoft。Storage/storageAccounts/{StorageAccountName}	字符串

EventSubscriptionDestination

名称	说明	值
endpointType	设置对象类型	EventHub HybridConnection StorageQueue WebHook (必需)

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

名称	说明	值
ResourceId	表示事件订阅的事件中心目标的终结点的 Azure 资源 ID。	string

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperti...

名称	说明	值
ResourceId	作为事件订阅目标的混合连接的 Azure 资源 ID。	string

StorageQueueEventSubscriptionDestination

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

StorageQueueEventSubscriptionDestinationProperties

名称	说明	值
queueName	作为事件订阅目标的存储帐户下的存储队列的名称。	字符串
ResourceId	存储帐户的 Azure 资源 ID，其中包含事件订阅的目标队列。	string

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

名称	说明	值
endpointUrl	表示事件订阅目标终结点的 URL。	字符串

EventSubscriptionFilter

名称	说明	值
includedEventTypes	需要作为事件订阅一部分的适用事件类型的列表。如果需要订阅所有事件类型，则需要将字符串“all”指定为此列表中的元素。	string[]
isSubjectCaseSensitive	指定筛选器的 SubjectBeginsWith 和 SubjectEndsWith 属性是否应以区分大小写的方式进行比较。	bool
subjectBeginsWith	一个可选字符串，用于根据资源路径前缀筛选事件订阅的事件。其格式取决于事件的发布者。此路径不支持通配符。	字符串
subjectEndsWith	一个可选字符串，用于根据资源路径后缀筛选事件订阅的事件。此路径不支持通配符。	字符串

RetryPolicy

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

快速入门模板

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

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

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

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

parent_id使用此资源上的属性可设置此资源的作用域。

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

资源组
订阅

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/eventSubscriptions@2019-01-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      deadLetterDestination = {
        endpointType = "string"
        // For remaining properties, see DeadLetterDestination objects
      }
      destination = {
        endpointType = "string"
        // For remaining properties, see EventSubscriptionDestination objects
      }
      filter = {
        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 属性以指定对象的类型。

对于 EventHub，请使用：

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

对于 HybridConnection，请使用：

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

对于 StorageQueue，请使用：

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

对于 WebHook，请使用：

  endpointType = "WebHook"
  properties = {
    endpointUrl = "string"
  }

属性值

eventSubscriptions

名称	说明	Value
type	资源类型	“Microsoft.EventGrid/eventSubscriptions@2019-01-01”
name	资源名称	字符串 (必需) 字符限制：3-64 有效字符：字母数字和连字符。
parent_id	要向其应用此扩展资源的资源的 ID。	字符串 (必需)
properties	事件订阅的属性	EventSubscriptionProperties

EventSubscriptionProperties

名称	说明	值
deadLetterDestination	事件订阅的 DeadLetter 目标。	DeadLetterDestination
destination	有关事件订阅必须传递事件的目标的信息。	EventSubscriptionDestination
filter	有关事件订阅的筛选器的信息。	EventSubscriptionFilter
标签	用户定义的标签列表。	string[]
retryPolicy	事件的重试策略。这可用于配置事件的最大传递尝试次数和生存时间。	RetryPolicy

DeadLetterDestination

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

StorageBlobDeadLetterDestination

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

StorageBlobDeadLetterDestinationProperties

名称	说明	值
blobContainerName	存储 Blob 容器的名称，该容器是死信事件的目标	string
ResourceId	死信事件目标的存储帐户的 Azure 资源 ID。例如：/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/microsoft。Storage/storageAccounts/{StorageAccountName}	字符串

EventSubscriptionDestination

名称	说明	值
endpointType	设置对象类型	EventHub HybridConnection StorageQueue WebHook (必需)

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

名称	说明	值
ResourceId	表示事件订阅的事件中心目标的终结点的 Azure 资源 ID。	字符串

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperti...

名称	说明	值
ResourceId	作为事件订阅目标的混合连接的 Azure 资源 ID。	字符串

StorageQueueEventSubscriptionDestination

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

StorageQueueEventSubscriptionDestinationProperties

名称	说明	值
queueName	作为事件订阅目标的存储帐户下的存储队列的名称。	字符串
ResourceId	存储帐户的 Azure 资源 ID，其中包含事件订阅的目标队列。	string

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

名称	说明	值
endpointUrl	表示事件订阅目标终结点的 URL。	字符串

EventSubscriptionFilter

名称	说明	值
includedEventTypes	需要属于事件订阅的适用事件类型的列表。如果需要订阅所有事件类型，则需要将此列表中的字符串“all”指定为元素。	string[]
isSubjectCaseSensitive	指定筛选器的 SubjectBeginsWith 和 SubjectEndsWith 属性应以区分大小写的方式进行比较。	bool
subjectBeginsWith	一个可选字符串，用于根据资源路径前缀筛选事件订阅的事件。其格式取决于事件的发布者。此路径不支持通配符。	字符串
subjectEndsWith	一个可选字符串，用于根据资源路径后缀筛选事件订阅的事件。此路径不支持通配符。	string

RetryPolicy

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

通过

Microsoft.EventGrid eventSubscriptions 2019-01-01

Bicep 资源定义

资源格式

DeadLetterDestination 对象

EventSubscriptionDestination 对象

属性值

eventSubscriptions

EventSubscriptionProperties

DeadLetterDestination

StorageBlobDeadLetterDestination

StorageBlobDeadLetterDestinationProperties

EventSubscriptionDestination

EventHubEventSubscriptionDestination

EventHubEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestination

HybridConnectionEventSubscriptionDestinationProperti...

StorageQueueEventSubscriptionDestination

StorageQueueEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestination

WebHookEventSubscriptionDestinationProperties

EventSubscriptionFilter

RetryPolicy

快速入门模板

ARM 模板资源定义

资源格式

DeadLetterDestination 对象

EventSubscriptionDestination 对象

属性值

eventSubscriptions

EventSubscriptionProperties

DeadLetterDestination

StorageBlobDeadLetterDestination

StorageBlobDeadLetterDestinationProperties

EventSubscriptionDestination

EventHubEventSubscriptionDestination

EventHubEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestination

HybridConnectionEventSubscriptionDestinationProperti...

StorageQueueEventSubscriptionDestination

StorageQueueEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestination

WebHookEventSubscriptionDestinationProperties

EventSubscriptionFilter

RetryPolicy

快速入门模板

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

资源格式

DeadLetterDestination 对象

EventSubscriptionDestination 对象

属性值

eventSubscriptions

EventSubscriptionProperties

DeadLetterDestination

StorageBlobDeadLetterDestination

StorageBlobDeadLetterDestinationProperties

EventSubscriptionDestination

EventHubEventSubscriptionDestination

EventHubEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestination

HybridConnectionEventSubscriptionDestinationProperti...

StorageQueueEventSubscriptionDestination

StorageQueueEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestination

WebHookEventSubscriptionDestinationProperties

EventSubscriptionFilter

RetryPolicy

反馈

其他资源