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

MessagesDequeueOptionalParams interface

可选参数。

扩展

属性

numberOfMessages

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

requestId

提供客户端生成的、具有 1 KB 字符限制的模糊值,启用存储分析日志记录时将在分析日志中记录该值。

timeoutInSeconds

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

visibilityTimeout

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

继承属性

tracingOptions

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

属性详细信息

numberOfMessages

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

numberOfMessages?: number

属性值

number

requestId

提供客户端生成的、具有 1 KB 字符限制的模糊值,启用存储分析日志记录时将在分析日志中记录该值。

requestId?: string

属性值

string

timeoutInSeconds

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

timeoutInSeconds?: number

属性值

number

visibilityTimeout

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

visibilityTimeout?: number

属性值

number

继承属性详细信息

tracingOptions

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

tracingOptions?: OperationTracingOptions

属性值

继承自CommonOptions.tracingOptions