QueuePeekMessagesOptions interface

參考

套件:: @azure/storage-queue

設定查看Messages 作業的選項

Extends: MessagesPeekOptionalParams,CommonOptions

屬性

AbortSignalLike 介面的實作，以發出取消作業的要求。例如，使用 @azure/abort-controller 來建立 AbortSignal。

繼承的屬性

numberOfMessages	自選。非零整數值，指定要從佇列擷取的訊息數目，最多 32 個。如果可見的較少，則會傳回可見的訊息。根據預設，會使用這項作業從佇列擷取單一訊息。
requestId	提供客戶端產生的不透明值，其中包含啟用記憶體分析記錄時，分析記錄中記錄的 1 KB 字元限制。
timeoutInSeconds	逾時參數是以秒為單位來表示。如需詳細資訊，請參閱設定佇列服務作業的逾時。
tracingOptions	設定啟用追蹤時所建立範圍的選項。

屬性詳細資料

abortSignal

AbortSignalLike 介面的實作，以發出取消作業的要求。例如，使用 @azure/abort-controller 來建立 AbortSignal。

abortSignal?: AbortSignalLike

屬性值

AbortSignalLike

繼承的屬性詳細資料

numberOfMessages

自選。非零整數值，指定要從佇列擷取的訊息數目，最多 32 個。如果可見的較少，則會傳回可見的訊息。根據預設，會使用這項作業從佇列擷取單一訊息。

numberOfMessages?: number

屬性值

number

繼承自MessagesPeekOptionalParams.numberOfMessages

requestId

提供客戶端產生的不透明值，其中包含啟用記憶體分析記錄時，分析記錄中記錄的 1 KB 字元限制。

requestId?: string

屬性值

string

繼承自MessagesPeekOptionalParams.requestId

timeoutInSeconds

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

timeoutInSeconds?: number

屬性值

number

繼承自MessagesPeekOptionalParams.timeoutInSeconds

tracingOptions

設定啟用追蹤時所建立範圍的選項。

tracingOptions?: OperationTracingOptions

屬性值

OperationTracingOptions

繼承自CommonOptions.tracingOptions

共用方式為