Package version:

Interface ServiceBusConnectionStringProperties

The set of properties that comprise a Service Bus connection string.

interface ServiceBusConnectionStringProperties {
    endpoint: string;
    entityPath?: string;
    fullyQualifiedNamespace: string;
    sharedAccessKey?: string;
    sharedAccessKeyName?: string;
    sharedAccessSignature?: string;
}

Properties

endpoint entityPath? fullyQualifiedNamespace sharedAccessKey? sharedAccessKeyName? sharedAccessSignature?

Properties

endpoint

endpoint: string

The value for "Endpoint" in the connection string.

Optional entityPath

entityPath?: string

The value for "EntityPath" in the connection string which would be the name of the queue or topic 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

fullyQualifiedNamespace: string

The fully qualified Service Bus 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 the ServiceBusClient.

Optional sharedAccessKey

sharedAccessKey?: string

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.

Optional sharedAccessKeyName

sharedAccessKeyName?: string

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.

Optional sharedAccessSignature

sharedAccessSignature?: string

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.

Settings

Member Visibility

Theme

Generated using TypeDoc