ConnectionConfig interface

パッケージ:

@azure/core-amqp

EventHub または ServiceBus 接続文字列の解析後に作成される接続構成オブジェクトについて説明します。

プロパティ

amqpHostname	接続先のホストの完全修飾名。 このフィールドは、AMQP プロキシがクライアントの接続先となる適切なバックエンド サービスを決定するために使用できます。 通常は "<yournamespace>.servicebus.windows.net" の形式です。
connectionString	接続文字列。
endpoint	Service Bus エンドポイント "sb://<yournamespace>.servicebus.windows.net/"
entityPath	接続を行う必要があるエンティティ (ハブ/キュー/トピック名) の名前/パス。
host	サービスの DNS ホスト名または IP アドレス。 通常、仲介者を介してサービスに接続しない限り、"<yournamespace>.servicebus.windows.net" の形式です。
port	ポート番号。
sharedAccessKey	アクセス キーのシークレット値。
sharedAccessKeyName	アクセス キーの名前。
useDevelopmentEmulator	これは、接続文字列に slug "; が含まれている場合にのみ true にする必要があります。UseDevelopmentEmulator=true" で、エンドポイントはループバック アドレスです。
webSocket	WebSocket 経由で AMQP 接続を作成するために使用される WebSocket コンストラクター。 ブラウザーでは、組み込みの WebSocket が既定で使用されます。 Node では、WebSocket コンストラクターが指定されていない場合、TCP ソケットが使用されます。
webSocketConstructorOptions	WebSocket コンストラクターに渡されるオプション
webSocketEndpointPath	WebSocket 経由の AMQP 接続を受け入れるエンドポイントのパス。

プロパティの詳細

amqpHostname

接続先のホストの完全修飾名。 このフィールドは、AMQP プロキシがクライアントの接続先となる適切なバックエンド サービスを決定するために使用できます。 通常は "<yournamespace>.servicebus.windows.net" の形式です。

amqpHostname?: string

プロパティ値

string

connectionString

接続文字列。

connectionString: string

プロパティ値

string

endpoint

Service Bus エンドポイント "sb://<yournamespace>.servicebus.windows.net/"

endpoint: string

プロパティ値

string

entityPath

接続を行う必要があるエンティティ (ハブ/キュー/トピック名) の名前/パス。

entityPath?: string

プロパティ値

string

host

サービスの DNS ホスト名または IP アドレス。 通常、仲介者を介してサービスに接続しない限り、"<yournamespace>.servicebus.windows.net" の形式です。

host: string

プロパティ値

string

port

ポート番号。

port?: number

プロパティ値

number

sharedAccessKey

アクセス キーのシークレット値。

sharedAccessKey: string

プロパティ値

string

sharedAccessKeyName

アクセス キーの名前。

sharedAccessKeyName: string

プロパティ値

string

useDevelopmentEmulator

これは、接続文字列に slug "; が含まれている場合にのみ true にする必要があります。UseDevelopmentEmulator=true" で、エンドポイントはループバック アドレスです。

useDevelopmentEmulator?: boolean

プロパティ値

boolean

webSocket

WebSocket 経由で AMQP 接続を作成するために使用される WebSocket コンストラクター。 ブラウザーでは、組み込みの WebSocket が既定で使用されます。 Node では、WebSocket コンストラクターが指定されていない場合、TCP ソケットが使用されます。

webSocket?: WebSocketImpl

プロパティ値

WebSocketImpl

webSocketConstructorOptions

WebSocket コンストラクターに渡されるオプション

webSocketConstructorOptions?: any

プロパティ値

any

webSocketEndpointPath

WebSocket 経由の AMQP 接続を受け入れるエンドポイントのパス。

webSocketEndpointPath?: string

プロパティ値

string