@azure/service-bus package

クラス

MessagingError	メッセージング エラーの基本クラスについて説明します。
ServiceBusAdministrationClient	すべての操作は、関連する出力を持つオブジェクトに解決される promise を返します。 これらのオブジェクトには、サービスからの直接応答にアクセスする場合に使用できる _response というプロパティもあります。
ServiceBusClient	キューやトピックにメッセージを送信するための Sender インスタンスと、キューとサブスクリプションからメッセージを受信する Receiver インスタンスを作成できるクライアント。
ServiceBusError	Service Bus 内で発生するエラー。

インターフェイス

AuthorizationRule	ATOM ベースの管理操作の AuthorizationRule の種類を表します。
CorrelationRuleFilter	関連付けフィルター式を表します。 CorrelationRuleFilter は、サブスクリプションからの受信メッセージのユーザー プロパティとシステム プロパティと照合される一連の条件を保持します。
CreateMessageBatchOptions	createBatchで Sender メソッドを構成するオプション。 maxSizeInBytes: バッチのサイズの上限。 使用例: { maxSizeInBytes: 1024 * 1024 // 1 MB }
CreateQueueOptions	キューの設定可能なオプションを表します。
CreateSubscriptionOptions	サブスクリプションの設定可能なオプションを表します
CreateTopicOptions	トピックの設定可能なオプションを表します
DeadLetterOptions	Service Bus から受信したメッセージの deadLetter() メソッドを使用してメッセージを配信不能にする理由とエラーの説明について説明します。
Delivery
GetMessageIteratorOptions	Service Bus から反復可能な反復子を取得するときのオプション。
HttpHeader	HttpHeaders コレクション内の個々のヘッダー。
HttpHeadersLike	HTTP ヘッダーのキーと値のペアのコレクション。
HttpResponse	常に存在する HTTP 応答のプロパティ。
MessageHandlers	一般的なメッセージ ハンドラー インターフェイス (streamMessages に使用)。
NamespaceProperties	Service Bus 名前空間に関連するメタデータを表します。
OperationOptions	すべての操作の基本オプションの種類。
PeekMessagesOptions	受信側の peekMessages メソッドに渡されるオプションについて説明します。
ProcessErrorArgs	processError コールバックの引数。
QueueProperties	updateQueue の入力を表します。
QueueRuntimeProperties	キュー エンティティのランタイム情報属性を表します
ReceiveMessagesOptions	Service Bus からメッセージのバッチを受信するときのオプション。
RetryOptions	モード、再試行回数、再試行間隔などを決定する再試行ポリシー オプション。
RuleProperties	ルールのすべての属性を表します。
ServiceBusAdministrationClientOptions	ServiceBusAdministrationClientのクライアント オプションを表します。
ServiceBusClientOptions	ServiceBusClient の作成時に指定できるオプションについて説明します。 webSocketOptions: Web ソケット経由の AMQP 接続のチャネリングを構成するオプション。 websocket: WebSocket 経由で接続する場合に AMQP 接続を作成するために使用される WebSocket コンストラクター。 webSocketConstructorOptions: WebSocket 経由で接続を確立するときに Websocket コンストラクターに渡すオプション。 retryOptions: クライアント上のすべての操作の再試行オプション。 maxRetries: 再試行可能なエラーが発生した場合に操作を再試行できる回数。 maxRetryDelayInMs: 再試行間の最大遅延。 指数再試行を実行する場合にのみ適用されます。 mode: RetryMode 列挙型で指定された、適用する再試行モード。 オプションは、Exponential と Fixedです。 既定値は Fixedです。 retryDelayInMs: 次の試行を行う前にミリ秒単位で待機する時間。 mode が Exponentialに設定されている場合、これは再試行の間に指数関数的に増加する遅延を計算するために使用されます。 既定値: 30000 ミリ秒。 timeoutInMs: 操作がタイムアウトするまでの待機時間 (ミリ秒単位)。これにより、再試行が残っている場合に再試行がトリガーされます。 最小値: 60000 ミリ秒。
ServiceBusConnectionStringProperties	Service Bus 接続文字列を構成するプロパティのセット。
ServiceBusMessage	Service Bus に送信されるメッセージについて説明します。
ServiceBusMessageBatch	<xref:createBatch> メソッドを使用して作成できるメッセージのバッチ。
ServiceBusReceivedMessage	ピーク操作中に Service Bus から受信したメッセージについて説明します。そのため解決できません。
ServiceBusReceiver	セッションを処理しないレシーバー。
ServiceBusReceiverOptions	レシーバーの作成時に使用するオプション。
ServiceBusRuleManager	サブスクリプションのルールを管理できるようにします。 このルール マネージャーではリッスン要求のみが必要ですが、ServiceBusAdministrationClient では要求の管理が必要です。
ServiceBusSender	送信者を使用すると、メッセージの送信、後で送信するメッセージのスケジュール設定、スケジュールされたメッセージの取り消しを行うことができます。 ServiceBusClient の createSender 関数を使用して、Sender をインスタンス化します。 Sender クラスは、基になる AMQP 送信者リンクに対する抽象化です。
ServiceBusSenderOptions	送信者の作成時に使用するオプション。
ServiceBusSessionReceiver	セッション ロックの更新など、セッションを処理するレシーバー。
ServiceBusSessionReceiverOptions	セッションが有効になっているキュー/サブスクリプションを使用する場合に、acceptSession メソッドと acceptNextSession メソッドに渡されるオプションについて説明します。
SqlRuleFilter	SqlRuleFilter で使用可能なすべてのフィールドを表します。
SubscribeOptions	Service Bus キューまたはサブスクリプションをサブスクライブするときに使用されるオプション。
SubscriptionProperties	updateSubscription の入力を表します。
SubscriptionRuntimeProperties	サブスクリプション エンティティのランタイム情報属性を表します
TokenCredential	認証トークンを提供できる資格情報を表します。
TopicProperties	updateTopic の入力を表します。
TopicRuntimeProperties	トピック エンティティのランタイム情報属性を表します
TryAddOptions	分散トレースのコンテキスト Span 手動で伝達するオプションのセット。
WebResourceLike	リモート サーバーに対して行われる HTTP 要求の説明。
WebSocketImpl	WebSocket コンストラクターの必要な形状について説明します。
WebSocketOptions	Web ソケット経由の AMQP 接続のチャネリングを構成するオプション。

型エイリアス

EntitiesResponse	反復処理を開始する continuationToken も含まれるエンティティに対するリスト操作の結果を表します。
EntityAvailabilityStatus	Service Bus メッセージング エンティティの availabilityStatus に使用できる値。
EntityStatus	Service Bus メッセージング エンティティの status に使用できる値。
OperationOptionsBase	注: この型は、@azure/core-client OperationOptions から関連するフィールドと構造をミラーリングすることを目的としています トレースと abortSignal を構成するためのオプション。
RawHttpHeaders	単純な JSON オブジェクトとして表される HttpHeaders コレクション。
ServiceBusErrorCode	Service Bus エラー コード。
SqlRuleAction	SqlRuleAction で使用可能なすべてのフィールドを表します
TransferProgressEvent	アップロードまたはダウンロードの進行状況に応じて発生します。
WithResponse	未加工の応答と共に返される操作の応答を表します。

列挙型

RetryMode	再試行モードの種類について説明します
TokenType	サポートされているトークンの種類について説明します。

関数

delay<T>(number, AbortSignalLike, string, T)	t ミリ秒後に promise を解決する setTimeout のラッパー。
isServiceBusError(unknown)	エラーの種類が ServiceBusError かどうかを判断します
parseServiceBusConnectionString(string)	指定された接続文字列を、Azure Service Bus に適用できるさまざまなプロパティに解析します。 このプロパティは、ServiceBusClient を構築するのに役立ちます。

関数の詳細

delay<T>(number, AbortSignalLike, string, T)

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

function delay<T>(delayInMs: number, abortSignal?: AbortSignalLike, abortErrorMsg?: string, value?: T): Promise<T | void>

パラメーター

delayInMs

number

遅延するミリ秒数。

abortSignal

AbortSignalLike

含まれている操作に関連付けられている abortSignal。

abortErrorMsg

string

含まれている操作に関連付けられている中止エラー メッセージ。

value

T

タイムアウト後に解決される値 (ミリ秒)。

戻り値

Promise<T | void>

• 解決済みの Promise

isServiceBusError(unknown)

エラーの種類が ServiceBusError かどうかを判断します

function isServiceBusError(err: unknown): err

パラメーター

err

unknown

ServiceBusError 型であるかどうかを確認するためのエラー

戻り値

err

parseServiceBusConnectionString(string)

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

function parseServiceBusConnectionString(connectionString: string): ServiceBusConnectionStringProperties

パラメーター

connectionString

string

Service Bus 名前空間、キュー、またはトピック用に作成された共有アクセス ポリシーに関連付けられている接続文字列。

戻り値

ServiceBusConnectionStringProperties