blob: 94766418dbbdf7606a0139a1fd61d2dd9db74a54 [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>AzureStorageCredentialsControllerService_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;">AzureStorageCredentialsControllerService_v12</h1><h2>Description: </h2><p>Provides credentials for Azure Blob processors using Azure Blob Storage client library v12.</p><h3>Tags: </h3><p>azure, microsoft, cloud, storage, blob, credentials</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>Storage Account Name</strong></td><td>storage-account-name</td><td></td><td id="allowable-values"></td><td id="description">The storage account name.<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Endpoint Suffix</strong></td><td>storage-endpoint-suffix</td><td id="default-value">blob.core.windows.net</td><td id="allowable-values"></td><td id="description">Storage accounts in public Azure always use a common FQDN suffix. Override this endpoint suffix with a different suffix in certain circumstances (like Azure Stack or non-public Azure regions).</td></tr><tr><td id="name"><strong>Credentials Type</strong></td><td>credentials-type</td><td id="default-value">SAS Token</td><td id="allowable-values"><ul><li>Account Key <img src="../../../../../html/images/iconInfo.png" alt="The primary or secondary Account Key of the storage account that provides full access to the resources in the account" title="The primary or secondary Account Key of the storage account that provides full access to the resources in the account"></img></li><li>SAS Token <img src="../../../../../html/images/iconInfo.png" alt="SAS (Shared Access Signature) Token generated for accessing resources in the storage account" title="SAS (Shared Access Signature) Token generated for accessing resources in the storage account"></img></li><li>Managed Identity <img src="../../../../../html/images/iconInfo.png" alt="Azure Virtual Machine Managed Identity (it can only be used when NiFi is running on Azure)" title="Azure Virtual Machine Managed Identity (it can only be used when NiFi is running on Azure)"></img></li><li>Service Principal <img src="../../../../../html/images/iconInfo.png" alt="Azure Active Directory Service Principal with Client Id / Client Secret of a registered application" title="Azure Active Directory Service Principal with Client Id / Client Secret of a registered application"></img></li></ul></td><td id="description">Credentials type to be used for authenticating to Azure</td></tr><tr><td id="name"><strong>Account Key</strong></td><td>storage-account-key</td><td></td><td id="allowable-values"></td><td id="description">The storage account key. This is an admin-like password providing access to every container in this account. It is recommended one uses Shared Access Signature (SAS) token instead for fine-grained control with policies.<br/><strong>Sensitive Property: true</strong><br/><br/><strong>This Property is only considered if </strong><strong>the [Credentials Type] Property has a value of "Account Key".</strong></td></tr><tr><td id="name"><strong>SAS Token</strong></td><td>storage-sas-token</td><td></td><td id="allowable-values"></td><td id="description">Shared Access Signature token, including the leading '?'. Specify either SAS token (recommended) or Account Key.<br/><strong>Sensitive Property: true</strong><br/><br/><strong>This Property is only considered if </strong><strong>the [Credentials Type] Property has a value of "SAS Token".</strong></td></tr><tr><td id="name">Managed Identity Client ID</td><td>managed-identity-client-id</td><td></td><td id="allowable-values"></td><td id="description">Client ID of the managed identity. The property is required when User Assigned Managed Identity is used for authentication. It must be empty in case of System Assigned Managed Identity.<br/><strong>Sensitive Property: true</strong><br/><br/><strong>This Property is only considered if </strong><strong>the [Credentials Type] Property has a value of "Managed Identity".</strong></td></tr><tr><td id="name"><strong>Service Principal Tenant ID</strong></td><td>service-principal-tenant-id</td><td></td><td id="allowable-values"></td><td id="description">Tenant ID of the Azure Active Directory hosting the Service Principal. The property is required when Service Principal authentication is used.<br/><strong>Sensitive Property: true</strong><br/><br/><strong>This Property is only considered if </strong><strong>the [Credentials Type] Property has a value of "Service Principal".</strong></td></tr><tr><td id="name"><strong>Service Principal Client ID</strong></td><td>service-principal-client-id</td><td></td><td id="allowable-values"></td><td id="description">Client ID (or Application ID) of the Client/Application having the Service Principal. The property is required when Service Principal authentication is used.<br/><strong>Sensitive Property: true</strong><br/><br/><strong>This Property is only considered if </strong><strong>the [Credentials Type] Property has a value of "Service Principal".</strong></td></tr><tr><td id="name"><strong>Service Principal Client Secret</strong></td><td>service-principal-client-secret</td><td></td><td id="allowable-values"></td><td id="description">Password of the Client/Application. The property is required when Service Principal authentication is used.<br/><strong>Sensitive Property: true</strong><br/><br/><strong>This Property is only considered if </strong><strong>the [Credentials Type] Property has a value of "Service Principal".</strong></td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html>