Skip to content

data-pipeline

Manage data pipelines (orchestration, scheduling)

Authentication scope: fabric

List data pipelines in a workspace

Terminal window
fabio data-pipeline list --workspace <value>
Flag Type Required Description
--workspace string Yes Workspace ID

Output fields: id, displayName, description

Read-only · Returns list

Show details of a data pipeline

Terminal window
fabio data-pipeline show --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Data pipeline ID

Read-only · Returns object

Create a new data pipeline

Terminal window
fabio data-pipeline create --workspace <value> --name <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--name string Yes Pipeline display name
--description string No Optional description
--sensitivity-label string No Sensitivity label ID to apply on creation

Examples

Terminal window
fabio data-pipeline create --workspace $WS --name "Daily-ETL"

Output fields: id, displayName

Mutates state · Returns object

Update data pipeline properties (name and/or description)

Terminal window
fabio data-pipeline update --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Data pipeline ID
--name string No New display name
--description string No New description

Mutates state · Returns object

Delete a data pipeline

Terminal window
fabio data-pipeline delete --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Data pipeline ID
--hard-delete bool No Permanently delete (cannot be recovered)

Mutates state · Destructive · Returns void

Run a data pipeline

Terminal window
fabio data-pipeline run --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Data pipeline ID
--wait bool No Wait for the pipeline run to complete (polls until finished)
--timeout string No Maximum time to wait in seconds
--cancel-on-timeout bool No Cancel the run if timeout is reached

Examples

Terminal window
fabio data-pipeline run --workspace $WS --id $DP

Mutates state · Long-running operation · Returns object

Get the definition of a data pipeline

Terminal window
fabio data-pipeline get-definition --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Data pipeline ID
--decode bool No Decode base64 payloads inline (adds decodedPayload field)

Read-only · Long-running operation · Returns object

Update the definition of a data pipeline

Terminal window
fabio data-pipeline update-definition --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Data pipeline ID
--file string No Path to pipeline definition file
--content string No Inline pipeline definition content (JSON)

Mutates state · Long-running operation · Returns void

Create a schedule for a data pipeline

Terminal window
fabio data-pipeline create-schedule --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Data pipeline ID
--file string No JSON file with schedule configuration
--content string No Inline JSON schedule configuration

Examples

Terminal window
fabio data-pipeline create-schedule --workspace $WS --id $DP --content '{"enabled":true,"configuration":{"type":"Cron","interval":10,"startDateTime":"2026-01-01T00:00:00","endDateTime":"2026-12-31T23:59:00","localTimeZoneId":"Central Standard Time"}}'

Mutates state · Returns object

List execute schedules for a data pipeline

Terminal window
fabio data-pipeline list-schedules --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Data pipeline ID

Examples

Terminal window
fabio data-pipeline list-schedules --workspace $WS --id $DP

Output fields: id, enabled, createdDateTime

Read-only · Returns list

Get a specific execute schedule for a data pipeline

Terminal window
fabio data-pipeline get-schedule --workspace <value> --id <value> --schedule-id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Data pipeline ID
--schedule-id string Yes Schedule ID

Read-only · Returns object

Update an execute schedule for a data pipeline

Terminal window
fabio data-pipeline update-schedule --workspace <value> --id <value> --schedule-id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Data pipeline ID
--schedule-id string Yes Schedule ID
--file string No JSON file with updated schedule configuration
--content string No Inline JSON updated schedule configuration

Examples

Terminal window
fabio data-pipeline update-schedule --workspace $WS --id $DP --schedule-id $SCHED_ID --content '{"enabled":false}'

Mutates state · Returns object

Delete an execute schedule for a data pipeline

Terminal window
fabio data-pipeline delete-schedule --workspace <value> --id <value> --schedule-id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Data pipeline ID
--schedule-id string Yes Schedule ID

Mutates state · Destructive · Returns void

List execute job instances for a data pipeline

Terminal window
fabio data-pipeline list-instances --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Data pipeline ID

Examples

Terminal window
fabio data-pipeline list-instances --workspace $WS --id $DP -o table

Output fields: id, status, invokeType, startTimeUtc, endTimeUtc

Read-only · Returns list

Get a specific execute job instance for a data pipeline

Terminal window
fabio data-pipeline get-instance --workspace <value> --id <value> --instance-id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Data pipeline ID
--instance-id string Yes Job instance ID

Examples

Terminal window
fabio data-pipeline get-instance --workspace $WS --id $DP --instance-id $INST_ID

Read-only · Returns object