SBQueue interface
队列资源的说明。
属性
| accessed |
上次发送消息时,或上次发出此队列的接收请求。 注意:此属性不会序列化。 它只能由服务器填充。 |
| auto |
ISO 8061 timeSpan 空闲间隔后,队列会自动删除。 最短持续时间为 5 分钟。 |
| count |
消息计数详细信息。 注意:此属性不会序列化。 它只能由服务器填充。 |
| created |
创建消息的确切时间。 注意:此属性不会序列化。 它只能由服务器填充。 |
| dead |
一个值,该值指示消息过期时此队列是否具有死信支持。 |
| default |
ISO 8601 默认消息时间跨度为实时值。 这是消息过期的持续时间,从消息发送到服务总线时开始。 这是未在消息本身上设置 TimeToLive 时使用的默认值。 |
| duplicate |
定义重复检测历史记录持续时间的 ISO 8601 timeSpan 结构。 默认值为 10 分钟。 |
| enable |
指示是否启用服务器端批处理作的值。 |
| enable |
一个值,该值指示是否启用 Express Entities。 快速队列将消息暂时保存在内存中,然后再将其写入永久性存储。 |
| enable |
一个值,该值指示队列是否要在多个消息中转站之间分区。 |
| forward |
用于转发死信消息的队列/主题名称 |
| forward |
用于转发消息的队列/主题名称 |
| lock |
扫视锁的 ISO 8601 时间跨度持续时间;也就是说,为其他接收方锁定消息的时间量。 LockDuration 的最大值为 5 分钟;默认值为 1 分钟。 |
| max |
最大传递计数。 在传递数之后,消息会自动死机。 默认值为 10。 |
| max |
队列可以接受的消息有效负载的最大大小(以 KB 为单位)。 此属性仅在高级版中使用,默认值为 1024。 |
| max |
队列的最大大小(以兆字节为单位),即为队列分配的内存大小。 默认值为 1024。 |
| message |
队列中的消息数。 注意:此属性不会序列化。 它只能由服务器填充。 |
| requires |
一个值,该值指示此队列是否需要重复检测。 |
| requires |
一个值,该值指示队列是否支持会话的概念。 |
| size |
队列的大小(以字节为单位)。 注意:此属性不会序列化。 它只能由服务器填充。 |
| status | 枚举消息实体状态的可能值。 |
| system |
与此资源相关的系统元数据。 注意:此属性不会序列化。 它只能由服务器填充。 |
| updated |
消息的确切更新时间。 注意:此属性不会序列化。 它只能由服务器填充。 |
继承属性
| id | 资源的完全限定资源 ID。 Ex - /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
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
队列的最大大小(以兆字节为单位),即为队列分配的内存大小。 默认值为 1024。
maxSizeInMegabytes?: number
属性值
number
messageCount
队列中的消息数。 注意:此属性不会序列化。 它只能由服务器填充。
messageCount?: number
属性值
number
requiresDuplicateDetection
一个值,该值指示此队列是否需要重复检测。
requiresDuplicateDetection?: boolean
属性值
boolean
requiresSession
一个值,该值指示队列是否支持会话的概念。
requiresSession?: boolean
属性值
boolean
sizeInBytes
队列的大小(以字节为单位)。 注意:此属性不会序列化。 它只能由服务器填充。
sizeInBytes?: number
属性值
number
status
systemData
updatedAt
消息的确切更新时间。 注意:此属性不会序列化。 它只能由服务器填充。
updatedAt?: Date
属性值
Date
继承属性详细信息
id
资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意:此属性不会序列化。 它只能由服务器填充。
id?: string
属性值
string
location
name
type
资源的类型。 例如,“Microsoft.EventHub/Namespaces”或“Microsoft.EventHub/Namespaces/EventHubs”注意:此属性不会序列化。 它只能由服务器填充。
type?: string
属性值
string