Format and send Records to Azure Event Hubs


azure, record, sink


In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Service Bus EndpointService Bus EndpointAzure
  • Azure Default Service Bus Endpoint
  • Azure China China Service Bus Endpoint
  • Azure Germany Germany Service Bus Endpoint
  • Azure US Government United States Government Endpoint
Provides the domain for connecting to Azure Event Hubs
Event Hub NamespaceEvent Hub NamespaceProvides provides the host for connecting to Azure Event Hubs
Event Hub NameEvent Hub NameProvides the Event Hub Name for connections
Transport TypeTransport TypeAMQP
  • AMQP AMQP over TCP on ports 5671 and 5672
  • AMQP_WEB_SOCKETS AMQP over HTTPS with WebSockets on port 443
Advanced Message Queuing Protocol Transport Type for communication with Azure Event Hubs
Record Writerrecord-sink-record-writerController Service API:
Implementations: AvroRecordSetWriter
Specifies the Controller Service to use for writing out the records.
Authentication StrategyAuthentication StrategyDefault Azure Credential
  • Shared Access Key Azure Event Hub shared access key
  • Default Azure Credential The Default Azure Credential will read credentials from standard environment variables and will also attempt to read Managed Identity credentials when running in Microsoft Azure environments
Strategy for authenticating to Azure Event Hubs
Shared Access PolicyShared Access PolicyThe name of the shared access policy. This policy must have Send claims

This Property is only considered if the [Authentication Strategy] Property has a value of "Shared Access Key".
Shared Access Policy KeyShared Access Policy KeyThe primary or secondary key of the shared access policy
Sensitive Property: true

This Property is only considered if the [Authentication Strategy] Property has a value of "Shared Access Key".
Partition KeyPartition KeyA hint for Azure Event Hub message broker how to distribute messages across one or more partitions
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)

State management:

This component does not store state.


This component is not restricted.

System Resource Considerations:

None specified.