QueuePeekMessagesOptions interface

パッケージ:

@azure/storage-queue

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

Extends

MessagesPeekOptionalParams,CommonOptions

プロパティ

abortSignal

操作を取り消す要求を通知する AbortSignalLike インターフェイスの実装。 たとえば、@azure/abort-controller を使用して AbortSignalを作成します。

継承されたプロパティ

numberOfMessages	随意。 キューから取得するメッセージの数を指定する 0 以外の整数値 (最大 32)。 表示されるメッセージが少ない場合は、表示されるメッセージが返されます。 既定では、この操作でキューから 1 つのメッセージが取得されます。
requestId	ストレージ分析ログが有効な場合に分析ログに記録される 1 KB の文字制限を持つ、クライアント生成の不透明な値を提供します。
timeoutInSeconds	タイムアウト パラメーターは秒単位で表されます。 詳細については、「キュー サービス操作のタイムアウトの設定 」を参照してください。
tracingOptions	トレースが有効な場合に作成されるスパンを構成するオプション。

プロパティの詳細

abortSignal

操作を取り消す要求を通知する AbortSignalLike インターフェイスの実装。 たとえば、@azure/abort-controller を使用して AbortSignalを作成します。

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

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

numberOfMessages

随意。 キューから取得するメッセージの数を指定する 0 以外の整数値 (最大 32)。 表示されるメッセージが少ない場合は、表示されるメッセージが返されます。 既定では、この操作でキューから 1 つのメッセージが取得されます。

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