ServiceBusClient class

接続文字列で提供される Azure Service Bus 名前空間への送信者と受信者を作成するために使用できる ServiceBusClient クラスのインスタンスを作成します。 クライアントで作成された送信者/受信者がメッセージの送受信に使用されるまで、サービスへの接続は行われません。

new ServiceBusClient(connectionString: string, options?: ServiceBusClientOptions)

パラメーター

提供された Azure Service Bus 名前空間への送信者と受信者を作成するために使用できる ServiceBusClient クラスのインスタンスを作成します。 クライアントで作成された送信者/受信者がメッセージの送受信に使用されるまで、サービスへの接続は行われません。

new ServiceBusClient(fullyQualifiedNamespace: string, credential: TokenCredential | NamedKeyCredential | SASCredential, options?: ServiceBusClientOptions)

パラメーター

このクライアントが作成される Service Bus インスタンスの完全修飾名前空間。 これは <yournamespace>.servicebus.windows.net に似ている可能性があります。

fullyQualifiedNamespace: string

プロパティ値

この ServiceBusClient を識別するために使用される名前。 指定しない場合、または空の場合は、ランダムに一意のものが生成されます。

identifier: string

プロパティ値

セッションが有効な Azure Service Bus キューに、次に使用可能なセッションのレシーバーを作成します。

"peekLock" (既定) と "receiveAndDelete" の 2 つの受信モードから選択できます。

• peekLock モードでは、受信側はキューで指定された期間、メッセージをロックします。
• receiveAndDelete モードでは、メッセージは受信時に Service Bus から削除されます。

受信側で completeMessage()、abandonMessage()、deferMessage()、または deadletterMessage() メソッドを呼び出すことで、メッセージを解決できます。

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

function acceptNextSession(queueName: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

パラメーター

戻り値

メッセージの受信、ピーク、および決済に使用できる受信者。

セッションが有効な Azure Service Bus サブスクリプションで、次に使用可能なセッションのレシーバーを作成します。

"peekLock" (既定) と "receiveAndDelete" の 2 つの受信モードから選択できます。

• peekLock モードでは、受信側はキューで指定された期間、メッセージをロックします。
• receiveAndDelete モードでは、メッセージは受信時に Service Bus から削除されます。

受信側で completeMessage()、abandonMessage()、deferMessage()、または deadletterMessage() メソッドを呼び出すことで、メッセージを解決できます。

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

function acceptNextSession(topicName: string, subscriptionName: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

パラメーター

戻り値

メッセージの受信、ピーク、および決済に使用できる受信者。

セッションが有効な Azure Service Bus キューのレシーバーを作成します。

"peekLock" (既定) と "receiveAndDelete" の 2 つの受信モードから選択できます。

• peekLock モードでは、受信側はキューで指定された期間、メッセージをロックします。
• receiveAndDelete モードでは、メッセージは受信時に Service Bus から削除されます。

受信側で completeMessage()、abandonMessage()、deferMessage()、または deadletterMessage() メソッドを呼び出すことで、メッセージを解決できます。

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

function acceptSession(queueName: string, sessionId: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

パラメーター

戻り値

メッセージの受信、ピーク、および決済に使用できる受信者。

セッションが有効な Azure Service Bus サブスクリプションのレシーバーを作成します。

"peekLock" (既定) と "receiveAndDelete" の 2 つの受信モードから選択できます。

• peekLock モードでは、受信側はキューで指定された期間、メッセージをロックします。
• receiveAndDelete モードでは、メッセージは受信時に Service Bus から削除されます。

受信側で completeMessage()、abandonMessage()、deferMessage()、または deadletterMessage() メソッドを呼び出すことで、メッセージを解決できます。

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

function acceptSession(topicName: string, subscriptionName: string, sessionId: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

パラメーター

戻り値

メッセージの受信、ピーク、および決済に使用できる受信者。

基になる AMQP 接続を閉じます。 注: これにより、このインスタンスから作成された Receiver インスタンスまたは Sender インスタンスも切断されます。

function close(): Promise<void>

戻り値

Azure Service Bus キューのレシーバーを作成します。 受信側のメソッドのいずれかが呼び出されるまで、サービスへの接続は行われません。

配信不能キューや転送配信不能キューなどのサブ キューをターゲットにするには、オプションで subQueue を指定します。 配信不能キューの詳細については、https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues を参照してください。

"peekLock" (既定) と "receiveAndDelete" の 2 つの受信モードから選択できます。

• peekLock モードでは、受信側はキューで指定された期間、メッセージをロックします。
• receiveAndDelete モードでは、メッセージは受信時に Service Bus から削除されます。

ロック期間内に解決されないメッセージは、キューに設定された最大配信数の回数として再配信され、その後、別の配信不能キューに送信されます。

受信側で completeMessage()、abandonMessage()、deferMessage()、または deadletterMessage() メソッドを呼び出すことで、メッセージを解決できます。

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

function createReceiver(queueName: string, options?: ServiceBusReceiverOptions): ServiceBusReceiver

パラメーター

戻り値

メッセージの受信、ピーク、および決済に使用できる受信者。

Azure Service Bus サブスクリプションのレシーバーを作成します。 受信側のメソッドのいずれかが呼び出されるまで、サービスへの接続は行われません。

配信不能キューや転送配信不能キューなどのサブ キューをターゲットにするには、オプションで subQueue を指定します。 配信不能キューの詳細については、https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues を参照してください。

"peekLock" (既定) と "receiveAndDelete" の 2 つの受信モードから選択できます。

• peekLock モードでは、受信側はキューで指定された期間、メッセージをロックします。
• receiveAndDelete モードでは、メッセージは受信時に Service Bus から削除されます。

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

受信側で completeMessage()、abandonMessage()、deferMessage()、または deadletterMessage() メソッドを呼び出すことで、メッセージを解決できます。

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

function createReceiver(topicName: string, subscriptionName: string, options?: ServiceBusReceiverOptions): ServiceBusReceiver

パラメーター

戻り値

メッセージの受信、ピーク、および決済に使用できる受信者。

サブスクリプションの規則の管理に使用 ServiceBusRuleManager のインスタンスを作成します。

function createRuleManager(topicName: string, subscriptionName: string): ServiceBusRuleManager

パラメーター

戻り値

ServiceBusRuleManager 指定したサブスクリプションとトピックを対象とします。

メッセージの送信、後で送信するメッセージのスケジュール設定、スケジュールされたメッセージの取り消しに使用できる Sender を作成します。 送信側のいずれかのメソッドが呼び出されるまで、サービスへの接続は行われません。

function createSender(queueOrTopicName: string, options?: ServiceBusSenderOptions): ServiceBusSender

パラメーター

戻り値