你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Microsoft.EventGrid systemTopics/eventSubscriptions 2021-06-01-preview
Bicep 资源定义
可以使用目标操作部署 systemTopics/eventSubscriptions 资源类型:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.EventGrid/systemTopics/eventSubscriptions 资源,请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.EventGrid/systemTopics/eventSubscriptions@2021-06-01-preview' = {
name: 'string'
parent: 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'
}
对于 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'
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'
]
属性值
systemTopics/eventSubscriptions
名字 | 描述 | 价值 |
---|---|---|
名字 | 资源名称 了解如何在 Bicep中设置子资源的名称和类型。 |
string (必需) |
父母 | 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。 有关详细信息,请参阅 父资源外部的子资源。 |
类型资源的符号名称:systemTopics |
性能 | 事件订阅的属性。 | EventSubscriptionProperties |
EventSubscriptionProperties
名字 | 描述 | 价值 |
---|---|---|
deadLetterDestination | 事件订阅的死信目标。 无法传递到其目标的任何事件都将发送到死信目标。 使用 Azure 事件网格的标识获取在传递/死信期间使用的身份验证令牌。 |
DeadLetterDestination |
deadLetterWithResourceIdentity | 事件订阅的死信目标。 无法传递到其目标的任何事件都将发送到死信目标。 使用父资源(即主题或域)上的托管标识设置来获取在传递/死信期间使用的身份验证令牌。 |
DeadLetterWithResourceIdentity |
deliveryWithResourceIdentity | 有关事件订阅必须传送事件的目标的信息。 使用父资源(即主题或域)上的托管标识设置来获取在传递/死信期间使用的身份验证令牌。 |
DeliveryWithResourceIdentity |
目的地 | 有关事件订阅必须传送事件的目标的信息。 使用 Azure 事件网格的标识获取在传递/死信期间使用的身份验证令牌。 |
EventSubscriptionDestination |
eventDeliverySchema | 事件订阅的事件传送架构。 | “CloudEventSchemaV1_0” “CustomInputSchema” “EventGridSchema” |
expirationTimeUtc | 事件订阅的过期时间。 | 字符串 |
滤波器 | 有关事件订阅筛选器的信息。 | EventSubscriptionFilter |
标签 | 用户定义的标签列表。 | string[] |
retryPolicy | 事件的重试策略。 这可用于配置事件的最大传递尝试次数和生存时间。 | RetryPolicy |
DeadLetterDestination
名字 | 描述 | 价值 |
---|---|---|
endpointType | 设置对象类型 | StorageBlob(必需) |
StorageBlobDeadLetterDestination
名字 | 描述 | 价值 |
---|---|---|
endpointType | 死信目标的终结点类型 | “StorageBlob”(必需) |
性能 | 基于存储 Blob 的死信目标的属性 | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
名字 | 描述 | 价值 |
---|---|---|
blobContainerName | 存储 Blob 容器的名称,该容器是死信事件的目标 | 字符串 |
resourceId | 存储帐户的 Azure 资源 ID,该 ID 是死信事件的目标 | 字符串 |
DeadLetterWithResourceIdentity
名字 | 描述 | 价值 |
---|---|---|
deadLetterDestination | 有关事件订阅必须传送事件的目标的信息。 使用父资源(即主题或域)上的托管标识设置来获取在传递/死信期间使用的身份验证令牌。 |
DeadLetterDestination |
身份 | 死信事件时要使用的标识。 | EventSubscriptionIdentity |
EventSubscriptionIdentity
名字 | 描述 | 价值 |
---|---|---|
类型 | 使用的托管标识的类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。 | “SystemAssigned” “UserAssigned” |
userAssignedIdentity | 与资源关联的用户标识。 | 字符串 |
DeliveryWithResourceIdentity
名字 | 描述 | 价值 |
---|---|---|
目的地 | 有关事件订阅必须传送事件的目标的信息。 使用 Azure 事件网格的标识获取在传递/死信期间使用的身份验证令牌。 |
EventSubscriptionDestination |
身份 | 传送事件时要使用的标识。 | EventSubscriptionIdentity |
EventSubscriptionDestination
名字 | 描述 | 价值 |
---|---|---|
endpointType | 设置对象类型 |
AzureFunction EventHub HybridConnection ServiceBusQueue ServiceBusTopic StorageQueue WebHook(必需) |
AzureFunctionEventSubscriptionDestination
名字 | 描述 | 价值 |
---|---|---|
endpointType | 事件订阅目标的终结点类型。 | “AzureFunction”(必需) |
性能 | 事件订阅目标的 Azure 函数属性。 | AzureFunctionEventSubscriptionDestinationProperties |
AzureFunctionEventSubscriptionDestinationProperties
名字 | 描述 | 价值 |
---|---|---|
deliveryAttributeMappings | 传递属性详细信息。 | DeliveryAttributeMapping[] |
maxEventsPerBatch | 每个批处理的最大事件数。 | int |
preferredBatchSizeInKilobytes | 首选批大小(以千字节为单位)。 | int |
resourceId | 表示事件订阅的 Azure Function 目标的终结点的 Azure 资源 ID。 | 字符串 |
DeliveryAttributeMapping
名字 | 描述 | 价值 |
---|---|---|
名字 | 传递属性或标头的名称。 | 字符串 |
类型 | 设置对象类型 |
动态 静态(必需) |
DynamicDeliveryAttributeMapping
名字 | 描述 | 价值 |
---|---|---|
类型 | 传递属性或标头名称的类型。 | “Dynamic”(必需) |
性能 | 动态传递属性映射的属性。 | DynamicDeliveryAttributeMappingProperties |
DynamicDeliveryAttributeMappingProperties
名字 | 描述 | 价值 |
---|---|---|
sourceField | 包含属性值的事件中的 JSON 路径。 | 字符串 |
StaticDeliveryAttributeMapping
名字 | 描述 | 价值 |
---|---|---|
类型 | 传递属性或标头名称的类型。 | “Static”(必需) |
性能 | 静态传递属性映射的属性。 | StaticDeliveryAttributeMappingProperties |
StaticDeliveryAttributeMappingProperties
名字 | 描述 | 价值 |
---|---|---|
isSecret | 指示属性是否包含敏感信息的布尔标志。 | bool |
价值 | 传递属性的值。 | 字符串 |
EventHubEventSubscriptionDestination
名字 | 描述 | 价值 |
---|---|---|
endpointType | 事件订阅目标的终结点类型。 | “EventHub”(必需) |
性能 | 事件订阅目标的事件中心属性。 | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
名字 | 描述 | 价值 |
---|---|---|
deliveryAttributeMappings | 传递属性详细信息。 | DeliveryAttributeMapping[] |
resourceId | 表示事件订阅的事件中心目标的终结点的 Azure 资源 ID。 | 字符串 |
HybridConnectionEventSubscriptionDestination
名字 | 描述 | 价值 |
---|---|---|
endpointType | 事件订阅目标的终结点类型。 | “HybridConnection”(必需) |
性能 | 事件订阅目标的混合连接属性。 | HybridConnectionEventSubscriptionDestinationProperti... |
HybridConnectionEventSubscriptionDestinationProperti...
名字 | 描述 | 价值 |
---|---|---|
deliveryAttributeMappings | 传递属性详细信息。 | DeliveryAttributeMapping[] |
resourceId | 作为事件订阅目标的混合连接的 Azure 资源 ID。 | 字符串 |
ServiceBusQueueEventSubscriptionDestination
名字 | 描述 | 价值 |
---|---|---|
endpointType | 事件订阅目标的终结点类型。 | “ServiceBusQueue”(必需) |
性能 | 事件订阅目标的服务总线属性。 | ServiceBusQueueEventSubscriptionDestinationPropertie... |
ServiceBusQueueEventSubscriptionDestinationPropertie...
名字 | 描述 | 价值 |
---|---|---|
deliveryAttributeMappings | 传递属性详细信息。 | DeliveryAttributeMapping[] |
resourceId | 表示事件订阅的服务总线目标的终结点的 Azure 资源 ID。 | 字符串 |
ServiceBusTopicEventSubscriptionDestination
名字 | 描述 | 价值 |
---|---|---|
endpointType | 事件订阅目标的终结点类型。 | “ServiceBusTopic”(必需) |
性能 | 事件订阅目标的服务总线主题属性。 | ServiceBusTopicEventSubscriptionDestinationPropertie... |
ServiceBusTopicEventSubscriptionDestinationPropertie...
名字 | 描述 | 价值 |
---|---|---|
deliveryAttributeMappings | 传递属性详细信息。 | DeliveryAttributeMapping[] |
resourceId | 表示事件订阅的服务总线主题目标的终结点的 Azure 资源 ID。 | 字符串 |
StorageQueueEventSubscriptionDestination
名字 | 描述 | 价值 |
---|---|---|
endpointType | 事件订阅目标的终结点类型。 | “StorageQueue”(必需) |
性能 | 事件订阅目标的存储队列属性。 | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
名字 | 描述 | 价值 |
---|---|---|
queueMessageTimeToLiveInSeconds | 存储队列消息生存时间(以秒为单位)。 | int |
queueName | 作为事件订阅目标的存储帐户下的存储队列的名称。 | 字符串 |
resourceId | 包含作为事件订阅目标的队列的存储帐户的 Azure 资源 ID。 | 字符串 |
WebHookEventSubscriptionDestination
名字 | 描述 | 价值 |
---|---|---|
endpointType | 事件订阅目标的终结点类型。 | “WebHook”(必需) |
性能 | 事件订阅目标的 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 | 一个可选字符串,用于根据资源路径前缀筛选事件订阅的事件。 此格式取决于事件的发布者。 此路径不支持通配符。 |
字符串 |
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”(必需) |
价值 | 布尔筛选器值。 | bool |
IsNotNullAdvancedFilter
名字 | 描述 | 价值 |
---|---|---|
operatorType | 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 | “IsNotNull”(必需) |
IsNullOrUndefinedAdvancedFilter
名字 | 描述 | 价值 |
---|---|---|
operatorType | 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 | “IsNullOrUndefined”(必需) |
NumberGreaterThanAdvancedFilter
名字 | 描述 | 价值 |
---|---|---|
operatorType | 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 | “NumberGreaterThan”(必需) |
价值 | 筛选器值。 | int |
NumberGreaterThanOrEqualsAdvancedFilter
名字 | 描述 | 价值 |
---|---|---|
operatorType | 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 | “NumberGreaterThanOrEquals”(必需) |
价值 | 筛选器值。 | int |
NumberInAdvancedFilter
名字 | 描述 | 价值 |
---|---|---|
operatorType | 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 | “NumberIn”(必需) |
值 | 筛选器值集。 | int[] |
NumberInRangeAdvancedFilter
名字 | 描述 | 价值 |
---|---|---|
operatorType | 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 | “NumberInRange”(必需) |
值 | 筛选器值集。 | int[][] |
NumberLessThanAdvancedFilter
名字 | 描述 | 价值 |
---|---|---|
operatorType | 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 | “NumberLessThan”(必需) |
价值 | 筛选器值。 | int |
NumberLessThanOrEqualsAdvancedFilter
名字 | 描述 | 价值 |
---|---|---|
operatorType | 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 | “NumberLessThanOrEquals”(必需) |
价值 | 筛选器值。 | 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 |
快速入门模板
以下快速入门模板部署此资源类型。
模板 | 描述 |
---|---|
创建 Blob 存储和事件网格订阅到 Blob |
创建 Azure Blob 存储帐户,然后创建该 Blob 的事件网格订阅。 |
使用事件网格连接部署 Azure 数据资源管理器数据库 |
使用事件网格连接部署 Azure 数据资源管理器数据库。 |
ARM 模板资源定义
可以使用目标操作部署 systemTopics/eventSubscriptions 资源类型:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.EventGrid/systemTopics/eventSubscriptions 资源,请将以下 JSON 添加到模板。
{
"type": "Microsoft.EventGrid/systemTopics/eventSubscriptions",
"apiVersion": "2021-06-01-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"
}
对于 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",
"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" ]
属性值
systemTopics/eventSubscriptions
名字 | 描述 | 价值 |
---|---|---|
类型 | 资源类型 | “Microsoft.EventGrid/systemTopics/eventSubscriptions” |
apiVersion | 资源 API 版本 | '2021-06-01-preview' |
名字 | 资源名称 了解如何在 JSON ARM 模板中设置子资源的名称和类型。 |
string (必需) |
性能 | 事件订阅的属性。 | EventSubscriptionProperties |
EventSubscriptionProperties
名字 | 描述 | 价值 |
---|---|---|
deadLetterDestination | 事件订阅的死信目标。 无法传递到其目标的任何事件都将发送到死信目标。 使用 Azure 事件网格的标识获取在传递/死信期间使用的身份验证令牌。 |
DeadLetterDestination |
deadLetterWithResourceIdentity | 事件订阅的死信目标。 无法传递到其目标的任何事件都将发送到死信目标。 使用父资源(即主题或域)上的托管标识设置来获取在传递/死信期间使用的身份验证令牌。 |
DeadLetterWithResourceIdentity |
deliveryWithResourceIdentity | 有关事件订阅必须传送事件的目标的信息。 使用父资源(即主题或域)上的托管标识设置来获取在传递/死信期间使用的身份验证令牌。 |
DeliveryWithResourceIdentity |
目的地 | 有关事件订阅必须传送事件的目标的信息。 使用 Azure 事件网格的标识获取在传递/死信期间使用的身份验证令牌。 |
EventSubscriptionDestination |
eventDeliverySchema | 事件订阅的事件传送架构。 | “CloudEventSchemaV1_0” “CustomInputSchema” “EventGridSchema” |
expirationTimeUtc | 事件订阅的过期时间。 | 字符串 |
滤波器 | 有关事件订阅筛选器的信息。 | EventSubscriptionFilter |
标签 | 用户定义的标签列表。 | string[] |
retryPolicy | 事件的重试策略。 这可用于配置事件的最大传递尝试次数和生存时间。 | RetryPolicy |
DeadLetterDestination
名字 | 描述 | 价值 |
---|---|---|
endpointType | 设置对象类型 | StorageBlob(必需) |
StorageBlobDeadLetterDestination
名字 | 描述 | 价值 |
---|---|---|
endpointType | 死信目标的终结点类型 | “StorageBlob”(必需) |
性能 | 基于存储 Blob 的死信目标的属性 | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
名字 | 描述 | 价值 |
---|---|---|
blobContainerName | 存储 Blob 容器的名称,该容器是死信事件的目标 | 字符串 |
resourceId | 存储帐户的 Azure 资源 ID,该 ID 是死信事件的目标 | 字符串 |
DeadLetterWithResourceIdentity
名字 | 描述 | 价值 |
---|---|---|
deadLetterDestination | 有关事件订阅必须传送事件的目标的信息。 使用父资源(即主题或域)上的托管标识设置来获取在传递/死信期间使用的身份验证令牌。 |
DeadLetterDestination |
身份 | 死信事件时要使用的标识。 | EventSubscriptionIdentity |
EventSubscriptionIdentity
名字 | 描述 | 价值 |
---|---|---|
类型 | 使用的托管标识的类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。 | “SystemAssigned” “UserAssigned” |
userAssignedIdentity | 与资源关联的用户标识。 | 字符串 |
DeliveryWithResourceIdentity
名字 | 描述 | 价值 |
---|---|---|
目的地 | 有关事件订阅必须传送事件的目标的信息。 使用 Azure 事件网格的标识获取在传递/死信期间使用的身份验证令牌。 |
EventSubscriptionDestination |
身份 | 传送事件时要使用的标识。 | EventSubscriptionIdentity |
EventSubscriptionDestination
名字 | 描述 | 价值 |
---|---|---|
endpointType | 设置对象类型 |
AzureFunction EventHub HybridConnection ServiceBusQueue ServiceBusTopic StorageQueue WebHook(必需) |
AzureFunctionEventSubscriptionDestination
名字 | 描述 | 价值 |
---|---|---|
endpointType | 事件订阅目标的终结点类型。 | “AzureFunction”(必需) |
性能 | 事件订阅目标的 Azure 函数属性。 | AzureFunctionEventSubscriptionDestinationProperties |
AzureFunctionEventSubscriptionDestinationProperties
名字 | 描述 | 价值 |
---|---|---|
deliveryAttributeMappings | 传递属性详细信息。 | DeliveryAttributeMapping[] |
maxEventsPerBatch | 每个批处理的最大事件数。 | int |
preferredBatchSizeInKilobytes | 首选批大小(以千字节为单位)。 | int |
resourceId | 表示事件订阅的 Azure Function 目标的终结点的 Azure 资源 ID。 | 字符串 |
DeliveryAttributeMapping
名字 | 描述 | 价值 |
---|---|---|
名字 | 传递属性或标头的名称。 | 字符串 |
类型 | 设置对象类型 |
动态 静态(必需) |
DynamicDeliveryAttributeMapping
名字 | 描述 | 价值 |
---|---|---|
类型 | 传递属性或标头名称的类型。 | “Dynamic”(必需) |
性能 | 动态传递属性映射的属性。 | DynamicDeliveryAttributeMappingProperties |
DynamicDeliveryAttributeMappingProperties
名字 | 描述 | 价值 |
---|---|---|
sourceField | 包含属性值的事件中的 JSON 路径。 | 字符串 |
StaticDeliveryAttributeMapping
名字 | 描述 | 价值 |
---|---|---|
类型 | 传递属性或标头名称的类型。 | “Static”(必需) |
性能 | 静态传递属性映射的属性。 | StaticDeliveryAttributeMappingProperties |
StaticDeliveryAttributeMappingProperties
名字 | 描述 | 价值 |
---|---|---|
isSecret | 指示属性是否包含敏感信息的布尔标志。 | bool |
价值 | 传递属性的值。 | 字符串 |
EventHubEventSubscriptionDestination
名字 | 描述 | 价值 |
---|---|---|
endpointType | 事件订阅目标的终结点类型。 | “EventHub”(必需) |
性能 | 事件订阅目标的事件中心属性。 | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
名字 | 描述 | 价值 |
---|---|---|
deliveryAttributeMappings | 传递属性详细信息。 | DeliveryAttributeMapping[] |
resourceId | 表示事件订阅的事件中心目标的终结点的 Azure 资源 ID。 | 字符串 |
HybridConnectionEventSubscriptionDestination
名字 | 描述 | 价值 |
---|---|---|
endpointType | 事件订阅目标的终结点类型。 | “HybridConnection”(必需) |
性能 | 事件订阅目标的混合连接属性。 | HybridConnectionEventSubscriptionDestinationProperti... |
HybridConnectionEventSubscriptionDestinationProperti...
名字 | 描述 | 价值 |
---|---|---|
deliveryAttributeMappings | 传递属性详细信息。 | DeliveryAttributeMapping[] |
resourceId | 作为事件订阅目标的混合连接的 Azure 资源 ID。 | 字符串 |
ServiceBusQueueEventSubscriptionDestination
名字 | 描述 | 价值 |
---|---|---|
endpointType | 事件订阅目标的终结点类型。 | “ServiceBusQueue”(必需) |
性能 | 事件订阅目标的服务总线属性。 | ServiceBusQueueEventSubscriptionDestinationPropertie... |
ServiceBusQueueEventSubscriptionDestinationPropertie...
名字 | 描述 | 价值 |
---|---|---|
deliveryAttributeMappings | 传递属性详细信息。 | DeliveryAttributeMapping[] |
resourceId | 表示事件订阅的服务总线目标的终结点的 Azure 资源 ID。 | 字符串 |
ServiceBusTopicEventSubscriptionDestination
名字 | 描述 | 价值 |
---|---|---|
endpointType | 事件订阅目标的终结点类型。 | “ServiceBusTopic”(必需) |
性能 | 事件订阅目标的服务总线主题属性。 | ServiceBusTopicEventSubscriptionDestinationPropertie... |
ServiceBusTopicEventSubscriptionDestinationPropertie...
名字 | 描述 | 价值 |
---|---|---|
deliveryAttributeMappings | 传递属性详细信息。 | DeliveryAttributeMapping[] |
resourceId | 表示事件订阅的服务总线主题目标的终结点的 Azure 资源 ID。 | 字符串 |
StorageQueueEventSubscriptionDestination
名字 | 描述 | 价值 |
---|---|---|
endpointType | 事件订阅目标的终结点类型。 | “StorageQueue”(必需) |
性能 | 事件订阅目标的存储队列属性。 | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
名字 | 描述 | 价值 |
---|---|---|
queueMessageTimeToLiveInSeconds | 存储队列消息生存时间(以秒为单位)。 | int |
queueName | 作为事件订阅目标的存储帐户下的存储队列的名称。 | 字符串 |
resourceId | 包含作为事件订阅目标的队列的存储帐户的 Azure 资源 ID。 | 字符串 |
WebHookEventSubscriptionDestination
名字 | 描述 | 价值 |
---|---|---|
endpointType | 事件订阅目标的终结点类型。 | “WebHook”(必需) |
性能 | 事件订阅目标的 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 | 一个可选字符串,用于根据资源路径前缀筛选事件订阅的事件。 此格式取决于事件的发布者。 此路径不支持通配符。 |
字符串 |
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”(必需) |
价值 | 布尔筛选器值。 | bool |
IsNotNullAdvancedFilter
名字 | 描述 | 价值 |
---|---|---|
operatorType | 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 | “IsNotNull”(必需) |
IsNullOrUndefinedAdvancedFilter
名字 | 描述 | 价值 |
---|---|---|
operatorType | 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 | “IsNullOrUndefined”(必需) |
NumberGreaterThanAdvancedFilter
名字 | 描述 | 价值 |
---|---|---|
operatorType | 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 | “NumberGreaterThan”(必需) |
价值 | 筛选器值。 | int |
NumberGreaterThanOrEqualsAdvancedFilter
名字 | 描述 | 价值 |
---|---|---|
operatorType | 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 | “NumberGreaterThanOrEquals”(必需) |
价值 | 筛选器值。 | int |
NumberInAdvancedFilter
名字 | 描述 | 价值 |
---|---|---|
operatorType | 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 | “NumberIn”(必需) |
值 | 筛选器值集。 | int[] |
NumberInRangeAdvancedFilter
名字 | 描述 | 价值 |
---|---|---|
operatorType | 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 | “NumberInRange”(必需) |
值 | 筛选器值集。 | int[][] |
NumberLessThanAdvancedFilter
名字 | 描述 | 价值 |
---|---|---|
operatorType | 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 | “NumberLessThan”(必需) |
价值 | 筛选器值。 | int |
NumberLessThanOrEqualsAdvancedFilter
名字 | 描述 | 价值 |
---|---|---|
operatorType | 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 | “NumberLessThanOrEquals”(必需) |
价值 | 筛选器值。 | 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 |
快速入门模板
以下快速入门模板部署此资源类型。
模板 | 描述 |
---|---|
创建 Blob 存储和事件网格订阅到 Blob |
创建 Azure Blob 存储帐户,然后创建该 Blob 的事件网格订阅。 |
使用事件网格连接部署 Azure 数据资源管理器数据库 |
使用事件网格连接部署 Azure 数据资源管理器数据库。 |
Terraform (AzAPI 提供程序)资源定义
可以使用目标操作部署 systemTopics/eventSubscriptions 资源类型:
- 资源组
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.EventGrid/systemTopics/eventSubscriptions 资源,请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventGrid/systemTopics/eventSubscriptions@2021-06-01-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"
}
对于 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"
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"
]
属性值
systemTopics/eventSubscriptions
名字 | 描述 | 价值 |
---|---|---|
类型 | 资源类型 | “Microsoft.EventGrid/systemTopics/eventSubscriptions@2021-06-01-preview” |
名字 | 资源名称 | string (必需) |
parent_id | 此资源的父资源的 ID。 | 类型资源的 ID:systemTopics |
性能 | 事件订阅的属性。 | EventSubscriptionProperties |
EventSubscriptionProperties
名字 | 描述 | 价值 |
---|---|---|
deadLetterDestination | 事件订阅的死信目标。 无法传递到其目标的任何事件都将发送到死信目标。 使用 Azure 事件网格的标识获取在传递/死信期间使用的身份验证令牌。 |
DeadLetterDestination |
deadLetterWithResourceIdentity | 事件订阅的死信目标。 无法传递到其目标的任何事件都将发送到死信目标。 使用父资源(即主题或域)上的托管标识设置来获取在传递/死信期间使用的身份验证令牌。 |
DeadLetterWithResourceIdentity |
deliveryWithResourceIdentity | 有关事件订阅必须传送事件的目标的信息。 使用父资源(即主题或域)上的托管标识设置来获取在传递/死信期间使用的身份验证令牌。 |
DeliveryWithResourceIdentity |
目的地 | 有关事件订阅必须传送事件的目标的信息。 使用 Azure 事件网格的标识获取在传递/死信期间使用的身份验证令牌。 |
EventSubscriptionDestination |
eventDeliverySchema | 事件订阅的事件传送架构。 | “CloudEventSchemaV1_0” “CustomInputSchema” “EventGridSchema” |
expirationTimeUtc | 事件订阅的过期时间。 | 字符串 |
滤波器 | 有关事件订阅筛选器的信息。 | EventSubscriptionFilter |
标签 | 用户定义的标签列表。 | string[] |
retryPolicy | 事件的重试策略。 这可用于配置事件的最大传递尝试次数和生存时间。 | RetryPolicy |
DeadLetterDestination
名字 | 描述 | 价值 |
---|---|---|
endpointType | 设置对象类型 | StorageBlob(必需) |
StorageBlobDeadLetterDestination
名字 | 描述 | 价值 |
---|---|---|
endpointType | 死信目标的终结点类型 | “StorageBlob”(必需) |
性能 | 基于存储 Blob 的死信目标的属性 | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
名字 | 描述 | 价值 |
---|---|---|
blobContainerName | 存储 Blob 容器的名称,该容器是死信事件的目标 | 字符串 |
resourceId | 存储帐户的 Azure 资源 ID,该 ID 是死信事件的目标 | 字符串 |
DeadLetterWithResourceIdentity
名字 | 描述 | 价值 |
---|---|---|
deadLetterDestination | 有关事件订阅必须传送事件的目标的信息。 使用父资源(即主题或域)上的托管标识设置来获取在传递/死信期间使用的身份验证令牌。 |
DeadLetterDestination |
身份 | 死信事件时要使用的标识。 | EventSubscriptionIdentity |
EventSubscriptionIdentity
名字 | 描述 | 价值 |
---|---|---|
类型 | 使用的托管标识的类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。 | “SystemAssigned” “UserAssigned” |
userAssignedIdentity | 与资源关联的用户标识。 | 字符串 |
DeliveryWithResourceIdentity
名字 | 描述 | 价值 |
---|---|---|
目的地 | 有关事件订阅必须传送事件的目标的信息。 使用 Azure 事件网格的标识获取在传递/死信期间使用的身份验证令牌。 |
EventSubscriptionDestination |
身份 | 传送事件时要使用的标识。 | EventSubscriptionIdentity |
EventSubscriptionDestination
名字 | 描述 | 价值 |
---|---|---|
endpointType | 设置对象类型 |
AzureFunction EventHub HybridConnection ServiceBusQueue ServiceBusTopic StorageQueue WebHook(必需) |
AzureFunctionEventSubscriptionDestination
名字 | 描述 | 价值 |
---|---|---|
endpointType | 事件订阅目标的终结点类型。 | “AzureFunction”(必需) |
性能 | 事件订阅目标的 Azure 函数属性。 | AzureFunctionEventSubscriptionDestinationProperties |
AzureFunctionEventSubscriptionDestinationProperties
名字 | 描述 | 价值 |
---|---|---|
deliveryAttributeMappings | 传递属性详细信息。 | DeliveryAttributeMapping[] |
maxEventsPerBatch | 每个批处理的最大事件数。 | int |
preferredBatchSizeInKilobytes | 首选批大小(以千字节为单位)。 | int |
resourceId | 表示事件订阅的 Azure Function 目标的终结点的 Azure 资源 ID。 | 字符串 |
DeliveryAttributeMapping
名字 | 描述 | 价值 |
---|---|---|
名字 | 传递属性或标头的名称。 | 字符串 |
类型 | 设置对象类型 |
动态 静态(必需) |
DynamicDeliveryAttributeMapping
名字 | 描述 | 价值 |
---|---|---|
类型 | 传递属性或标头名称的类型。 | “动态”(必需) |
性能 | 动态传递属性映射的属性。 | DynamicDeliveryAttributeMappingProperties |
DynamicDeliveryAttributeMappingProperties
名字 | 描述 | 价值 |
---|---|---|
sourceField | 包含属性值的事件中的 JSON 路径。 | 字符串 |
StaticDeliveryAttributeMapping
名字 | 描述 | 价值 |
---|---|---|
类型 | 传递属性或标头名称的类型。 | “静态”(必需) |
性能 | 静态传递属性映射的属性。 | StaticDeliveryAttributeMappingProperties |
StaticDeliveryAttributeMappingProperties
名字 | 描述 | 价值 |
---|---|---|
isSecret | 指示属性是否包含敏感信息的布尔标志。 | bool |
价值 | 传递属性的值。 | 字符串 |
EventHubEventSubscriptionDestination
名字 | 描述 | 价值 |
---|---|---|
endpointType | 事件订阅目标的终结点类型。 | “EventHub”(必需) |
性能 | 事件订阅目标的事件中心属性。 | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
名字 | 描述 | 价值 |
---|---|---|
deliveryAttributeMappings | 传递属性详细信息。 | DeliveryAttributeMapping[] |
resourceId | 表示事件订阅的事件中心目标的终结点的 Azure 资源 ID。 | 字符串 |
HybridConnectionEventSubscriptionDestination
名字 | 描述 | 价值 |
---|---|---|
endpointType | 事件订阅目标的终结点类型。 | “HybridConnection”(必需) |
性能 | 事件订阅目标的混合连接属性。 | HybridConnectionEventSubscriptionDestinationProperti... |
HybridConnectionEventSubscriptionDestinationProperti...
名字 | 描述 | 价值 |
---|---|---|
deliveryAttributeMappings | 传递属性详细信息。 | DeliveryAttributeMapping[] |
resourceId | 作为事件订阅目标的混合连接的 Azure 资源 ID。 | 字符串 |
ServiceBusQueueEventSubscriptionDestination
名字 | 描述 | 价值 |
---|---|---|
endpointType | 事件订阅目标的终结点类型。 | “ServiceBusQueue” (必需) |
性能 | 事件订阅目标的服务总线属性。 | ServiceBusQueueEventSubscriptionDestinationPropertie... |
ServiceBusQueueEventSubscriptionDestinationPropertie...
名字 | 描述 | 价值 |
---|---|---|
deliveryAttributeMappings | 传递属性详细信息。 | DeliveryAttributeMapping[] |
resourceId | 表示事件订阅的服务总线目标的终结点的 Azure 资源 ID。 | 字符串 |
ServiceBusTopicEventSubscriptionDestination
名字 | 描述 | 价值 |
---|---|---|
endpointType | 事件订阅目标的终结点类型。 | “ServiceBusTopic” (必需) |
性能 | 事件订阅目标的服务总线主题属性。 | ServiceBusTopicEventSubscriptionDestinationPropertie... |
ServiceBusTopicEventSubscriptionDestinationPropertie...
名字 | 描述 | 价值 |
---|---|---|
deliveryAttributeMappings | 传递属性详细信息。 | DeliveryAttributeMapping[] |
resourceId | 表示事件订阅的服务总线主题目标的终结点的 Azure 资源 ID。 | 字符串 |
StorageQueueEventSubscriptionDestination
名字 | 描述 | 价值 |
---|---|---|
endpointType | 事件订阅目标的终结点类型。 | “StorageQueue”(必需) |
性能 | 事件订阅目标的存储队列属性。 | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
名字 | 描述 | 价值 |
---|---|---|
queueMessageTimeToLiveInSeconds | 存储队列消息生存时间(以秒为单位)。 | int |
queueName | 作为事件订阅目标的存储帐户下的存储队列的名称。 | 字符串 |
resourceId | 包含作为事件订阅目标的队列的存储帐户的 Azure 资源 ID。 | 字符串 |
WebHookEventSubscriptionDestination
名字 | 描述 | 价值 |
---|---|---|
endpointType | 事件订阅目标的终结点类型。 | “WebHook”(必需) |
性能 | 事件订阅目标的 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 | 一个可选字符串,用于根据资源路径前缀筛选事件订阅的事件。 此格式取决于事件的发布者。 此路径不支持通配符。 |
字符串 |
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” (必需) |
价值 | 布尔筛选器值。 | bool |
IsNotNullAdvancedFilter
名字 | 描述 | 价值 |
---|---|---|
operatorType | 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 | “IsNotNull”(必需) |
IsNullOrUndefinedAdvancedFilter
名字 | 描述 | 价值 |
---|---|---|
operatorType | 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 | “IsNullOrUndefined”(必需) |
NumberGreaterThanAdvancedFilter
名字 | 描述 | 价值 |
---|---|---|
operatorType | 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 | “NumberGreaterThan”(必需) |
价值 | 筛选器值。 | int |
NumberGreaterThanOrEqualsAdvancedFilter
名字 | 描述 | 价值 |
---|---|---|
operatorType | 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 | “NumberGreaterThanOrEquals” (必需) |
价值 | 筛选器值。 | int |
NumberInAdvancedFilter
名字 | 描述 | 价值 |
---|---|---|
operatorType | 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 | “NumberIn”(必需) |
值 | 筛选器值集。 | int[] |
NumberInRangeAdvancedFilter
名字 | 描述 | 价值 |
---|---|---|
operatorType | 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 | “NumberInRange”(必需) |
值 | 筛选器值集。 | int[][] |
NumberLessThanAdvancedFilter
名字 | 描述 | 价值 |
---|---|---|
operatorType | 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 | “NumberLessThan”(必需) |
价值 | 筛选器值。 | int |
NumberLessThanOrEqualsAdvancedFilter
名字 | 描述 | 价值 |
---|---|---|
operatorType | 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 | “NumberLessThanOrEquals”(必需) |
价值 | 筛选器值。 | 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 |