Spark CLI
MicrosoftOfficialPublished by Microsoft
- Skill
- Tool integration
- Software development
- MIT
- Low risk
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
spark-cli is a mode-based dispatcher designed to handle the full lifecycle of Fabric Spark operations. It provides structured guidance for authoring notebook code, managing interactive Livy sessions, diagnosing Spark job failures, and operating Materialized Lake Views (MLV). The skill enforces strict operational boundaries, requiring users to select a specific mode (authoring, consumption, operations, or mlv) and consult the corresponding reference documentation before executing any commands to ensure correct API usage and payload construction.
What it does
- Authors and manages Fabric notebook cell code including PySpark, Scala, and %%sql.
- Facilitates interactive data analysis through Livy session management.
- Diagnoses failed, slow, or OOM Spark jobs and pipeline runs.
- Manages the complete lifecycle of Materialized Lake Views, including definition, scheduling, and refresh monitoring.
- Provides standardized patterns for data engineering, schema management, and error handling in Fabric.
- Ensures proper telemetry and authentication for all Fabric API interactions.
When to use it
- When writing or updating code within Fabric notebooks.
- When performing ad-hoc data analysis using interactive Livy sessions.
- When investigating performance bottlenecks or failures in Spark jobs.
- When creating, scheduling, or troubleshooting Materialized Lake Views.
- When you need to ensure your Fabric API calls follow mandatory telemetry and authentication standards.
Advantages
- Provides a structured, mode-based approach to prevent configuration errors.
- Centralizes complex Spark and MLV management tasks into a single interface.
- Enforces best practices for data engineering and schema management.
- Reduces ambiguity by clearly defining the scope of Spark-related operations versus other CLI tools.
Usage examples
- “Write a notebook cell that reads a bronze table and writes a silver Delta table.”
- The agent enters 'authoring' mode, reads the relevant reference, and generates the appropriate PySpark code using Delta Lake patterns.
- “My notebook run failed with an OOM error, can you help me diagnose it?”
- The agent enters 'operations' mode, reads the diagnostic workflow reference, and guides the user through analyzing the job logs and metrics.
- “Schedule a nightly refresh for the lakehouse MLV and show me its run history.”
- The agent enters 'mlv' mode, reads the MLV reference, and executes the necessary API calls to configure the schedule and retrieve the history.
Install
Download the skill as a ZIP:
https://autogineer.com/agent-skills/microsoft/spark-cli/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip spark-cli.zip -d .agents/skills
Documentation by Microsoft
Telemetry — MANDATORY. Every
api.fabric.microsoft.comcall must carryx-ms-fabric-skill: spark-cli(az rest:--headers "x-ms-fabric-skill=spark-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
spark-clifor notebook cell code (including%%sqlcells), named notebook runs, Livy sessions, Spark failure triage, and everything about a Materialized Lake View -- writing the definition, reviewing a query for incremental-refresh readiness, and scheduling, refreshing, monitoring or diagnosing an existing one. A KQL materialized view in an Eventhouse iseventhouse-cli; plain read-only T-SQL against a Warehouse or Lakehouse SQL endpoint issqldw-cli.Hard routing boundary: never execute an Eventhouse/KQL materialized-view request from this skill. Route it to
eventhouse-cli; if that skill is unavailable, state that the request cannot be completed in the current skill context and stop without calling Fabric APIs or creating artifacts.
Fabric Spark and Materialized Lake Views -- CLI Skill
This one skill owns Fabric Spark: notebook cell authoring, notebook runs, Livy-session analysis, Spark failure diagnostics, and the whole Materialized Lake View lifecycle.
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.
Mode selection
| Mode | Use when the request ... | Example triggers | Read this first |
|---|---|---|---|
authoring | writes notebook cell code (PySpark, Scala, SparkR, %%sql, %%configure), runs a notebook by name and reports a NORMAL run status, or authors a Materialized Lake View definition or reviews an MLV query for incremental-refresh readiness | write notebook code, notebook cell code, %%sql cell, run notebook, execute notebook, notebookutils, create materialized lake view, is this MLV query incremental-refresh ready | references/authoring.md |
consumption | runs interactive ad-hoc PySpark in a Lakehouse Livy session -- never a notebook | create a Livy session, run calculation in Livy, PySpark, DataFrame analysis, join tables across lakehouses, Delta time-travel | references/consumption.md |
operations | diagnoses a FAILED, unhealthy, throttled or slow Spark notebook / pipeline / Livy run | failed notebook, Spark Livy health, Spark OOM, why is my notebook slow, job diagnostics, 430 throttling | references/operations.md |
mlv | discovers or operates EXISTING Materialized Lake Views: Spark SQL discovery, refresh schedules, on-demand refresh, run history, cancellation, and refresh-failure classification | discover MLVs, list materialized lake views, schedule MLV, MLV run history, cancel refresh, trigger MLV refresh, diagnose MLV refresh failure | references/mlv.md |
Mode boundary rule
Mode is decided by the artefact and the outcome, not by the language. A notebook cell is always authoring even when the cell is %%sql. A Livy session is always consumption. A Spark run that FAILED or is unhealthy is operations; a run that succeeded is reported by authoring. For a Materialized Lake View the VERB decides: writing or reviewing the definition is authoring, while discovering, scheduling, refreshing, monitoring or diagnosing existing MLVs is mlv. If discovery must be executed, switch to consumption for Livy or authoring for a notebook only after reading the discovery command from references/mlv.md.
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 | for an EXISTING notebook, POST .../notebooks/{id}/updateDefinition to save the cell; a NEW notebook needs POST /v1/workspaces/{ws}/items first; for a run request, trigger the job via the Jobs API. Printing cell code into the chat is not saving or running it. |
consumption | none -- this mode is read-only |
operations | none -- this mode is read-only |
mlv | POST /v1/workspaces/{ws}/lakehouses/{lakehouse}/jobs/refreshMaterializedLakeViews/instances for an on-demand refresh, or the schedule create/update/delete call for a scheduling request. Reporting what the schedule would be is not creating it. |
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.
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.
Treat vague requests such as "set up my data" as insufficiently scoped. Ask what artefact, source, destination, and outcome the user wants; never infer intent by finding and running an existing notebook or job.
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.Apply the same read-once discipline to every other file you load, including nested
references/<mode>/*.mdsub-references and sharedcommon/*.mdfiles: open only the ones you actually need, read each ONCE end to end, and never grep or re-open one you already loaded.Resolve workspace and item ids by listing and filtering, never by guessing a GUID.
Stop after routing any Eventhouse/KQL materialized-view request. Unavailable sibling skills are a blocking boundary, not permission to implement their workload directly.
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.
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 family already owns (see CRITICAL NOTES 3).
Attempting an out-of-scope request through raw REST calls when the owning skill is unavailable. Name the owning skill and stop; do not improvise by creating Fabric artefacts outside
spark-cli's scope.
Examples
| User request | Mode | Reference to read |
|---|---|---|
| "Write a notebook cell that reads the bronze table and writes a silver Delta table." | authoring | references/authoring.md |
| "Create a Livy session and count the distinct customers in the lakehouse." | consumption | references/consumption.md |
| "My notebook run failed with an OOM -- work out why." | operations | references/operations.md |
| "Is this materialized lake view query ready for incremental refresh?" | authoring | references/authoring.md |
| "Show me the Spark SQL command that lists the MLVs in schema silver." | mlv | references/mlv.md |
| "Schedule a nightly refresh for the lakehouse MLV lineage and show me its run history." | mlv | references/mlv.md |
Files
- ATTRIBUTION.mdAdded by AutoGineer863 B
- LICENSELicence file added by AutoGineer1.1 KiB
- SKILL.md10.1 KiB
- apm.yml430 B
- references/authoring.md32.9 KiB
- references/authoring/resources/data-engineering-patterns.md24.3 KiB
- references/authoring/resources/development-workflow.md7.4 KiB
- references/authoring/resources/infrastructure-orchestration.md10.4 KiB
- references/authoring/resources/materialized-lake-view-patterns.md20.1 KiB
- references/authoring/resources/mlv-incremental-refresh-patterns.md11.4 KiB
- references/authoring/resources/notebook-api-operations.md14.2 KiB
- references/consumption.md12.3 KiB
- references/mlv.md32.8 KiB
- references/operations.md20.3 KiB
- references/operations/automated-diagnostic-workflow.md12.7 KiB
- references/operations/diagnostic-workflow.md7.3 KiB
- references/operations/job-diagnostics.md17.7 KiB
- references/operations/jobinsight-api.md7.2 KiB
- references/operations/performance-patterns.md17.4 KiB
- references/operations/pipeline-diagnosis.md20.8 KiB
- references/operations/session-health.md8.7 KiB
- references/operations/spark-history-server.md6.5 KiB
references/operations/jobinsight-api.md
JobInsight API Reference
Scope: Copy Spark event logs from Fabric to OneLake for offline analysis using the JobInsight Scala library. This enables Tier 2 diagnostics (local Spark History Server) when online APIs are insufficient.
Overview
JobInsight is a Scala library available on Fabric Spark clusters that provides diagnostic utilities for Spark job analysis. It is not available as a standalone package — it must run inside a Fabric Spark notebook or Livy session.
LogUtils.copyEventLog
import com.microsoft.jobinsight.diagnostic.LogUtils
val contentLength: Long = LogUtils.copyEventLog(
workspaceId: String, // Fabric workspace UUID
artifactId: String, // Notebook / artifact UUID
livyId: String, // Spark Livy session UUID
jobType: String, // "sessions", "batches", etc.
targetDir: String, // abfss:// path where event logs are written
overwrite: Boolean, // true to overwrite existing logs (default: true)
attemptId: Integer // YARN attempt number; null = auto-detect, 1 = first attempt
)Parameters
| Parameter | Type | Description |
|---|---|---|
workspaceId | String | The Fabric workspace UUID containing the Spark session |
artifactId | String | The UUID of the artifact (notebook, lakehouse job, etc.) that created the session |
livyId | String | The Livy session UUID (from the Spark session list API) |
jobType | String | Type of job: "sessions" (interactive notebooks), "batches" (Spark Job Definitions) |
targetDir | String | OneLake abfss:// path for output. Event log files are written here. |
overwrite | Boolean | If true, overwrites any existing event log at the target path (default: true) |
attemptId | Integer | YARN application attempt number. Pass 1 for most sessions. Pass null for auto-detection. |
Return Value
Returns a Long representing the total number of bytes copied.
Target Directory Format
The recommended target directory pattern for lakehouse storage:
abfss://{workspaceId}@onelake.dfs.fabric.microsoft.com/{lakehouseId}/Files/spark-events/{livyId}/This places event logs under the lakehouse Files section, organized by session.
Requirements
| Requirement | Detail |
|---|---|
| Fabric Runtime | ≥ 1.3 (Spark ≥ 3.5). JobInsight is NOT available on earlier runtimes. |
| Same capacity | The notebook running JobInsight must execute on the same capacity as the Spark session being debugged. |
| Execution environment | Must run on a Fabric Spark cluster (library is pre-installed). |
| Authentication | The authenticated user must have access to the source Spark session. |
| Target permissions | Target lakehouse directory must be writable (Contributor role). |
| Language | Scala only — not available in PySpark. |
Attempt ID (7th Parameter)
The attemptId parameter controls how copyEventLog matches event-log files in blob storage.
Internal flow:
CredentialProvider.getEventLogDirSasInfo()→ gets a SAS-scoped directory URLCredentialProvider.listFiles()→ lists blobs under that directoryCredentialProvider.eventLogNamePattern(attemptId)→ builds a regex to filter filesFiles matching the regex are copied to
targetDir
Regex behavior:
attemptId value | Generated regex | Matches |
|---|---|---|
null (auto-detect) | application_[\d]+_[\d]+(\.inprogress)? | application_xxx_0001 only |
1 | application_[\d]+_[\d]+_1(\.inprogress)? | application_xxx_0001_1 |
2 | application_[\d]+_[\d]+_2(\.inprogress)? | application_xxx_0001_2 |
Known issue: Spark event-log files almost always include an attempt suffix (e.g. _1). When attemptId = null, the regex uses String.matches() (full match) and does not match file names with the _1 suffix. Auto-detection queries cluster metadata to resolve the attempt number, but this metadata is garbage-collected within ~3 days of session completion. After that, the call falls back to the null regex and silently fails.
Recommendation: Always pass attemptId = 1 unless you know the session had multiple YARN attempts (very rare for interactive notebook sessions).
Common Errors
| Error | Cause | Fix |
|---|---|---|
ClassNotFoundException: LogUtils | Running outside Fabric Spark | Must run inside a Fabric notebook |
Failed to get event log, please check input parameters | Event-log file name matching failed (see Attempt ID section) | Pass explicit attemptId = 1 instead of null |
AccessDenied on source | No access to session logs | Verify workspace permissions |
AccessDenied on target | Cannot write to lakehouse | Need Contributor role on target workspace |
SessionNotFoundException | Invalid livyId | Verify the session exists and has completed |
Usage Example
Direct in Fabric Notebook (Scala cell)
import com.microsoft.jobinsight.diagnostic.LogUtils
val workspaceId = "4cb9b656-c8f8-485e-a151-e81bb913abc8"
val notebookId = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
val livyId = "12345678-1234-1234-1234-123456789abc"
val lakehouseId = "abcdef12-3456-7890-abcd-ef1234567890"
val targetDir = s"abfss://[email protected]/$lakehouseId/Files/spark-events/$livyId/"
val bytesWritten = LogUtils.copyEventLog(
workspaceId, notebookId, livyId,
"sessions", targetDir, true, 1
)
println(s"Copied $bytesWritten bytes of event logs")Via Notebook Run API (Automation Pattern)
Since JobInsight is Scala-only and cluster-bound, the recommended automation pattern is:
Create a parameterized Scala notebook using a Fabric parameter cell (toggle the cell to "Parameter" in the notebook toolbar) to declare default values for
workspaceId,livyId, andtargetDirRun it via the Fabric Notebook Run API:
az rest --method post --resource "https://api.fabric.microsoft.com" \ --url "https://api.fabric.microsoft.com/v1/workspaces/$workspaceId/items/$notebookId/jobs/RunNotebook/instances" \ --body '{"executionData": {"parameters": {"workspaceId": "...", "livyId": "...", "targetDir": "..."}}}'Poll the Location header for completion (see COMMON-CLI.md § LRO Pattern)
Downloading Event Logs from OneLake
After copyEventLog writes event logs to OneLake, download them locally for the Spark History Server:
# Get a storage token
TOKEN=$(az account get-access-token --resource https://storage.azure.com --query accessToken -o tsv)
# List event log files
curl -s -H "Authorization: Bearer $TOKEN" \
"https://onelake.dfs.fabric.microsoft.com/$workspaceId/$lakehouseId/Files/spark-events/$livyId?resource=filesystem&recursive=true" \
| jq -r '.paths[].name'
# Download each file to local directory
LOCAL_DIR="$HOME/.spark-local/event-logs/$livyId"
mkdir -p "$LOCAL_DIR"
# For each file listed above:
curl -s -H "Authorization: Bearer $TOKEN" \
"https://onelake.dfs.fabric.microsoft.com/$workspaceId/$lakehouseId/<filepath>" \
-o "$LOCAL_DIR/<filename>"Then start the local Spark History Server — see spark-history-server.md.
Requirements 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.
Security
What our scanner noticed· Low risk
- Instructions that use the network
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/spark-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 spark-cli.zip