MessagesDequeueOptionalParams interface

パッケージ:

@azure/storage-queue

省略可能なパラメーター。

Extends

CommonOptions

プロパティ

numberOfMessages	随意。 キューから取得するメッセージの数を指定する 0 以外の整数値 (最大 32)。 表示されるメッセージが少ない場合は、表示されるメッセージが返されます。 既定では、この操作でキューから 1 つのメッセージが取得されます。
requestId	ストレージ分析ログが有効な場合に分析ログに記録される 1 KB の文字制限を持つ、クライアント生成の不透明な値を提供します。
timeoutInSeconds	タイムアウト パラメーターは秒単位で表されます。 詳細については、「キュー サービス操作のタイムアウトの設定 」を参照してください。
visibilityTimeout	随意。 サーバー時刻に対する新しい可視性タイムアウト値を秒単位で指定します。 既定値は 30 秒です。 指定した値は 1 秒以上である必要があり、バージョン 2011-08-18 より前の REST プロトコル バージョンでは 7 日以上、または 2 時間を超えることはできません。 メッセージの可視性タイムアウトは、有効期限より後の値に設定できます。

継承されたプロパティ

tracingOptions

トレースが有効な場合に作成されるスパンを構成するオプション。

プロパティの詳細

numberOfMessages

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

numberOfMessages?: number

プロパティ値

number

requestId

ストレージ分析ログが有効な場合に分析ログに記録される 1 KB の文字制限を持つ、クライアント生成の不透明な値を提供します。

requestId?: string

プロパティ値

string

timeoutInSeconds

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

timeoutInSeconds?: number

プロパティ値

number

visibilityTimeout

随意。 サーバー時刻に対する新しい可視性タイムアウト値を秒単位で指定します。 既定値は 30 秒です。 指定した値は 1 秒以上である必要があり、バージョン 2011-08-18 より前の REST プロトコル バージョンでは 7 日以上、または 2 時間を超えることはできません。 メッセージの可視性タイムアウトは、有効期限より後の値に設定できます。

visibilityTimeout?: number

プロパティ値

number

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

tracingOptions

トレースが有効な場合に作成されるスパンを構成するオプション。

tracingOptions?: OperationTracingOptions

プロパティ値

OperationTracingOptions

継承元CommonOptions.tracingOptions