ServiceBusReceiverOptions interface

パッケージ:

@azure/service-bus

レシーバーの作成時に使用するオプション。

プロパティ

identifier	受信者を識別する名前を設定します。 これは、ログと例外を関連付けるために使用できます。 指定しない場合、または空の場合は、ランダムな一意のものが使用されます。
maxAutoLockRenewalDurationInMs	メッセージのロックがクライアントによって自動的に更新される最大時間 (ミリ秒単位)。 この自動更新は、メッセージが解決されると停止します。 既定値: 300 * 1000 ミリ秒 (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 本文の種類の値またはシーケンスと共に送信された場合は適用されません。 このオプションは、クライアントが解析を試みるよりも、メッセージ本文に存在するバイトを直接操作する場合に使用します。
subQueueType	任意のキューまたはサブスクリプションに適用できるサブ キューを表します。 有効な値は "deadLetter" と "transferDeadLetter" です。 配信不能キューの詳細については、次を参照してください。 https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

プロパティの詳細

identifier

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

identifier?: string

プロパティ値

string

maxAutoLockRenewalDurationInMs

メッセージのロックがクライアントによって自動的に更新される最大時間 (ミリ秒単位)。 この自動更新は、メッセージが解決されると停止します。

• 既定値: 300 * 1000 ミリ秒 (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

subQueueType

任意のキューまたはサブスクリプションに適用できるサブ キューを表します。 有効な値は "deadLetter" と "transferDeadLetter" です。 配信不能キューの詳細については、次を参照してください。 https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

subQueueType?: "deadLetter" | "transferDeadLetter"

プロパティ値

"deadLetter" | "transferDeadLetter"