次の方法で共有

ServiceBusClient class

  • リファレンス
パッケージ:
@azure/service-bus

キューやトピックにメッセージを送信するための Sender インスタンスと、キューとサブスクリプションからメッセージを受信する Receiver インスタンスを作成できるクライアント。

コンストラクター

ServiceBusClient(string, ServiceBusClientOptions)

ServiceBusClient クラスのインスタンスを作成します。このクラスを使用して、接続文字列で指定されたAzure Service Bus名前空間への送信者と受信者を作成できます。 クライアントで作成された送信者/受信者がメッセージの送受信に使用されるまで、サービスへの接続は行われません。
ServiceBusClient(string, TokenCredential | NamedKeyCredential | SASCredential, ServiceBusClientOptions)

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

プロパティ

fullyQualifiedNamespace

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

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

メソッド

acceptNextSession(string, ServiceBusSessionReceiverOptions)

セッションが有効な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
acceptNextSession(string, string, ServiceBusSessionReceiverOptions)

セッションが有効な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
acceptSession(string, string, ServiceBusSessionReceiverOptions)

セッションが有効なキューのレシーバー 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
acceptSession(string, string, string, ServiceBusSessionReceiverOptions)

サブスクリプションが有効なセッションのレシーバー 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
close()

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

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

配信不能キューや転送配信不能キューなどのサブ キューをターゲットにするには、 オプションに を 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
createReceiver(string, string, ServiceBusReceiverOptions)

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

配信不能キューや転送配信不能キューなどのサブ キューをターゲットにするには、 オプションに を 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
createRuleManager(string, string)

サブスクリプションのルールを管理するために使用される ServiceBusRuleManager のインスタンスを作成します。
createSender(string, ServiceBusSenderOptions)

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

コンストラクターの詳細

ServiceBusClient(string, ServiceBusClientOptions)

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

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

パラメーター

connectionString

string

名前空間の接続文字列Azure Service Bus。 注: この接続文字列には EntityPath を含めることができますが、これは無視されます。

options
ServiceBusClientOptions

Service Bus クライアントのオプション。

ServiceBusClient(string, TokenCredential | NamedKeyCredential | SASCredential, ServiceBusClientOptions)

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

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

パラメーター

fullyQualifiedNamespace

string

Service Bus インスタンスの完全な名前空間。これは、.servicebus.windows.net に似ている可能性があります。

credential

TokenCredential | NamedKeyCredential | SASCredential

Azure Service Busとの接続を認証するためのトークンを取得するためにクライアントによって使用される資格情報オブジェクト。 資格情報の作成については、「@azure/ID」を参照してください。 AAD に対してインターフェイスの独自の実装を TokenCredential 使用している場合は、service-bus の "スコープ" を に ["https://servicebus.azure.net//user_impersonation"] 設定して、適切なトークンを取得します。 接続文字列を使用せずに と をAzureNamedKeyCredential渡SharedAccessKeyNameSharedAccessKeyす場合は、from @azure/core-auth を使用します。 これらのフィールドは、 name の フィールドと key フィールドにそれぞれ AzureNamedKeyCredentialマップされます。 接続文字列を使用せずに を AzureSASCredential 渡 SharedAccessSignature す場合は、from @azure/core-auth を使用します。 このフィールドは、 の にsignatureAzureSASCredentialマップされます。

options
ServiceBusClientOptions

クライアントを構成するときに適用するオプションのセット。

  • retryOptions : クライアント上のすべての操作の再試行ポリシーを構成します。 たとえば、{ "maxRetries": 4 } または { "maxRetries": 4, "retryDelayInMs": 30000 } です。
  • webSocketOptions: Web ソケット経由の AMQP 接続のチャネリングを構成します。

プロパティの詳細

fullyQualifiedNamespace

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

fullyQualifiedNamespace: string

プロパティ値

string

identifier

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

identifier: string

プロパティ値

string

メソッドの詳細

acceptNextSession(string, ServiceBusSessionReceiverOptions)

セッションが有効な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>

パラメーター

queueName

string

受信元のキューの名前。

options
ServiceBusSessionReceiverOptions

オプションには、receiveMode(既定値は peekLock)、セッション レシーバーを作成するためのオプションがあります。

戻り値

Promise<ServiceBusSessionReceiver>

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

acceptNextSession(string, string, ServiceBusSessionReceiverOptions)

セッションが有効な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>

パラメーター

topicName

string

受信元のサブスクリプションのトピックの名前。

subscriptionName

string

受け取るサブスクリプションの名前 (の下 topic)。

options
ServiceBusSessionReceiverOptions

オプションには、receiveMode(既定値は peekLock)、セッション レシーバーを作成するためのオプションがあります。

戻り値

Promise<ServiceBusSessionReceiver>

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

acceptSession(string, string, ServiceBusSessionReceiverOptions)

セッションが有効なキューのレシーバー 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>

パラメーター

queueName

string

受信元のキューの名前。

sessionId

string

メッセージを受信する必要があるセッションの ID

options
ServiceBusSessionReceiverOptions

オプションには、receiveMode(既定値は peekLock)、セッション レシーバーを作成するためのオプションがあります。

戻り値

Promise<ServiceBusSessionReceiver>

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

acceptSession(string, string, string, ServiceBusSessionReceiverOptions)

サブスクリプションが有効なセッションのレシーバー 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>

パラメーター

topicName

string

受信元のサブスクリプションのトピックの名前。

subscriptionName

string

受け取るサブスクリプションの名前 (の下 topic)。

sessionId

string

メッセージを受信する必要があるセッションの ID

options
ServiceBusSessionReceiverOptions

オプションには、receiveMode(既定値は peekLock)、セッション レシーバーを作成するためのオプションがあります。

戻り値

Promise<ServiceBusSessionReceiver>

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

close()

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

function close(): Promise<void>

戻り値

Promise<void>

createReceiver(string, ServiceBusReceiverOptions)

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

配信不能キューや転送配信不能キューなどのサブ キューをターゲットにするには、 オプションに を 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

パラメーター

queueName

string

受信元のキューの名前。

options
ServiceBusReceiverOptions

receiveMode を渡すオプション。既定値は peekLock です。

戻り値

ServiceBusReceiver

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

createReceiver(string, string, ServiceBusReceiverOptions)

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

配信不能キューや転送配信不能キューなどのサブ キューをターゲットにするには、 オプションに を 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

パラメーター

topicName

string

受信元のサブスクリプションのトピックの名前。

subscriptionName

string

受け取るサブスクリプションの名前 (の下 topic)。

options
ServiceBusReceiverOptions

receiveMode を渡すオプション。既定値は peekLock です。

戻り値

ServiceBusReceiver

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

createRuleManager(string, string)

サブスクリプションのルールを管理するために使用される ServiceBusRuleManager のインスタンスを作成します。

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

パラメーター

topicName

string

ServiceBusRuleManager を作成するトピック

subscriptionName

string

ServiceBusRuleManager を作成するための指定されたトピックに固有のサブスクリプション。

戻り値

ServiceBusRuleManager

指定したサブスクリプションとトピックをスコープとした ServiceBusRuleManager 。

createSender(string, ServiceBusSenderOptions)

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

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

パラメーター

queueOrTopicName

string

メッセージを送信するキューまたはトピックの名前。

options
ServiceBusSenderOptions

戻り値

ServiceBusSender