blob: 1e99b2364a56d56e038d34ac738cca887ca6f311 [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>FetchAzureBlobStorage_v12</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;">FetchAzureBlobStorage_v12</h1><h2>Description: </h2><p>Retrieves the specified blob from Azure Blob Storage and writes its content to the content of the FlowFile. The processor uses Azure Blob Storage client library v12.</p><h3>Tags: </h3><p>azure, microsoft, cloud, storage, blob</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, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</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>Storage Credentials</strong></td><td>storage-credentials-service</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>AzureStorageCredentialsService_v12<br/><strong>Implementation: </strong><a href="../org.apache.nifi.services.azure.storage.AzureStorageCredentialsControllerService_v12/index.html">AzureStorageCredentialsControllerService_v12</a></td><td id="description">Controller Service used to obtain Azure Blob Storage Credentials.</td></tr><tr><td id="name"><strong>Container Name</strong></td><td>container-name</td><td id="default-value">${azure.container}</td><td id="allowable-values"></td><td id="description">Name of the Azure storage container. In case of PutAzureBlobStorage processor, container can be created if it does not exist.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Blob Name</strong></td><td>blob-name</td><td id="default-value">${azure.blobname}</td><td id="allowable-values"></td><td id="description">The full name of the blob<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Range Start</td><td>range-start</td><td></td><td id="allowable-values"></td><td id="description">The byte position at which to start reading from the blob. An empty value or a value of zero will start reading at the beginning of the blob.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Range Length</td><td>range-length</td><td></td><td id="allowable-values"></td><td id="description">The number of bytes to download from the blob, starting from the Range Start. An empty value or a value that extends beyond the end of the blob will read to the end of the blob.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Proxy Configuration Service</td><td>proxy-configuration-service</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>ProxyConfigurationService<br/><strong>Implementation: </strong><a href="../../../nifi-proxy-configuration-nar/1.19.1/org.apache.nifi.proxy.StandardProxyConfigurationService/index.html">StandardProxyConfigurationService</a></td><td id="description">Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP, SOCKS In case of SOCKS, it is not guaranteed that the selected SOCKS Version will be used by the processor.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All successfully processed FlowFiles are routed to this relationship</td></tr><tr><td>failure</td><td>Unsuccessful operations will be transferred to the failure 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>azure.container</td><td>The name of the Azure Blob Storage container</td></tr><tr><td>azure.blobname</td><td>The name of the blob on Azure Blob Storage</td></tr><tr><td>azure.primaryUri</td><td>Primary location of the blob</td></tr><tr><td>azure.etag</td><td>ETag of the blob</td></tr><tr><td>azure.blobtype</td><td>Type of the blob (either BlockBlob, PageBlob or AppendBlob)</td></tr><tr><td>mime.type</td><td>MIME Type of the content</td></tr><tr><td>lang</td><td>Language code for the content</td></tr><tr><td>azure.timestamp</td><td>Timestamp of the blob</td></tr><tr><td>azure.length</td><td>Length of the blob</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 requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.azure.storage.ListAzureBlobStorage_v12/index.html">ListAzureBlobStorage_v12</a>, <a href="../org.apache.nifi.processors.azure.storage.PutAzureBlobStorage_v12/index.html">PutAzureBlobStorage_v12</a>, <a href="../org.apache.nifi.processors.azure.storage.DeleteAzureBlobStorage_v12/index.html">DeleteAzureBlobStorage_v12</a></p></body></html>