GetAzureEventHub
Description
Receives messages from Microsoft Azure Event Hubs without reliable checkpoint tracking. In clustered environment, GetAzureEventHub processor instances work independently and all cluster nodes process all messages (unless running the processor in Primary Only mode). ConsumeAzureEventHub offers the recommended approach to receiving messages from Azure Event Hubs. This processor creates a thread pool for connections to Azure Event Hubs.
Tags
azure, cloud, eventhub, events, microsoft, streaming, streams
Properties
In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| Event Hub Namespace * | Event Hub Namespace | Namespace of Azure Event Hubs prefixed to Service Bus Endpoint domain | ||
| Event Hub Name * | Event Hub Name | Name of Azure Event Hubs source | ||
| Service Bus Endpoint * | Service Bus Endpoint | Azure |
| To support namespaces not in the default windows.net domain. |
| Transport Type * | Transport Type | AMQP |
| Advanced Message Queuing Protocol Transport Type for communication with Azure Event Hubs |
| Shared Access Policy Name | Shared Access Policy Name | The name of the shared access policy. This policy must have Listen claims. | ||
| Shared Access Policy Key | Shared Access Policy Primary Key | The key of the shared access policy. Either the primary or the secondary key can be used. | ||
| Use Azure Managed Identity * | use-managed-identity | false |
| Choose whether or not to use the managed identity of Azure VM/VMSS |
| Consumer Group * | Event Hub Consumer Group | $Default | The name of the consumer group to use when pulling events | |
| Message Enqueue Time | Event Hub Message Enqueue Time | A 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 Size | Partition Recivier Fetch Size | The number of events that a receiver should fetch from an Event Hubs partition before returning. The default is 100 | ||
| Partition Receiver Timeout | Partition 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 | ||
| Proxy Configuration Service | proxy-configuration-service | Controller Service: ProxyConfigurationService Implementations: StandardProxyConfigurationService | Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP + AuthN This property is only considered if:
|
Dynamic Properties
This component does not support dynamic properties.
Relationships
| Name | Description |
|---|---|
| success | Any FlowFile that is successfully received from the event hub will be transferred to this Relationship. |
Reads Attributes
This processor does not read attributes.
Writes Attributes
| Name | Description |
|---|---|
| eventhub.enqueued.timestamp | The time (in milliseconds since epoch, UTC) at which the message was enqueued in the event hub |
| eventhub.name | The name of the event hub from which the message was pulled |
| eventhub.offset | The offset into the partition at which the message was stored |
| eventhub.partition | The 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' |
| eventhub.sequence | The Azure sequence number associated with the message |
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
This component does not specify system resource considerations.