Microsoft Azure Service Bus prerequisites
Introduction
To use the Microsoft Azure Service Bus connector, you must have the credentials for a Service Bus namespace.
This document describes obtaining the credentials for a Service Bus namespace for both Microsoft Entra ID and Shared Access Signature authentication types.
Important
Prior to following the steps outlined on this page, you must have a Service Bus namespace. For information on creating a namespace, see Microsoft's documentation.
Microsoft Entra ID
This section describes how to configure a Service Bus namespace with Microsoft Entra ID authentication and obtain the required credentials for connection configuration. The steps for authenticating with Shared Access Signatures are described in the next section.
Create an app
Follow these steps to create an app registration to use for authenticating the Service Bus namespace:
- Log in to the Microsoft Azure portal.
- In the left-hand navigation pane, select Microsoft Entra ID, then App registrations.
- Click New registration.
-
Enter a name for the application. The remaining fields can be left as their default:
-
Click Register to complete the app registration. You are then directed to the app's Overview page:
Important
Retain the app registration's Application (client) ID and Directory (tenant) ID to use as the Client ID and Tenant ID when configuring a connection.
-
From the app registration's Overview page, click Add a certificate or secret. On the Certificates & secrets page, select the Client secrets tab and then click New client secret. Enter a name for the client secret and select an expiration time. After clicking Add, the client secret's details are displayed.
Important
Retain the client secret's Value to use as the Client secret when configuring a connection.
-
Once steps 1 - 6 are completed, you should have the following credentials from your app registration to be used during connection configuration:
Microsoft Entra ID credential Connection field The app registration's Application (client) ID (step 5) Client ID The app registration's Directory (tenant) ID (step 5) Tenant ID The Value of the app registration's client secret (step 6) Client secret
Add the app registration to the Azure Service Bus Data Owner role
Follow these steps to add the app registration to the Azure Service Bus Data Owner role for your Service Bus namespace:
-
Navigate to the Service Bus namespace and go to its Access control (IAM) page, select the Role assignments tab, and then click Add > Role assignments:
-
On the Add role assignments panel, select Azure Service Bus Data Owner as the Role, and select the app registration created in the previous section.
-
Click Save.
Shared Access Signature
This section describes how to obtain credentials (to be used during connection configuration) for a Service Bus namespace with Shared Access Signature authentication. The steps for authenticating with Microsoft Entra ID are described in the previous sections.
-
From the Service Bus namespace's overview section, navigate to Shared access policies under Settings in the left-hand navigation pane:
-
Under Policy click the name of the policy to be used for authentication. The example above uses the default RootManageSharedAccessKey administrator policy. If you have created additional policies they are also listed here. Retain the name of the selected policy, as it is used as the Policy name during connection configuration.
-
Once a policy is clicked, its keys and connection strings are displayed. Retain the Primary key, as it is used as the Primary key during connection configuration.