QueueReceiveMessageOptions interface
receiveMessages 操作
- Extends
プロパティ
| abort |
操作を取り消す要求を通知する |
継承されたプロパティ
| number |
随意。 キューから取得するメッセージの数を指定する 0 以外の整数値 (最大 32)。 表示されるメッセージが少ない場合は、表示されるメッセージが返されます。 既定では、この操作でキューから 1 つのメッセージが取得されます。 |
| request |
ストレージ分析ログが有効な場合に分析ログに記録される 1 KB の文字制限を持つ、クライアント生成の不透明な値を提供します。 |
| timeout |
タイムアウト パラメーターは秒単位で表されます。 詳細については、「キュー サービス操作のタイムアウトの設定 」を参照してください。 |
| tracing |
トレースが有効な場合に作成されるスパンを構成するオプション。 |
| visibility |
随意。 サーバー時刻に対する新しい可視性タイムアウト値を秒単位で指定します。 既定値は 30 秒です。 指定した値は 1 秒以上である必要があり、バージョン 2011-08-18 より前の REST プロトコル バージョンでは 7 日以上、または 2 時間を超えることはできません。 メッセージの可視性タイムアウトは、有効期限より後の値に設定できます。 |
プロパティの詳細
abortSignal
操作を取り消す要求を通知する AbortSignalLike インターフェイスの実装。
たとえば、@azure/abort-controller を使用して AbortSignalを作成します。
abortSignal?: AbortSignalLikeプロパティ値
継承されたプロパティの詳細
numberOfMessages
随意。 キューから取得するメッセージの数を指定する 0 以外の整数値 (最大 32)。 表示されるメッセージが少ない場合は、表示されるメッセージが返されます。 既定では、この操作でキューから 1 つのメッセージが取得されます。
numberOfMessages?: numberプロパティ値
number
requestId
ストレージ分析ログが有効な場合に分析ログに記録される 1 KB の文字制限を持つ、クライアント生成の不透明な値を提供します。
requestId?: stringプロパティ値
string
Inherited FromMessagesDequeueOptionalParams.requestId
timeoutInSeconds
タイムアウト パラメーターは秒単位で表されます。 詳細については、「キュー サービス操作のタイムアウトの設定 」を参照してください。
timeoutInSeconds?: numberプロパティ値
number
tracingOptions
トレースが有効な場合に作成されるスパンを構成するオプション。
tracingOptions?: OperationTracingOptionsプロパティ値
visibilityTimeout
随意。 サーバー時刻に対する新しい可視性タイムアウト値を秒単位で指定します。 既定値は 30 秒です。 指定した値は 1 秒以上である必要があり、バージョン 2011-08-18 より前の REST プロトコル バージョンでは 7 日以上、または 2 時間を超えることはできません。 メッセージの可視性タイムアウトは、有効期限より後の値に設定できます。
visibilityTimeout?: numberプロパティ値
number