MessagesPeekOptionalParams interface

套件:

@azure/storage-queue

選用參數。

Extends

RequestOptionsBase

屬性

numberOfMessages	選擇性。 這是非零整數值，可指定從佇列擷取的訊息數目 (32 則為上限)。 如果可見的訊息較少，則會傳回可見的訊息。 根據預設，使用此作業會從佇列擷取單一訊息。
requestId	提供啟用儲存體分析記錄時，由用戶端產生的不透明值，而且在分析記錄中記錄 1 KB 的字元限制。
timeoutInSeconds	逾時參數是以秒為單位表示。 如需詳細資訊，請參閱 設定佇列服務作業的逾時。

繼承的屬性

abortSignal	中止控制器的訊號。 可用來中止傳送網路要求和等候回應。
customHeaders	將會在傳送要求之前套用。
onDownloadProgress	下載進度時引發的回呼。
onUploadProgress	上傳進度時引發的回呼。
serializerOptions	覆寫 XML 剖析/建置行為的選項。
shouldDeserialize	是否應該還原序列化 HttpOperationResponse。 如果未定義，則應該還原序列化 HttpOperationResponse。
timeout	要求在自動終止之前可能需要的毫秒數。 如果要求終止， AbortError 則會擲回 。
tracingContext	追蹤：建立範圍時所使用的內容。

屬性詳細資料

numberOfMessages

選擇性。 這是非零整數值，可指定從佇列擷取的訊息數目 (32 則為上限)。 如果可見的訊息較少，則會傳回可見的訊息。 根據預設，使用此作業會從佇列擷取單一訊息。

numberOfMessages?: number

屬性值

number

requestId

提供啟用儲存體分析記錄時，由用戶端產生的不透明值，而且在分析記錄中記錄 1 KB 的字元限制。

requestId?: string

屬性值

string

timeoutInSeconds

逾時參數是以秒為單位表示。 如需詳細資訊，請參閱 設定佇列服務作業的逾時。

timeoutInSeconds?: number

屬性值

number

繼承的屬性詳細資料

abortSignal

中止控制器的訊號。 可用來中止傳送網路要求和等候回應。

abortSignal?: AbortSignalLike

屬性值

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

屬性值

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

屬性值

@azure/core-tracing.Context

繼承自 RequestOptionsBase.tracingCoNtext