PluginsAzureTasksStorageAdlsRead

Read​Read

Read Read

yaml
type: "io.kestra.plugin.azure.storage.adls.Read"

Read a file from Azure Data Lake Storage.

Examples

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

endpoint

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️

The blob service endpoint.

filePath

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️

File path

Full path of the file in its file system

fileSystem

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️

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

connectionString

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Connection string of the Storage Account.

sasToken

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

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.

sharedKeyAccountAccessKey

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Shared Key access key for authenticating requests.

sharedKeyAccountName

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Shared Key account name for authenticating requests.

Outputs

file

The downloaded file.

Definitions

com.azure.storage.file.datalake.models.AccessTier

com.azure.storage.file.datalake.models.ArchiveStatus

io.kestra.plugin.azure.storage.adls.models.AdlsFile

Properties

accessControlList
  • Type: array
  • SubType: string
  • Dynamic: ❓
  • Required: ❓
archiveStatus
archiveTier
contentEncoding
  • Type: string
  • Dynamic: ❓
  • Required: ❓
contentLanguage
  • Type: string
  • Dynamic: ❓
  • Required: ❓
contentMd5
  • Type: string
  • Dynamic: ❓
  • Required: ❓
contentType
  • Type: string
  • Dynamic: ❓
  • Required: ❓
creationTime
  • Type: string
  • Dynamic: ❓
  • Required: ❓
  • Format: date-time
eTag
  • Type: string
  • Dynamic: ❓
  • Required: ❓
fileName
  • Type: string
  • Dynamic: ❓
  • Required: ❓
fileSystem
  • Type: string
  • Dynamic: ❓
  • Required: ❓
group
  • Type: string
  • Dynamic: ❓
  • Required: ❓
isDirectory
  • Type: boolean
  • Dynamic: ❓
  • Required: ❓
lastModifed
  • Type: string
  • Dynamic: ❓
  • Required: ❓
  • Format: date-time
leaseDuration
  • Type: string
  • Dynamic: ❓
  • Required: ❓
  • Possible Values:
    • INFINITE
    • FIXED
leaseState
  • Type: string
  • Dynamic: ❓
  • Required: ❓
  • Possible Values:
    • AVAILABLE
    • LEASED
    • EXPIRED
    • BREAKING
    • BROKEN
leaseStatus
  • Type: string
  • Dynamic: ❓
  • Required: ❓
  • Possible Values:
    • LOCKED
    • UNLOCKED
name
  • Type: string
  • Dynamic: ❓
  • Required: ❓
owner
  • Type: string
  • Dynamic: ❓
  • Required: ❓
permissions
  • Type: string
  • Dynamic: ❓
  • Required: ❓
size
  • Type: integer
  • Dynamic: ❓
  • Required: ❓
uri
  • Type: string
  • Dynamic: ❓
  • Required: ❓
  • Format: uri

Was this page helpful?