PluginsAzureTasksStorageBlobDeleteList

DeleteList​Delete​List

DeleteList DeleteList

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

Delete a list of keys from the Azure Blob Storage.

Examples

yaml
id: azure_storage_blob_delete_list
namespace: company.team

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

Properties

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.

concurrent

  • Type: integer
  • Dynamic: ❌
  • Required: ❌
  • Minimum: >= 2

Number of concurrent parallel deletions.

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.

errorOnEmpty

  • Type: boolean
  • Dynamic: ✔️
  • Required: ❌
  • Default: false

Whether to raise an error if the file is not found.

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

count

  • Type: integer
  • Required: ❌
  • Default: 0

The count of deleted blobs.

size

  • Type: integer
  • Required: ❌
  • Default: 0

The size of all the deleted blobs.

Definitions

Was this page helpful?