Download

Download a file from OneDrive or SharePoint.

yaml
type: "io.kestra.plugin.microsoft365.oneshare.Download"

Examples

Download a file from OneDrive

yaml
id: download_from_onedrive
namespace: company.team

tasks:
  - id: download
    type: io.kestra.plugin.microsoft365.oneshare.Download
    tenantId: "{{ secret('TENANT_ID') }}"
    clientId: "{{ secret('CLIENT_ID') }}"
    clientSecret: "{{ secret('CLIENT_SECRET') }}"
    driveId: "b!abc123def456"
    itemId: "01ABC123DEF456GHI789"

Download file and process data

yaml
id: download_and_process
namespace: company.team

tasks:
  - id: download_file
    type: io.kestra.plugin.microsoft365.oneshare.Download
    tenantId: "{{ secret('TENANT_ID') }}"
    clientId: "{{ secret('CLIENT_ID') }}"
    clientSecret: "{{ secret('CLIENT_SECRET') }}"
    driveId: "b!abc123def456"
    itemId: "01ABC123DEF456GHI789"

  - id: read_csv
    type: io.kestra.plugin.serdes.csv.CsvReader
    from: "{{ outputs.download_file.uri }}"

Properties

driveId*string

The ID of the drive.

itemId*string

The ID of the item (file) to download.

clientIdstring

Client ID

Client ID of the Azure service principal. If you don't have a service principal, refer to create a service principal with Azure CLI.

clientSecretstring

Client Secret

Service principal client secret. Use this for Client Secret authentication. Provide clientId, tenantId, and clientSecret. Either clientSecret OR pemCertificate must be provided, not both.

pemCertificatestring

PEM Certificate

text

Alternative authentication method using certificate-based authentication.
Use this for Client Certificate authentication. Provide clientId, tenantId, and pemCertificate.
Either clientSecret OR pemCertificate must be provided, not both.

tenantIdstring

Tenant ID

Outputs

uristring

Formaturi

The URI of the downloaded file in Kestra's internal storage.