| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetAzureEventHub</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">GetAzureEventHub</h1><h2>Description: </h2><p>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.</p><h3>Tags: </h3><p>azure, microsoft, cloud, eventhub, events, streaming, streams</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Display Name</th><th>API Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Event Hub Name</strong></td><td>Event Hub Name</td><td></td><td id="allowable-values"></td><td id="description">Name of Azure Event Hubs source</td></tr><tr><td id="name"><strong>Service Bus Endpoint</strong></td><td>Service Bus Endpoint</td><td id="default-value">Azure</td><td id="allowable-values"><ul><li>Azure <img src="../../../../../html/images/iconInfo.png" alt="Servicebus endpoint for general use" title="Servicebus endpoint for general use"></img></li><li>Azure China <img src="../../../../../html/images/iconInfo.png" alt="Servicebus endpoint for China" title="Servicebus endpoint for China"></img></li><li>Azure Germany <img src="../../../../../html/images/iconInfo.png" alt="Servicebus endpoint for Germany" title="Servicebus endpoint for Germany"></img></li><li>Azure US Government <img src="../../../../../html/images/iconInfo.png" alt="Servicebus endpoint for US Government" title="Servicebus endpoint for US Government"></img></li></ul></td><td id="description">To support namespaces not in the default windows.net domain.</td></tr><tr><td id="name"><strong>Event Hub Namespace</strong></td><td>Event Hub Namespace</td><td></td><td id="allowable-values"></td><td id="description">Namespace of Azure Event Hubs prefixed to Service Bus Endpoint domain</td></tr><tr><td id="name">Shared Access Policy Name</td><td>Shared Access Policy Name</td><td></td><td id="allowable-values"></td><td id="description">The name of the shared access policy. This policy must have Listen claims.</td></tr><tr><td id="name">Shared Access Policy Primary Key</td><td>Shared Access Policy Primary Key</td><td></td><td id="allowable-values"></td><td id="description">The primary key of the shared access policy<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Use Azure Managed Identity</td><td>use-managed-identity</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Choose whether or not to use the managed identity of Azure VM/VMSS</td></tr><tr><td id="name">Number of Event Hub Partitions</td><td>Number of Event Hub Partitions</td><td></td><td id="allowable-values"></td><td id="description">This property is deprecated and no longer used.</td></tr><tr><td id="name"><strong>Consumer Group</strong></td><td>Event Hub Consumer Group</td><td id="default-value">$Default</td><td id="allowable-values"></td><td id="description">The name of the consumer group to use when pulling events</td></tr><tr><td id="name">Message Enqueue Time</td><td>Event Hub Message Enqueue Time</td><td></td><td id="allowable-values"></td><td id="description">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</td></tr><tr><td id="name">Partition Receiver Fetch Size</td><td>Partition Recivier Fetch Size</td><td></td><td id="allowable-values"></td><td id="description">The number of events that a receiver should fetch from an Event Hubs partition before returning. The default is 100</td></tr><tr><td id="name">Partition Receiver Timeout</td><td>Partition Receiver Timeout (millseconds)</td><td></td><td id="allowable-values"></td><td id="description">The amount of time in milliseconds a Partition Receiver should wait to receive the Fetch Size before returning. The default is 60000</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Any FlowFile that is successfully received from the event hub will be transferred to this Relationship.</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>eventhub.enqueued.timestamp</td><td>The time (in milliseconds since epoch, UTC) at which the message was enqueued in the event hub</td></tr><tr><td>eventhub.offset</td><td>The offset into the partition at which the message was stored</td></tr><tr><td>eventhub.sequence</td><td>The Azure sequence number associated with the message</td></tr><tr><td>eventhub.name</td><td>The name of the event hub from which the message was pulled</td></tr><tr><td>eventhub.partition</td><td>The name of the event hub partition from which the message was pulled</td></tr><tr><td>eventhub.property.*</td><td>The application properties of this message. IE: 'application' would be 'eventhub.property.application'</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component does not allow an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> |