blob: 25f7ebdcbc8bd11241c3d1f99b7aad1b81cd9672 [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutAzureEventHub</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;">PutAzureEventHub</h1><h2>Description: </h2><p>Send FlowFile contents to Azure Event Hubs</p><h3>Tags: </h3><p>microsoft, azure, cloud, eventhub, events, streams, streaming</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 destination</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"><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">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 Send 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">Partitioning Key Attribute Name</td><td>partitioning-key-attribute-name</td><td></td><td id="allowable-values"></td><td id="description">If specified, the value from argument named by this field will be used as a partitioning key to be used by event hub.</td></tr><tr><td id="name"><strong>Maximum Batch Size</strong></td><td>max-batch-size</td><td id="default-value">100</td><td id="allowable-values"></td><td id="description">Maximum number of FlowFiles processed for each Processor invocation</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 sent to the event hubs will be transferred to this Relationship.</td></tr><tr><td>failure</td><td>Any FlowFile that could not be sent to the event hub will be transferred to this Relationship.</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3><table id="system-resource-considerations"><tr><th>Resource</th><th>Description</th></tr><tr><td>MEMORY</td><td>The Processor buffers FlowFile contents in memory before sending</td></tr></table></body></html>