你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.EventGrid eventSubscriptions 2019-01-01
- 最新
- 2024-12-15-preview
- 2024-06-01-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 资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.EventGrid/eventSubscriptions 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2019-01-01' = {
scope: resourceSymbolicName or scope
name: '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
}
}
}
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'
}
}
DeadLetterDestination 对象
设置 endpointType 属性以指定对象的类型。
对于 StorageBlob，请使用：
{
endpointType: 'StorageBlob'
properties: {
blobContainerName: 'string'
resourceId: 'string'
}
}
属性值
DeadLetterDestination
| 名字 | 描述 | 价值 |
|---|---|---|
| endpointType | 对于 StorageBlobDeadLetterDestination，请设置为“StorageBlob”。 | “StorageBlob”（必需） |
EventHubEventSubscriptionDestination
| 名字 | 描述 | 价值 |
|---|---|---|
| endpointType | 事件订阅目标的终结点类型 | “EventHub”（必需） |
| 性能 | 事件订阅目标的事件中心属性 | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| resourceId | 表示事件订阅的事件中心目标的终结点的 Azure 资源 ID。 | 字符串 |
EventSubscriptionDestination
| 名字 | 描述 | 价值 |
|---|---|---|
| endpointType | 设置为 EventHubEventSubscriptionDestination类型的“EventHub”。 对于 HybridConnectionEventSubscriptionDestination，请设置为“HybridConnection”。 对于 type StorageQueueEventSubscriptionDestination，设置为“StorageQueue”。 对于 WebHookEventSubscriptionDestination，请设置为“WebHook”。 | “EventHub” “HybridConnection” “StorageQueue” “WebHook”（必需） |
EventSubscriptionFilter
| 名字 | 描述 | 价值 |
|---|---|---|
| includedEventTypes | 需要属于事件订阅的适用事件类型的列表。 如果需要订阅所有事件类型，则需要将此字符串“all”指定为此列表中的元素。 |
string[] |
| isSubjectCaseSensitive | 指定筛选器的 SubjectBeginsWith 和 SubjectEndsWith 属性 应以区分大小写的方式进行比较。 |
bool |
| subjectBeginsWith | 一个可选字符串，用于根据资源路径前缀筛选事件订阅的事件。 此格式取决于事件的发布者。 此路径不支持通配符。 |
字符串 |
| subjectEndsWith | 一个可选字符串，用于根据资源路径后缀筛选事件订阅的事件。 此路径不支持通配符。 |
字符串 |
EventSubscriptionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| deadLetterDestination | 事件订阅的 DeadLetter 目标。 | DeadLetterDestination |
| 目的地 | 有关事件订阅必须传送事件的目标的信息。 | EventSubscriptionDestination |
| 滤波器 | 有关事件订阅筛选器的信息。 | EventSubscriptionFilter |
| 标签 | 用户定义的标签列表。 | string[] |
| retryPolicy | 事件的重试策略。 这可用于配置事件的最大传递尝试次数和生存时间。 | RetryPolicy |
HybridConnectionEventSubscriptionDestination
| 名字 | 描述 | 价值 |
|---|---|---|
| endpointType | 事件订阅目标的终结点类型 | “HybridConnection”（必需） |
| 性能 | 事件订阅目标的混合连接属性 | HybridConnectionEventSubscriptionDestinationProperties |
HybridConnectionEventSubscriptionDestinationProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| resourceId | 作为事件订阅目标的混合连接的 Azure 资源 ID。 | 字符串 |
Microsoft.EventGrid/eventSubscriptions
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 资源名称 | string （必需） |
| 性能 | 事件订阅的属性 | EventSubscriptionProperties |
| 范围 | 在与部署范围不同的范围内创建资源时使用。 | 将此属性设置为资源的符号名称，以应用 扩展资源。 |
RetryPolicy
| 名字 | 描述 | 价值 |
|---|---|---|
| eventTimeToLiveInMinutes | 事件生存时间（以分钟为单位）。 | int |
| maxDeliveryAttempts | 事件的最大传递重试尝试次数。 | int |
StorageBlobDeadLetterDestination
| 名字 | 描述 | 价值 |
|---|---|---|
| endpointType | 死信目标的终结点类型 | “StorageBlob”（必需） |
| 性能 | 基于存储 Blob 的死信目标的属性 | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| blobContainerName | 存储 Blob 容器的名称，该容器是死信事件的目标 | 字符串 |
| resourceId | 存储帐户的 Azure 资源 ID，该 ID 是死信事件的目标。 例如：/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/microsoft。Storage/storageAccounts/{StorageAccountName} | 字符串 |
StorageQueueEventSubscriptionDestination
| 名字 | 描述 | 价值 |
|---|---|---|
| endpointType | 事件订阅目标的终结点类型 | “StorageQueue”（必需） |
| 性能 | 事件订阅目标的存储队列属性 | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| queueName | 作为事件订阅目标的存储帐户下的存储队列的名称。 | 字符串 |
| resourceId | 包含作为事件订阅目标的队列的存储帐户的 Azure 资源 ID。 | 字符串 |
WebHookEventSubscriptionDestination
| 名字 | 描述 | 价值 |
|---|---|---|
| endpointType | 事件订阅目标的终结点类型 | “WebHook”（必需） |
| 性能 | 事件订阅目标的 WebHook 属性 | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| endpointUrl | 表示事件订阅目标的终结点的 URL。 | 字符串 |
快速入门示例
以下快速入门示例部署此资源类型。
| Bicep 文件 | 描述 |
|---|---|
| 创建 Azure 事件网格自定义主题和队列订阅 | 创建 Azure 事件网格自定义主题和服务总线队列订阅。 模板最初由 Markus Meyer 创作。 |
| 创建 Azure 事件网格自定义主题和订阅 | 创建 Azure 事件网格自定义主题和 Webhook 订阅。 模板最初由 John Downs 创作。 |
ARM 模板资源定义
可以使用目标操作部署 eventSubscriptions 资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.EventGrid/eventSubscriptions 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.EventGrid/eventSubscriptions",
"apiVersion": "2019-01-01",
"name": "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"
}
}
}
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"
}
}
DeadLetterDestination 对象
设置 endpointType 属性以指定对象的类型。
对于 StorageBlob，请使用：
{
"endpointType": "StorageBlob",
"properties": {
"blobContainerName": "string",
"resourceId": "string"
}
}
属性值
DeadLetterDestination
| 名字 | 描述 | 价值 |
|---|---|---|
| endpointType | 对于 StorageBlobDeadLetterDestination，请设置为“StorageBlob”。 | “StorageBlob”（必需） |
EventHubEventSubscriptionDestination
| 名字 | 描述 | 价值 |
|---|---|---|
| endpointType | 事件订阅目标的终结点类型 | “EventHub”（必需） |
| 性能 | 事件订阅目标的事件中心属性 | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| resourceId | 表示事件订阅的事件中心目标的终结点的 Azure 资源 ID。 | 字符串 |
EventSubscriptionDestination
| 名字 | 描述 | 价值 |
|---|---|---|
| endpointType | 设置为 EventHubEventSubscriptionDestination类型的“EventHub”。 对于 HybridConnectionEventSubscriptionDestination，请设置为“HybridConnection”。 对于 type StorageQueueEventSubscriptionDestination，设置为“StorageQueue”。 对于 WebHookEventSubscriptionDestination，请设置为“WebHook”。 | “EventHub” “HybridConnection” “StorageQueue” “WebHook”（必需） |
EventSubscriptionFilter
| 名字 | 描述 | 价值 |
|---|---|---|
| includedEventTypes | 需要属于事件订阅的适用事件类型的列表。 如果需要订阅所有事件类型，则需要将此字符串“all”指定为此列表中的元素。 |
string[] |
| isSubjectCaseSensitive | 指定筛选器的 SubjectBeginsWith 和 SubjectEndsWith 属性 应以区分大小写的方式进行比较。 |
bool |
| subjectBeginsWith | 一个可选字符串，用于根据资源路径前缀筛选事件订阅的事件。 此格式取决于事件的发布者。 此路径不支持通配符。 |
字符串 |
| subjectEndsWith | 一个可选字符串，用于根据资源路径后缀筛选事件订阅的事件。 此路径不支持通配符。 |
字符串 |
EventSubscriptionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| deadLetterDestination | 事件订阅的 DeadLetter 目标。 | DeadLetterDestination |
| 目的地 | 有关事件订阅必须传送事件的目标的信息。 | EventSubscriptionDestination |
| 滤波器 | 有关事件订阅筛选器的信息。 | EventSubscriptionFilter |
| 标签 | 用户定义的标签列表。 | string[] |
| retryPolicy | 事件的重试策略。 这可用于配置事件的最大传递尝试次数和生存时间。 | RetryPolicy |
HybridConnectionEventSubscriptionDestination
| 名字 | 描述 | 价值 |
|---|---|---|
| endpointType | 事件订阅目标的终结点类型 | “HybridConnection”（必需） |
| 性能 | 事件订阅目标的混合连接属性 | HybridConnectionEventSubscriptionDestinationProperties |
HybridConnectionEventSubscriptionDestinationProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| resourceId | 作为事件订阅目标的混合连接的 Azure 资源 ID。 | 字符串 |
Microsoft.EventGrid/eventSubscriptions
| 名字 | 描述 | 价值 |
|---|---|---|
| apiVersion | API 版本 | '2019-01-01' |
| 名字 | 资源名称 | string （必需） |
| 性能 | 事件订阅的属性 | EventSubscriptionProperties |
| 类型 | 资源类型 | “Microsoft.EventGrid/eventSubscriptions” |
RetryPolicy
| 名字 | 描述 | 价值 |
|---|---|---|
| eventTimeToLiveInMinutes | 事件生存时间（以分钟为单位）。 | int |
| maxDeliveryAttempts | 事件的最大传递重试尝试次数。 | int |
StorageBlobDeadLetterDestination
| 名字 | 描述 | 价值 |
|---|---|---|
| endpointType | 死信目标的终结点类型 | “StorageBlob”（必需） |
| 性能 | 基于存储 Blob 的死信目标的属性 | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| blobContainerName | 存储 Blob 容器的名称，该容器是死信事件的目标 | 字符串 |
| resourceId | 存储帐户的 Azure 资源 ID，该 ID 是死信事件的目标。 例如：/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/microsoft。Storage/storageAccounts/{StorageAccountName} | 字符串 |
StorageQueueEventSubscriptionDestination
| 名字 | 描述 | 价值 |
|---|---|---|
| endpointType | 事件订阅目标的终结点类型 | “StorageQueue”（必需） |
| 性能 | 事件订阅目标的存储队列属性 | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| queueName | 作为事件订阅目标的存储帐户下的存储队列的名称。 | 字符串 |
| resourceId | 包含作为事件订阅目标的队列的存储帐户的 Azure 资源 ID。 | 字符串 |
WebHookEventSubscriptionDestination
| 名字 | 描述 | 价值 |
|---|---|---|
| endpointType | 事件订阅目标的终结点类型 | “WebHook”（必需） |
| 性能 | 事件订阅目标的 WebHook 属性 | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| endpointUrl | 表示事件订阅目标的终结点的 URL。 | 字符串 |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 描述 |
|---|---|
创建 Azure 事件网格自定义主题和队列订阅
|
创建 Azure 事件网格自定义主题和服务总线队列订阅。 模板最初由 Markus Meyer 创作。 |
|
创建 Azure 事件网格自定义主题和订阅
|
创建 Azure 事件网格自定义主题和 Webhook 订阅。 模板最初由 John Downs 创作。 |
|
创建 Azure 事件网格自定义主题订阅
|
创建 Azure 事件网格自定义主题和服务总线主题订阅。 模板最初由 Markus Meyer 创作。 |
|
创建事件网格自定义主题和事件中心处理程序
|
创建 Azure 事件网格自定义主题和事件中心来处理事件。 |
|
为资源事件创建事件网格订阅
|
创建资源组或 Azure 订阅的事件网格订阅。 |
| 使用 CloudEvents
|
创建自定义 Azure 事件网格主题、具有 CloudEvents 架构的 Webhook 订阅和逻辑应用作为事件处理程序。 模板最初由 Justin Yoo 创作。 |
Terraform （AzAPI 提供程序）资源定义
可以使用目标操作部署 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
}
}
})
}
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"
}
}
DeadLetterDestination 对象
设置 endpointType 属性以指定对象的类型。
对于 StorageBlob，请使用：
{
endpointType = "StorageBlob"
properties = {
blobContainerName = "string"
resourceId = "string"
}
}
属性值
DeadLetterDestination
| 名字 | 描述 | 价值 |
|---|---|---|
| endpointType | 对于 StorageBlobDeadLetterDestination，请设置为“StorageBlob”。 | “StorageBlob”（必需） |
EventHubEventSubscriptionDestination
| 名字 | 描述 | 价值 |
|---|---|---|
| endpointType | 事件订阅目标的终结点类型 | “EventHub”（必需） |
| 性能 | 事件订阅目标的事件中心属性 | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| resourceId | 表示事件订阅的事件中心目标的终结点的 Azure 资源 ID。 | 字符串 |
EventSubscriptionDestination
| 名字 | 描述 | 价值 |
|---|---|---|
| endpointType | 设置为 EventHubEventSubscriptionDestination类型的“EventHub”。 对于 HybridConnectionEventSubscriptionDestination，请设置为“HybridConnection”。 对于 type StorageQueueEventSubscriptionDestination，设置为“StorageQueue”。 对于 WebHookEventSubscriptionDestination，请设置为“WebHook”。 | “EventHub” “HybridConnection” “StorageQueue” “WebHook”（必需） |
EventSubscriptionFilter
| 名字 | 描述 | 价值 |
|---|---|---|
| includedEventTypes | 需要属于事件订阅的适用事件类型的列表。 如果需要订阅所有事件类型，则需要将此字符串“all”指定为此列表中的元素。 |
string[] |
| isSubjectCaseSensitive | 指定筛选器的 SubjectBeginsWith 和 SubjectEndsWith 属性 应以区分大小写的方式进行比较。 |
bool |
| subjectBeginsWith | 一个可选字符串，用于根据资源路径前缀筛选事件订阅的事件。 此格式取决于事件的发布者。 此路径不支持通配符。 |
字符串 |
| subjectEndsWith | 一个可选字符串，用于根据资源路径后缀筛选事件订阅的事件。 此路径不支持通配符。 |
字符串 |
EventSubscriptionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| deadLetterDestination | 事件订阅的 DeadLetter 目标。 | DeadLetterDestination |
| 目的地 | 有关事件订阅必须传送事件的目标的信息。 | EventSubscriptionDestination |
| 滤波器 | 有关事件订阅筛选器的信息。 | EventSubscriptionFilter |
| 标签 | 用户定义的标签列表。 | string[] |
| retryPolicy | 事件的重试策略。 这可用于配置事件的最大传递尝试次数和生存时间。 | RetryPolicy |
HybridConnectionEventSubscriptionDestination
| 名字 | 描述 | 价值 |
|---|---|---|
| endpointType | 事件订阅目标的终结点类型 | “HybridConnection”（必需） |
| 性能 | 事件订阅目标的混合连接属性 | HybridConnectionEventSubscriptionDestinationProperties |
HybridConnectionEventSubscriptionDestinationProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| resourceId | 作为事件订阅目标的混合连接的 Azure 资源 ID。 | 字符串 |
Microsoft.EventGrid/eventSubscriptions
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 资源名称 | string （必需） |
| parent_id | 要向其应用此扩展资源的资源的 ID。 | string （必需） |
| 性能 | 事件订阅的属性 | EventSubscriptionProperties |
| 类型 | 资源类型 | “Microsoft.EventGrid/eventSubscriptions@2019-01-01” |
RetryPolicy
| 名字 | 描述 | 价值 |
|---|---|---|
| eventTimeToLiveInMinutes | 事件生存时间（以分钟为单位）。 | int |
| maxDeliveryAttempts | 事件的最大传递重试尝试次数。 | int |
StorageBlobDeadLetterDestination
| 名字 | 描述 | 价值 |
|---|---|---|
| endpointType | 死信目标的终结点类型 | “StorageBlob”（必需） |
| 性能 | 基于存储 Blob 的死信目标的属性 | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| blobContainerName | 存储 Blob 容器的名称，该容器是死信事件的目标 | 字符串 |
| resourceId | 存储帐户的 Azure 资源 ID，该 ID 是死信事件的目标。 例如：/subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/microsoft。Storage/storageAccounts/{StorageAccountName} | 字符串 |
StorageQueueEventSubscriptionDestination
| 名字 | 描述 | 价值 |
|---|---|---|
| endpointType | 事件订阅目标的终结点类型 | “StorageQueue”（必需） |
| 性能 | 事件订阅目标的存储队列属性 | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| queueName | 作为事件订阅目标的存储帐户下的存储队列的名称。 | 字符串 |
| resourceId | 包含作为事件订阅目标的队列的存储帐户的 Azure 资源 ID。 | 字符串 |
WebHookEventSubscriptionDestination
| 名字 | 描述 | 价值 |
|---|---|---|
| endpointType | 事件订阅目标的终结点类型 | “WebHook”（必需） |
| 性能 | 事件订阅目标的 WebHook 属性 | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| endpointUrl | 表示事件订阅目标的终结点的 URL。 | 字符串 |