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 秒。 指定的值必須大於或等於 1 秒，且無法在 2011-08-18 版之前的 REST 通訊協定版本上大於 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 秒。 指定的值必須大於或等於 1 秒，且無法在 2011-08-18 版之前的 REST 通訊協定版本上大於 7 天或大於 2 小時。 訊息的可見度逾時可以設為晚於到期時間的值。

visibilityTimeout?: number

屬性值

number

繼承自MessagesDequeueOptionalParams.visibilityTimeout