Setup an Azure Service Bus Connection Manager

The Azure Service Bus Connection Manager is an SSIS connection manager component that can be used to establish connections with Azure Service Bus.

To add a new connection, right-click the Connection Manager area in your Visual Studio project, and choose "New Connection..." from the context menu. You will be prompted the "Add SSIS Connection Manager" window. Select the "Azure Service Bus (KingswaySoft)" item to add a new Azure Service Bus Connection Manager.

New SSIS Connection

Add SSIS Azure Connection

The Azure Service Bus Connection Manager contains 1 page of configuration. 

  • General

General page

The General page allows you to specify connection properties and login credentials to Azure Service Bus. 

Add SSIS Azure Connection Manager

Namespace:

The namespace field lets you specify the URL of your Azure Service Bus endpoint. It should follow the pattern of: example.servicebus.windows.net/

Service Endpoint (since v6.1)

The Service Endpoint is the actual URL that is utilized by the connection manager to connect to Azure Service Bus. This field should be prepopulated for you. In special cases where you want to specify the Service Endpoint, you can change the value by first unlocking the field using the lock/unlock button next to it.

Issuer Name

The issuer name that will be used for authentication.

Issuer Key

The issuer key that will be used for authentication.

Enter Connection String Button

Add SSIS Azure Connection Manager - string

If you have a connection string, you can click the 'Enter Connection String' button to enter it. The component will extract the relevant parts of the connection string to populate the above fields in the connection manager.  Note that the namespace section of the connection string should typically have the suffix .servicebus.windows.net. If this suffix is not part of the connection string it will be added automatically - so the suffix is essentially optional.

Transport Type

The transport type you would like to use with your connection.

  • Ampq: The Advanced Message Queuing Protocol (AMQP) transport type.
  • NetMessaging: The network messaging transport type.
Connectivity Mode (since v4.0)

The Connectivity Mode option sets the underlying wire-level protocol used to communicate with Service Bus.

The supported field values are:

  • AutoDetect (Default): Automatically selects between the TCP, HTTP and HTTPS modes based on an auto-detection mechanism that probes whether either connectivity option is available for the current network environment. If both are available, the system will choose TCP by default.
  • Http: Listeners attempt an HTTP connection followed by an HTTPS connection with the Service Bus service, then wait for messages. 
  • Https: Listeners attempt an HTTPS connection with the Service Bus service, then wait for messages.
  • Tcp: Listeners create TCP connections to the Service Bus service to a destination port in the range 9350 to 9354.
Operation Timeout

The timeout value for operations with your connection.

Ignore Certificate Errors (since v6.2)

This option can be used to ignore those SSL certificate errors when connecting to Azure Service Bus.   

Warning: Enabling "Ignore Certificate Errors" option is generally NOT recommended, particularly for production instance. Unless there is a strong reason to believe the connection is secure - such as the network communication is only happening in an internal infrastructure, this option should be unchecked for best security.

Retry on Intermittent Errors (since v6.2)

Use this option to indicate if Azure Service Bus retry policy will be used. When this option is enabled, a default setup of exponentially increasing retry intervals for messaging operations will be provided. Uncheck this option to effectively disables retries.

Test Connection

After all the connection information has been provided, you may click the "Test Connection" button to test if the user credentials entered can connect to Azure Service Bus.