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

Microsoft.ServiceBus namespaces/topics/subscriptions

Bicep 资源定义

namespaces/topics/subscriptions 资源类型可以部署到:

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

资源格式

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

resource symbolicname 'Microsoft.ServiceBus/namespaces/topics/subscriptions@2022-01-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    autoDeleteOnIdle: 'string'
    clientAffineProperties: {
      clientId: 'string'
      isDurable: bool
      isShared: bool
    }
    deadLetteringOnFilterEvaluationExceptions: bool
    deadLetteringOnMessageExpiration: bool
    defaultMessageTimeToLive: 'string'
    duplicateDetectionHistoryTimeWindow: 'string'
    enableBatchedOperations: bool
    forwardDeadLetteredMessagesTo: 'string'
    forwardTo: 'string'
    isClientAffine: bool
    lockDuration: 'string'
    maxDeliveryCount: int
    requiresSession: bool
    status: 'string'
  }
}

属性值

namespaces/topics/subscriptions

名称 说明
name 资源名称

了解如何在 Bicep 中为子资源设置名称和类型。
字符串 (必需)

字符限制:1-50

有效字符:
字母数字、句点、连字符和下划线。

以字母数字开头和结尾。
父级 (parent) 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源之外的子资源
类型为资源的符号名称: topics
properties 订阅资源的属性。 SBSubscriptionProperties

SBSubscriptionProperties

名称 说明
autoDeleteOnIdle ISO 8061 timeSpan 空闲间隔之后,主题将自动删除。 最短持续时间为 5 分钟。 字符串
clientAffineProperties 特定于客户端仿射订阅的属性。 SBClientAffineProperties
deadLetteringOnFilterEvaluationExceptions 指示订阅是否支持筛选器评估异常的死信的值。 bool
deadLetteringOnMessageExpiration 指示消息过期时订阅是否支持死信的值。 bool
defaultMessageTimeToLive ISO 8061 默认消息时间跨度到实时值。 这是消息过期的持续时间,从消息发送到服务总线时开始。 这是未在消息本身上设置 TimeToLive 时使用的默认值。 字符串
duplicateDetectionHistoryTimeWindow ISO 8601 timeSpan 结构,用于定义重复检测历史记录的持续时间。 默认值为 10 分钟。 字符串
enableBatchedOperations 指示是否启用服务器端批处理操作的值。 bool
forwardDeadLetteredMessagesTo 用于转发死信消息的队列/主题名称 字符串
forwardTo 用于转发消息的队列/主题名称 字符串
isClientAffine 指示订阅是否与客户端 ID 关联的值。 bool
lockDuration 订阅的 ISO 8061 锁定持续时间时间跨度。 默认值为 1 分钟。 string
maxDeliveryCount 最大传递数。 int
requiresSession 指示订阅是否支持会话概念的值。 bool
状态 枚举消息实体状态的可能值。 “Active”
“正在创建”
“正在删除”
“Disabled”
“ReceiveDisabled”
“重命名”
“正在还原”
“SendDisabled”
“未知”

SBClientAffineProperties

名称 说明
clientId 指示创建客户端仿像订阅的应用程序的客户端 ID。 字符串
isDurable 对于客户端仿射订阅,此值指示订阅是否持久。 bool
isShared 对于客户端仿射订阅,此值指示订阅是否共享。 bool

快速入门模板

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

模板 说明
集成模式 - 消息路由器 - 服务总线

部署到 Azure
演示如何使用服务总线主题设置消息路由器模式的解决方案
使用服务总线通过逻辑应用关联消息

部署到 Azure
其中显示了如何使用 Azure 服务总线

ARM 模板资源定义

namespaces/topics/subscriptions 资源类型可以部署到:

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

资源格式

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

{
  "type": "Microsoft.ServiceBus/namespaces/topics/subscriptions",
  "apiVersion": "2022-01-01-preview",
  "name": "string",
  "properties": {
    "autoDeleteOnIdle": "string",
    "clientAffineProperties": {
      "clientId": "string",
      "isDurable": "bool",
      "isShared": "bool"
    },
    "deadLetteringOnFilterEvaluationExceptions": "bool",
    "deadLetteringOnMessageExpiration": "bool",
    "defaultMessageTimeToLive": "string",
    "duplicateDetectionHistoryTimeWindow": "string",
    "enableBatchedOperations": "bool",
    "forwardDeadLetteredMessagesTo": "string",
    "forwardTo": "string",
    "isClientAffine": "bool",
    "lockDuration": "string",
    "maxDeliveryCount": "int",
    "requiresSession": "bool",
    "status": "string"
  }
}

属性值

namespaces/topics/subscriptions

名称 说明 Value
type 资源类型 “Microsoft.ServiceBus/namespaces/topics/subscriptions”
apiVersion 资源 API 版本 “2022-01-01-preview”
name 资源名称

了解如何在 JSON ARM 模板中设置子资源的名称和类型。
字符串 (必需)

字符限制:1-50

有效字符:
字母数字、句点、连字符和下划线。

以字母数字开头和结尾。
properties 订阅资源的属性。 SBSubscriptionProperties

SBSubscriptionProperties

名称 说明
autoDeleteOnIdle ISO 8061 timeSpan 空闲间隔,在此间隔后将自动删除主题。 最短持续时间为 5 分钟。 字符串
clientAffineProperties 特定于客户端仿射订阅的属性。 SBClientAffineProperties
deadLetteringOnFilterEvaluationExceptions 指示订阅是否具有筛选器评估异常的死信支持的值。 bool
deadLetteringOnMessageExpiration 指示消息过期时订阅是否具有死信支持的值。 bool
defaultMessageTimeToLive ISO 8061 默认消息时间跨度到实时值。 这是消息过期的持续时间,从消息发送到服务总线时开始。 这是未在消息本身上设置 TimeToLive 时使用的默认值。 string
duplicateDetectionHistoryTimeWindow 定义重复检测历史记录持续时间的 ISO 8601 timeSpan 结构。 默认值为 10 分钟。 string
enableBatchedOperations 指示是否启用服务器端批处理操作的值。 bool
forwardDeadLetteredMessagesTo 用于转发死信消息的队列/主题名称 string
forwardTo 用于转发消息的队列/主题名称 字符串
isClientAffine 指示订阅是否与客户端 ID 关联的值。 bool
lockDuration 订阅的 ISO 8061 锁定持续时间时间跨度。 默认值为 1 分钟。 string
maxDeliveryCount 最大交付次数。 int
requiresSession 指示订阅是否支持会话概念的值。 bool
状态 枚举消息实体状态的可能值。 'Active'
'Creating'
'正在删除'
'Disabled'
'ReceiveDisabled'
“重命名”
“正在还原”
“SendDisabled”
“未知”

SBClientAffineProperties

名称 说明
clientId 指示创建客户端仿像订阅的应用程序的客户端 ID。 string
isDurable 对于客户端仿射订阅,此值指示订阅是否持久。 bool
isShared 对于客户端仿射订阅,此值指示订阅是否共享。 bool

快速入门模板

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

模板 说明
集成模式 - 消息路由器 - 服务总线

部署到 Azure
演示如何使用服务总线主题设置消息路由器模式的解决方案
使用服务总线通过逻辑应用关联消息

部署到 Azure
其中显示了如何使用 Azure 服务总线

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

namespaces/topics/subscriptions 资源类型可以部署到:

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ServiceBus/namespaces/topics/subscriptions@2022-01-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      autoDeleteOnIdle = "string"
      clientAffineProperties = {
        clientId = "string"
        isDurable = bool
        isShared = bool
      }
      deadLetteringOnFilterEvaluationExceptions = bool
      deadLetteringOnMessageExpiration = bool
      defaultMessageTimeToLive = "string"
      duplicateDetectionHistoryTimeWindow = "string"
      enableBatchedOperations = bool
      forwardDeadLetteredMessagesTo = "string"
      forwardTo = "string"
      isClientAffine = bool
      lockDuration = "string"
      maxDeliveryCount = int
      requiresSession = bool
      status = "string"
    }
  })
}

属性值

namespaces/topics/subscriptions

名称 说明 Value
type 资源类型 “Microsoft.ServiceBus/namespaces/topics/subscriptions@2022-01-01-preview”
name 资源名称 字符串 (必需)

字符限制:1-50

有效字符:
字母数字、句点、连字符和下划线。

以字母数字开头和结尾。
parent_id 此资源的父资源的 ID。 类型为:topics 的资源的 ID
properties 订阅资源的属性。 SBSubscriptionProperties

SBSubscriptionProperties

名称 说明
autoDeleteOnIdle ISO 8061 timeSpan 空闲间隔,在此间隔后将自动删除主题。 最短持续时间为 5 分钟。 字符串
clientAffineProperties 特定于客户端仿射订阅的属性。 SBClientAffineProperties
deadLetteringOnFilterEvaluationExceptions 指示订阅是否具有筛选器评估异常的死信支持的值。 bool
deadLetteringOnMessageExpiration 指示消息过期时订阅是否具有死信支持的值。 bool
defaultMessageTimeToLive ISO 8061 默认消息时间跨度到实时值。 这是消息过期的持续时间,从消息发送到服务总线时开始。 这是未在消息本身上设置 TimeToLive 时使用的默认值。 字符串
duplicateDetectionHistoryTimeWindow 定义重复检测历史记录持续时间的 ISO 8601 timeSpan 结构。 默认值为 10 分钟。 字符串
enableBatchedOperations 指示是否启用服务器端批处理操作的值。 bool
forwardDeadLetteredMessagesTo 用于转发死信消息的队列/主题名称 字符串
forwardTo 用于转发消息的队列/主题名称 字符串
isClientAffine 指示订阅是否与客户端 ID 关联的值。 bool
lockDuration 订阅的 ISO 8061 锁定持续时间时间跨度。 默认值为 1 分钟。 string
maxDeliveryCount 最大传递数。 int
requiresSession 指示订阅是否支持会话概念的值。 bool
状态 枚举消息实体状态的可能值。 “活动”
“正在创建”
“正在删除”
“Disabled”
“ReceiveDisabled”
“重命名”
“正在还原”
“SendDisabled”
"Unknown"

SBClientAffineProperties

名称 说明
clientId 指示创建客户端仿射订阅的应用程序的客户端 ID。 字符串
isDurable 对于客户端仿射订阅,此值指示订阅是否持久。 bool
isShared 对于客户端仿射订阅,此值指示订阅是否共享。 bool