QueuePeekMessagesOptions interface

パッケージ:

@azure/storage-queue

peekMessages 操作を構成するためのオプション

Extends

MessagesPeekOptionalParams,CommonOptions

継承されたプロパティ

abortSignal	中止コントローラーのシグナル。 ネットワーク要求の送信と応答の待機の両方を中止するために使用できます。
customHeaders	は、要求が送信される前に適用されます。
numberOfMessages	省略可能。 キューから取得するメッセージの数を示すゼロ以外の整数値を指定します (上限は 32 件)。 表示できるメッセージの数が指定された数よりも少ない場合は、表示できるメッセージが返されます。 既定では、この操作によってキューから 1 つのメッセージが取得されます。
onDownloadProgress	ダウンロードの進行状況時に発生するコールバック。
onUploadProgress	アップロードの進行状況時に発生するコールバック。
requestId	ストレージ解析ロギングが有効なときに解析ログに記録される、クライアントで生成された非透過の値を 1 KB の文字制限付きで提供します。
serializerOptions	XML 解析/構築の動作をオーバーライドするオプション。
shouldDeserialize	HttpOperationResponse を逆シリアル化する必要があるかどうか。 これが未定義の場合は、HttpOperationResponse を逆シリアル化する必要があります。
timeout	要求が自動的に終了するまでの時間 (ミリ秒)。 要求が終了すると、 AbortError がスローされます。
timeoutInSeconds	タイムアウト パラメーターは秒単位で表されます。 詳細については、「キュー サービス操作のタイムアウトの設定」を参照してください。
tracingContext	トレース: スパンの作成時に使用されるコンテキスト。
tracingOptions	トレースが有効になっているときに作成されたスパンを構成するためのオプション。

継承されたプロパティの詳細

abortSignal

中止コントローラーのシグナル。 ネットワーク要求の送信と応答の待機の両方を中止するために使用できます。

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

MessagesPeekOptionalParams.abortSignalから継承

customHeaders

は、要求が送信される前に適用されます。

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

プロパティ値

{[key: string]: string}

MessagesPeekOptionalParams.customHeadersから継承

numberOfMessages

省略可能。 キューから取得するメッセージの数を示すゼロ以外の整数値を指定します (上限は 32 件)。 表示できるメッセージの数が指定された数よりも少ない場合は、表示できるメッセージが返されます。 既定では、この操作によってキューから 1 つのメッセージが取得されます。

numberOfMessages?: number

プロパティ値

number

MessagesPeekOptionalParams.numberOfMessagesから継承

onDownloadProgress

ダウンロードの進行状況時に発生するコールバック。

onDownloadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

(progress: TransferProgressEvent) => void

MessagesPeekOptionalParams.onDownloadProgress から継承

onUploadProgress

アップロードの進行状況時に発生するコールバック。

onUploadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

(progress: TransferProgressEvent) => void

MessagesPeekOptionalParams.onUploadProgress から継承

requestId

ストレージ解析ロギングが有効なときに解析ログに記録される、クライアントで生成された非透過の値を 1 KB の文字制限付きで提供します。

requestId?: string

プロパティ値

string

MessagesPeekOptionalParams.requestIdから継承

serializerOptions

XML 解析/構築の動作をオーバーライドするオプション。

serializerOptions?: SerializerOptions

プロパティ値

SerializerOptions

MessagesPeekOptionalParams.serializerOptionsから継承

shouldDeserialize

HttpOperationResponse を逆シリアル化する必要があるかどうか。 これが未定義の場合は、HttpOperationResponse を逆シリアル化する必要があります。

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

プロパティ値

boolean | (response: HttpOperationResponse) => boolean

MessagesPeekOptionalParams.shouldDeserializeから継承されます

timeout

要求が自動的に終了するまでの時間 (ミリ秒)。 要求が終了すると、 AbortError がスローされます。

timeout?: number

プロパティ値

number

MessagesPeekOptionalParams.timeoutから継承

timeoutInSeconds

タイムアウト パラメーターは秒単位で表されます。 詳細については、「キュー サービス操作のタイムアウトの設定」を参照してください。

timeoutInSeconds?: number

プロパティ値

number

MessagesPeekOptionalParams.timeoutInSecondsから継承

tracingContext

トレース: スパンの作成時に使用されるコンテキスト。

tracingContext?: Context

プロパティ値

@azure/core-tracing.Context

MessagesPeekOptionalParams.tracingContextから継承

tracingOptions

トレースが有効になっているときに作成されたスパンを構成するためのオプション。

tracingOptions?: OperationTracingOptions

プロパティ値

OperationTracingOptions

CommonOptions.tracingOptionsから継承