Azure Event Hubs Publisher Documentation

Version: 1.1.2

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

Azure Event Hubs Publisher

This module publishes message data to Azure Event Hubs.

Settings

* required for all credentials except Azure Shared Access Key

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)

Input

Each message should contain the specified 'Source Property' and this property should hold an Object or an Array of Objects. This object will be converted to JSON and sent as a UTF8 string to the Event Hub. Note: The module expects an object and not a simple value (i.e: Source Property can not be e.g. 3 or false )

Output

The output will have a copy of the input plus a crosser property with the status of the request.

Examples

In this example we are sending an object (data) with two measurements to Azure:

## Settings
Namespace = crosser
Event Hub Name = test
Source Property = data

## Input
{
   "data": {
      "temp": 23,
      "pressure": 18
   }
}

## Outputs
{
   "data": {
      "temp": 23,
      "pressure": 18
   },
   "crosser": {
      "success": true
   }
}

## In Azure
Received the event: "{"pressure":18,"temp":23}"

Examples

In this example we are sending an object (data) with two measurements to Azure, and we are adding a message property to the event data that can be used for ingestion in Azure:

## Settings
Namespace = crosser.sericebus.windows.net
Event Hub Name = test
Source Property = data
Message Properties:
Database = {database}
Table = {table}

Note: 
Ingestion Properties are case sensitive.
Ingestion Properties can be referenced from the incoming message using template syntax.


## Input
{
   "data": {
      "temp": 23,
      "pressure": 18
   },
   "database": "my_db",
   "table": "my_table"
}

## Output
{
  "crosser": {
    "success": true
  },
  "data": {
    "pressure": 18,
    "temp": 23
  },
  "database": "my_db",
  "table": "my_table"
}