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

Microsoft.EventGrid eventSubscriptions 2017-06-15-preview

• 最新
• 2023-12-15-preview
• 2023-06-01-preview
• 2022-06-15
• 2021-12-01
• 2021-10-15-preview
• 2021-06-01-preview
• 2020-10-15-preview
• 2020-06-01
• 2020-04-01-preview
• 2020-01-01-preview
• 2019-06-01
• 2019-02-01-preview
• 2019-01-01
• 2018-09-15-preview
• 2018-05-01-preview
• 2018-01-01
• 2017-09-15-preview
• 2017-06-15-preview

Bicep 资源定义

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

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

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

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

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

资源格式

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

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2017-06-15-preview' = {
  name: 'string'
  scope: resourceSymbolicName
  properties: {
    destination: {
      endpointType: 'WebHook'
      properties: {
        endpointUrl: 'string'
      }
    }
    filter: {
      includedEventTypes: [
        'string'
      ]
      isSubjectCaseSensitive: bool
      subjectBeginsWith: 'string'
      subjectEndsWith: 'string'
    }
    labels: [
      'string'
    ]
  }
}

属性值

eventSubscriptions

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

EventSubscriptionProperties

名称	说明	值
destination	有关事件订阅必须传递事件的目标的信息。	EventSubscriptionDestination
filter	有关事件订阅的筛选器的信息。	EventSubscriptionFilter
标签	用户定义的标签列表。	string[]

EventSubscriptionDestination

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

EventSubscriptionDestinationProperties

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

EventSubscriptionFilter

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

快速入门模板

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

模板	说明
创建自定义主题和订阅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": "2017-06-15-preview",
  "name": "string",
  "scope": "string",
  "properties": {
    "destination": {
      "endpointType": "WebHook",
      "properties": {
        "endpointUrl": "string"
      }
    },
    "filter": {
      "includedEventTypes": [ "string" ],
      "isSubjectCaseSensitive": "bool",
      "subjectBeginsWith": "string",
      "subjectEndsWith": "string"
    },
    "labels": [ "string" ]
  }
}

属性值

eventSubscriptions

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

EventSubscriptionProperties

名称	说明	值
destination	有关事件订阅必须传递事件的目标的信息。	EventSubscriptionDestination
filter	有关事件订阅的筛选器的信息。	EventSubscriptionFilter
标签	用户定义的标签列表。	string[]

EventSubscriptionDestination

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

EventSubscriptionDestinationProperties

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

EventSubscriptionFilter

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

快速入门模板

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

模板	说明
创建自定义主题和订阅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@2017-06-15-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      destination = {
        endpointType = "WebHook"
        properties = {
          endpointUrl = "string"
        }
      }
      filter = {
        includedEventTypes = [
          "string"
        ]
        isSubjectCaseSensitive = bool
        subjectBeginsWith = "string"
        subjectEndsWith = "string"
      }
      labels = [
        "string"
      ]
    }
  })
}

属性值

eventSubscriptions

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

EventSubscriptionProperties

名称	说明	值
destination	有关事件订阅必须传递事件的目标的信息。	EventSubscriptionDestination
filter	有关事件订阅的筛选器的信息。	EventSubscriptionFilter
标签	用户定义的标签列表。	string[]

EventSubscriptionDestination

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

EventSubscriptionDestinationProperties

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

EventSubscriptionFilter

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