Share via

ConnectionConfig interface

  • Reference
Package:
@azure/core-amqp

Describes the connection config object that is created after parsing an EventHub or ServiceBus connection string.

Properties

amqpHostname

The fully qualified name of the host to connect to. This field can be used by AMQP proxies to determine the correct back-end service to connect the client to. Typically of the form ".servicebus.windows.net".
connectionString

The connection string.
endpoint

The service bus endpoint "sb://.servicebus.windows.net/".
entityPath

The name/path of the entity (hub/queue/topic name) to which the connection needs to happen.
host

The DNS hostname or IP address of the service. Typically of the form ".servicebus.windows.net" unless connecting to the service through an intermediary.
port

The port number.
sharedAccessKey

The secret value of the access key.
sharedAccessKeyName

The name of the access key.
useDevelopmentEmulator

This should be true only if the connection string contains the slug ";UseDevelopmentEmulator=true" and the endpoint is a loopback address.
webSocket

The WebSocket constructor used to create an AMQP connection over a WebSocket. In browsers, the built-in WebSocket will be used by default. In Node, a TCP socket will be used if a WebSocket constructor is not provided.
webSocketConstructorOptions

Options to be passed to the WebSocket constructor
webSocketEndpointPath

The path for the endpoint that accepts an AMQP connection over WebSockets.

Property Details

amqpHostname

The fully qualified name of the host to connect to. This field can be used by AMQP proxies to determine the correct back-end service to connect the client to. Typically of the form ".servicebus.windows.net".

amqpHostname?: string

Property Value

string

connectionString

The connection string.

connectionString: string

Property Value

string

endpoint

The service bus endpoint "sb://.servicebus.windows.net/".

endpoint: string

Property Value

string

entityPath

The name/path of the entity (hub/queue/topic name) to which the connection needs to happen.

entityPath?: string

Property Value

string

host

The DNS hostname or IP address of the service. Typically of the form ".servicebus.windows.net" unless connecting to the service through an intermediary.

host: string

Property Value

string

port

The port number.

port?: number

Property Value

number

sharedAccessKey

The secret value of the access key.

sharedAccessKey: string

Property Value

string

sharedAccessKeyName

The name of the access key.

sharedAccessKeyName: string

Property Value

string

useDevelopmentEmulator

This should be true only if the connection string contains the slug ";UseDevelopmentEmulator=true" and the endpoint is a loopback address.

useDevelopmentEmulator?: boolean

Property Value

boolean

webSocket

The WebSocket constructor used to create an AMQP connection over a WebSocket. In browsers, the built-in WebSocket will be used by default. In Node, a TCP socket will be used if a WebSocket constructor is not provided.

webSocket?: WebSocketImpl

Property Value

WebSocketImpl

webSocketConstructorOptions

Options to be passed to the WebSocket constructor

webSocketConstructorOptions?: any

Property Value

any

webSocketEndpointPath

The path for the endpoint that accepts an AMQP connection over WebSockets.

webSocketEndpointPath?: string

Property Value

string