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

Microsoft.EventGrid eventSubscriptions

项目
12/17/2024

Bicep 资源定义

可以使用目标操作部署 eventSubscriptions 资源类型：

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

资源格式

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

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2024-12-15-preview' = {
  scope: resourceSymbolicName or scope
  name: 'string'
  properties: {
    deadLetterDestination: {
      endpointType: 'string'
      // For remaining properties, see DeadLetterDestination objects
    }
    deadLetterWithResourceIdentity: {
      deadLetterDestination: {
        endpointType: 'string'
        // For remaining properties, see DeadLetterDestination objects
      }
      identity: {
        federatedIdentityCredentialInfo: {
          federatedClientId: 'string'
        }
        type: 'string'
        userAssignedIdentity: 'string'
      }
    }
    deliveryWithResourceIdentity: {
      destination: {
        endpointType: 'string'
        // For remaining properties, see EventSubscriptionDestination objects
      }
      identity: {
        federatedIdentityCredentialInfo: {
          federatedClientId: 'string'
        }
        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'
  }
}

DeliveryAttributeMapping 对象

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

对于动态，请使用：

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

对于静态，请使用：

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

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

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

对于 MonitorAlert，请使用：

{
  endpointType: 'MonitorAlert'
  properties: {
    actionGroups: [
      'string'
    ]
    description: 'string'
    severity: 'string'
  }
}

对于 NamespaceTopic，请使用：

{
  endpointType: 'NamespaceTopic'
  properties: {
    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
    minimumTlsVersionAllowed: 'string'
    preferredBatchSizeInKilobytes: int
  }
}

属性值

AdvancedFilter

名字	描述	价值
钥匙	要根据要筛选的事件中的字段/属性。	字符串
operatorType	对于 type BoolEqualsAdvancedFilter，设置为“BoolEquals”。对于类型 IsNotNullAdvancedFilter，设置为“IsNotNull”。对于类型 IsNullOrUndefinedAdvancedFilter，设置为“IsNullOrUndefined”。对于 type NumberGreaterThanAdvancedFilter，设置为“NumberGreaterThan”。对于 type NumberGreaterThanOrEqualsAdvancedFilter，设置为“NumberGreaterThanOrEquals”。对于 type NumberInAdvancedFilter，设置为“NumberIn”。对于 type NumberInRangeAdvancedFilter，设置为“NumberInRange”。对于 type NumberLessThanAdvancedFilter，设置为“NumberLessThan”。对于 type NumberLessThanOrEqualsAdvancedFilter，设置为“NumberLessThanOrEquals”。对于 type NumberNotInAdvancedFilter，设置为“NumberNotIn”。对于 type NumberNotInRangeAdvancedFilter，设置为“NumberNotInRange”。对于 type StringBeginsWithAdvancedFilter，设置为“StringBeginsWith”。对于 stringContainsAdvancedFilter，请设置为 “StringContains”类型。对于 type StringEndsWithAdvancedFilter，设置为“StringEndsWith”。对于 type StringInAdvancedFilter，设置为“StringIn”。对于 type StringNotBeginsWithAdvancedFilter，设置为“StringNotBeginsWith”。对于 type StringNotContainsAdvancedFilter，设置为“StringNotContains”。对于 stringNotEndsWith 类型，设置为“StringNotEndsWithAdvancedFilter”。对于 stringNotInAdvancedFilter类型，请设置为“StringNotIn”。	“BoolEquals” “IsNotNull” “IsNullOrUndefined” “NumberGreaterThan” “NumberGreaterThanOrEquals” “NumberIn” “NumberInRange” “NumberLessThan” “NumberLessThanOrEquals” “NumberNotIn” “NumberNotInRange” “StringBeginsWith” “StringContains” “StringEndsWith” “StringIn” “StringNotBeginsWith” “StringNotContains” “StringNotEndsWith” “StringNotIn”（必需）

AzureFunctionEventSubscriptionDestination

名字	描述	价值
endpointType	事件订阅目标的终结点类型。	“AzureFunction”（必需）
性能	事件订阅目标的 Azure 函数属性。	AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

名字	描述	价值
deliveryAttributeMappings	传递属性详细信息。	DeliveryAttributeMapping[]
maxEventsPerBatch	每个批处理的最大事件数。	int
preferredBatchSizeInKilobytes	首选批大小（以千字节为单位）。	int
resourceId	表示事件订阅的 Azure Function 目标的终结点的 Azure 资源 ID。	字符串

BoolEqualsAdvancedFilter

名字	描述	价值
operatorType	用于筛选的运算符类型，例如 NumberIn、StringContains、BoolEquals 等。	“BoolEquals”（必需）
价值	布尔筛选器值。	bool

DeadLetterDestination

名字	描述	价值
endpointType	对于 StorageBlobDeadLetterDestination，请设置为“StorageBlob”。	“StorageBlob”（必需）

DeadLetterWithResourceIdentity

名字	描述	价值
deadLetterDestination	有关事件订阅必须传送事件的目标的信息。使用父资源（即主题或域）上的托管标识设置来获取死信期间使用的身份验证令牌。	DeadLetterDestination
身份	死信事件时要使用的标识。	EventSubscriptionIdentity

DeliveryAttributeMapping

名字	描述	价值
名字	传递属性或标头的名称。	字符串
类型	对于 DynamicDeliveryAttributeMapping，请设置为“Dynamic”。对于 type StaticDeliveryAttributeMapping，设置为“Static Static”。	“Dynamic” “Static”（必需）

DeliveryWithResourceIdentity

名字	描述	价值
目的地	有关事件订阅必须传送事件的目标的信息。使用父资源（即主题或域）上的托管标识设置来获取在传递期间使用的身份验证令牌。	EventSubscriptionDestination
身份	传送事件时要使用的标识。	EventSubscriptionIdentity

DynamicDeliveryAttributeMapping

名字	描述	价值
性能	动态传递属性映射的属性。	DynamicDeliveryAttributeMappingProperties
类型	传递属性或标头名称的类型。	“Dynamic”（必需）

DynamicDeliveryAttributeMappingProperties

名字	描述	价值
sourceField	包含属性值的事件中的 JSON 路径。	字符串

EventHubEventSubscriptionDestination

名字	描述	价值
endpointType	事件订阅目标的终结点类型。	“EventHub”（必需）
性能	事件订阅目标的事件中心属性。	EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

名字	描述	价值
deliveryAttributeMappings	传递属性详细信息。	DeliveryAttributeMapping[]
resourceId	表示事件订阅的事件中心目标的终结点的 Azure 资源 ID。	字符串

EventSubscriptionDestination

名字	描述	价值
endpointType	对于 AzureFunctionEventSubscriptionDestination类型，设置为“AzureFunction”。设置为 EventHubEventSubscriptionDestination类型的“EventHub”。对于 HybridConnectionEventSubscriptionDestination，请设置为“HybridConnection”。对于 MonitorAlertEventSubscriptionDestination，请设置为“MonitorAlert”。对于 NamespaceTopicEventSubscriptionDestination，请设置为“NamespaceTopic”。对于 partnerEventSubscriptionDestination类型，设置为“PartnerDestination”。对于 ServiceBusQueueEventSubscriptionDestination，请设置为“ServiceBusQueue”。对于 ServiceBusTopicEventSubscriptionDestination，请设置为“ServiceBusTopic”。对于 type StorageQueueEventSubscriptionDestination，设置为“StorageQueue”。对于 WebHookEventSubscriptionDestination，请设置为“WebHook”。	“AzureFunction” “EventHub” “HybridConnection” “MonitorAlert” “NamespaceTopic” “PartnerDestination” “ServiceBusQueue” “ServiceBusTopic” “StorageQueue” “WebHook”（必需）

EventSubscriptionFilter

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

EventSubscriptionIdentity

名字	描述	价值
federatedIdentityCredentialInfo	用于资源传递的联合标识凭据（FIC）的详细信息。	FederatedIdentityCredentialInfo
类型	使用的托管标识的类型。可以是“SystemAssigned”或“UserAssigned”。	“SystemAssigned” “UserAssigned”
userAssignedIdentity	与资源关联的用户标识。	字符串

EventSubscriptionProperties

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

FederatedIdentityCredentialInfo

名字	描述	价值
federatedClientId	与联合标识凭据（FIC）关联的多租户 AAD 应用程序。	字符串约束：最小长度 = 36 最大长度 = 36 模式 = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$` （必需）

HybridConnectionEventSubscriptionDestination

名字	描述	价值
endpointType	事件订阅目标的终结点类型。	“HybridConnection”（必需）
性能	事件订阅目标的混合连接属性。	HybridConnectionEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestinationProperties

名字	描述	价值
deliveryAttributeMappings	传递属性详细信息。	DeliveryAttributeMapping[]
resourceId	作为事件订阅目标的混合连接的 Azure 资源 ID。	字符串

IsNotNullAdvancedFilter

名字	描述	价值
operatorType	用于筛选的运算符类型，例如 NumberIn、StringContains、BoolEquals 等。	“IsNotNull”（必需）

IsNullOrUndefinedAdvancedFilter

名字	描述	价值
operatorType	用于筛选的运算符类型，例如 NumberIn、StringContains、BoolEquals 等。	“IsNullOrUndefined”（必需）