GetAzureEventHub

Description:

Receives messages from a Microsoft Azure Event Hub, writing the contents of the Azure message to the content of the FlowFile

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, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the nifi.properties file has an entry for the property nifi.sensitive.props.key.

NameDefault ValueAllowable ValuesDescription
Event Hub NameThe name of the Azure Event Hub to pull messages from
Service Bus Endpoint.servicebus.windows.net
  • .servicebus.windows.net
  • .servicebus.chinacloudapi.cn
To support Namespaces in non-standard Host URIs ( not .servicebus.windows.net, ie .servicebus.chinacloudapi.cn) select from the drop down acceptable options
Event Hub NamespaceThe Azure Namespace that the Event Hub is assigned to. This is generally equal to <Event Hub Name>-ns
Shared Access Policy NameThe name of the Event Hub Shared Access Policy. This Policy must have Listen permissions.
Shared Access Policy Primary KeyThe primary key of the Event Hub Shared Access Policy
Sensitive Property: true
Number of Event Hub PartitionsThe number of partitions that the Event Hub has. Only this number of partitions will be used, so it is important to ensure that if the number of partitions changes that this value be updated. Otherwise, some messages may not be consumed.
Event Hub Consumer Group$DefaultThe name of the Event Hub Consumer Group to use when pulling events
Event Hub Message Enqueue TimeA timestamp (ISO-8061 Instant) formatted as YYYY-MM-DDThhmmss.sssZ (2016-01-01T01:01:01.000Z) from which messages should have been enqueued in the EventHub to start reading from
Partition Recivier Fetch SizeThe number of events that a receiver should fetch from an EventHubs partition before returning. Default(100)
Partiton Receiver Timeout (millseconds)The amount of time a Partition Receiver should wait to receive the Fetch Size before returning. Default(60000)

Relationships:

NameDescription
successAny FlowFile that is successfully received from the Azure 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 Azure 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 Azure Partition from which the message was pulled

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component does not allow an incoming relationship.