Dataflows CLI
MicrosoftOfficialPublished by Microsoft
- Skill
- Tool integration
- Automation and integrations
- MIT
- Low risk
- Has scripts
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
The dataflows-cli skill provides a structured interface for interacting with Fabric Dataflow Gen2 items. It operates as a mode-based dispatcher, requiring users to select between authoring, consumption, or upgrade modes. The skill handles complex tasks such as M language definition updates, connection management, output destination configuration, and the migration of legacy Gen1 dataflows to Gen2.1. It emphasizes safe, intentional operations by requiring users to read specific reference documentation before executing state-changing API calls.
What it does
- Creates and updates Fabric Dataflow Gen2 items and their definitions.
- Manages connections, credentials, and output destinations for dataflows.
- Previews Power Query M definitions using executeQuery to validate logic before persistence.
- Facilitates the upgrade of Gen1 dataflows to Gen2.1 via save-as operations.
- Retrieves refresh history and inspects existing dataflow definitions.
- Provides a framework for executing and testing ad-hoc M queries.
When to use it
- When you need to programmatically create or modify Fabric Dataflow Gen2 items.
- When performing maintenance on Power Query M definitions or data connections.
- When migrating legacy Gen1 dataflows to the Gen2.1 architecture.
- When you need to audit refresh history or validate dataflow configurations.
- When testing M query logic against live data sources before saving changes.
Advantages
- Enforces a structured, mode-based workflow to prevent accidental mutations.
- Provides granular control over Dataflow Gen2 definitions and metadata.
- Supports complex lifecycle tasks like Gen1-to-Gen2 upgrades.
- Integrates directly with Fabric REST APIs for automated data pipeline management.
Usage examples
- “Show me the refresh history and parameters of the SalesIngest dataflow.”
- The agent enters consumption mode, reads the consumption reference, and retrieves the requested refresh history and parameters for the specified dataflow.
- “Preview this M query, then save it into the SalesIngest dataflow definition.”
- The agent enters authoring mode, previews the M query to validate it, and then executes the updateDefinition call to persist the changes.
- “Is my Gen1 dataflow ready to upgrade to Gen2.1?”
- The agent enters upgrade mode, performs a readiness assessment, and reports on the risk and requirements for upgrading the specified Gen1 dataflow.
Install
Download the skill as a ZIP:
https://autogineer.com/agent-skills/microsoft/dataflows-cli/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip dataflows-cli.zip -d .agents/skills
Documentation by Microsoft
Telemetry — MANDATORY. Every
api.fabric.microsoft.comcall must carryx-ms-fabric-skill: dataflows-cli(az rest:--headers "x-ms-fabric-skill=dataflows-cli"), including every LRO poll,fabric_lroand retry. Snippets omit it — add it anyway.
CRITICAL NOTES
To find the workspace details (including its ID) from workspace name: list all workspaces and, then, use JMESPath filtering
To find the item details (including its ID) from workspace ID, item type, and item name: list all items of that type in that workspace and, then, use JMESPath filtering
Skill disambiguation: use
dataflows-clifor every Fabric Dataflow Gen2 item and Power Query M concern. Synapse / ADF pipeline and dataset JSON translation ispipeline-migration; Spark notebook transformations arespark-cli; T-SQL transformations aresqldw-cli.
Fabric Dataflow Gen2 -- CLI Skill
This one skill owns Fabric Dataflow Gen2 items: connections, Power Query M, output destinations, saved definitions, refresh history, and Gen1 upgrades.
It is a mode dispatcher and contains NO procedures. Pick the mode that matches the request from the table below, then read the matching references/<mode>.md file end to end with your file-reading tool BEFORE issuing a single command. That file holds the endpoints, payload shapes, templates and gotchas; acting without it produces wrong payloads and wrong results.
Read it once per session. A file you have already read stays in context, so do not re-read it on a later turn; open the deeper files under references/<mode>/ only when a row in that file's reference table matches what you still need, and open only that row's file.
Mode selection
| Mode | Use when the request ... | Example triggers | Read this first |
|---|---|---|---|
authoring | creates or changes a dataflow: connections, credentials, M edits previewed before save, output destinations, updateDefinition | executeQuery preview, updateDefinition, connection setup, supportedConnectionTypes, credentialType, add output destination | references/authoring.md |
consumption | reads a saved dataflow: definition, parameters, refresh history, or runs a saved/ad-hoc read-only M query and parses Arrow | getDefinition, executeQuery saved query, ad-hoc query, Arrow IPC, refresh history | references/consumption.md |
upgrade | upgrades a Gen1 dataflow to Gen2.1 via save-as and rebind, or assesses upgrade readiness/risk | Gen1 Gen2 readiness, saveAsNativeArtifact, clone Gen1 dataflow, upgrade risk assessment | references/upgrade.md |
Mode boundary rule
consumption is read-only. A preview run that exists to validate M before updateDefinition, and any capability lookup (supportedConnectionTypes, credentialType), belong to authoring even though they issue the same executeQuery call -- classify by intent, not by endpoint.
If a request genuinely spans modes, handle them one at a time and read each reference before you start that part. If the mode is ambiguous after reading this table, ask one short clarifying question instead of guessing.
Terminal write -- the step you must not skip
Reading the reference and planning the change is NOT completing the task. Each mutating mode ends with one state-changing call. If you did not issue it, nothing was persisted -- say so explicitly rather than reporting success.
| Mode | Terminal write |
|---|---|
authoring | POST /v1/workspaces/{ws}/dataflows/{id}/updateDefinition to persist the M, connections and output destinations; a NEW dataflow needs POST /v1/workspaces/{ws}/items (or /dataflows) first. executeQuery is a preview and writes nothing. If the user asked for a refresh, also POST .../jobs/instances?jobType=Refresh. |
consumption | none -- this mode is read-only |
upgrade | saveAsNativeArtifact to create the Gen2.1 artefact, then rebind. A readiness report alone does not upgrade anything. |
Before you report the task done, confirm the terminal call returned success and, where the reference documents a readback, read the artefact back to prove the change landed.
upgrade generation boundary -- HARD STOP (mandatory)
Save-as runs only from Gen1 to Gen2.1. For an execution request whose source is Gen2, or whose source generation is not established, state that no public save-as or in-place upgrade endpoint is available and stop before any API call. This does not block a read-only readiness scan whose purpose is to discover and classify Gen1 candidates.
Do not read "choose the closest endpoint and proceed" as approval to export a definition and create a copy, do not switch to authoring to do it instead, and do not mutate anything. Ask the user to clarify the intended outcome and to approve explicitly.
consumption reporting
consumption has no terminal write, so its deliverable is the answer itself. When that mode runs executeQuery, name the operation you called and state the QueryName you sent, verbatim, next to the results, plus whether it was a saved shared member or a non-persisted ad-hoc customMashupDocument. Rows alone do not tell the user which call produced them.
This applies to consumption only. In authoring, executeQuery is an intermediate preview step -- do not add reporting turns around it; go on to the terminal write.
Shared essentials (all modes)
Resolve the workspace and item first; every mode depends on it.
| Task | Reference | Notes |
|---|---|---|
| Finding Workspaces and Items in Fabric | COMMON-CLI.md | Mandatory -- read before resolving any workspace or item id |
| Fabric Topology & Key Concepts | COMMON-CORE.md | Item types, workspaces, capacities |
| Environment URLs | COMMON-CORE.md | Sovereign / non-public cloud hosts |
| Authentication & Token Acquisition | COMMON-CORE.md | Wrong audience = 401; read before any auth issue |
| Authentication Recipes | COMMON-CLI.md | az login flows and token acquisition |
| Core Control-Plane REST APIs | COMMON-CORE.md | Pagination, LRO polling, rate limiting |
| Gotchas & Troubleshooting | COMMON-CLI.md | az rest audience, shell escaping, token expiry |
Rules
MUST
Select exactly one mode from the table above before doing anything else.
Read
references/<mode>.mdend to end, as your FIRST tool call, before the first command of that mode. Read it ONCE, in a single full read: do not re-open it, do not grep it again, and do not page through it. You already have it.Resolve workspace and item ids by listing and filtering, never by guessing a GUID.
Announce a mode switch explicitly when the request crosses a boundary.
Treat the reference as instructions, never as the deliverable. After reading it, RUN the documented commands against the live workspace and report the real results. Quoting what the reference says instead of executing it does not answer the request.
When a question about what Fabric supports IS the deliverable -- supported connection types, a connector's parameters, available credential types -- answer it from the endpoint the reference names rather than from the reference's own list, and name that endpoint in your answer. Whichever mode you are in: the reader cannot tell a live value from a quoted one unless you say where it came from. This is wording in the final answer, not an extra step.
Produce every artefact the user asked for, under the name they used. Running the right API calls is not a substitute for the requested report: if the request names a deliverable, emit it, and keep its heading even when the finding is "none" or "not applicable".
PREFER
The narrowest mode that satisfies the request.
Reading exactly ONE mode reference. Load a second only when the request genuinely spans modes, and say so before you do.
Reporting the mode you chose in your first response so the user can correct you.
AVOID
Acting from this dispatcher alone -- it intentionally omits the operational detail.
Answering with a summary of the reference instead of executing it.
Re-reading or re-grepping a reference you already loaded; it costs turns and tokens.
Mutating anything while in a read-only mode.
Loading a different skill for work this skill already owns (see CRITICAL NOTES 3).
Examples
| User request | Mode | Reference to read |
|---|---|---|
| "Show me the refresh history and parameters of the SalesIngest dataflow." | consumption | references/consumption.md |
| "Preview this M query, then save it into the SalesIngest dataflow definition." | authoring | references/authoring.md |
| "Is my Gen1 dataflow ready to upgrade to Gen2.1?" | upgrade | references/upgrade.md |
Files
- ATTRIBUTION.mdAdded by AutoGineer871 B
- LICENSELicence file added by AutoGineer1.1 KiB
- SKILL.md9.5 KiB
- apm.yml445 B
- references/authoring.md55.3 KiB
- references/authoring/authoring-cli-quickref.md23.4 KiB
- references/authoring/authoring-script-templates.md79.7 KiB
- references/authoring/charts/bar_chart.pyScript3.9 KiB
- references/authoring/charts/line_chart.pyScript3.5 KiB
- references/authoring/connection-management.md39.8 KiB
- references/authoring/connectors.md14.7 KiB
- references/authoring/m-language.md9.7 KiB
- references/authoring/mashup-preview.md28.3 KiB
- references/authoring/output-destinations.md39.6 KiB
- references/consumption.md28.7 KiB
- references/consumption/chart-visualization.md2.6 KiB
- references/consumption/charts/bar_chart.pyScript3.9 KiB
- references/consumption/charts/line_chart.pyScript3.5 KiB
- references/consumption/consumption-cli-quickref.md6.7 KiB
- references/consumption/discovery-queries.md7.0 KiB
- references/consumption/script-templates.md17.1 KiB
- references/upgrade.md21.0 KiB
- references/upgrade/risk-assessment-guide.md11.2 KiB
- references/upgrade/upgrade-cli-quickref.md8.8 KiB
references/consumption/script-templates.md
Script Templates
Self-contained templates for dataflow consumption via CLI. Copy-paste and customize.
Bash — List Dataflows with Pagination
#!/usr/bin/env bash
set -euo pipefail
# --- Configuration ---
WS_ID="${WS_ID:?Set WS_ID env var (workspace ID)}"
API="https://api.fabric.microsoft.com/v1"
# --- Prerequisites ---
az account show >/dev/null 2>&1 || { echo "ERROR: Not logged in. Run: az login"; exit 1; }
command -v jq >/dev/null 2>&1 || { echo "ERROR: jq not found. Install: apt-get install jq"; exit 1; }
# --- Paginated listing ---
echo "Dataflows in workspace $WS_ID:"
echo "---"
URL="$API/workspaces/$WS_ID/dataflows"
COUNT=0
while [ -n "$URL" ]; do
RESPONSE=$(az rest --method get --resource "https://api.fabric.microsoft.com" --url "$URL")
echo "$RESPONSE" | jq -r '.value[] | "\(.displayName)\t\(.id)"'
PAGE_COUNT=$(echo "$RESPONSE" | jq '.value | length')
COUNT=$((COUNT + PAGE_COUNT))
TOKEN=$(echo "$RESPONSE" | jq -r '.continuationToken // empty')
if [ -n "$TOKEN" ]; then
URL="$API/workspaces/$WS_ID/dataflows?continuationToken=$TOKEN"
else
URL=""
fi
done
echo "---"
echo "✓ Total: $COUNT dataflow(s)"Bash — Full Definition Decode and Report
#!/usr/bin/env bash
set -euo pipefail
# --- Configuration ---
WS_ID="${WS_ID:?Set WS_ID env var}"
DF_ID="${DF_ID:?Set DF_ID env var (dataflow ID)}"
API="https://api.fabric.microsoft.com/v1"
OUTPUT_DIR="${1:-.}"
# --- Prerequisites ---
az account show >/dev/null 2>&1 || { echo "ERROR: Run 'az login' first."; exit 1; }
command -v jq >/dev/null 2>&1 || { echo "ERROR: jq not found."; exit 1; }
mkdir -p "$OUTPUT_DIR"
# --- Get dataflow name ---
DF_NAME=$(az rest --method get --resource "https://api.fabric.microsoft.com" \
--url "$API/workspaces/$WS_ID/dataflows/$DF_ID" --query "displayName" -o tsv)
echo "=== Dataflow: $DF_NAME ==="
# --- Get definition ---
echo "Fetching definition..."
RESPONSE=$(az rest --method post --resource "https://api.fabric.microsoft.com" \
--url "$API/workspaces/$WS_ID/dataflows/$DF_ID/getDefinition")
# --- Decode and save each part ---
for PART in "mashup.pq" "queryMetadata.json" ".platform"; do
FILENAME=$(basename "$PART")
echo "$RESPONSE" | jq -r ".definition.parts[] | select(.path==\"$PART\") | .payload" | \
base64 --decode > "$OUTPUT_DIR/$FILENAME"
echo "✓ Decoded $PART → $OUTPUT_DIR/$FILENAME"
done
# --- Report: Queries ---
echo ""
echo "=== Queries ==="
grep -oP '(?<=shared )\w+(?= =)' "$OUTPUT_DIR/mashup.pq" | while read -r QUERY; do
echo " - $QUERY"
done
# --- Report: Connections ---
echo ""
echo "=== Connections ==="
jq -r '.connections[] | " - [\(.kind)] \(.path)"' "$OUTPUT_DIR/queryMetadata.json"
# --- Report: Load-enabled queries ---
echo ""
echo "=== Output Queries (loadEnabled=true) ==="
jq -r '.queriesMetadata | to_entries[] | select(.value.loadEnabled==true) | " - \(.key)"' "$OUTPUT_DIR/queryMetadata.json"
echo ""
echo "✓ Definition report complete. Files saved to $OUTPUT_DIR/"Bash — Monitor Refresh with Polling Loop
#!/usr/bin/env bash
set -euo pipefail
# --- Configuration ---
WS_ID="${WS_ID:?Set WS_ID env var}"
DF_ID="${DF_ID:?Set DF_ID env var}"
API="https://api.fabric.microsoft.com/v1"
MAX_WAIT="${MAX_WAIT:-3600}" # 60 minutes default
POLL_INTERVAL=5
# --- Prerequisites ---
az account show >/dev/null 2>&1 || { echo "ERROR: Run 'az login' first."; exit 1; }
# --- Get latest job instance ---
echo "Checking latest job for dataflow $DF_ID..."
LATEST=$(az rest --method get --resource "https://api.fabric.microsoft.com" \
--url "$API/workspaces/$WS_ID/dataflows/$DF_ID/jobs/instances" \
--query "value[0]")
STATUS=$(echo "$LATEST" | jq -r '.status')
JOB_ID=$(echo "$LATEST" | jq -r '.id')
echo "Job $JOB_ID — Status: $STATUS"
if [ "$STATUS" = "Completed" ] || [ "$STATUS" = "Failed" ] || [ "$STATUS" = "Cancelled" ]; then
echo "Job already in terminal state."
echo "$LATEST" | jq '{status, invokeType, startTimeUtc, endTimeUtc, failureReason}'
exit 0
fi
# --- Poll until terminal ---
ELAPSED=0
while [ "$ELAPSED" -lt "$MAX_WAIT" ]; do
sleep "$POLL_INTERVAL"
ELAPSED=$((ELAPSED + POLL_INTERVAL))
STATUS=$(az rest --method get --resource "https://api.fabric.microsoft.com" \
--url "$API/workspaces/$WS_ID/dataflows/$DF_ID/jobs/instances" \
--query "value[0].status" -o tsv)
echo "[${ELAPSED}s] Status: $STATUS"
case "$STATUS" in
Completed|Failed|Cancelled)
echo "✓ Job reached terminal state: $STATUS"
az rest --method get --resource "https://api.fabric.microsoft.com" \
--url "$API/workspaces/$WS_ID/dataflows/$DF_ID/jobs/instances" \
--query "value[0]"
exit 0
;;
esac
# Exponential backoff: 5 → 10 → 20 → 30 (cap)
if [ "$POLL_INTERVAL" -lt 30 ]; then
POLL_INTERVAL=$((POLL_INTERVAL * 2))
[ "$POLL_INTERVAL" -gt 30 ] && POLL_INTERVAL=30
fi
done
echo "⚠ Timeout after ${MAX_WAIT}s. Last status: $STATUS"
exit 1Bash — Parameter Discovery Report
#!/usr/bin/env bash
set -euo pipefail
# --- Configuration ---
WS_ID="${WS_ID:?Set WS_ID env var}"
DF_ID="${DF_ID:?Set DF_ID env var}"
API="https://api.fabric.microsoft.com/v1"
# --- Prerequisites ---
az account show >/dev/null 2>&1 || { echo "ERROR: Run 'az login' first."; exit 1; }
command -v jq >/dev/null 2>&1 || { echo "ERROR: jq not found."; exit 1; }
# --- Get dataflow name ---
DF_NAME=$(az rest --method get --resource "https://api.fabric.microsoft.com" \
--url "$API/workspaces/$WS_ID/dataflows/$DF_ID" --query "displayName" -o tsv)
echo "=== Parameters for: $DF_NAME ==="
echo ""
# --- Discover parameters ---
PARAMS=$(az rest --method get --resource "https://api.fabric.microsoft.com" \
--url "$API/workspaces/$WS_ID/dataflows/$DF_ID/parameters" 2>&1) || {
echo "No parameters found (dataflow may not be parametric)."
exit 0
}
PARAM_COUNT=$(echo "$PARAMS" | jq '.value | length')
if [ "$PARAM_COUNT" -eq 0 ]; then
echo "No parameters defined."
exit 0
fi
echo "$PARAMS" | jq -r '.value[] | "Parameter: \(.name)\n Type: \(.type)\n Required: \(.isRequired)\n Default: \(.defaultValue // "none")\n Desc: \(.description // "none")\n"'
echo "---"
echo "✓ $PARAM_COUNT parameter(s) discovered"PowerShell — List Dataflows
#Requires -Version 5.1
param(
[Parameter(Mandatory)][string]$WorkspaceId
)
$null = az account show 2>$null
if ($LASTEXITCODE -ne 0) { Write-Error "Not logged in. Run: az login"; exit 1 }
$API = "https://api.fabric.microsoft.com/v1"
$url = "$API/workspaces/$WorkspaceId/dataflows"
$allDataflows = @()
do {
$response = az rest --method get --resource "https://api.fabric.microsoft.com" --url $url | ConvertFrom-Json
$allDataflows += $response.value
if ($response.continuationToken) {
$url = "$API/workspaces/$WorkspaceId/dataflows?continuationToken=$($response.continuationToken)"
} else {
$url = $null
}
} while ($url)
$allDataflows | ForEach-Object {
[PSCustomObject]@{
Name = $_.displayName
Id = $_.id
Desc = $_.description
}
} | Format-Table -AutoSize
Write-Host "Total: $($allDataflows.Count) dataflow(s)"PowerShell — Definition Decode
⚠ LRO caveat: the
az rest --method post .../getDefinitioncall below assumes a synchronous 200 response. The Fabric API may return 202 + Location (large definitions, server load). For production code, use theInvoke-WebRequestLRO branch shown immediately below, or copy the Fabric LRO Polling Pattern PowerShell branch into your script.
#Requires -Version 5.1
param(
[Parameter(Mandatory)][string]$WorkspaceId,
[Parameter(Mandatory)][string]$DataflowId,
[string]$OutputDir = "."
)
$null = az account show 2>$null
if ($LASTEXITCODE -ne 0) { Write-Error "Not logged in. Run: az login"; exit 1 }
$API = "https://api.fabric.microsoft.com/v1"
$resource = "https://api.fabric.microsoft.com"
New-Item -ItemType Directory -Path $OutputDir -Force | Out-Null
# getDefinition is an LRO. az rest cannot surface response headers, so use Invoke-WebRequest
# to capture the 202/Location case, then poll per Fabric LRO contract.
$token = az account get-access-token --resource $resource --query accessToken -o tsv
$headers = @{ Authorization = "Bearer $token"; "Content-Length" = "0" }
try {
$resp = Invoke-WebRequest -Method Post -Uri "$API/workspaces/$WorkspaceId/dataflows/$DataflowId/getDefinition" `
-Headers $headers -UseBasicParsing
} catch {
Write-Error "getDefinition failed: $($_.Exception.Message)"; exit 1
}
if ($resp.StatusCode -eq 202) {
$location = $resp.Headers["Location"]
if ($location -is [array]) { $location = $location[0] }
$retryRaw = $resp.Headers["Retry-After"]
if ($retryRaw -is [array]) { $retryRaw = $retryRaw[0] }
$retryAfter = 5; [void][int]::TryParse([string]$retryRaw, [ref]$retryAfter)
$response = $null
while ($null -eq $response) {
Start-Sleep -Seconds $retryAfter
$op = az rest --method get --resource $resource --url $location | ConvertFrom-Json
switch ($op.status) {
'Succeeded' { $response = az rest --method get --resource $resource --url "$($location.TrimEnd('/'))/result" | ConvertFrom-Json }
'Failed' { Write-Error "getDefinition failed: $($op.error.message)"; exit 1 }
'Cancelled' { Write-Error "getDefinition cancelled"; exit 1 }
}
}
} else {
$response = $resp.Content | ConvertFrom-Json
}
foreach ($part in $response.definition.parts) {
$filename = Split-Path $part.path -Leaf
$decoded = [System.Text.Encoding]::UTF8.GetString([System.Convert]::FromBase64String($part.payload))
Set-Content -Path (Join-Path $OutputDir $filename) -Value $decoded -Encoding UTF8
Write-Host "Decoded $($part.path) -> $OutputDir\$filename"
}
Write-Host "`nDone. Files saved to $OutputDir"PowerShell — Job History Report
#Requires -Version 5.1
param(
[Parameter(Mandatory)][string]$WorkspaceId,
[Parameter(Mandatory)][string]$DataflowId
)
$null = az account show 2>$null
if ($LASTEXITCODE -ne 0) { Write-Error "Not logged in. Run: az login"; exit 1 }
$API = "https://api.fabric.microsoft.com/v1"
$jobs = (az rest --method get --resource "https://api.fabric.microsoft.com" `
--url "$API/workspaces/$WorkspaceId/dataflows/$DataflowId/jobs/instances" | ConvertFrom-Json).value
if (-not $jobs) { Write-Host "No job history found."; exit 0 }
$jobs | ForEach-Object {
[PSCustomObject]@{
Status = $_.status
Type = $_.invokeType
Start = $_.startTimeUtc
End = $_.endTimeUtc
Error = $_.failureReason
}
} | Format-Table -AutoSize
$completed = $jobs | Where-Object { $_.status -eq "Completed" }
$failed = $jobs | Where-Object { $_.status -eq "Failed" }
Write-Host "Summary: $($completed.Count) completed, $($failed.Count) failed, $($jobs.Count) total"Bash — Query Execution and Arrow Conversion
Execute a query and convert Apache Arrow results to CSV:
#!/bin/bash
# Configuration
WORKSPACE_ID="${1:?Usage: $0 <workspace_id> <dataflow_id> <query_name>}"
DATAFLOW_ID="${2:?Usage: $0 <workspace_id> <dataflow_id> <query_name>}"
QUERY_NAME="${3:?Usage: $0 <workspace_id> <dataflow_id> <query_name>}"
API="https://api.fabric.microsoft.com/v1"
AZ="az rest --resource https://api.fabric.microsoft.com"
echo "Executing query: $QUERY_NAME from dataflow: $DATAFLOW_ID"
# Execute the query — raw Apache Arrow IPC stream is captured via --output-file (NOT a JSON envelope).
# For persisted queries, send QueryName only — omit customMashupDocument.
ARROW_PATH="${QUERY_NAME}_results.arrow"
$AZ --method post \
--url "$API/workspaces/$WORKSPACE_ID/dataflows/$DATAFLOW_ID/executeQuery" \
--body "{\"QueryName\": \"$QUERY_NAME\"}" \
--output-file "$ARROW_PATH"
if [ ! -s "$ARROW_PATH" ]; then
echo "ERROR: Empty response from executeQuery"
exit 1
fi
# Detect embedded source errors — executeQuery returns HTTP 200 even on Kusto/SQL failures;
# the error JSON sits inside the stream's PQ Arrow Metadata block.
if grep -q '"Error":"' "$ARROW_PATH"; then
echo "ERROR: Query execution failed (embedded in Arrow body):"
python3 -c "import re,sys; raw=open(sys.argv[1],'rb').read().decode('utf-8','replace'); m=re.search(r'\\{\"Error\":\"[^\"]+\"\\}', raw); print(m.group(0) if m else '(error marker present, JSON not parsed)')" "$ARROW_PATH"
exit 1
fi
echo "Arrow data saved to: $ARROW_PATH"
# Convert to CSV if pyarrow is available
if command -v python3 >/dev/null && python3 -c "import pyarrow, pandas" 2>/dev/null; then
python3 << EOF
import pyarrow as pa
import pandas as pd
table = pa.ipc.open_stream(open("${QUERY_NAME}_results.arrow", "rb")).read_all()
df = table.to_pandas()
df.to_csv("${QUERY_NAME}_results.csv", index=False)
print(f"Converted {len(df)} rows to: ${QUERY_NAME}_results.csv")
print(f"Columns: {list(df.columns)}")
EOF
else
echo "Note: Install pyarrow+pandas for automatic CSV conversion: pip install pyarrow pandas"
fiPowerShell — Query Execution and Arrow Conversion
Execute a query and convert Apache Arrow results to CSV:
param(
[Parameter(Mandatory)]
[string]$WorkspaceId,
[Parameter(Mandatory)]
[string]$DataflowId,
[Parameter(Mandatory)]
[string]$QueryName,
[string]$CustomMashup = ""
)
$API = "https://api.fabric.microsoft.com/v1"
$AZ = "az rest --resource https://api.fabric.microsoft.com"
Write-Host "Executing query: $QueryName from dataflow: $DataflowId"
# Build request body — omit customMashupDocument for persisted queries
if ($CustomMashup) {
$body = @{
QueryName = $QueryName
customMashupDocument = $CustomMashup
} | ConvertTo-Json -Compress
} else {
$body = @{
QueryName = $QueryName
} | ConvertTo-Json -Compress
}
$bodyFile = [IO.Path]::GetTempFileName()
[IO.File]::WriteAllText($bodyFile, $body, [Text.UTF8Encoding]::new($false))
$arrowPath = "${QueryName}_results.arrow"
# Execute the query — raw Apache Arrow IPC stream is captured via --output-file (NOT a JSON envelope).
try {
az rest --method post `
--resource "https://api.fabric.microsoft.com" `
--url "$API/workspaces/$WorkspaceId/dataflows/$DataflowId/executeQuery" `
--body "@$bodyFile" `
--output-file $arrowPath
} catch {
Write-Error "Failed to execute query: $_"
exit 1
} finally {
Remove-Item $bodyFile -ErrorAction SilentlyContinue
}
if (-not (Test-Path $arrowPath) -or (Get-Item $arrowPath).Length -eq 0) {
Write-Error "Empty response from executeQuery"
exit 1
}
# Detect embedded source errors — executeQuery returns HTTP 200 even on Kusto/SQL failures;
# the error JSON sits inside the stream's PQ Arrow Metadata block.
$arrowText = [Text.Encoding]::UTF8.GetString([IO.File]::ReadAllBytes($arrowPath))
$embeddedErr = [Regex]::Match($arrowText, '\{"Error":"[^"]+"\}').Value
if ($embeddedErr) {
Write-Error "Query execution failed (embedded in Arrow body): $embeddedErr"
exit 1
}
Write-Host "Arrow data saved to: $arrowPath"
# Convert to CSV if pyarrow is available
$pythonScript = @"
import pyarrow as pa
import pandas as pd
import sys
try:
table = pa.ipc.open_stream(open('$arrowPath', 'rb')).read_all()
df = table.to_pandas()
df.to_csv('${QueryName}_results.csv', index=False)
print(f'Converted {len(df)} rows to: ${QueryName}_results.csv')
print(f'Columns: {list(df.columns)}')
except Exception as e:
print(f'Conversion failed: {e}', file=sys.stderr)
sys.exit(1)
"@
$pythonScript | python3
# Native commands don't throw on non-zero exit — guard on $LASTEXITCODE so a missing
# pyarrow/pandas (ModuleNotFoundError) or absent python3 surfaces the install hint
# instead of silently leaving a half-finished conversion.
if ($LASTEXITCODE -ne 0) {
Write-Host "Note: Install pyarrow+pandas for automatic CSV conversion: pip install pyarrow pandas"
}Batch Query Execution with Error Handling
Execute multiple queries and collect results:
#!/bin/bash
# Configuration
WORKSPACE_ID="${1:?Usage: $0 <workspace_id> <dataflow_id>}"
DATAFLOW_ID="${2:?Usage: $0 <workspace_id> <dataflow_id>}"
QUERIES=("SalesData" "CustomerList" "ProductCatalog")
API="https://api.fabric.microsoft.com/v1"
AZ="az rest --resource https://api.fabric.microsoft.com"
mkdir -p query_results
FAILED_QUERIES=()
for QUERY in "${QUERIES[@]}"; do
echo "Processing: $QUERY"
ARROW_PATH="query_results/${QUERY}.arrow"
$AZ --method post \
--url "$API/workspaces/$WORKSPACE_ID/dataflows/$DATAFLOW_ID/executeQuery" \
--body "{\"QueryName\": \"$QUERY\"}" \
--output-file "$ARROW_PATH" 2>/dev/null
# executeQuery returns HTTP 200 even on source-layer failures; the error JSON is embedded
# inside the Arrow stream's PQ Arrow Metadata block. Treat absence of "Error":" as success.
if [ -s "$ARROW_PATH" ] && ! grep -q '"Error":"' "$ARROW_PATH"; then
echo " ✓ Saved to $ARROW_PATH"
else
echo " ✗ Failed"
FAILED_QUERIES+=("$QUERY")
fi
done
echo ""
echo "Summary: $((${#QUERIES[@]} - ${#FAILED_QUERIES[@]}))/${#QUERIES[@]} queries succeeded"
if [ ${#FAILED_QUERIES[@]} -gt 0 ]; then
echo "Failed queries: ${FAILED_QUERIES[*]}"
exit 1
fiRequirements and compatibility
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta
“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.
Needs: Needs Python
Security
What our scanner noticed· Low risk
- Instructions that use the network
- Scripts that your agent may run
This skill includes scripts that your agent may run. Read them before you use it.
A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.
Attribution and licence
- Published by
- Microsoft
- Publisher
- Microsoft (Official)
- Source
- microsoft/skills-for-fabric · skills/dataflows-cli · commit f8fac11
- Licence
- MIT License (redistribution allowed)
- LICENSE (added by AutoGineer from LICENSE)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
- Also distributed in
- microsoft/skills-for-fabric
AutoGineer is not affiliated with or endorsed by Microsoft or Microsoft.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download dataflows-cli.zip