Share via

EventHubConnectionStringProperties interface

  • Reference
Package:
@azure/event-hubs

The set of properties that comprise an Event Hub connection string.

Properties

endpoint

The value for "Endpoint" in the connection string.
eventHubName

The value for "EntityPath" in the connection string which would be the name of the event hub instance associated with the connection string. Connection string from a Shared Access Policy created at the namespace level will not have the EntityPath in it.
fullyQualifiedNamespace

The fully qualified Event Hub namespace extracted from the "Endpoint" in the connection string. This is likely to be similar to {yournamespace}.servicebus.windows.net. This is typically used to construct an EventHubProducerClient or an EventHubConsumerClient.
sharedAccessKey

The value for "SharedAccessKey" in the connection string. This along with the "SharedAccessKeyName" in the connection string is used to generate a SharedAccessSignature which can be used authorize the connection to the service.
sharedAccessKeyName

The value for "SharedAccessKeyName" in the connection string. This along with the "SharedAccessKey" in the connection string is used to generate a SharedAccessSignature which can be used authorize the connection to the service.
sharedAccessSignature

The value for "SharedAccessSignature" in the connection string. This is typically not present in the connection string generated for a Shared Access Policy. It is instead generated by the user and appended to the connection string for ease of use.
useDevelopmentEmulator

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

Property Details

endpoint

The value for "Endpoint" in the connection string.

endpoint: string

Property Value

string

eventHubName

The value for "EntityPath" in the connection string which would be the name of the event hub instance associated with the connection string. Connection string from a Shared Access Policy created at the namespace level will not have the EntityPath in it.

eventHubName?: string

Property Value

string

fullyQualifiedNamespace

The fully qualified Event Hub namespace extracted from the "Endpoint" in the connection string. This is likely to be similar to {yournamespace}.servicebus.windows.net. This is typically used to construct an EventHubProducerClient or an EventHubConsumerClient.

fullyQualifiedNamespace: string

Property Value

string

sharedAccessKey

The value for "SharedAccessKey" in the connection string. This along with the "SharedAccessKeyName" in the connection string is used to generate a SharedAccessSignature which can be used authorize the connection to the service.

sharedAccessKey?: string

Property Value

string

sharedAccessKeyName

The value for "SharedAccessKeyName" in the connection string. This along with the "SharedAccessKey" in the connection string is used to generate a SharedAccessSignature which can be used authorize the connection to the service.

sharedAccessKeyName?: string

Property Value

string

sharedAccessSignature

The value for "SharedAccessSignature" in the connection string. This is typically not present in the connection string generated for a Shared Access Policy. It is instead generated by the user and appended to the connection string for ease of use.

sharedAccessSignature?: 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