CreateQueueOptions interface

队列上的授权规则

authorizationRules?: AuthorizationRule[]

属性值

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

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

autoDeleteOnIdle?: string

属性值

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

availabilityStatus?: EntityAvailabilityStatus

属性值

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

deadLetteringOnMessageExpiration?: boolean

属性值

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

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

defaultMessageTimeToLive?: string

属性值

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

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

duplicateDetectionHistoryTimeWindow?: string

属性值

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

enableBatchedOperations?: boolean

属性值

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

enableExpress?: boolean

属性值

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

enablePartitioning?: boolean

属性值

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

forwardDeadLetteredMessagesTo?: string

属性值

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

forwardTo?: string

属性值

确定消息应锁定以供接收方处理的时间（以秒为单位）。 在此时间段后，消息将解锁，可供下一个接收方使用。 （如果启用了会话，则此锁定持续时间适用于会话，不适用于消息。

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

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

lockDuration?: string

属性值

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

maxDeliveryCount?: number

属性值

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

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

maxMessageSizeInKilobytes?: number

属性值

指定最大队列大小（以兆字节为单位）。 任何尝试排队导致队列超过此值的消息都将失败。

maxSizeInMegabytes?: number

属性值

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

requiresDuplicateDetection?: boolean

属性值

如果设置为 true，则队列将识别会话，并且仅支持 SessionReceiver。 REST 不支持会话感知队列。 仅在队列创建时可设置。

requiresSession?: boolean

属性值

消息传送实体的状态。

status?: EntityStatus

属性值

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

userMetadata?: string

属性值

可用于中止请求的信号。

abortSignal?: AbortSignalLike

属性值

继承自 OperationOptions.abortSignal 的

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

onResponse?: RawResponseCallback

属性值

继承自OperationOptions.onResponse

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

requestOptions?: OperationRequestOptions

属性值

继承自 operationOptions.requestOptions 的

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

serializerOptions?: SerializerOptions

属性值

继承自OperationOptions.serializerOptions

启用跟踪时使用的选项。

tracingOptions?: OperationTracingOptions

属性值

继承自OperationOptions.tracingOptions