Microsoft 365 Download

Microsoft 365 Download
Certified
Download OneDrive/SharePoint file to storage

Downloads a file by item ID and stores it in Kestra internal storage (kestra:///). Streams via Graph content endpoint; large locked files may fail. Requires Microsoft Graph permissions Files.Read.All and Sites.Read.All.

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.CsvToIon
    from: "{{ outputs.download_file.uri }}"

Properties

driveId *string

Drive ID

OneDrive or SharePoint drive identifier required for all OneShare tasks

itemId *string

Item ID

DriveItem ID of the file to download

clientId string

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.

clientSecret string

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.

pemCertificate string

PEM Certificate

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.