QueueSendMessageOptions interface

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

Extends

プロパティ

abortSignal

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

継承されたプロパティ

messageTimeToLive

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

requestId

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

timeoutInSeconds

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

tracingOptions

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

visibilityTimeout

随意。 指定する場合は、x-ms-version 2011-08-18 以降を使用して要求を行う必要があります。 指定しない場合、既定値は 0 です。 サーバー時刻に対する新しい可視性タイムアウト値を秒単位で指定します。 新しい値は 0 以上である必要があり、7 日を超えることはできません。 メッセージの可視性タイムアウトを、有効期限より後の値に設定することはできません。 visibilitytimeout は、time-to-live 値より小さい値に設定する必要があります。

プロパティの詳細

abortSignal

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

abortSignal?: AbortSignalLike

プロパティ値

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

messageTimeToLive

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

messageTimeToLive?: number

プロパティ値

number

MessagesEnqueueOptionalParams.messageTimeToLive から継承された

requestId

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

requestId?: string

プロパティ値

string

MessagesEnqueueOptionalParams.requestId から継承された

timeoutInSeconds

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

timeoutInSeconds?: number

プロパティ値

number

MessagesEnqueueOptionalParams.timeoutInSeconds から継承された

tracingOptions

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

tracingOptions?: OperationTracingOptions

プロパティ値

継承元CommonOptions.tracingOptions

visibilityTimeout

随意。 指定する場合は、x-ms-version 2011-08-18 以降を使用して要求を行う必要があります。 指定しない場合、既定値は 0 です。 サーバー時刻に対する新しい可視性タイムアウト値を秒単位で指定します。 新しい値は 0 以上である必要があり、7 日を超えることはできません。 メッセージの可視性タイムアウトを、有効期限より後の値に設定することはできません。 visibilitytimeout は、time-to-live 値より小さい値に設定する必要があります。

visibilityTimeout?: number

プロパティ値

number

MessagesEnqueueOptionalParams.visibilityTimeout から継承された