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

Microsoft.ServiceBus 命名空间/队列 2022-10-01-preview

• 最新
• 2023-01-01-preview
• 2022-10-01-preview
• 2022-01-01-preview
• 2021-11-01
• 2021-06-01-preview
• 2021-01-01-preview
• 2018-01-01-preview
• 2017-04-01
• 2015-08-01

Bicep 资源定义

可以使用目标操作部署命名空间/队列资源类型：

• 资源组 - 请参阅 资源组部署命令

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

资源格式

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

resource symbolicname 'Microsoft.ServiceBus/namespaces/queues@2022-10-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    autoDeleteOnIdle: 'string'
    deadLetteringOnMessageExpiration: bool
    defaultMessageTimeToLive: 'string'
    duplicateDetectionHistoryTimeWindow: 'string'
    enableBatchedOperations: bool
    enableExpress: bool
    enablePartitioning: bool
    forwardDeadLetteredMessagesTo: 'string'
    forwardTo: 'string'
    lockDuration: 'string'
    maxDeliveryCount: int
    maxMessageSizeInKilobytes: int
    maxSizeInMegabytes: int
    requiresDuplicateDetection: bool
    requiresSession: bool
    status: 'string'
  }
}

属性值

namespaces/queues

名字	描述	价值
名字	资源名称 了解如何在 Bicep中设置子资源的名称和类型。	string （必需） 字符限制：1-260 有效字符： 字母数字、句点、连字符、下划线和斜杠。 以字母数字开头和结尾。
父母	在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源外部的子资源。	类型资源的符号名称：命名空间
性能	队列属性	SBQueueProperties

SBQueueProperties

名字	描述	价值
autoDeleteOnIdle	ISO 8061 timeSpan 空闲间隔后，队列会自动删除。 最短持续时间为 5 分钟。	字符串
deadLetteringOnMessageExpiration	一个值，该值指示消息过期时此队列是否具有死信支持。	bool
defaultMessageTimeToLive	ISO 8601 默认消息时间跨度为实时值。 这是消息过期的持续时间，从消息发送到服务总线时开始。 这是未在消息本身上设置 TimeToLive 时使用的默认值。	字符串
duplicateDetectionHistoryTimeWindow	定义重复检测历史记录持续时间的 ISO 8601 timeSpan 结构。 默认值为 10 分钟。	字符串
enableBatchedOperations	指示是否启用服务器端批处理操作的值。	bool
enableExpress	一个值，该值指示是否启用 Express Entities。 快速队列将消息暂时保存在内存中，然后再将其写入永久性存储。	bool
enablePartitioning	一个值，该值指示队列是否要在多个消息中转站之间分区。	bool
forwardDeadLetteredMessagesTo	用于转发死信消息的队列/主题名称	字符串
forwardTo	用于转发消息的队列/主题名称	字符串
lockDuration	扫视锁的 ISO 8601 时间跨度持续时间;也就是说，为其他接收方锁定消息的时间量。 LockDuration 的最大值为 5 分钟;默认值为 1 分钟。	字符串
maxDeliveryCount	最大传递计数。 在传递数之后，消息会自动死机。 默认值为 10。	int
maxMessageSizeInKilobytes	队列可以接受的消息有效负载的最大大小（以 KB 为单位）。 此属性仅在高级版中使用，默认值为 1024。	int
maxSizeInMegabytes	队列的最大大小（以兆字节为单位），即为队列分配的内存大小。 默认值为 1024。	int
requiresDuplicateDetection	一个值，该值指示此队列是否需要重复检测。	bool
requiresSession	一个值，该值指示队列是否支持会话的概念。	bool
地位	枚举消息实体状态的可能值。	“Active” “创建” “删除” “Disabled” “ReceiveDisabled” “重命名” “正在还原” “SendDisabled” “未知”

快速入门模板

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

模板	描述
创建 Azure 事件网格自定义主题和队列订阅	创建 Azure 事件网格自定义主题和服务总线队列订阅。 模板最初由 Markus Meyer 创作。
创建服务总线命名空间和队列授权规则	使用此模板可以部署服务总线标准命名空间，以及命名空间和队列的授权规则。
创建服务总线命名空间和队列	使用此模板可以部署服务总线标准命名空间和队列。

ARM 模板资源定义

可以使用目标操作部署命名空间/队列资源类型：

• 资源组 - 请参阅 资源组部署命令

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

资源格式

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

{
  "type": "Microsoft.ServiceBus/namespaces/queues",
  "apiVersion": "2022-10-01-preview",
  "name": "string",
  "properties": {
    "autoDeleteOnIdle": "string",
    "deadLetteringOnMessageExpiration": "bool",
    "defaultMessageTimeToLive": "string",
    "duplicateDetectionHistoryTimeWindow": "string",
    "enableBatchedOperations": "bool",
    "enableExpress": "bool",
    "enablePartitioning": "bool",
    "forwardDeadLetteredMessagesTo": "string",
    "forwardTo": "string",
    "lockDuration": "string",
    "maxDeliveryCount": "int",
    "maxMessageSizeInKilobytes": "int",
    "maxSizeInMegabytes": "int",
    "requiresDuplicateDetection": "bool",
    "requiresSession": "bool",
    "status": "string"
  }
}

属性值

namespaces/queues

名字	描述	价值
类型	资源类型	“Microsoft.ServiceBus/namespaces/queues”
apiVersion	资源 API 版本	'2022-10-01-preview'
名字	资源名称 了解如何在 JSON ARM 模板中设置子资源的名称和类型。	string （必需） 字符限制：1-260 有效字符： 字母数字、句点、连字符、下划线和斜杠。 以字母数字开头和结尾。
性能	队列属性	SBQueueProperties

SBQueueProperties

名字	描述	价值
autoDeleteOnIdle	ISO 8061 timeSpan 空闲间隔后，队列会自动删除。 最短持续时间为 5 分钟。	字符串
deadLetteringOnMessageExpiration	一个值，该值指示消息过期时此队列是否具有死信支持。	bool
defaultMessageTimeToLive	ISO 8601 默认消息时间跨度为实时值。 这是消息过期的持续时间，从消息发送到服务总线时开始。 这是未在消息本身上设置 TimeToLive 时使用的默认值。	字符串
duplicateDetectionHistoryTimeWindow	定义重复检测历史记录持续时间的 ISO 8601 timeSpan 结构。 默认值为 10 分钟。	字符串
enableBatchedOperations	指示是否启用服务器端批处理操作的值。	bool
enableExpress	一个值，该值指示是否启用 Express Entities。 快速队列将消息暂时保存在内存中，然后再将其写入永久性存储。	bool
enablePartitioning	一个值，该值指示队列是否要在多个消息中转站之间分区。	bool
forwardDeadLetteredMessagesTo	用于转发死信消息的队列/主题名称	字符串
forwardTo	用于转发消息的队列/主题名称	字符串
lockDuration	扫视锁的 ISO 8601 时间跨度持续时间;也就是说，为其他接收方锁定消息的时间量。 LockDuration 的最大值为 5 分钟;默认值为 1 分钟。	字符串
maxDeliveryCount	最大传递计数。 在传递数之后，消息会自动死机。 默认值为 10。	int
maxMessageSizeInKilobytes	队列可以接受的消息有效负载的最大大小（以 KB 为单位）。 此属性仅在高级版中使用，默认值为 1024。	int
maxSizeInMegabytes	队列的最大大小（以兆字节为单位），即为队列分配的内存大小。 默认值为 1024。	int
requiresDuplicateDetection	一个值，该值指示此队列是否需要重复检测。	bool
requiresSession	一个值，该值指示队列是否支持会话的概念。	bool
地位	枚举消息实体状态的可能值。	“Active” “创建” “删除” “Disabled” “ReceiveDisabled” “重命名” “正在还原” “SendDisabled” “未知”

快速入门模板

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

模板	描述
创建 Azure 事件网格自定义主题和队列订阅	创建 Azure 事件网格自定义主题和服务总线队列订阅。 模板最初由 Markus Meyer 创作。
创建服务总线命名空间和队列授权规则	使用此模板可以部署服务总线标准命名空间，以及命名空间和队列的授权规则。
创建服务总线命名空间和队列	使用此模板可以部署服务总线标准命名空间和队列。

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署命名空间/队列资源类型：

• 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ServiceBus/namespaces/queues@2022-10-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      autoDeleteOnIdle = "string"
      deadLetteringOnMessageExpiration = bool
      defaultMessageTimeToLive = "string"
      duplicateDetectionHistoryTimeWindow = "string"
      enableBatchedOperations = bool
      enableExpress = bool
      enablePartitioning = bool
      forwardDeadLetteredMessagesTo = "string"
      forwardTo = "string"
      lockDuration = "string"
      maxDeliveryCount = int
      maxMessageSizeInKilobytes = int
      maxSizeInMegabytes = int
      requiresDuplicateDetection = bool
      requiresSession = bool
      status = "string"
    }
  })
}

属性值

namespaces/queues

名字	描述	价值
类型	资源类型	“Microsoft.ServiceBus/namespaces/queues@2022-10-01-preview”
名字	资源名称	string （必需） 字符限制：1-260 有效字符： 字母数字、句点、连字符、下划线和斜杠。 以字母数字开头和结尾。
parent_id	此资源的父资源的 ID。	类型资源的 ID：命名空间
性能	队列属性	SBQueueProperties

SBQueueProperties

名字	描述	价值
autoDeleteOnIdle	ISO 8061 timeSpan 空闲间隔后，队列会自动删除。 最短持续时间为 5 分钟。	字符串
deadLetteringOnMessageExpiration	一个值，该值指示消息过期时此队列是否具有死信支持。	bool
defaultMessageTimeToLive	ISO 8601 默认消息时间跨度为实时值。 这是消息过期的持续时间，从消息发送到服务总线时开始。 这是未在消息本身上设置 TimeToLive 时使用的默认值。	字符串
duplicateDetectionHistoryTimeWindow	定义重复检测历史记录持续时间的 ISO 8601 timeSpan 结构。 默认值为 10 分钟。	字符串
enableBatchedOperations	指示是否启用服务器端批处理操作的值。	bool
enableExpress	一个值，该值指示是否启用 Express Entities。 快速队列将消息暂时保存在内存中，然后再将其写入永久性存储。	bool
enablePartitioning	一个值，该值指示队列是否要在多个消息中转站之间分区。	bool
forwardDeadLetteredMessagesTo	用于转发死信消息的队列/主题名称	字符串
forwardTo	用于转发消息的队列/主题名称	字符串
lockDuration	扫视锁的 ISO 8601 时间跨度持续时间;也就是说，为其他接收方锁定消息的时间量。 LockDuration 的最大值为 5 分钟;默认值为 1 分钟。	字符串
maxDeliveryCount	最大传递计数。 在传递数之后，消息会自动死机。 默认值为 10。	int
maxMessageSizeInKilobytes	队列可以接受的消息有效负载的最大大小（以 KB 为单位）。 此属性仅在高级版中使用，默认值为 1024。	int
maxSizeInMegabytes	队列的最大大小（以兆字节为单位），即为队列分配的内存大小。 默认值为 1024。	int
requiresDuplicateDetection	一个值，该值指示此队列是否需要重复检测。	bool
requiresSession	一个值，该值指示队列是否支持会话的概念。	bool
地位	枚举消息实体状态的可能值。	“活动” “创建” “删除” “Disabled” “ReceiveDisabled” “重命名” “正在还原” “SendDisabled” “未知”