Azure Event Hubs
Discover more about the Azure Event Hubs connector and how to use it on the Digibee Integration Platform.
The content of this documentation is under revision and may change. We appreciate your understanding as we work to improve it.
Azure Event Hubs sends and receives 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)
.
General tab
Parameter | Description | Default value | Data type |
---|---|---|---|
Dynamic Account | When active, the connector will use the account dynamically. Otherwise, it will use the account statically. | False | Boolean |
Account Name | The name of the dynamic account used by the connector. This account must have been previously configured in a Store Account connector in the pipeline for this process to take effect. It is only available if the Dynamic Account parameter is active. | N/A | String |
Account | The account used by the connector. It is only available if the Dynamic Account parameter is inactive. | N/A | Account |
Fail On Error | If the option is activated, the pipeline's execution with an error will be interrupted. Otherwise, the pipeline execution proceeds, but the result will show a false value for the | False | Boolean |
Optional tab
Parameter | Description | Default value | Data type |
---|---|---|---|
Namespace | EventHubs namespace created in Azure Portal. | N/A | String |
Event Hub Name | 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 | 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 | 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 |
Body | The body, if applicable. |
| String |
Headers tab
Parameter | Description | Default value | Data type |
---|---|---|---|
Partition Key | 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 |
Partition Id | It sets the partition ID of the Event Hub. | N/A | String |
Documentation tab
Parameter | Description | Default value | Data type |
---|---|---|---|
Documentation | Section for documenting any necessary information about the connector configuration and business rules. | N/A | String |
Last updated