Lease

type: "io.kestra.plugin.azure.storage.adls.update.Lease"

Lease a file from Azure Data Lake Storage.

Examples

id: azure_storage_datalake_lease
namespace: company.team

tasks:
  - id: lease_file
    type: io.kestra.plugin.azure.storage.adls.Lease
    endpoint: "https://yourblob.blob.core.windows.net"
    sasToken: "{{ secret('SAS_TOKEN') }}"
    fileSystem: "mydata"
    filePath: "path/to/myfile"
    leaseDuration: 20
    action: ACQUIRE

Properties

action

• Type: string
• Dynamic: ✔️
• Required: ✔️
• Default: ACQUIRE
• Possible Values:
  • ACQUIRE
  • RENEW
  • RELEASE
  • BREAK

Lease action

The lease action you want to set (ex: 'ACQUIRE')

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.

leaseDuration

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

connectionString

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

Connection string of the Storage Account.

leaseId

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

Lease ID

ID of the lease that must be provided for the following action : RENEW, BREAK, RELEASE

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

id

• Type: string
• Required: ❌

Lease ID.