Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceBusConnectionStringProperties

Package version

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

Hierarchy

  • ServiceBusConnectionStringProperties

Index

Properties

endpoint

endpoint: string

The value for "Endpoint" in the connection string.

Optional entityPath

entityPath: undefined | 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: undefined | 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: undefined | 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: undefined | 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.

Generated using TypeDoc