Azure Event Hubs Consumer Documentation

Version: 1.0.1

Retrieved: 2025-10-09 15:15:43

Azure Event Hubs Consumer

Recieves data from Azure Event Hubs

Settings

Credentials

Valid credentials must be provided to allow the module to connect to the Event Hub. The following types of credentials are supported:

• Azure Shared Access Key (Endpoint=sb://{namespace}/servicebus.windows.net/;SharedAccessKeyName=...)
• Azure Shared Access Signature (sr=sb://{namespace}/servicebus.windows.net/&sig=...)
  Note: Azure does not provide an UI to generate the SAS token, you will have to use a script.
• Azure Service Principal Secret (tenantID, clientID and secret)
• Azure Service Principal Certificate (tenantID, clientID and certificate)

Checkpoint storage

The module can keep track of which events that have been consumed, by storing the current offset in the stream (sequence number) at regular intervals as a checkpoint. If the Flow is restarted it will then request events that have arrived after the last stored checkpoint. To store checkpoints the module must be configured with credential and URL to an Azure Blob storage container. When to store checkpoints is determined by the Events Before Checkpoint setting. If checkpoints are not used the module will receive all events currently available when starting the Flow, including events that have already been processed. Note that also with checkpointing the module may receive events already seen at startup, if the checkpoint interval is larger than 1.

Output

A output for every event will be delivered.

Examples

Example of an event received from an Event Hub:

## Settings
Namespace = crosser
Event Hub Name = test
Storage Account URL = https://<xyz>.blob.core.windows.net/<aaa>
Parse Body As JSON = true
Events Before Checkpoint = 10

## Output
{
  "body": {
    "pressure": 954,
    "temp": 53
  },
  "crosser": {
    "success": true
  },
  "enqueuedTime": "2024-04-04T13:39:00.224+00:00",
  "offset": 8589942256,
  "partitionKey": null,
  "properties": {},
  "sequenceNumber": 3184
}