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

CreateQueueOptions interface

包:

@azure/service-bus

表示队列上的可设置选项

扩展

OperationOptions

属性

authorizationRules	队列上的授权规则
autoDeleteOnIdle	删除实体之前的最大空闲时间。 这是以 ISO-8601 持续时间格式指定的，例如“PT1M”1 分钟，“PT5S”指定 5 秒。 有关 ISO-8601 持续时间格式的详细信息： https://en.wikipedia.org/wiki/ISO_8601#Durations
availabilityStatus	消息传送实体的可用性状态。
deadLetteringOnMessageExpiration	如果启用并且消息过期，服务总线会将消息从队列移到队列的死信子队列中。 如果禁用，消息将从队列中永久删除。 只可以在创建队列时设置。
defaultMessageTimeToLive	如果消息在队列中存储的时间超过指定时间，则消息会自动移动到死信子队列或删除，具体取决于是否启用 DeadLettering。 当且仅当消息 TTL 小于队列上设置的 TTL 时，在消息上指定的 TTL 才会覆盖此值。 创建队列后，此值是不可变的。 这是以 ISO-8601 持续时间格式指定的，例如“PT1M”1 分钟，“PT5S”指定 5 秒。 有关 ISO-8601 持续时间格式的详细信息： https://en.wikipedia.org/wiki/ISO_8601#Durations
duplicateDetectionHistoryTimeWindow	指定服务总线检测消息重复的时间跨度。 这是以 ISO-8601 持续时间格式指定的，例如“PT1M”1 分钟，“PT5S”指定 5 秒。 有关 ISO-8601 持续时间格式的详细信息： https://en.wikipedia.org/wiki/ISO_8601#Durations
enableBatchedOperations	指定是否应允许批处理操作。
enableExpress	指定是否对队列启用快速实体。
enablePartitioning	指定是否应对队列进行分区。
forwardDeadLetteredMessagesTo	将死信消息转发到的队列或主题的绝对 URL 或名称。 例如，绝对 URL 输入的形式为 sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
forwardTo	消息要转发到的队列或主题的绝对 URL 或名称。 例如，绝对 URL 输入的形式为 sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
lockDuration	确定将由接受者处理的消息的锁定时间（单位：秒）。 此锁定期限过后，消息将解锁并可供下一个接收者使用。 (如果启用了会话，则此锁定持续时间适用于会话，不适用于 messages。) 这是以 ISO-8601 持续时间格式指定的，例如“PT1M”1 分钟，“PT5S”指定 5 秒。 有关 ISO-8601 持续时间格式的详细信息： https://en.wikipedia.org/wiki/ISO_8601#Durations
maxDeliveryCount	消息的最大传递计数，如果消息仍未解决，则会移动到死信子队列。
maxMessageSizeInKilobytes	发送到此队列的消息的最大消息大小（以 KB 为单位）。 (仅适用于高级层服务总线命名空间。)
maxSizeInMegabytes	指定最大队列大小 (MB)。 尝试将消息加入队列时，如果该消息会导致队列超过此值，尝试将失败。
requiresDuplicateDetection	如果启用，主题将在 DuplicateDetectionHistoryTimeWindow 属性指定的时间范围内检测重复消息。 只可以在创建队列时设置。
requiresSession	如果设置为 true，则队列将是会话感知队列，并且仅支持 SessionReceiver。 无法通过 REST 支持会话感知队列。 只可以在创建队列时设置。
status	消息传送实体的状态。
userMetadata	用户提供了与队列关联的元数据信息。 用于指定文本内容，如标记、标签等。值不得超过以 utf-8 编码的 1024 字节。

继承属性

abortSignal	可用于中止请求的信号。
onResponse	在执行请求的操作时，每次从服务器收到响应时要调用的函数。 可以多次调用。
requestOptions	创建和发送此操作的 HTTP 请求时使用的选项。
serializerOptions	用于替代序列化/反序列化行为的选项。
tracingOptions	启用跟踪时使用的选项。

属性详细信息

authorizationRules

队列上的授权规则

authorizationRules?: AuthorizationRule[]

属性值

AuthorizationRule[]

autoDeleteOnIdle

删除实体之前的最大空闲时间。 这是以 ISO-8601 持续时间格式指定的，例如“PT1M”1 分钟，“PT5S”指定 5 秒。

有关 ISO-8601 持续时间格式的详细信息： https://en.wikipedia.org/wiki/ISO_8601#Durations

autoDeleteOnIdle?: string

属性值

string

availabilityStatus

消息传送实体的可用性状态。

availabilityStatus?: EntityAvailabilityStatus

属性值

EntityAvailabilityStatus

deadLetteringOnMessageExpiration

如果启用并且消息过期，服务总线会将消息从队列移到队列的死信子队列中。 如果禁用，消息将从队列中永久删除。 只可以在创建队列时设置。

deadLetteringOnMessageExpiration?: boolean

属性值

boolean

defaultMessageTimeToLive

如果消息在队列中存储的时间超过指定时间，则消息会自动移动到死信子队列或删除，具体取决于是否启用 DeadLettering。 当且仅当消息 TTL 小于队列上设置的 TTL 时，在消息上指定的 TTL 才会覆盖此值。 创建队列后，此值是不可变的。 这是以 ISO-8601 持续时间格式指定的，例如“PT1M”1 分钟，“PT5S”指定 5 秒。

有关 ISO-8601 持续时间格式的详细信息： https://en.wikipedia.org/wiki/ISO_8601#Durations

defaultMessageTimeToLive?: string

属性值

string

duplicateDetectionHistoryTimeWindow

指定服务总线检测消息重复的时间跨度。 这是以 ISO-8601 持续时间格式指定的，例如“PT1M”1 分钟，“PT5S”指定 5 秒。

有关 ISO-8601 持续时间格式的详细信息： https://en.wikipedia.org/wiki/ISO_8601#Durations

duplicateDetectionHistoryTimeWindow?: string

属性值

string

enableBatchedOperations

指定是否应允许批处理操作。

enableBatchedOperations?: boolean

属性值

boolean

enableExpress

指定是否对队列启用快速实体。

enableExpress?: boolean

属性值

boolean

enablePartitioning

指定是否应对队列进行分区。

enablePartitioning?: boolean

属性值

boolean

forwardDeadLetteredMessagesTo

将死信消息转发到的队列或主题的绝对 URL 或名称。 例如，绝对 URL 输入的形式为 sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardDeadLetteredMessagesTo?: string

属性值

string

forwardTo

消息要转发到的队列或主题的绝对 URL 或名称。 例如，绝对 URL 输入的形式为 sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardTo?: string

属性值

string

lockDuration

确定将由接受者处理的消息的锁定时间（单位：秒）。 此锁定期限过后，消息将解锁并可供下一个接收者使用。 (如果启用了会话，则此锁定持续时间适用于会话，不适用于 messages。)

这是以 ISO-8601 持续时间格式指定的，例如“PT1M”1 分钟，“PT5S”指定 5 秒。

有关 ISO-8601 持续时间格式的详细信息： https://en.wikipedia.org/wiki/ISO_8601#Durations

lockDuration?: string

属性值

string

maxDeliveryCount

消息的最大传递计数，如果消息仍未解决，则会移动到死信子队列。

maxDeliveryCount?: number

属性值

number

maxMessageSizeInKilobytes

发送到此队列的消息的最大消息大小（以 KB 为单位）。

(仅适用于高级层服务总线命名空间。)

maxMessageSizeInKilobytes?: number

属性值

number

maxSizeInMegabytes

指定最大队列大小 (MB)。 尝试将消息加入队列时，如果该消息会导致队列超过此值，尝试将失败。

maxSizeInMegabytes?: number

属性值

number

requiresDuplicateDetection

如果启用，主题将在 DuplicateDetectionHistoryTimeWindow 属性指定的时间范围内检测重复消息。 只可以在创建队列时设置。

requiresDuplicateDetection?: boolean

属性值

boolean

requiresSession

如果设置为 true，则队列将是会话感知队列，并且仅支持 SessionReceiver。 无法通过 REST 支持会话感知队列。 只可以在创建队列时设置。

requiresSession?: boolean

属性值

boolean

status

消息传送实体的状态。

status?: EntityStatus

属性值

EntityStatus

userMetadata

用户提供了与队列关联的元数据信息。 用于指定文本内容，如标记、标签等。值不得超过以 utf-8 编码的 1024 字节。

userMetadata?: string

属性值

string

继承属性详细信息

abortSignal

可用于中止请求的信号。

abortSignal?: AbortSignalLike

属性值

AbortSignalLike

继承自OperationOptions.abortSignal

onResponse

在执行请求的操作时，每次从服务器收到响应时要调用的函数。 可以多次调用。

onResponse?: RawResponseCallback

属性值

RawResponseCallback

继承自OperationOptions.onResponse

requestOptions

创建和发送此操作的 HTTP 请求时使用的选项。

requestOptions?: OperationRequestOptions

属性值

OperationRequestOptions

继承自OperationOptions.requestOptions

serializerOptions

用于替代序列化/反序列化行为的选项。

serializerOptions?: SerializerOptions

属性值

SerializerOptions

继承自OperationOptions.serializerOptions

tracingOptions

启用跟踪时使用的选项。

tracingOptions?: OperationTracingOptions

属性值

OperationTracingOptions

继承自OperationOptions.tracingOptions