ServiceBusSessionReceiverOptions interface

パッケージ:

@azure/service-bus

セッションが有効になっている Queue/Subscription を使用する場合に acceptSession メソッドと acceptNextSession メソッドに渡されるオプションについて説明します。

Extends

OperationOptionsBase

プロパティ

identifier	セッション レシーバーを識別する名前を設定します。 これは、ログと例外を関連付けるために使用できます。 指定しない場合、または空の場合は、ランダムな一意のものが使用されます。
maxAutoLockRenewalDurationInMs	セッションのロックがクライアントによって自動的に更新される最大期間 (ミリ秒単位)。 既定値: 300000 ミリ秒 (5 分)。 自動ロック更新を無効にするには、これを に設定します 0。 例: ロックが 2 分で期限切れになり、処理時間が 8 分の場合... maxAutoLockRenewalDurationInMs を 10 分に設定すると、ロックは約 4 回自動的に更新されます (ロックの更新を利用して、セッションをロック期間の 4 倍にロックすることと同じです)。
receiveMode	受信側の受信モードを表します。 receiveAndDelete モードでは、メッセージは受信時に Service Bus から削除されます。 peekLock モードでは、受信側はキュー/サブスクリプションで指定された期間、メッセージをロックします。 ロック期間内に解決されないメッセージは、キューまたはサブスクリプションに設定されている最大配信数の回数だけ再配信され、その後、別の配信不能キューに送信されます。 メッセージに対して complete()、abandon()、defer() または deadletter() メソッドを呼び出すことで、メッセージを解決できます。 peekLock とメッセージ決済のしくみの詳細については、以下を参照してください。 https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
skipConvertingDate	メッセージの受信時に、メッセージ注釈またはアプリケーション プロパティのプロパティの Date 型の数値への変換をスキップするかどうか。 既定では、Date 型のプロパティは互換性のために UNIX エポック番号に変換されます。
skipParsingBodyAsJson	メッセージの受信時に、クライアントがメッセージ本文で JSON.parse() を実行できないようにするオプション。 メッセージが AMQP 本文の種類の値またはシーケンスと共に送信された場合は適用されません。 このオプションは、クライアントが解析を試みるよりも、メッセージ本文に存在するバイトを直接操作する場合に使用します。

継承されたプロパティ

abortSignal	要求を中止するために使用できるシグナル。
tracingOptions	トレースが有効な場合に使用されるオプション。

プロパティの詳細

identifier

セッション レシーバーを識別する名前を設定します。 これは、ログと例外を関連付けるために使用できます。 指定しない場合、または空の場合は、ランダムな一意のものが使用されます。

identifier?: string

プロパティ値

string

maxAutoLockRenewalDurationInMs

セッションのロックがクライアントによって自動的に更新される最大期間 (ミリ秒単位)。

• 既定値: 300000 ミリ秒 (5 分)。
• 自動ロック更新を無効にするには、これを に設定します 0。

例:

ロックが 2 分で期限切れになり、処理時間が 8 分の場合...

maxAutoLockRenewalDurationInMs を 10 分に設定すると、ロックは約 4 回自動的に更新されます (ロックの更新を利用して、セッションをロック期間の 4 倍にロックすることと同じです)。

maxAutoLockRenewalDurationInMs?: number

プロパティ値

number

receiveMode

受信側の受信モードを表します。

receiveAndDelete モードでは、メッセージは受信時に Service Bus から削除されます。

peekLock モードでは、受信側はキュー/サブスクリプションで指定された期間、メッセージをロックします。

ロック期間内に解決されないメッセージは、キューまたはサブスクリプションに設定されている最大配信数の回数だけ再配信され、その後、別の配信不能キューに送信されます。

メッセージに対して complete()、abandon()、defer() または deadletter() メソッドを呼び出すことで、メッセージを解決できます。

peekLock とメッセージ決済のしくみの詳細については、以下を参照してください。 https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

receiveMode?: "peekLock" | "receiveAndDelete"

プロパティ値

"peekLock" | "receiveAndDelete"

skipConvertingDate

メッセージの受信時に、メッセージ注釈またはアプリケーション プロパティのプロパティの Date 型の数値への変換をスキップするかどうか。 既定では、Date 型のプロパティは互換性のために UNIX エポック番号に変換されます。

skipConvertingDate?: boolean

プロパティ値

boolean

skipParsingBodyAsJson

メッセージの受信時に、クライアントがメッセージ本文で JSON.parse() を実行できないようにするオプション。 メッセージが AMQP 本文の種類の値またはシーケンスと共に送信された場合は適用されません。 このオプションは、クライアントが解析を試みるよりも、メッセージ本文に存在するバイトを直接操作する場合に使用します。

skipParsingBodyAsJson?: boolean

プロパティ値

boolean

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

abortSignal

要求を中止するために使用できるシグナル。

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

継承元 OperationOptionsBase.abortSignal

tracingOptions

トレースが有効な場合に使用されるオプション。

tracingOptions?: OperationTracingOptions

プロパティ値

OperationTracingOptions

継承元 OperationOptionsBase.tracingOptions