MessagesEnqueueOptionalParams interface

  • リファレンス
パッケージ:
@azure/storage-queue

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

Extends
CommonOptions

プロパティ

messageTimeToLive

省略可能。 メッセージの有効期限を秒単位で指定します。 バージョン 2017-07-29 より前のバージョンでは、最大有効期間は 7 日間です。 バージョン 2017-07-29 以降の場合、最大有効期間は任意の正の数と、メッセージの有効期限が切れないことを示す -1 になります。 このパラメーターが省略されている場合、既定の有効期限は 7 日です。
requestId

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

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

省略可能。 指定する場合は、x-ms-version の 2011-08-18 以降を使用して要求を行う必要があります。 値を指定しない場合は、既定値 0 が使用されます。 サーバー時間を基準に、新しい表示タイムアウト値を秒単位で指定します。 新しい値は、0 以上の 7 日を超えない値である必要があります。 メッセージの表示タイムアウト値は、有効期限より後の値に設定できます。 visibilitytimeout は、有効期間の値より小さい値に設定する必要があります。

継承されたプロパティ

tracingOptions

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

プロパティの詳細

messageTimeToLive

省略可能。 メッセージの有効期限を秒単位で指定します。 バージョン 2017-07-29 より前のバージョンでは、最大有効期間は 7 日間です。 バージョン 2017-07-29 以降の場合、最大有効期間は任意の正の数と、メッセージの有効期限が切れないことを示す -1 になります。 このパラメーターが省略されている場合、既定の有効期限は 7 日です。

messageTimeToLive?: number

プロパティ値

number

requestId

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

requestId?: string

プロパティ値

string

timeoutInSeconds

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

timeoutInSeconds?: number

プロパティ値

number

visibilityTimeout

省略可能。 指定する場合は、x-ms-version の 2011-08-18 以降を使用して要求を行う必要があります。 値を指定しない場合は、既定値 0 が使用されます。 サーバー時間を基準に、新しい表示タイムアウト値を秒単位で指定します。 新しい値は、0 以上の 7 日を超えない値である必要があります。 メッセージの表示タイムアウト値は、有効期限より後の値に設定できます。 visibilitytimeout は、有効期間の値より小さい値に設定する必要があります。

visibilityTimeout?: number

プロパティ値

number

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

tracingOptions

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

tracingOptions?: OperationTracingOptions

プロパティ値

OperationTracingOptions

CommonOptions.tracingOptionsから継承