Azure Read

Azure Read

Certified

Read a file from Azure Data Lake Storage

Read a file from Azure Data Lake Storage using the Azure SDK.

yaml
type: io.kestra.plugin.azure.storage.adls.Read
yaml
id: azure_storage_datalake_read
namespace: company.team

tasks:
  - id: read_file
    type: io.kestra.plugin.azure.storage.adls.Read
    connectionString: "{{ secret('AZURE_CONNECTION_STRING') }}"
    fileSystem: "tasks"
    endpoint: "https://yourblob.blob.core.windows.net"
    filePath: "full/path/to/file.txt"

  - id: log_size
    type: io.kestra.plugin.core.debug.Echo
    level: INFO
    format: " {{ outputs.read_file.file.size }}"
Properties

Service endpoint URL

Base HTTPS endpoint of the target service.

File path

Full path of the file in its file system

The name of the file systems. If the path name contains special characters, pass in the url encoded version of the path name

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
Possible Values
MD5SHA_256

Checksum algorithm

Algorithm used to compute and compare the checksum. Defaults to MD5. Note: validateChecksum (server-side) only supports MD5, since that is what Azure stores. SHA-256 requires expectedChecksum.

Connection string of the Storage Account.

Expected checksum

User-supplied expected checksum for the downloaded file. Accepts a lowercase or uppercase hex digest, or the equivalent base64 encoding (Azure's native Content-MD5 format). Takes precedence over validateChecksum.

Fail when the server has no Content-MD5

Only applies when validateChecksum is true. If true, the task fails when the Azure object has no stored Content-MD5. If false (default), validation is skipped with a warning.

The SAS token to use for authenticating requests.

This string should only be the query parameters (with or without a leading '?') and not a full URL.

Shared Key access key for authenticating requests.

Shared Key account name for authenticating requests.

Validate checksum against server's Content-MD5

If true, compute the MD5 of the downloaded file and compare it to the Content-MD5 stored on the Azure object. Many block blobs uploaded as streams have no Content-MD5; see failOnMissingChecksum to control that case.

The downloaded file

Definitions
accessControlListarray
SubTypestring
archiveStatus
archiveTier
contentEncodingstring
contentLanguagestring
contentMd5string
contentTypestring
creationTimestring
Formatdate-time
eTagstring
fileNamestring
fileSystemstring
groupstring
isDirectoryboolean
lastModifedstring
Formatdate-time
leaseDurationstring
Possible Values
INFINITEFIXED
leaseStatestring
Possible Values
AVAILABLELEASEDEXPIREDBREAKINGBROKEN
leaseStatusstring
Possible Values
LOCKEDUNLOCKED
namestring
ownerstring
permissionsstring
sizeinteger
uristring
Formaturi