ServiceBusClient クラス

定義

名前空間:

Azure.Messaging.ServiceBus

アセンブリ:

Azure.Messaging.ServiceBus.dll

パッケージ:

Azure.Messaging.ServiceBus v7.17.5

Source:

ServiceBusClient.cs

ServiceBusClientは、すべての Service Bus エンティティを操作できる最上位クライアントです。 ここから取得された下位レベルの型 ( や などServiceBusSenderServiceBusReceiver) は、同じ AMQP 接続を共有します。 を ServiceBusClient 破棄すると、AMQP 接続が閉じます。

public class ServiceBusClient : IAsyncDisposable

type ServiceBusClient = class
    interface IAsyncDisposable

Public Class ServiceBusClient
Implements IAsyncDisposable

継承

Object

ServiceBusClient

実装

IAsyncDisposable

注釈

ServiceBusClientは、アプリケーションの有効期間中は安全にキャッシュして使用できます。これは、アプリケーションが Service Bus を定期的または半定期的に使用する場合のベスト プラクティスです。 クライアントは、ネットワーク、CPU、メモリの効率的な使用を確保する責任があります。 アプリケーションのシャットダウン時に を呼び出 DisposeAsync() すと、ネットワーク リソースやその他のアンマネージ オブジェクトが適切にクリーンアップされます。

コンストラクター

ServiceBusClient()	モックに使用できます。
ServiceBusClient(String)	ServiceBusClient クラスの新しいインスタンスを初期化します。
ServiceBusClient(String, AzureNamedKeyCredential, ServiceBusClientOptions)	ServiceBusClient クラスの新しいインスタンスを初期化します。
ServiceBusClient(String, AzureSasCredential, ServiceBusClientOptions)	ServiceBusClient クラスの新しいインスタンスを初期化します。
ServiceBusClient(String, ServiceBusClientOptions)	ServiceBusClient クラスの新しいインスタンスを初期化します。
ServiceBusClient(String, TokenCredential)	ServiceBusClient クラスの新しいインスタンスを初期化します。
ServiceBusClient(String, TokenCredential, ServiceBusClientOptions)	ServiceBusClient クラスの新しいインスタンスを初期化します。

プロパティ

FullyQualifiedNamespace	接続が関連付けられている完全修飾 Service Bus 名前空間。 これは と似ている {yournamespace}.servicebus.windows.net可能性があります。
Identifier	この ServiceBusClientを識別するために使用される名前。
IsClosed	これが ServiceBusClient 閉じられているかどうかを示します。
TransportType	この ServiceBusClientに使用されるトランスポートの種類。

メソッド

AcceptNextSessionAsync(String, ServiceBusSessionReceiverOptions, CancellationToken)	アクティブ メッセージを ServiceBusSessionReceiver 含む次のロック解除されたセッションを受け入れることで、セッションが有効なキューからのメッセージの受信と解決に使用できるインスタンスを作成します。 アクティブ メッセージを含むロック解除されたセッションがない場合、構成されたTryTimeout値の後に呼び出しがタイムアウトし、 が にServiceTimeout設定された をServiceBusExceptionReasonスローします。 で ServiceBusReceiveMode を指定 ServiceBusReceiverOptions して、メッセージの受信方法を構成できます。 既定値は PeekLock です。
AcceptNextSessionAsync(String, String, ServiceBusSessionReceiverOptions, CancellationToken)	アクティブ メッセージを ServiceBusSessionReceiver 含む次のロック解除されたセッションを受け入れることで、セッションが有効なサブスクリプションからのメッセージの受信と決済に使用できるインスタンスを作成します。 アクティブ メッセージを含むロック解除されたセッションがない場合、構成されたTryTimeout値の後に呼び出しがタイムアウトし、 が にServiceTimeout設定された をServiceBusExceptionReasonスローします。 で ServiceBusReceiveMode を指定 ServiceBusReceiverOptions して、メッセージの受信方法を構成できます。 既定値は PeekLock です。
AcceptSessionAsync(String, String, ServiceBusSessionReceiverOptions, CancellationToken)	特定のセッションを ServiceBusSessionReceiver 受け入れることで、セッションが有効なキューからのメッセージの受信と解決に使用できるインスタンスを作成します。 で ServiceBusReceiveMode を指定 ServiceBusReceiverOptions して、メッセージの受信方法を構成できます。 既定値は PeekLock です。
AcceptSessionAsync(String, String, String, ServiceBusSessionReceiverOptions, CancellationToken)	特定のセッションを ServiceBusSessionReceiver 受け入れることで、セッションが有効なサブスクリプションからのメッセージの受信と決済に使用できるインスタンスを作成します。 で ServiceBusReceiveMode を指定 ServiceBusReceiverOptions して、メッセージの受信方法を構成できます。 既定値は PeekLock です。
CreateProcessor(String)	プロセッサに ServiceBusProcessor 設定されているイベント ハンドラーを使用してメッセージを処理するために使用できるインスタンスを作成します。 を使用 ServiceBusReceiveMode して、メッセージの受信方法を指定します。 既定値は PeekLock モードです。 を変更する場合は、 ServiceBusReceiveModeメソッドを使用 CreateProcessor(String, ServiceBusProcessorOptions) します。 は ServiceBusReceiveMode 型で ServiceBusProcessorOptions 設定されます。
CreateProcessor(String, ServiceBusProcessorOptions)	プロセッサに ServiceBusProcessor 設定されているイベント ハンドラーを使用してメッセージを処理するために使用できるインスタンスを作成します。 を使用 ServiceBusReceiveMode して、メッセージの受信方法を指定します。 既定値は PeekLock モードです。 は ServiceBusReceiveMode 型で ServiceBusProcessorOptions 設定されます。
CreateProcessor(String, String)	プロセッサに ServiceBusProcessor 設定されているイベント ハンドラーを使用してメッセージを処理するために使用できるインスタンスを作成します。 を使用 ServiceBusReceiveMode して、メッセージの受信方法を指定します。 既定値は PeekLock モードです。 を変更する場合は、 ServiceBusReceiveModeメソッドを使用 CreateProcessor(String, String, ServiceBusProcessorOptions) します。 は ServiceBusReceiveMode 型で ServiceBusProcessorOptions 設定されます。
CreateProcessor(String, String, ServiceBusProcessorOptions)	プロセッサに ServiceBusProcessor 設定されているイベント ハンドラーを使用してメッセージを処理するために使用できるインスタンスを作成します。 を使用 ServiceBusReceiveMode して、メッセージの受信方法を指定します。 既定値は PeekLock モードです。 は ServiceBusReceiveMode 型で ServiceBusProcessorOptions 設定されます。
CreateReceiver(String)	特定の ServiceBusReceiver キューからのメッセージの受信と解決に使用できるインスタンスを作成します。 を使用 ServiceBusReceiveMode して、メッセージの受信方法を指定します。 既定値は PeekLock モードです。 を変更する場合は、 ServiceBusReceiveModeメソッドを使用 CreateReceiver(String, ServiceBusReceiverOptions) します。 ServiceBusReceiveModeは でServiceBusReceiverOptions設定されます。
CreateReceiver(String, ServiceBusReceiverOptions)	特定の ServiceBusReceiver キューからのメッセージの受信と解決に使用できるインスタンスを作成します。 を使用 ServiceBusReceiveMode して、メッセージの受信方法を指定します。 既定値は PeekLock モードです。 ServiceBusReceiveModeは でServiceBusReceiverOptions設定されます。
CreateReceiver(String, String)	特定の ServiceBusReceiver サブスクリプションからのメッセージの受信と決済に使用できるインスタンスを作成します。 を使用 ServiceBusReceiveMode して、メッセージの受信方法を指定します。 既定値は PeekLock モードです。 を変更する場合は、 ServiceBusReceiveModeメソッドを使用 CreateReceiver(String, String, ServiceBusReceiverOptions) します。 ServiceBusReceiveModeは でServiceBusReceiverOptions設定されます。
CreateReceiver(String, String, ServiceBusReceiverOptions)	特定の ServiceBusReceiver サブスクリプションからのメッセージの受信と決済に使用できるインスタンスを作成します。 を使用 ServiceBusReceiveMode して、メッセージの受信方法を指定します。 既定値は PeekLock モードです。 ServiceBusReceiveModeは でServiceBusReceiverOptions設定されます。
CreateRuleManager(String, String)	ServiceBusRuleManagerは、サブスクリプションのルールを管理するために使用されます。
CreateSender(String)	特定の ServiceBusSender キューまたはトピックにメッセージを送信するために使用できるインスタンスを作成します。
CreateSender(String, ServiceBusSenderOptions)	特定の ServiceBusSender キューまたはトピックにメッセージを送信するために使用できるインスタンスを作成します。
CreateSessionProcessor(String, ServiceBusSessionProcessorOptions)	プロセッサに ServiceBusSessionProcessor 設定されているイベント ハンドラーを使用してセッション メッセージを処理するために使用できるインスタンスを作成します。 を使用 ServiceBusReceiveMode して、メッセージの受信方法を指定します。 既定値は PeekLock モードです。 は ServiceBusReceiveMode 型で ServiceBusProcessorOptions 設定されます。
CreateSessionProcessor(String, String, ServiceBusSessionProcessorOptions)	プロセッサに ServiceBusSessionProcessor 設定されているイベント ハンドラーを使用してメッセージを処理するために使用できるインスタンスを作成します。 を使用 ServiceBusReceiveMode して、メッセージの受信方法を指定します。 既定値は PeekLock モードです。 は ServiceBusReceiveMode 型で ServiceBusProcessorOptions 設定されます。
DisposeAsync()	によって使用されるリソースをクリーンするために必要なタスクをServiceBusClient実行します。これには、クライアント自体が閉じられているかの確認が含まれます。