GetAzureEventHub

Description:

Receives messages from Microsoft Azure Event Hubs, writing the contents of the Azure message to the content of the FlowFile. Note: Please be aware that this processor creates a thread pool of 4 threads for Event Hub Client. They will be extra threads other than the concurrent tasks scheduled for this processor.

Tags:

azure, microsoft, cloud, eventhub, events, streaming, streams

Properties:

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.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Event Hub NameEvent Hub NameName of Azure Event Hubs source
Service Bus EndpointService Bus EndpointAzure
  • Azure Servicebus endpoint for general use
  • Azure China Servicebus endpoint for China
  • Azure Germany Servicebus endpoint for Germany
  • Azure US Government Servicebus endpoint for US Government
To support namespaces not in the default windows.net domain.
Event Hub NamespaceEvent Hub NamespaceNamespace of Azure Event Hubs prefixed to Service Bus Endpoint domain
Shared Access Policy NameShared Access Policy NameThe name of the shared access policy. This policy must have Listen claims.
Shared Access Policy Primary KeyShared Access Policy Primary KeyThe primary key of the shared access policy
Sensitive Property: true
Use Azure Managed Identityuse-managed-identityfalse
  • true
  • false
Choose whether or not to use the managed identity of Azure VM/VMSS
Number of Event Hub PartitionsNumber of Event Hub PartitionsThis property is deprecated and no longer used.
Consumer GroupEvent Hub Consumer Group$DefaultThe name of the consumer group to use when pulling events
Message Enqueue TimeEvent Hub Message Enqueue TimeA timestamp (ISO-8601 Instant) formatted as YYYY-MM-DDThhmmss.sssZ (2016-01-01T01:01:01.000Z) from which messages should have been enqueued in the Event Hub to start reading from
Partition Receiver Fetch SizePartition Recivier Fetch SizeThe number of events that a receiver should fetch from an Event Hubs partition before returning. The default is 100
Partition Receiver TimeoutPartition Receiver Timeout (millseconds)The amount of time in milliseconds a Partition Receiver should wait to receive the Fetch Size before returning. The default is 60000

Relationships:

NameDescription
successAny FlowFile that is successfully received from the event hub will be transferred to this Relationship.

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
eventhub.enqueued.timestampThe time (in milliseconds since epoch, UTC) at which the message was enqueued in the event hub
eventhub.offsetThe offset into the partition at which the message was stored
eventhub.sequenceThe Azure sequence number associated with the message
eventhub.nameThe name of the event hub from which the message was pulled
eventhub.partitionThe name of the event hub partition from which the message was pulled
eventhub.property.*The application properties of this message. IE: 'application' would be 'eventhub.property.application'

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component does not allow an incoming relationship.

System Resource Considerations:

None specified.