FetchAzureBlobStorage_v12

FetchAzureBlobStorage_v12 2.0.0

Bundle: org.apache.nifi | nifi-azure-nar
Description: 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.
Tags: azure, blob, cloud, microsoft, storage
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: false

Properties

Blob Name
The full name of the blob

Display Name

Blob Name

Description

The full name of the blob

API Name

blob-name

Default Value

${azure.blobname}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Client-Side Encryption Key ID
Specifies the ID of the key to use for client-side encryption.
Display Name

Client-Side Encryption Key ID

Description

Specifies the ID of the key to use for client-side encryption.

API Name

Client-Side Encryption Key ID

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true

Dependencies
- Client-Side Encryption Key Type is set to any of [LOCAL]
Client-Side Encryption Key Type
Specifies the key type to use for client-side encryption.
Display Name

Client-Side Encryption Key Type

Description

Specifies the key type to use for client-side encryption.

API Name

Client-Side Encryption Key Type

Default Value

NONE

Allowable Values
- NONE
- LOCAL
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Client-Side Encryption Local Key
When using local client-side encryption, this is the raw key, encoded in hexadecimal
Display Name

Client-Side Encryption Local Key

Description

When using local client-side encryption, this is the raw key, encoded in hexadecimal

API Name

Client-Side Encryption Local Key

Expression Language Scope

Not Supported

Sensitive

true

Required

true

Dependencies
- Client-Side Encryption Key Type is set to any of [LOCAL]
Container Name
Name of the Azure storage container. In case of PutAzureBlobStorage processor, container can be created if it does not exist.

Display Name

Container Name

Description

Name of the Azure storage container. In case of PutAzureBlobStorage processor, container can be created if it does not exist.

API Name

container-name

Default Value

${azure.container}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Proxy Configuration Service
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.

Display Name

Proxy Configuration Service

Description

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.

API Name

proxy-configuration-service

Service Interface

org.apache.nifi.proxy.ProxyConfigurationService

Service Implementations

org.apache.nifi.proxy.StandardProxyConfigurationService

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Range Length
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.

Display Name

Range Length

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.

API Name

range-length

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Range Start
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.

Display Name

Range Start

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.

API Name

range-start

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Storage Credentials
Controller Service used to obtain Azure Blob Storage Credentials.

Display Name

Storage Credentials

Description

Controller Service used to obtain Azure Blob Storage Credentials.

API Name

storage-credentials-service

Service Interface

org.apache.nifi.services.azure.storage.AzureStorageCredentialsService_v12

Service Implementations

org.apache.nifi.services.azure.storage.AzureStorageCredentialsControllerService_v12

org.apache.nifi.services.azure.storage.AzureStorageCredentialsControllerServiceLookup_v12

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Relationships

Name	Description
failure	Unsuccessful operations will be transferred to the failure relationship.
success	All successfully processed FlowFiles are routed to this relationship

Writes Attributes

Name	Description
azure.container	The name of the Azure Blob Storage container
azure.blobname	The name of the blob on Azure Blob Storage
azure.primaryUri	Primary location of the blob
azure.etag	ETag of the blob
azure.blobtype	Type of the blob (either BlockBlob, PageBlob or AppendBlob)
mime.type	MIME Type of the content
lang	Language code for the content
azure.timestamp	Timestamp of the blob
azure.length	Length of the blob

Use Cases Involving Other Components

Retrieve all files in an Azure Blob Storage container

Description

Retrieve all files in an Azure Blob Storage container

Keywords

azure, blob, storage, state, retrieve, fetch, all, stream

Processor Configurations

org.apache.nifi.processors.azure.storage.ListAzureBlobStorage_v12

The "Container Name" property should be set to the name of the Blob Storage Container that files reside in.     If the flow being built is to be reused elsewhere, it's a good idea to parameterize this property by setting it to something like `#{AZURE_CONTAINER}`.

The "Storage Credentials" property should specify an instance of the AzureStorageCredentialsService_v12 in order to provide credentials for accessing the storage container.

The 'success' Relationship of this Processor is then connected to FetchAzureBlobStorage_v12.

org.apache.nifi.processors.azure.storage.FetchAzureBlobStorage_v12

"Container Name" = "${azure.container}"
"Blob Name" = "${azure.blobname}"

The "Storage Credentials" property should specify an instance of the AzureStorageCredentialsService_v12 in order to provide credentials for accessing the storage container.