ServiceBusClientOptions interface
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 ミリ秒。
-
プロパティ
| custom |
Service Bus サービスに接続するときに使用するカスタム エンドポイント。 これは、ネットワークが標準の Azure Service Bus エンドポイント アドレスへの接続を許可せず、中継局経由での接続を許可している場合に役立ちます。 例: "https://my.custom.endpoint:100/" |
| identifier | このクライアントを識別する ID。 これを使用して、ログと例外を関連付けることができます。 |
| retry |
モード、再試行回数、再試行間隔などを決定する再試行ポリシー オプション。 |
| user |
送信要求にユーザー エージェントの詳細を追加するためのオプション。 |
| web |
Web ソケット経由の AMQP 接続のチャネリングを構成するオプション。 |
プロパティの詳細
customEndpointAddress
Service Bus サービスに接続するときに使用するカスタム エンドポイント。 これは、ネットワークが標準の Azure Service Bus エンドポイント アドレスへの接続を許可せず、中継局経由での接続を許可している場合に役立ちます。
例: "https://my.custom.endpoint:100/"
customEndpointAddress?: stringプロパティ値
string
identifier
このクライアントを識別する ID。 これを使用して、ログと例外を関連付けることができます。
identifier?: stringプロパティ値
string
retryOptions
userAgentOptions
送信要求にユーザー エージェントの詳細を追加するためのオプション。
userAgentOptions?: UserAgentPolicyOptions