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

Microsoft.EventGrid 命名空间/topics/eventSubscriptions 2023-06-01-preview

Bicep 资源定义

可以使用目标操作部署命名空间/topics/eventSubscriptions 资源类型:

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

资源格式

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

resource symbolicname 'Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2023-06-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    deliveryConfiguration: {
      deliveryMode: 'string'
      queue: {
        deadLetterDestinationWithResourceIdentity: {
          deadLetterDestination: {
            endpointType: 'string'
            // For remaining properties, see DeadLetterDestination objects
          }
          identity: {
            type: 'string'
            userAssignedIdentity: 'string'
          }
        }
        eventTimeToLive: 'string'
        maxDeliveryCount: int
        receiveLockDurationInSeconds: int
      }
    }
    eventDeliverySchema: 'string'
    filtersConfiguration: {
      filters: [
        {
          key: 'string'
          operatorType: 'string'
          // For remaining properties, see Filter objects
        }
      ]
      includedEventTypes: [
        'string'
      ]
    }
  }
}

DeadLetterDestination 对象

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

对于 StorageBlob,请使用:

{
  endpointType: 'StorageBlob'
  properties: {
    blobContainerName: 'string'
    resourceId: 'string'
  }
}

筛选对象

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

属性值

BoolEqualsFilter

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

DeadLetterDestination

名字 描述 价值
endpointType 对于 StorageBlobDeadLetterDestination,请设置为“StorageBlob”。 “StorageBlob”(必需)

DeadLetterWithResourceIdentity

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

DeliveryConfiguration

名字 描述 价值
deliveryMode 事件订阅的传递模式。 “Queue”
队列 当 deliveryMode 为队列并表示有关队列订阅的信息时,应填充此属性。 QueueInfo

EventSubscriptionIdentity

名字 描述 价值
类型 使用的托管标识的类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。 “SystemAssigned”
“UserAssigned”
userAssignedIdentity 与资源关联的用户标识。 字符串

滤波器

名字 描述 价值
钥匙 要根据要筛选的事件中的字段/属性。 字符串
operatorType 对于 BoolEqualsFilter类型,设置为“BoolEquals”。 对于 IsNotNullFilter类型,设置为“IsNotNull”。 对于类型 IsNullOrUndefinedFilter,设置为“IsNullOrUndefined”。 对于 type NumberGreaterThanFilter,设置为“NumberGreaterThan”。 对于 type NumberGreaterThanOrEqualsFilter,设置为“NumberGreaterThanOrEquals”。 设置为 type NumberInFilter的“NumberIn”。 对于 type NumberInRangeFilter,设置为“NumberInRange”。 对于 type NumberLessThanFilter,设置为“NumberLessThanThan”。 对于 type NumberLessThanOrEqualsFilter,设置为“NumberLessThanOrEquals”。 对于 type NumberNotInFilter,设置为“NumberNotIn”。 对于 type NumberNotInRangeFilter,设置为“NumberNotInRange”。 对于 stringBeginsWithfilter,type 设置为“StringBeginsWith”。 对于 stringContainsFilter类型,设置为“StringContains”。 对于 stringEndsWithFilter类型,请设置为“StringEndsWith”。 对于 stringInFilter 类型,设置为“StringIn”。 对于 type StringNotBeginsWithFilter,设置为“StringNotBeginsWith”。 对于 stringNotContainsFilter,请设置为 type StringNotContainsFilter 。 对于 type StringNotEndsWithFilter,设置为“StringNotEndsWith”。 对于 stringNotInFilter类型,设置为 “StringNotIn” 类型。 “BoolEquals”
“IsNotNull”
“IsNullOrUndefined”
“NumberGreaterThan”
“NumberGreaterThanOrEquals”
“NumberIn”
“NumberInRange”
“NumberLessThan”
“NumberLessThanOrEquals”
“NumberNotIn”
“NumberNotInRange”
“StringBeginsWith”
“StringContains”
“StringEndsWith”
“StringIn”
“StringNotBeginsWith”
“StringNotContains”
“StringNotEndsWith”
“StringNotIn”(必需)

FiltersConfiguration

名字 描述 价值
过滤 器 用于筛选事件订阅的筛选器数组。 筛选器[]
includedEventTypes 需要属于事件订阅的适用事件类型的列表。 如果需要订阅所有默认事件类型,请将 IncludedEventTypes 设置为 null。 string[]

IsNotNullFilter

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

IsNullOrUndefinedFilter

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

Microsoft.EventGrid/namespaces/topics/eventSubscriptions

名字 描述 价值
名字 资源名称 字符串

约束:
最小长度 = 3
最大长度 = 3
模式 = ^[a-zA-Z0-9-]*$ (必需)
父母 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源外部的子资源
类型资源的符号名称:命名空间/主题
性能 事件订阅的属性。 SubscriptionProperties

NumberGreaterThanFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberGreaterThan”(必需)
价值 筛选器值。 int

NumberGreaterThanOrEqualsFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberGreaterThanOrEquals”(必需)
价值 筛选器值。 int

NumberInFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberIn”(必需)
筛选器值集。 int[]

NumberInRangeFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberInRange”(必需)
筛选器值集。 int[][]

NumberLessThanFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberLessThan”(必需)
价值 筛选器值。 int

NumberLessThanOrEqualsFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberLessThanOrEquals”(必需)
价值 筛选器值。 int

NumberNotInFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberNotIn”(必需)
筛选器值集。 int[]

NumberNotInRangeFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberNotInRange”(必需)
筛选器值集。 int[][]

QueueInfo

名字 描述 价值
deadLetterDestinationWithResourceIdentity 事件订阅的死信目标。 无法传递到其目标的任何事件都将发送到死信目标。
使用父资源(即主题)上的托管标识设置来获取在传递/死信期间使用的身份验证令牌。
DeadLetterWithResourceIdentity
eventTimeToLive ISO 8601 格式的时间跨度持续时间,用于确定消息发布后订阅可用的消息时长。
此持续时间值使用以下格式表示:“P(n)Y(n)M(n)DT(n)H(n)M(n)M(n)S',其中:
- (n) 被后跟 (n) 的每次元素的值替换。
- P 是持续时间(或句点)设计器,始终放置在持续时间的开头。
- Y 是年份设计者,它遵循年份的值。
- M 是月份设计者,它遵循月份数的值。
- W 是周指示符,它遵循周数的值。
- D 是日期指示符,它遵循天数的值。
- T 是时间指示符,它位于时间组件之前。
- H 是小时指示符,它遵循小时数的值。
- M 是分钟指示符,它遵循分钟数的值。
- S 是第二个指示符,它遵循秒数的值。
无法设置此持续时间值大于主题的 EventRetentionInDays。 它是一个可选字段,其最小值为 1 分钟,并且其最大值已确定
按主题的 EventRetentionInDays 值。 下面是有效值的示例:
- “P0DT23H12M”或“PT23H12M”:持续时间为 23 小时 12 分钟。
- “P1D”或“P1DT0H0M0S”:持续时间为 1 天。
字符串
maxDeliveryCount 事件的最大传递计数。 int
receiveLockDurationInSeconds 消息处于接收状态并等待接受、释放或拒绝的最大时间段(以秒为单位)。
如果在客户端收到消息后未转换到已接受(未处理)、释放或拒绝,则此时间已过,
消息可用于重新传送。 这是一个可选字段,默认值为 60 秒,最小值为 60 秒,最大值为 300 秒。
int

StorageBlobDeadLetterDestination

名字 描述 价值
endpointType 死信目标的终结点类型 “StorageBlob”(必需)
性能 基于存储 Blob 的死信目标的属性 StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

名字 描述 价值
blobContainerName 存储 Blob 容器的名称,该容器是死信事件的目标 字符串
resourceId 存储帐户的 Azure 资源 ID,该 ID 是死信事件的目标 字符串

StringBeginsWithFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringBeginsWith”(必需)
筛选器值集。 string[]

StringContainsFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringContains”(必需)
筛选器值集。 string[]

StringEndsWithFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringEndsWith”(必需)
筛选器值集。 string[]

StringInFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringIn”(必需)
筛选器值集。 string[]

StringNotBeginsWithFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotBeginsWith”(必需)
筛选器值集。 string[]

StringNotContainsFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotContains”(必需)
筛选器值集。 string[]

StringNotEndsWithFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotEndsWith”(必需)
筛选器值集。 string[]

StringNotInFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotIn”(必需)
筛选器值集。 string[]

SubscriptionProperties

名字 描述 价值
deliveryConfiguration 有关事件订阅的传递配置的信息。 DeliveryConfiguration
eventDeliverySchema 事件订阅的事件传送架构。 “CloudEventSchemaV1_0”
filtersConfiguration 有关事件订阅筛选器的信息。 FiltersConfiguration

ARM 模板资源定义

可以使用目标操作部署命名空间/topics/eventSubscriptions 资源类型:

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

资源格式

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

{
  "type": "Microsoft.EventGrid/namespaces/topics/eventSubscriptions",
  "apiVersion": "2023-06-01-preview",
  "name": "string",
  "properties": {
    "deliveryConfiguration": {
      "deliveryMode": "string",
      "queue": {
        "deadLetterDestinationWithResourceIdentity": {
          "deadLetterDestination": {
            "endpointType": "string"
            // For remaining properties, see DeadLetterDestination objects
          },
          "identity": {
            "type": "string",
            "userAssignedIdentity": "string"
          }
        },
        "eventTimeToLive": "string",
        "maxDeliveryCount": "int",
        "receiveLockDurationInSeconds": "int"
      }
    },
    "eventDeliverySchema": "string",
    "filtersConfiguration": {
      "filters": [ {
        "key": "string",
        "operatorType": "string"
        // For remaining properties, see Filter objects
      } ],
      "includedEventTypes": [ "string" ]
    }
  }
}

DeadLetterDestination 对象

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

对于 StorageBlob,请使用:

{
  "endpointType": "StorageBlob",
  "properties": {
    "blobContainerName": "string",
    "resourceId": "string"
  }
}

筛选对象

设置 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" ]
}

属性值

BoolEqualsFilter

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

DeadLetterDestination

名字 描述 价值
endpointType 对于 StorageBlobDeadLetterDestination,请设置为“StorageBlob”。 “StorageBlob”(必需)

DeadLetterWithResourceIdentity

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

DeliveryConfiguration

名字 描述 价值
deliveryMode 事件订阅的传递模式。 “Queue”
队列 当 deliveryMode 为队列并表示有关队列订阅的信息时,应填充此属性。 QueueInfo

EventSubscriptionIdentity

名字 描述 价值
类型 使用的托管标识的类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。 “SystemAssigned”
“UserAssigned”
userAssignedIdentity 与资源关联的用户标识。 字符串

滤波器

名字 描述 价值
钥匙 要根据要筛选的事件中的字段/属性。 字符串
operatorType 对于 BoolEqualsFilter类型,设置为“BoolEquals”。 对于 IsNotNullFilter类型,设置为“IsNotNull”。 对于类型 IsNullOrUndefinedFilter,设置为“IsNullOrUndefined”。 对于 type NumberGreaterThanFilter,设置为“NumberGreaterThan”。 对于 type NumberGreaterThanOrEqualsFilter,设置为“NumberGreaterThanOrEquals”。 设置为 type NumberInFilter的“NumberIn”。 对于 type NumberInRangeFilter,设置为“NumberInRange”。 对于 type NumberLessThanFilter,设置为“NumberLessThanThan”。 对于 type NumberLessThanOrEqualsFilter,设置为“NumberLessThanOrEquals”。 对于 type NumberNotInFilter,设置为“NumberNotIn”。 对于 type NumberNotInRangeFilter,设置为“NumberNotInRange”。 对于 stringBeginsWithfilter,type 设置为“StringBeginsWith”。 对于 stringContainsFilter类型,设置为“StringContains”。 对于 stringEndsWithFilter类型,请设置为“StringEndsWith”。 对于 stringInFilter 类型,设置为“StringIn”。 对于 type StringNotBeginsWithFilter,设置为“StringNotBeginsWith”。 对于 stringNotContainsFilter,请设置为 type StringNotContainsFilter 。 对于 type StringNotEndsWithFilter,设置为“StringNotEndsWith”。 对于 stringNotInFilter类型,设置为 “StringNotIn” 类型。 “BoolEquals”
“IsNotNull”
“IsNullOrUndefined”
“NumberGreaterThan”
“NumberGreaterThanOrEquals”
“NumberIn”
“NumberInRange”
“NumberLessThan”
“NumberLessThanOrEquals”
“NumberNotIn”
“NumberNotInRange”
“StringBeginsWith”
“StringContains”
“StringEndsWith”
“StringIn”
“StringNotBeginsWith”
“StringNotContains”
“StringNotEndsWith”
“StringNotIn”(必需)

FiltersConfiguration

名字 描述 价值
过滤 器 用于筛选事件订阅的筛选器数组。 筛选器[]
includedEventTypes 需要属于事件订阅的适用事件类型的列表。 如果需要订阅所有默认事件类型,请将 IncludedEventTypes 设置为 null。 string[]

IsNotNullFilter

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

IsNullOrUndefinedFilter

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

Microsoft.EventGrid/namespaces/topics/eventSubscriptions

名字 描述 价值
apiVersion API 版本 '2023-06-01-preview'
名字 资源名称 字符串

约束:
最小长度 = 3
最大长度 = 3
模式 = ^[a-zA-Z0-9-]*$ (必需)
性能 事件订阅的属性。 SubscriptionProperties
类型 资源类型 “Microsoft.EventGrid/namespaces/topics/eventSubscriptions”

NumberGreaterThanFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberGreaterThan”(必需)
价值 筛选器值。 int

NumberGreaterThanOrEqualsFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberGreaterThanOrEquals”(必需)
价值 筛选器值。 int

NumberInFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberIn”(必需)
筛选器值集。 int[]

NumberInRangeFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberInRange”(必需)
筛选器值集。 int[][]

NumberLessThanFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberLessThan”(必需)
价值 筛选器值。 int

NumberLessThanOrEqualsFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberLessThanOrEquals”(必需)
价值 筛选器值。 int

NumberNotInFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberNotIn”(必需)
筛选器值集。 int[]

NumberNotInRangeFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberNotInRange”(必需)
筛选器值集。 int[][]

QueueInfo

名字 描述 价值
deadLetterDestinationWithResourceIdentity 事件订阅的死信目标。 无法传递到其目标的任何事件都将发送到死信目标。
使用父资源(即主题)上的托管标识设置来获取在传递/死信期间使用的身份验证令牌。
DeadLetterWithResourceIdentity
eventTimeToLive ISO 8601 格式的时间跨度持续时间,用于确定消息发布后订阅可用的消息时长。
此持续时间值使用以下格式表示:“P(n)Y(n)M(n)DT(n)H(n)M(n)M(n)S',其中:
- (n) 被后跟 (n) 的每次元素的值替换。
- P 是持续时间(或句点)设计器,始终放置在持续时间的开头。
- Y 是年份设计者,它遵循年份的值。
- M 是月份设计者,它遵循月份数的值。
- W 是周指示符,它遵循周数的值。
- D 是日期指示符,它遵循天数的值。
- T 是时间指示符,它位于时间组件之前。
- H 是小时指示符,它遵循小时数的值。
- M 是分钟指示符,它遵循分钟数的值。
- S 是第二个指示符,它遵循秒数的值。
无法设置此持续时间值大于主题的 EventRetentionInDays。 它是一个可选字段,其最小值为 1 分钟,并且其最大值已确定
按主题的 EventRetentionInDays 值。 下面是有效值的示例:
- “P0DT23H12M”或“PT23H12M”:持续时间为 23 小时 12 分钟。
- “P1D”或“P1DT0H0M0S”:持续时间为 1 天。
字符串
maxDeliveryCount 事件的最大传递计数。 int
receiveLockDurationInSeconds 消息处于接收状态并等待接受、释放或拒绝的最大时间段(以秒为单位)。
如果在客户端收到消息后未转换到已接受(未处理)、释放或拒绝,则此时间已过,
消息可用于重新传送。 这是一个可选字段,默认值为 60 秒,最小值为 60 秒,最大值为 300 秒。
int

StorageBlobDeadLetterDestination

名字 描述 价值
endpointType 死信目标的终结点类型 “StorageBlob”(必需)
性能 基于存储 Blob 的死信目标的属性 StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

名字 描述 价值
blobContainerName 存储 Blob 容器的名称,该容器是死信事件的目标 字符串
resourceId 存储帐户的 Azure 资源 ID,该 ID 是死信事件的目标 字符串

StringBeginsWithFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringBeginsWith”(必需)
筛选器值集。 string[]

StringContainsFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringContains”(必需)
筛选器值集。 string[]

StringEndsWithFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringEndsWith”(必需)
筛选器值集。 string[]

StringInFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringIn”(必需)
筛选器值集。 string[]

StringNotBeginsWithFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotBeginsWith”(必需)
筛选器值集。 string[]

StringNotContainsFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotContains”(必需)
筛选器值集。 string[]

StringNotEndsWithFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotEndsWith”(必需)
筛选器值集。 string[]

StringNotInFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotIn”(必需)
筛选器值集。 string[]

SubscriptionProperties

名字 描述 价值
deliveryConfiguration 有关事件订阅的传递配置的信息。 DeliveryConfiguration
eventDeliverySchema 事件订阅的事件传送架构。 “CloudEventSchemaV1_0”
filtersConfiguration 有关事件订阅筛选器的信息。 FiltersConfiguration

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

可以使用目标操作部署命名空间/topics/eventSubscriptions 资源类型:

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2023-06-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      deliveryConfiguration = {
        deliveryMode = "string"
        queue = {
          deadLetterDestinationWithResourceIdentity = {
            deadLetterDestination = {
              endpointType = "string"
              // For remaining properties, see DeadLetterDestination objects
            }
            identity = {
              type = "string"
              userAssignedIdentity = "string"
            }
          }
          eventTimeToLive = "string"
          maxDeliveryCount = int
          receiveLockDurationInSeconds = int
        }
      }
      eventDeliverySchema = "string"
      filtersConfiguration = {
        filters = [
          {
            key = "string"
            operatorType = "string"
            // For remaining properties, see Filter objects
          }
        ]
        includedEventTypes = [
          "string"
        ]
      }
    }
  })
}

DeadLetterDestination 对象

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

对于 StorageBlob,请使用:

{
  endpointType = "StorageBlob"
  properties = {
    blobContainerName = "string"
    resourceId = "string"
  }
}

筛选对象

设置 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"
  ]
}

属性值

BoolEqualsFilter

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

DeadLetterDestination

名字 描述 价值
endpointType 对于 StorageBlobDeadLetterDestination,请设置为“StorageBlob”。 “StorageBlob”(必需)

DeadLetterWithResourceIdentity

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

DeliveryConfiguration

名字 描述 价值
deliveryMode 事件订阅的传递模式。 “Queue”
队列 当 deliveryMode 为队列并表示有关队列订阅的信息时,应填充此属性。 QueueInfo

EventSubscriptionIdentity

名字 描述 价值
类型 使用的托管标识的类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。 “SystemAssigned”
“UserAssigned”
userAssignedIdentity 与资源关联的用户标识。 字符串

滤波器

名字 描述 价值
钥匙 要根据要筛选的事件中的字段/属性。 字符串
operatorType 对于 BoolEqualsFilter类型,设置为“BoolEquals”。 对于 IsNotNullFilter类型,设置为“IsNotNull”。 对于类型 IsNullOrUndefinedFilter,设置为“IsNullOrUndefined”。 对于 type NumberGreaterThanFilter,设置为“NumberGreaterThan”。 对于 type NumberGreaterThanOrEqualsFilter,设置为“NumberGreaterThanOrEquals”。 设置为 type NumberInFilter的“NumberIn”。 对于 type NumberInRangeFilter,设置为“NumberInRange”。 对于 type NumberLessThanFilter,设置为“NumberLessThanThan”。 对于 type NumberLessThanOrEqualsFilter,设置为“NumberLessThanOrEquals”。 对于 type NumberNotInFilter,设置为“NumberNotIn”。 对于 type NumberNotInRangeFilter,设置为“NumberNotInRange”。 对于 stringBeginsWithfilter,type 设置为“StringBeginsWith”。 对于 stringContainsFilter类型,设置为“StringContains”。 对于 stringEndsWithFilter类型,请设置为“StringEndsWith”。 对于 stringInFilter 类型,设置为“StringIn”。 对于 type StringNotBeginsWithFilter,设置为“StringNotBeginsWith”。 对于 stringNotContainsFilter,请设置为 type StringNotContainsFilter 。 对于 type StringNotEndsWithFilter,设置为“StringNotEndsWith”。 对于 stringNotInFilter类型,设置为 “StringNotIn” 类型。 “BoolEquals”
“IsNotNull”
“IsNullOrUndefined”
“NumberGreaterThan”
“NumberGreaterThanOrEquals”
“NumberIn”
“NumberInRange”
“NumberLessThan”
“NumberLessThanOrEquals”
“NumberNotIn”
“NumberNotInRange”
“StringBeginsWith”
“StringContains”
“StringEndsWith”
“StringIn”
“StringNotBeginsWith”
“StringNotContains”
“StringNotEndsWith”
“StringNotIn”(必需)

FiltersConfiguration

名字 描述 价值
过滤 器 用于筛选事件订阅的筛选器数组。 筛选器[]
includedEventTypes 需要属于事件订阅的适用事件类型的列表。 如果需要订阅所有默认事件类型,请将 IncludedEventTypes 设置为 null。 string[]

IsNotNullFilter

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

IsNullOrUndefinedFilter

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

Microsoft.EventGrid/namespaces/topics/eventSubscriptions

名字 描述 价值
名字 资源名称 字符串

约束:
最小长度 = 3
最大长度 = 3
模式 = ^[a-zA-Z0-9-]*$ (必需)
parent_id 此资源的父资源的 ID。 类型资源的 ID:命名空间/主题
性能 事件订阅的属性。 SubscriptionProperties
类型 资源类型 “Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2023-06-01-preview”

NumberGreaterThanFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberGreaterThan”(必需)
价值 筛选器值。 int

NumberGreaterThanOrEqualsFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberGreaterThanOrEquals”(必需)
价值 筛选器值。 int

NumberInFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberIn”(必需)
筛选器值集。 int[]

NumberInRangeFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberInRange”(必需)
筛选器值集。 int[][]

NumberLessThanFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberLessThan”(必需)
价值 筛选器值。 int

NumberLessThanOrEqualsFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberLessThanOrEquals”(必需)
价值 筛选器值。 int

NumberNotInFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberNotIn”(必需)
筛选器值集。 int[]

NumberNotInRangeFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “NumberNotInRange”(必需)
筛选器值集。 int[][]

QueueInfo

名字 描述 价值
deadLetterDestinationWithResourceIdentity 事件订阅的死信目标。 无法传递到其目标的任何事件都将发送到死信目标。
使用父资源(即主题)上的托管标识设置来获取在传递/死信期间使用的身份验证令牌。
DeadLetterWithResourceIdentity
eventTimeToLive ISO 8601 格式的时间跨度持续时间,用于确定消息发布后订阅可用的消息时长。
此持续时间值使用以下格式表示:“P(n)Y(n)M(n)DT(n)H(n)M(n)M(n)S',其中:
- (n) 被后跟 (n) 的每次元素的值替换。
- P 是持续时间(或句点)设计器,始终放置在持续时间的开头。
- Y 是年份设计者,它遵循年份的值。
- M 是月份设计者,它遵循月份数的值。
- W 是周指示符,它遵循周数的值。
- D 是日期指示符,它遵循天数的值。
- T 是时间指示符,它位于时间组件之前。
- H 是小时指示符,它遵循小时数的值。
- M 是分钟指示符,它遵循分钟数的值。
- S 是第二个指示符,它遵循秒数的值。
无法设置此持续时间值大于主题的 EventRetentionInDays。 它是一个可选字段,其最小值为 1 分钟,并且其最大值已确定
按主题的 EventRetentionInDays 值。 下面是有效值的示例:
- “P0DT23H12M”或“PT23H12M”:持续时间为 23 小时 12 分钟。
- “P1D”或“P1DT0H0M0S”:持续时间为 1 天。
字符串
maxDeliveryCount 事件的最大传递计数。 int
receiveLockDurationInSeconds 消息处于接收状态并等待接受、释放或拒绝的最大时间段(以秒为单位)。
如果在客户端收到消息后未转换到已接受(未处理)、释放或拒绝,则此时间已过,
消息可用于重新传送。 这是一个可选字段,默认值为 60 秒,最小值为 60 秒,最大值为 300 秒。
int

StorageBlobDeadLetterDestination

名字 描述 价值
endpointType 死信目标的终结点类型 “StorageBlob”(必需)
性能 基于存储 Blob 的死信目标的属性 StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

名字 描述 价值
blobContainerName 存储 Blob 容器的名称,该容器是死信事件的目标 字符串
resourceId 存储帐户的 Azure 资源 ID,该 ID 是死信事件的目标 字符串

StringBeginsWithFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringBeginsWith”(必需)
筛选器值集。 string[]

StringContainsFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringContains”(必需)
筛选器值集。 string[]

StringEndsWithFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringEndsWith”(必需)
筛选器值集。 string[]

StringInFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringIn”(必需)
筛选器值集。 string[]

StringNotBeginsWithFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotBeginsWith”(必需)
筛选器值集。 string[]

StringNotContainsFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotContains”(必需)
筛选器值集。 string[]

StringNotEndsWithFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotEndsWith”(必需)
筛选器值集。 string[]

StringNotInFilter

名字 描述 价值
operatorType 用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。 “StringNotIn”(必需)
筛选器值集。 string[]

SubscriptionProperties

名字 描述 价值
deliveryConfiguration 有关事件订阅的传递配置的信息。 DeliveryConfiguration
eventDeliverySchema 事件订阅的事件传送架构。 “CloudEventSchemaV1_0”
filtersConfiguration 有关事件订阅筛选器的信息。 FiltersConfiguration