Azure Event Hubs

Discover more about the Azure Event Hubs connector and how to use it on the Digibee Integration Platform.

Important information:

  • This documentation is currently available only in English but will soon be translated into Portuguese.

  • The content is under revision and may change. We appreciate your understanding as we work to improve the documentation.

Send and receive events to/from Azure Event Hubs using AMQP protocol.

Parameters

Take a look at the configuration options for the component. Parameters supported by Double Braces expressions are marked with (DB).

Required Tab

ParameterDescriptionDefault valueData type

Dynamic Account

When activated, the connector will use the account dynamically. When deactivated, it’ll use the account statically.

false

boolean

Account Name DB

The name of the account that is generated dynamically via the Store Account connector.

string

Account

Sets the account to be used by the connector.

N/A

account

Fail On Error

If true will stop pipeline with an error, if false will let the pipeline continue but the output will show a property success with value false

false

boolean

Optional Tab

ParameterDescriptionDefault valueData type

Namespace DB

EventHubs namespace created in Azure Portal.

N/A

string

Event Hub Name DB

EventHubs name under a specific namespace.

N/A

string

Amqp Transport Type

Sets the transport type by which all the communication with Azure Event Hubs occurs. Default value is AmqpTransportType#AMQP.

AMQP

string

Partition Id DB

Sets the identifier of the Event Hub partition that the events will be sent to. If the identifier is not specified, the Event Hubs service will be responsible for routing events that are sent to an available partition.

N/A

string

Partition Key DB

Sets a hashing key to be provided for the batch of events, which instructs the Event Hubs service to map this key to a specific partition. The selection of a partition is stable for a given partition hashing key. Should any other batches of events be sent using the same exact partition hashing key, the Event Hubs service will route them all to the same partition. This should be specified only when there is a need to group events by partition, but there is flexibility into which partition they are routed. If ensuring that a batch of events is sent only to a specific partition, it is recommended that the {link #setPartitionId(String) identifier of the position be specified directly} when sending the batch.

N/A

string

Headers Tab

ParameterDescriptionDefault valueData type

CamelAzureEventHubsPartitionKey DB

(producer) Overrides the hashing key to be provided for the batch of events, which instructs the Event Hubs service to map this key to a specific partition. (consumer) It sets the partition hashing key if it was set when originally publishing the event. If it exists, this value was used to compute a hash to select a partition to send the message to. This is only present on a received EventData.

N/A

string

CamelAzureEventHubsPartitionId DB

(producer) Overrides the identifier of the Event Hub partition that the events will be sent to. (consumer) It sets the partition id of the Event Hub.

N/A

string

Successful executions should output at least a property "success": true

Last updated