Skip to main content

ADLSCredentialsControllerService

Description

Defines credentials for ADLS processors.

Tags

adls, azure, cloud, credentials, microsoft, storage

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 NameAPI NameDefault ValueAllowable ValuesDescription
Storage Account Name *storage-account-nameThe storage account name. There are certain risks in allowing the account name to be stored as a FlowFile attribute. While it does provide for a more flexible flow by allowing the account name to be fetched dynamically from a FlowFile attribute, care must be taken to restrict access to the event provenance data (e.g., by strictly controlling the policies governing provenance for this processor). In addition, the provenance repositories may be put on encrypted disk partitions.

Supports Expression Language, using FlowFile attributes and Environment variables.
Endpoint Suffix *storage-endpoint-suffixdfs.core.windows.netStorage 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).

Supports Expression Language, using Environment variables.
Credentials Type *credentials-typeSAS Token
  • Account Key
  • SAS Token
  • Managed Identity
  • Service Principal
Credentials type to be used for authenticating to Azure
Account Key *storage-account-keyThe 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, Managed Identity or Service Principal instead for fine-grained control with policies. There are certain risks in allowing the account key to be stored as a FlowFile attribute. While it does provide for a more flexible flow by allowing the account key to be fetched dynamically from a FlowFile attribute, care must be taken to restrict access to the event provenance data (e.g., by strictly controlling the policies governing provenance for this processor). In addition, the provenance repositories may be put on encrypted disk partitions.

Supports Expression Language, using FlowFile attributes and Environment variables.

This property is only considered if:
  • the property Credentials Type has a value of ACCOUNT_KEY
SAS Token *storage-sas-tokenShared Access Signature token (the leading '?' may be included) There are certain risks in allowing the SAS token to be stored as a FlowFile attribute. While it does provide for a more flexible flow by allowing the SAS token to be fetched dynamically from a FlowFile attribute, care must be taken to restrict access to the event provenance data (e.g., by strictly controlling the policies governing provenance for this processor). In addition, the provenance repositories may be put on encrypted disk partitions.

Supports Expression Language, using FlowFile attributes and Environment variables.

This property is only considered if:
  • the property Credentials Type has a value of SAS_TOKEN
Managed Identity Client IDmanaged-identity-client-idClient 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.

This property is only considered if:
  • the property Credentials Type has a value of MANAGED_IDENTITY
Service Principal Tenant ID *service-principal-tenant-idTenant ID of the Azure Active Directory hosting the Service Principal.

This property is only considered if:
  • the property Credentials Type has a value of SERVICE_PRINCIPAL
Service Principal Client ID *service-principal-client-idClient ID (or Application ID) of the Client/Application having the Service Principal.

This property is only considered if:
  • the property Credentials Type has a value of SERVICE_PRINCIPAL
Service Principal Client Secret *service-principal-client-secretPassword of the Client/Application.

This property is only considered if:
  • the property Credentials Type has a value of SERVICE_PRINCIPAL
Proxy Configuration Serviceproxy-configuration-serviceController Service:
ProxyConfigurationService

Implementations:
StandardProxyConfigurationService
Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: SOCKS, HTTP In case of SOCKS, it is not guaranteed that the selected SOCKS Version will be used by the processor.

This property is only considered if:
  • the property Credentials Type has a value of SERVICE_PRINCIPAL or MANAGED_IDENTITY

State Management

This component does not store state.

Restricted

This component is not restricted.

System Resource Considerations

This component does not specify system resource considerations.

See Also