@azure/service-bus package

メッセージング エラーの基本クラスについて説明します。

すべての操作は、関連する出力を持つオブジェクトに解決される promise を返します。 これらのオブジェクトには、 という _response プロパティもあります。サービスからの直接応答にアクセスする場合に使用できます。

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

Service Bus 内で発生するエラー。

ATOM ベースの管理操作の の AuthorizationRule 種類を表します。

関連付けフィルター式を表します。 CorrelationRuleFilter は、サブスクリプションからの受信メッセージのユーザー プロパティとシステム プロパティに一致する一連の条件を保持します。

で メソッドを createBatch 構成するための Senderオプション。

• maxSizeInBytes: バッチのサイズの上限。

使用例:

{
    maxSizeInBytes: 1024 * 1024 // 1 MB
}

キューの設定可能なオプションを表します

サブスクリプションの設定可能なオプションを表します

トピックの設定可能なオプションを表します

Service Bus から受信したメッセージの メソッドを使用して deadLetter() メッセージを配信不能にする理由とエラーの説明について説明します。

Service Bus から反復可能な反復子を取得するときのオプション。

HttpHeaders コレクション内の個々のヘッダー。

HTTP ヘッダーのキーと値のペアのコレクション。

常に存在する HTTP 応答のプロパティ。

一般的なメッセージ ハンドラー インターフェイス (streamMessages に使用)。

Service Bus 名前空間に関連するメタデータを表します。

すべての操作の基本オプションの種類。

レシーバーの メソッドに peekMessages 渡されるオプションについて説明します。

コールバックの processError 引数。

updateQueue の入力を表します。

キュー エンティティのランタイム情報属性を表します

Service Bus からメッセージのバッチを受信するときのオプション。

モード、再試行回数、再試行間隔などを決定する再試行ポリシー オプション。

ルールのすべての属性を表します。

のクライアント オプションを表します ServiceBusAdministrationClient。

ServiceBusClient の作成時に指定できるオプションについて説明します。

• webSocketOptions : Web ソケット経由の AMQP 接続のチャネリングを構成するオプション。
  • websocket : WebSocket 経由で接続を行う場合に AMQP 接続の作成に使用される WebSocket コンストラクター。
  • webSocketConstructorOptions : WebSocket 経由で接続を行う場合に Websocket コンストラクターに渡すオプション。
• retryOptions : クライアントに対するすべての操作の再試行オプション。
  • maxRetries : 再試行可能なエラーが発生した場合に操作を再試行できる回数。
  • maxRetryDelayInMs: 再試行間の最大遅延。 指数再試行を実行する場合にのみ適用されます。
  • mode: 列挙型で RetryMode 指定された、適用する再試行モード。 オプションは Exponential と Fixed です。 既定値は Fixed です。
  • retryDelayInMs: 次の試行を行う前に待機する時間をミリ秒単位で指定します。 が にExponential設定されている場合mode、これは再試行の間に指数関数的に増加する遅延を計算するために使用されます。 既定値: 30000 ミリ秒。
  • timeoutInMs: 操作がタイムアウトするまでの待機時間 (ミリ秒単位)。これにより、再試行が残っている場合に再試行がトリガーされます。 最小値: 60000 ミリ秒。

Service Bus 接続文字列を構成するプロパティのセット。

Service Bus に送信するメッセージについて説明します。

メソッドを使用して作成できるメッセージの <xref:createBatch> バッチ。

ピーク操作中に Service Bus から受信したメッセージについて説明します。そのため、解決できません。

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

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

サブスクリプションのルールを管理できるようにします。 このルール マネージャーではリッスン要求のみが必要ですが、 ServiceBusAdministrationClient には要求の管理が必要です。

Sender を使用すると、メッセージの送信、後で送信するメッセージのスケジュール設定、スケジュールされたメッセージの取り消しを行うことができます。 createSender ServiceBusClient の 関数を使用して、Sender をインスタンス化します。 Sender クラスは、基になる AMQP 送信者リンクに対する抽象化です。

送信者を作成するときに使用するオプション。

セッション ロックの更新など、セッションを処理するレシーバー。

セッションが有効になっている Queue/Subscription を使用する場合に acceptSession メソッドと acceptNextSession メソッドに渡されるオプションについて説明します。

SqlRuleFilter で使用可能なすべてのフィールドを表します

Service Bus キューまたはサブスクリプションをサブスクライブするときに使用されるオプション。

updateSubscription の入力を表します。

サブスクリプション エンティティのランタイム情報属性を表します

認証トークンを提供できる資格情報を表します。

updateTopic の入力を表します。

トピック エンティティのランタイム情報属性を表します

分散トレースのコンテキストを手動で伝達 Span するオプションのセット。

リモート サーバーに対して行われる HTTP 要求の説明。

WebSocket コンストラクターの必要な形状について説明します。

Web ソケット経由の AMQP 接続のチャネリングを構成するためのオプション。

反復処理を開始する も含むエンティティに対するリスト操作の continuationToken 結果を表します。

Service Bus メッセージング エンティティに使用 availabilityStatus できる値。

Service Bus メッセージング エンティティに使用 status できる値。

注: この型は、OperationOptions から関連するフィールドと構造 @azure/core-client をミラー化することを目的としています

トレースと abortSignal を構成するためのオプション。

単純な JSON オブジェクトとして表される HttpHeaders コレクション。

Service Bus のエラー コード。

SqlRuleAction で使用可能なすべてのフィールドを表します

アップロードまたはダウンロードの進行状況に応じて発生します。

未加工の応答と共に、操作の返された応答を表します。

再試行モードの種類について説明します

サポートされているトークンの種類について説明します。

t ミリ秒後に promise を解決する setTimeout のラッパー。

エラーが型であるかどうかを判断します ServiceBusError

指定された接続文字列を、Azure Service Busに適用できるさまざまなプロパティに解析します。 プロパティは、ServiceBusClient を構築するのに役立ちます。