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

QueueReceiveMessageOptions interface

包:

@azure/storage-queue

配置 receiveMessages 操作的选项

扩展

MessagesDequeueOptionalParams,CommonOptions

属性

abortSignal

AbortSignalLike 接口的实现，用于向请求发出取消操作的信号。 例如，使用 @azure/abort-controller 创建 AbortSignal。

继承属性

numberOfMessages	自选。 一个非零整数值，该值指定要从队列中检索的消息数，最大为 32。 如果可见较少，则返回可见消息。 默认情况下，使用此操作从队列中检索单个消息。
requestId	提供客户端生成的不透明值，该值在启用存储分析日志记录时，在分析日志中记录了 1 KB 字符限制。
timeoutInSeconds	超时参数以秒为单位表示。 有关详细信息，请参阅 为队列服务操作设置超时。
tracingOptions	用于配置启用跟踪时创建的跨度的选项。
visibilityTimeout	自选。 指定相对于服务器时间的新可见性超时值（以秒为单位）。 默认值为 30 秒。 指定的值必须大于或等于 1 秒，并且不能大于 7 天，也不能在版本 2011-08-18 之前的 REST 协议版本上大于 2 小时。 消息的可见性超时可以设置为晚于到期时间的值。

属性详细信息

abortSignal

AbortSignalLike 接口的实现，用于向请求发出取消操作的信号。 例如，使用 @azure/abort-controller 创建 AbortSignal。

abortSignal?: AbortSignalLike

属性值

AbortSignalLike

继承属性详细信息

numberOfMessages

自选。 一个非零整数值，该值指定要从队列中检索的消息数，最大为 32。 如果可见较少，则返回可见消息。 默认情况下，使用此操作从队列中检索单个消息。

numberOfMessages?: number

属性值

number

继承自messagesDequeueOptionalParams.numberOfMessages

requestId

提供客户端生成的不透明值，该值在启用存储分析日志记录时，在分析日志中记录了 1 KB 字符限制。

requestId?: string

属性值

string

继承自 messagesDequeueOptionalParams.requestId 的

timeoutInSeconds

超时参数以秒为单位表示。 有关详细信息，请参阅 为队列服务操作设置超时。

timeoutInSeconds?: number

属性值

number

继承自messagesDequeueOptionalParams.timeoutInSeconds

tracingOptions

用于配置启用跟踪时创建的跨度的选项。

tracingOptions?: OperationTracingOptions

属性值

OperationTracingOptions

继承自CommonOptions.tracingOptions

visibilityTimeout

自选。 指定相对于服务器时间的新可见性超时值（以秒为单位）。 默认值为 30 秒。 指定的值必须大于或等于 1 秒，并且不能大于 7 天，也不能在版本 2011-08-18 之前的 REST 协议版本上大于 2 小时。 消息的可见性超时可以设置为晚于到期时间的值。

visibilityTimeout?: number

属性值

number

继承自messagesDequeueOptionalParams.visibilityTimeout