How to use IBM® App Connect with Microsoft Azure Event Hubs

Microsoft Azure Event Hubs is a high-throughput data streaming platform that processes millions of events every second, enabling real-time analytics and seamless integration across enterprise systems.

Availability:
  • A connector in IBM App Connect Enterprise as a ServiceApp Connect Enterprise as a Service connector
  • A local connector in a Designer instance of IBM App Connect in containers (Continuous Delivery release)Local connector in containers (Continuous Delivery release) 13.0.5.0-r1 or later

Supported product and API versions

To find out which product and API versions this connector supports, see Detailed System Requirements on the IBM Support page.

Connecting to Microsoft Azure Event Hubs

Complete the connection fields that you see in the App Connect Designer Connect > Applications and APIs page or flow editor. If necessary, work with your Microsoft Azure Event Hubs administrator to obtain these values.

Microsoft Azure Event Hubs has the following connection fields.
  • Account name is a meaningful name for your account that helps you to identify it.
  • Tenant ID is the unique identifier for your Microsoft Entra tenant.
  • Client ID is the unique client identifier that is assigned to your application when it is registered with Microsoft Entra ID.
  • Client secret is the client secret that is used to authenticate your application with Microsoft Entra ID.
  • Subscription ID is the unique identifier for your Azure subscription. It is used to identify which subscription your Azure Event Hubs resources belong to.
  • Resource group name is the name of the resource group that contains your Azure Event Hubs resources. Resource groups are logical containers for Azure resources.
  • Namespace name is the name of the Azure Event Hubs namespace. A namespace is a container for Event Hubs and provides a scoping container for addressing Event Hubs within your Azure subscription.

To obtain the connection values for Microsoft Azure Event Hubs, see Obtaining connection values for Microsoft Azure Event Hubs.

To connect to a Microsoft Azure Event Hubs endpoint from the App Connect Designer Applications and APIs page for the first time, expand Microsoft Azure Event Hubs, then click Connect.

Tip:

Before you use the account that is created in App Connect in a flow, rename the account to something meaningful that helps you to identify it. To rename the account on the Applications and APIs page, select the account, open its options menu (⋮), then click Rename Account.

General Considerations

Before you use App Connect Designer with Microsoft Azure Event Hubs, take note of the following considerations:

  • You can see lists of the trigger events and actions that are available on the Applications and APIs page of the App Connect Designer.

    For some applications, the events and actions depend on the environment and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.

  • If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.

Post connection considerations

Take note of the following consideration after you are connected to Microsoft Azure Event Hubs:
API usage
For detailed information on the API usage for Microsoft Azure Event Hubs, see Azure Event Hubs quotas and limits in the Event Hubs documentation page.

Events and Actions

Microsoft Azure Event Hubs events

These events are for changes in this application that trigger a flow to start completing the actions in the flow.

Event Description
New message Detects new messages that are received in Event Hubs

Microsoft Azure Event Hubs actions

Your flow completes these actions on this application.

Object Action Description
Consumer groups Retrieve consumer groups Retrieves consumer groups under event hub. Enter the consumer group name to fetch a specific consumer group.
Event hubs Create event hub Creates an event hub within a specified namespace and resource group
Retrieve all event hubs Retrieves all event hubs in a specified namespace and resource group
Update event hub Updates the existing Azure Event Hub
Delete event hub Deletes the specified Azure Event Hub
Messages Send message Sends a message to an event hub or a specific partition inside it
Retrieve messages Retrieves messages from an event hub, partition, or a consumer group
Partitions Retrieve partitions Retrieves all the partitions in a specific event hub
Retrieve partition by ID Retrieves a partition by using its partition ID

Model Context Protocol (MCP) support

The Microsoft Azure Event Hubs connector supports MCP, and all Microsoft Azure Event Hubs actions for the listed objects can be added to an MCP server as tools. For more information on how to configure an MCP server, see Creating and managing MCP servers.