你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
MessagesPeekOptionalParams interface
可选参数。
- Extends
属性
number |
可选。 用来指定要从队列检索的消息数目的非零整数值,最大值为 32。 如果可见的消息较少,则返回可见的消息。 默认情况下,使用此操作将检索队列中的一条消息。 |
request |
提供客户端生成的、具有 1 KB 字符限制的模糊值,启用存储分析日志记录时将在分析日志中记录该值。 |
timeout |
超时参数以秒为单位表示。 有关详细信息,请参阅 为队列服务操作设置超时。 |
继承属性
abort |
中止控制器的信号。 可用于中止发送网络请求和等待响应。 |
custom |
将在发送请求之前应用。 |
on |
下载进度时触发的回调。 |
on |
上传进度时触发的回调。 |
serializer |
用于替代 XML 分析/生成行为的选项。 |
should |
是否应反序列化 HttpOperationResponse。 如果未定义,则应反序列化 HttpOperationResponse。 |
timeout | 请求在自动终止之前可以花费的毫秒数。
如果请求终止, |
tracing |
跟踪:创建范围时使用的上下文。 |
属性详细信息
numberOfMessages
可选。 用来指定要从队列检索的消息数目的非零整数值,最大值为 32。 如果可见的消息较少,则返回可见的消息。 默认情况下,使用此操作将检索队列中的一条消息。
numberOfMessages?: number
属性值
number
requestId
提供客户端生成的、具有 1 KB 字符限制的模糊值,启用存储分析日志记录时将在分析日志中记录该值。
requestId?: string
属性值
string
timeoutInSeconds
继承属性详细信息
abortSignal
中止控制器的信号。 可用于中止发送网络请求和等待响应。
abortSignal?: AbortSignalLike
属性值
继承自 RequestOptionsBase.abortSignal
customHeaders
将在发送请求之前应用。
customHeaders?: {[key: string]: string}
属性值
{[key: string]: string}
继承自 RequestOptionsBase.customHeaders
onDownloadProgress
下载进度时触发的回调。
onDownloadProgress?: (progress: TransferProgressEvent) => void
属性值
(progress: TransferProgressEvent) => void
继承自 RequestOptionsBase.onDownloadProgress
onUploadProgress
上传进度时触发的回调。
onUploadProgress?: (progress: TransferProgressEvent) => void
属性值
(progress: TransferProgressEvent) => void
继承自 RequestOptionsBase.onUploadProgress
serializerOptions
用于替代 XML 分析/生成行为的选项。
serializerOptions?: SerializerOptions
属性值
继承自 RequestOptionsBase.serializerOptions
shouldDeserialize
是否应反序列化 HttpOperationResponse。 如果未定义,则应反序列化 HttpOperationResponse。
shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean
属性值
boolean | (response: HttpOperationResponse) => boolean
继承自 RequestOptionsBase.shouldDeserialize
timeout
请求在自动终止之前可以花费的毫秒数。
如果请求终止, AbortError
则会引发 。
timeout?: number
属性值
number
继承自 RequestOptionsBase.timeout
tracingContext
跟踪:创建范围时使用的上下文。
tracingContext?: Context
属性值
继承自 RequestOptionsBase.tracingContext