ServiceBusClientOptions interface

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 ミリ秒。

プロパティ

customEndpointAddress	Service Bus サービスに接続するときに使用するカスタムエンドポイント。これは、ネットワークが標準のAzure Service Bus エンドポイントアドレスへの接続を許可せず、中継経由で接続できる場合に便利です。例: "https://my.custom.endpoint:100/"
identifier	このクライアントを識別する ID。これは、ログと例外を関連付けるために使用できます。
retryOptions	モード、再試行回数、再試行間隔などを決定する再試行ポリシーオプション。
userAgentOptions	送信要求にユーザーエージェントの詳細を追加するためのオプション。
webSocketOptions	Web ソケット経由の AMQP 接続のチャネリングを構成するためのオプション。

Service Bus サービスに接続するときに使用するカスタムエンドポイント。これは、ネットワークが標準のAzure Service Bus エンドポイントアドレスへの接続を許可せず、中継経由で接続できる場合に便利です。

例: "https://my.custom.endpoint:100/"

customEndpointAddress?: string

string

このクライアントを識別する ID。これは、ログと例外を関連付けるために使用できます。

identifier?: string

string

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

retryOptions?: RetryOptions

送信要求にユーザーエージェントの詳細を追加するためのオプション。

userAgentOptions?: UserAgentPolicyOptions

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

webSocketOptions?: WebSocketOptions