Azure Service Bus

You can configure Azure Service Bus as either a source or a target.

Azure Service Bus offers different service tiers, each with varying capabilities. We've tested the Premium tier with this Micro-Integration and it meets the expected performance throughput. In addition, even though the Azure Service Bus offers large message sizes of 80 MB and above, you cannot use message sizes larger than:

  • 30 MB for Solace Event Broker Services (Enterprise service classes)
  • 10 MB for Solace Event Broker Services (Enterprise-100 Standalone service class).

Ensure that you select an Azure Service Bus tier that meets your requirements for performance throughput. For more information about tier differences, see Azure Service Bus Premium messaging and Azure Service Bus Quotas.

To configure the connection details for Azure Service Bus in your Micro-Integration, see Azure Service Bus Connection Parameters

You must also define at least one Micro-Integration Flow that specifies:

For a listing of available message headers, see Azure Service Bus Message Headers.

Azure Service Bus Connection Parameters

The following table describes the connection parameters for Azure Service Bus.

Field Description

Authentication Scheme

The authentication method to use with Azure Service Bus. Choose one of:

Connection String Authentication

The following table describes the connection parameters for connection string authentication.

Field Description

Service Bus Namespace Connection String

The Azure Service Bus connection string.

The connection string must provide one of:

  • a Shared Access Key (SharedAccessKeyName and SharedAccessKey), for example:

     Endpoint=sb://<SERVICE_BUS_NAMESPACE>.servicebus.windows.net/;SharedAccessKeyName=<POLICY_NAME>;SharedAccessKey=<SHARED_KEY>

  • OR, a Shared Access Signature (SharedAccessSignature), for example:

    Endpoint=sb://<SERVICE_BUS_NAMESPACE>.servicebus.windows.net/;SharedAccessSignature sig=<signature-string>&se=<expiry>&skn=<keyName>&sr=<URL-encoded-resourceURI>

AMQP connection strings are not supported.

Service Principal with Client Secret Authentication

Service principal authentication is an authentication method that uses a Microsoft Entra ID (formerly Azure AD) application registration with a client secret credential.

Before you can use service principal authentication, you must:

  1. Register an application in Microsoft Entra ID (formerly Azure AD).

  2. Create a client secret for the application.

  3. Assign the appropriate roles to the service principal on your Azure Service Bus namespace. At minimum, you require the Azure Service Bus Data Owner role, but you can alternatively use specific roles like Azure Service Bus Data Sender and Azure Service Bus Data Receiver, depending on your needs.

The following table describes the connection parameters for authenticating with a service principal and client secret.

Field Description

Client ID

The Application (service principal) ID.

In Microsoft Azure, you can find this in: Microsoft Entra ID → App registrations → <Your app> → Overview → Application (client) ID.

Client Secret

The client secret value.

In Microsoft Azure, you can find this in: Microsoft Entra ID → App registrations → <Your app> → Certificates & secrets → New client secret.

Tenant ID

The Microsoft Entra ID (Azure AD) tenant ID.

In Microsoft Azure, you can find this in: Microsoft Entra ID → App registrations → <Your app> → Overview → Directory (tenant) ID.

Service Bus Namespace

The Service Bus namespace name.

In Microsoft Azure, you can find this in: Azure Portal → Service Bus → Namespace → Overview → Name.

Enter only the namespace name, not the full URL. The Micro-Integration automatically constructs the fully qualified namespace as <namespace>.servicebus.windows.net.

Micro-Integration Flow Parameters

You must configure the endpoint parameters for each Flow. Each Flow can have different settings, but they all share the connection details of the parent Micro-Integration. These parameters differ depending on whether Azure Service Bus is configured as a source or a target.

Azure Service Bus Source Parameters

The following table describes the parameters for configuring Azure Service Bus as a source.

Field Description

Destination Type

The type for the Azure Service Bus destination. Select either an Azure TOPIC or QUEUE.

Destination

The source destination.

Subscription

The subscription name for the group consumer. This field is required when Destination Type is TOPIC.

Azure Service Bus Target Parameters

The following table describes the parameters for configuring Azure Service Bus as a target.

Setting a Smart Topic Destination on the Mappings step overrides the target destination field set on the Details step.

Field Description

Destination

The target destination.

Destination Type

The type for the Azure Service Bus destination. Select either an Azure TOPIC or QUEUE.