PluginsAzureTasksStorageBlobDownloads

Downloads​Downloads

Downloads Downloads

yaml
type: "io.kestra.plugin.azure.storage.blob.Downloads"

Downloads files from the Azure Blob Storage.

Examples

yaml
id: azure_storage_blob_downloads
namespace: company.team

tasks:
  - id: downloads
    type: io.kestra.plugin.azure.storage.blob.Downloads
    endpoint: "https://yourblob.blob.core.windows.net"
    connectionString: "DefaultEndpointsProtocol=...=="
    container: "mydata"
    prefix: "sub-dir"
    delimiter: "/"

Properties

action

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️
  • Possible Values:
    • MOVE
    • DELETE
    • NONE

The action to perform on the retrieved files. If using NONE, make sure to handle the files inside your flow to avoid infinite triggering.

container

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

The blob container.

endpoint

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

The blob service endpoint.

filter

  • Type: string
  • Dynamic: ❓
  • Required: ✔️
  • Default: FILES
  • Possible Values:
    • FILES
    • DIRECTORY
    • BOTH

The filter for files or directories.

connectionString

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

Connection string of the Storage Account.

delimiter

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

The delimiter for blob hierarchy, "/" for hierarchy based on directories.

moveTo

The destination container and key.

prefix

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

Limits the response to keys that begin with the specified prefix.

regexp

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

A regular expression to filter on the full key.

ex: regExp: .* to match all files regExp: .*2020-01-0.\\.csv to match files between 01 and 09 of january ending with .csv

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

blobs

  • Type: array
  • SubType: Blob
  • Required: ❌

The list of blobs.

outputFiles

  • Type: object
  • SubType: string
  • Required: ❌

The downloaded files as a map of from/to URIs.

Definitions

io.kestra.plugin.azure.storage.blob.models.Blob

Properties

container
  • Type: string
  • Dynamic: ❓
  • Required: ❓
name
  • Type: string
  • Dynamic: ❓
  • Required: ❓
size
  • Type: integer
  • Dynamic: ❓
  • Required: ❓
uri
  • Type: string
  • Dynamic: ❓
  • Required: ❓
  • Format: uri

io.kestra.plugin.azure.storage.blob.Copy-CopyObject

Properties

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

The blob container.

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

The full blob path on the container.

Was this page helpful?