dataflow
Manage dataflows (Power BI data transformation)
Authentication scope: fabric
List dataflows in a workspace
fabio dataflow list --workspace <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
Read-only · Returns list
Show details of a dataflow
fabio dataflow show --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Dataflow ID |
Read-only · Returns object
create
Section titled “create”Create a new dataflow
fabio dataflow create --workspace <value> --name <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--name |
string |
Yes | Dataflow display name |
--description |
string |
No | Optional description |
--sensitivity-label |
string |
No | Sensitivity label ID to apply on creation |
Mutates state · Returns object
update
Section titled “update”Update dataflow properties (name and/or description)
fabio dataflow update --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Dataflow ID |
--name |
string |
No | New display name |
--description |
string |
No | New description |
Mutates state · Returns object
delete
Section titled “delete”Delete a dataflow
fabio dataflow delete --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Dataflow ID |
--hard-delete |
bool |
No | Permanently delete (cannot be recovered) |
Mutates state · Destructive · Returns void
get-definition
Section titled “get-definition”Get the definition of a dataflow
fabio dataflow get-definition --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Dataflow ID |
--decode |
bool |
No | Decode base64 payloads inline (adds decodedPayload field) |
Read-only · Long-running operation · Returns object
update-definition
Section titled “update-definition”Update the definition of a dataflow
fabio dataflow update-definition --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Dataflow ID |
--file |
string |
No | Dataflow definition file path (reads file content) |
--content |
string |
No | Dataflow definition content (inline) |
Mutates state · Long-running operation · Returns void
Run a dataflow on demand
fabio dataflow run --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Dataflow ID |
--job-type |
string |
No | Job type: execute (default) or apply-changes |
--execute-option |
string |
No | Execute option (only for execute job type): SkipApplyChanges (default), ApplyChangesIfNeeded |
--parameters |
string |
No | Parameters JSON array for execution (e.g., ‘[{“parameterName”:“X”,“type”:“Automatic”,“value”:25}]’) |
--wait |
bool |
No | Wait for the job to complete (polls until finished) |
--timeout |
integer |
No | Maximum time to wait in seconds (default: 600). Only used with –wait |
--cancel-on-timeout |
bool |
No | Cancel the job if –wait times out (default: leave running) |
Mutates state · Long-running operation · Returns object
discover-parameters
Section titled “discover-parameters”Discover parameters of a dataflow
fabio dataflow discover-parameters --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Dataflow ID |
Read-only · Returns object
execute-query
Section titled “execute-query”Execute a query against a dataflow (returns Apache Arrow IPC)
fabio dataflow execute-query --workspace <value> --id <value> --query-name <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Dataflow ID |
--query-name |
string |
Yes | Name of the query to execute from the dataflow |
--mashup |
string |
No | Optional custom mashup document (M expression) to override the dataflow’s default |
--file |
string |
No | Output file path (writes raw Apache Arrow IPC bytes). If not specified, reports metadata only |
--arrow-version |
string |
No | Apache Arrow version for response format: 1 (default) or 2 |
Read-only · Returns object