Share via

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

QueueReceiveMessageOptions interface

  • 参考
包:
@azure/storage-queue

用于配置 receiveMessages 操作的选项

Extends

MessagesDequeueOptionalParams,CommonOptions

继承属性

abortSignal

中止控制器的信号。 可用于中止发送网络请求和等待响应。
customHeaders

将在发送请求之前应用。
numberOfMessages

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

下载进度时触发的回调。
onUploadProgress

上传进度时触发的回调。
requestId

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

用于替代 XML 分析/生成行为的选项。
shouldDeserialize

是否应反序列化 HttpOperationResponse。 如果未定义，则应反序列化 HttpOperationResponse。
timeout

请求在自动终止之前可以花费的毫秒数。 如果请求终止， AbortError 则会引发 。
timeoutInSeconds

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

跟踪：创建跨度时使用的上下文。
tracingOptions

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

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

继承属性详细信息

abortSignal

中止控制器的信号。 可用于中止发送网络请求和等待响应。

abortSignal?: AbortSignalLike

属性值

AbortSignalLike

继承自MessagesDequeueOptionalParams.abortSignal

customHeaders

将在发送请求之前应用。

customHeaders?: {[key: string]: string}

属性值

{[key: string]: string}

继承自MessagesDequeueOptionalParams.customHeaders

numberOfMessages

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

numberOfMessages?: number

属性值

number

继承自MessagesDequeueOptionalParams.numberOfMessages

onDownloadProgress

下载进度时触发的回调。

onDownloadProgress?: (progress: TransferProgressEvent) => void

属性值

(progress: TransferProgressEvent) => void

继承自MessagesDequeueOptionalParams.onDownloadProgress

onUploadProgress

上传进度时触发的回调。

onUploadProgress?: (progress: TransferProgressEvent) => void

属性值

(progress: TransferProgressEvent) => void

继承自MessagesDequeueOptionalParams.onUploadProgress

requestId

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

requestId?: string

属性值

string

继承自MessagesDequeueOptionalParams.requestId

serializerOptions

用于替代 XML 分析/生成行为的选项。

serializerOptions?: SerializerOptions

属性值

SerializerOptions

继承自MessagesDequeueOptionalParams.serializerOptions

shouldDeserialize

是否应反序列化 HttpOperationResponse。 如果未定义，则应反序列化 HttpOperationResponse。

shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean

属性值

boolean | (response: HttpOperationResponse) => boolean

继承自MessagesDequeueOptionalParams.shouldDeserialize

timeout

请求在自动终止之前可以花费的毫秒数。 如果请求终止， AbortError 则会引发 。

timeout?: number

属性值

number

继承自MessagesDequeueOptionalParams.timeout

timeoutInSeconds

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

timeoutInSeconds?: number

属性值

number

继承自MessagesDequeueOptionalParams.timeoutInSeconds

tracingContext

跟踪：创建跨度时使用的上下文。

tracingContext?: Context

属性值

@azure/core-tracing.Context

继承自MessagesDequeueOptionalParams.tracingContext

tracingOptions

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

tracingOptions?: OperationTracingOptions

属性值

OperationTracingOptions

继承自CommonOptions.tracingOptions

visibilityTimeout

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

visibilityTimeout?: number

属性值

number

继承自MessagesDequeueOptionalParams.visibilityTimeout