ServiceBusReceiver interface

パッケージ:

@azure/service-bus

セッションを処理しないレシーバー。

プロパティ

entityPath	受信者が作成されたエンティティのパス。
identifier	受信者を識別するために使用される名前。 これを使用して、ログと例外を関連付けることができます。 指定しない場合、または空の場合は、ランダムに一意のものが生成されます。
isClosed	受信側またはそれを作成したクライアントのいずれかが閉じている場合は、true を返します。
receiveMode	受信側の作成に使用される受信モード。

メソッド

abandonMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	受信側がメッセージに保持しているロックが解除され、別の受信操作のために Service Bus でメッセージを再び使用できるようになります。
close()	受信側を閉じます。 いったん閉じると、受信側はそれ以降の操作には使用できません。 ServiceBusClient の createReceiver() メソッドを使用して、新しい Receiver を作成します。
completeMessage(ServiceBusReceivedMessage)	Service Bus からメッセージを削除します。
deadLetterMessage(ServiceBusReceivedMessage, DeadLetterOptions & {[key: string]: number | boolean | string | Date | null})	メッセージを配信不能サブキューに移動します。 配信不能メッセージを受信するには、配信不能サブキューのパスを使用して、新しい QueueClient/SubscriptionClient を作成します。
deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	メッセージの処理を延期します。 メッセージの sequenceNumber を保存して、receiveDeferredMessage メソッドを使用してメッセージを今後再び受信します。
getMessageIterator(GetMessageIteratorOptions)	Service Bus からメッセージを受信するために使用できる反復子を返します。
peekMessages(number, PeekMessagesOptions)	キューまたはサブスクリプション上のアクティブなメッセージの次のバッチ (遅延メッセージを含むが配信不能ではないメッセージを含む) を変更せずにピークします。 peekMessages() の最初の呼び出しは、最初のアクティブなメッセージをフェッチします。 後続の各呼び出しでは、後続のメッセージがフェッチされます。 "受信" メッセージとは異なり、"ピーク" メッセージはメッセージの読み取り専用バージョンです。 Completed/Abandoned/Deferred/Deadletteredすることはできません。
receiveDeferredMessages(Long | Long[], OperationOptionsBase)	指定された sequenceNumbersによって識別される遅延メッセージの配列に解決される promise を返します。
receiveMessages(number, ReceiveMessagesOptions)	Service Bus から受信したメッセージの配列に解決される Promise を返します。
renewMessageLock(ServiceBusReceivedMessage)	キュー/サブスクリプションの作成時に指定された期間、メッセージのロックを更新します。 メッセージの lockedUntilUtc プロパティで、ロックの有効期限が切れる時刻を確認します。 ロックの有効期限が切れる前にメッセージが解決されない場合 (complete()、defer()、または deadletter()を使用して)、メッセージは次の受信操作のためにキュー/サブスクリプションに戻ります。
subscribe(MessageHandlers, SubscribeOptions)	メッセージをメッセージ ハンドラーにストリーミングします。

プロパティの詳細

entityPath

受信者が作成されたエンティティのパス。

entityPath: string

プロパティ値

string

identifier

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

identifier: string

プロパティ値

string

isClosed

受信側またはそれを作成したクライアントのいずれかが閉じている場合は、true を返します。

isClosed: boolean

プロパティ値

boolean

receiveMode

受信側の作成に使用される受信モード。

receiveMode: "peekLock" | "receiveAndDelete"

プロパティ値

"peekLock" | "receiveAndDelete"

メソッドの詳細

abandonMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})

受信側がメッセージに保持しているロックが解除され、別の受信操作のために Service Bus でメッセージを再び使用できるようになります。

function abandonMessage(message: ServiceBusReceivedMessage, propertiesToModify?: {[key: string]: number | boolean | string | Date | null}): Promise<void>

パラメーター

message

ServiceBusReceivedMessage

propertiesToModify

{[key: string]: number | boolean | string | Date | null}

メッセージの破棄中に変更するメッセージのプロパティ。

戻り値

Promise<void>

close()

受信側を閉じます。 いったん閉じると、受信側はそれ以降の操作には使用できません。 ServiceBusClient の createReceiver() メソッドを使用して、新しい Receiver を作成します。

function close(): Promise<void>

戻り値

Promise<void>

completeMessage(ServiceBusReceivedMessage)

Service Bus からメッセージを削除します。

function completeMessage(message: ServiceBusReceivedMessage): Promise<void>

パラメーター

message

ServiceBusReceivedMessage

戻り値

Promise<void>

deadLetterMessage(ServiceBusReceivedMessage, DeadLetterOptions & {[key: string]: number | boolean | string | Date | null})

メッセージを配信不能サブキューに移動します。 配信不能メッセージを受信するには、配信不能サブキューのパスを使用して、新しい QueueClient/SubscriptionClient を作成します。

function deadLetterMessage(message: ServiceBusReceivedMessage, options?: DeadLetterOptions & {[key: string]: number | boolean | string | Date | null}): Promise<void>

パラメーター

message

ServiceBusReceivedMessage

options

DeadLetterOptions & {[key: string]: number | boolean | string | Date | null}

メッセージを拒否するときに指定できる DeadLetter オプション。

戻り値

Promise<void>

deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})

メッセージの処理を延期します。 メッセージの sequenceNumber を保存して、receiveDeferredMessage メソッドを使用してメッセージを今後再び受信します。

function deferMessage(message: ServiceBusReceivedMessage, propertiesToModify?: {[key: string]: number | boolean | string | Date | null}): Promise<void>

パラメーター

message

ServiceBusReceivedMessage

propertiesToModify

{[key: string]: number | boolean | string | Date | null}

メッセージの遅延中に変更するメッセージのプロパティ

戻り値

Promise<void>

getMessageIterator(GetMessageIteratorOptions)

Service Bus からメッセージを受信するために使用できる反復子を返します。

function getMessageIterator(options?: GetMessageIteratorOptions): AsyncIterableIterator<ServiceBusReceivedMessage>

パラメーター

options

GetMessageIteratorOptions

受信操作を制御するための一連のオプション。

• abortSignal: 進行中の操作を中止するために使用するシグナル。

戻り値

AsyncIterableIterator<ServiceBusReceivedMessage>

peekMessages(number, PeekMessagesOptions)

キューまたはサブスクリプション上のアクティブなメッセージの次のバッチ (遅延メッセージを含むが配信不能ではないメッセージを含む) を変更せずにピークします。

• peekMessages() の最初の呼び出しは、最初のアクティブなメッセージをフェッチします。 後続の各呼び出しでは、後続のメッセージがフェッチされます。
• "受信" メッセージとは異なり、"ピーク" メッセージはメッセージの読み取り専用バージョンです。 Completed/Abandoned/Deferred/Deadletteredすることはできません。

function peekMessages(maxMessageCount: number, options?: PeekMessagesOptions): Promise<ServiceBusReceivedMessage[]>

パラメーター

maxMessageCount

number

ピークするメッセージの最大数。

options

PeekMessagesOptions

ピークするメッセージの最大数、ピークを開始する sequenceNumber、または abortSignal を指定して操作を中止できるようにするオプション。

戻り値

Promise<ServiceBusReceivedMessage[]>

receiveDeferredMessages(Long | Long[], OperationOptionsBase)

指定された sequenceNumbersによって識別される遅延メッセージの配列に解決される promise を返します。

function receiveDeferredMessages(sequenceNumbers: Long | Long[], options?: OperationOptionsBase): Promise<ServiceBusReceivedMessage[]>

パラメーター

sequenceNumbers

Long | Long[]

受信する必要があるメッセージのシーケンス番号またはシーケンス番号の配列。

options

OperationOptionsBase

中止シグナルまたはトレース オプションを渡すオプション バッグ。

戻り値

Promise<ServiceBusReceivedMessage[]>

指定された sequenceNumbers で識別されるメッセージのリスト。メッセージが見つからない場合は空のリスト。

receiveMessages(number, ReceiveMessagesOptions)

Service Bus から受信したメッセージの配列に解決される Promise を返します。

function receiveMessages(maxMessageCount: number, options?: ReceiveMessagesOptions): Promise<ServiceBusReceivedMessage[]>

パラメーター

maxMessageCount

number

受信するメッセージの最大数。

options

ReceiveMessagesOptions

受信操作を制御するための一連のオプション。

• maxWaitTimeInMs: 使用可能なメッセージがない場合に空の配列を返す前に、最初のメッセージを待機する最大時間。
• abortSignal: 進行中の操作を中止するために使用するシグナル。

戻り値

Promise<ServiceBusReceivedMessage[]>

メッセージの配列で解決される Promise。

renewMessageLock(ServiceBusReceivedMessage)

キュー/サブスクリプションの作成時に指定された期間、メッセージのロックを更新します。

• メッセージの lockedUntilUtc プロパティで、ロックの有効期限が切れる時刻を確認します。
• ロックの有効期限が切れる前にメッセージが解決されない場合 (complete()、defer()、または deadletter()を使用して)、メッセージは次の受信操作のためにキュー/サブスクリプションに戻ります。

function renewMessageLock(message: ServiceBusReceivedMessage): Promise<Date>

パラメーター

message

ServiceBusReceivedMessage

戻り値

Promise<Date>

新しいロック トークンの有効期限の日付と時刻 (UTC 形式)。

subscribe(MessageHandlers, SubscribeOptions)

メッセージをメッセージ ハンドラーにストリーミングします。

function subscribe(handlers: MessageHandlers, options?: SubscribeOptions): { close() => Promise<void> }

パラメーター

handlers

MessageHandlers

メッセージとエラーに対して呼び出されるハンドラー。

options

SubscribeOptions

サブスクライブのオプション。

戻り値

{ close() => Promise<void> }

閉じることができるオブジェクト。残りのメッセージを handlers に送信し、新しいメッセージの到着を停止します。