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

SBQueue interface

包:

@azure/arm-servicebus

队列资源的说明。

扩展

ProxyResource

属性

accessedAt	上次发送消息的时间，或上次收到此队列的接收请求的时间。 注意：此属性不会被序列化。 它只能由服务器填充。
autoDeleteOnIdle	ISO 8061 timeSpan 空闲间隔后，队列会自动删除。 最短持续时间为 5 分钟。
countDetails	消息计数详细信息。 注意：此属性不会被序列化。 它只能由服务器填充。
createdAt	消息的确切创建时间。 注意：此属性不会被序列化。 它只能由服务器填充。
deadLetteringOnMessageExpiration	一个 值，该值指示消息过期时此队列是否支持死信。
defaultMessageTimeToLive	ISO 8601 默认消息时间跨度到实时值。 这是消息过期的持续时间，从消息发送到服务总线时开始。 这是未在消息本身上设置 TimeToLive 时使用的默认值。
duplicateDetectionHistoryTimeWindow	ISO 8601 timeSpan 结构，用于定义重复检测历史记录的持续时间。 默认值为 10 分钟。
enableBatchedOperations	指示是否启用服务器端批处理操作的值。
enableExpress	一个 值，该值指示是否启用 Express Entities。 在将消息写入持久存储之前，快速队列暂时将消息保留在内存中。
enablePartitioning	一个 值，该值指示是否要跨多个消息中转站对队列进行分区。
forwardDeadLetteredMessagesTo	用于转发死信消息的队列/主题名称
forwardTo	用于转发消息的队列/主题名称
lockDuration	ISO 8601 速览锁的持续时间;也就是说，消息锁定给其他接收方的时间量。 LockDuration 的最大值为 5 分钟;默认值为 1 分钟。
maxDeliveryCount	最大传递计数。 传递次数达到此数字后，自动将消息视为死信。 默认值为 10。
maxMessageSizeInKilobytes	队列可接受的消息有效负载) 的最大大小 (KB。 此属性目前仅在高级版中使用，默认值为 1024。
maxSizeInMegabytes	队列的最大大小（以 MB 为单位），即为队列分配的内存大小。 默认值为 1024。
messageCount	队列中的消息数。 注意：此属性不会被序列化。 它只能由服务器填充。
requiresDuplicateDetection	一个值，该值指示此队列是否需要重复检测。
requiresSession	一个 值，该值指示队列是否支持会话的概念。
sizeInBytes	队列的大小（以字节为单位）。 注意：此属性不会被序列化。 它只能由服务器填充。
status	枚举消息实体状态的可能值。
systemData	与此资源相关的系统元数据。 注意：此属性不会被序列化。 它只能由服务器填充。
updatedAt	消息的确切更新时间。 注意：此属性不会被序列化。 它只能由服务器填充。

继承属性

id	资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意：此属性不会被序列化。 它只能由服务器填充。
location	资源所在的地理位置 注意：此属性不会被序列化。 它只能由服务器填充。
name	资源的名称 注意：此属性不会被序列化。 它只能由服务器填充。
type	资源类型。 例如，“Microsoft.EventHub/Namespaces”或“Microsoft.EventHub/Namespaces/EventHubs”注意：此属性不会被序列化。 它只能由服务器填充。

属性详细信息

accessedAt

上次发送消息的时间，或上次收到此队列的接收请求的时间。 注意：此属性不会被序列化。 它只能由服务器填充。

accessedAt?: Date

属性值

Date

autoDeleteOnIdle

ISO 8061 timeSpan 空闲间隔后，队列会自动删除。 最短持续时间为 5 分钟。

autoDeleteOnIdle?: string

属性值

string

countDetails

消息计数详细信息。 注意：此属性不会被序列化。 它只能由服务器填充。

countDetails?: MessageCountDetails

属性值

MessageCountDetails

createdAt

消息的确切创建时间。 注意：此属性不会被序列化。 它只能由服务器填充。

createdAt?: Date

属性值

Date

deadLetteringOnMessageExpiration

一个 值，该值指示消息过期时此队列是否支持死信。

deadLetteringOnMessageExpiration?: boolean

属性值

boolean

defaultMessageTimeToLive

ISO 8601 默认消息时间跨度到实时值。 这是消息过期的持续时间，从消息发送到服务总线时开始。 这是未在消息本身上设置 TimeToLive 时使用的默认值。

defaultMessageTimeToLive?: string

属性值

string

duplicateDetectionHistoryTimeWindow

ISO 8601 timeSpan 结构，用于定义重复检测历史记录的持续时间。 默认值为 10 分钟。

duplicateDetectionHistoryTimeWindow?: string

属性值

string

enableBatchedOperations

指示是否启用服务器端批处理操作的值。

enableBatchedOperations?: boolean

属性值

boolean

enableExpress

一个 值，该值指示是否启用 Express Entities。 在将消息写入持久存储之前，快速队列暂时将消息保留在内存中。

enableExpress?: boolean

属性值

boolean

enablePartitioning

一个 值，该值指示是否要跨多个消息中转站对队列进行分区。

enablePartitioning?: boolean

属性值

boolean

forwardDeadLetteredMessagesTo

用于转发死信消息的队列/主题名称

forwardDeadLetteredMessagesTo?: string

属性值

string

forwardTo

用于转发消息的队列/主题名称

forwardTo?: string

属性值

string

lockDuration

ISO 8601 速览锁的持续时间;也就是说，消息锁定给其他接收方的时间量。 LockDuration 的最大值为 5 分钟;默认值为 1 分钟。

lockDuration?: string

属性值

string

maxDeliveryCount

最大传递计数。 传递次数达到此数字后，自动将消息视为死信。 默认值为 10。

maxDeliveryCount?: number

属性值

number

maxMessageSizeInKilobytes

队列可接受的消息有效负载) 的最大大小 (KB。 此属性目前仅在高级版中使用，默认值为 1024。

maxMessageSizeInKilobytes?: number

属性值

number

maxSizeInMegabytes

队列的最大大小（以 MB 为单位），即为队列分配的内存大小。 默认值为 1024。

maxSizeInMegabytes?: number

属性值

number

messageCount

队列中的消息数。 注意：此属性不会被序列化。 它只能由服务器填充。

messageCount?: number

属性值

number

requiresDuplicateDetection

一个值，该值指示此队列是否需要重复检测。

requiresDuplicateDetection?: boolean

属性值

boolean

requiresSession

一个 值，该值指示队列是否支持会话的概念。

requiresSession?: boolean

属性值

boolean

sizeInBytes

队列的大小（以字节为单位）。 注意：此属性不会被序列化。 它只能由服务器填充。

sizeInBytes?: number

属性值

number

status

枚举消息实体状态的可能值。

status?: EntityStatus

属性值

EntityStatus

systemData

与此资源相关的系统元数据。 注意：此属性不会被序列化。 它只能由服务器填充。

systemData?: SystemData

属性值

SystemData

updatedAt

消息的确切更新时间。 注意：此属性不会被序列化。 它只能由服务器填充。

updatedAt?: Date

属性值

Date

继承属性详细信息

id

资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意：此属性不会被序列化。 它只能由服务器填充。

id?: string

属性值

string

继承自ProxyResource.id

location

资源所在的地理位置 注意：此属性不会被序列化。 它只能由服务器填充。

location?: string

属性值

string

继承自ProxyResource.location

name

资源的名称 注意：此属性不会被序列化。 它只能由服务器填充。

name?: string

属性值

string

继承自ProxyResource.name

type

资源类型。 例如，“Microsoft.EventHub/Namespaces”或“Microsoft.EventHub/Namespaces/EventHubs”注意：此属性不会被序列化。 它只能由服务器填充。

type?: string

属性值

string

继承自ProxyResource.type