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/authoring/resources/infrastructure-orchestration.md
Infrastructure & Orchestration — Skill Resource
Essential patterns for workspace provisioning, lakehouse configuration, and pipeline orchestration in Microsoft Fabric.
Recommended patterns
Must
Always use version control for infrastructure definitions and deployment scripts — track changes, enable rollback
Implement environment isolation — separate dev/test/prod workspaces with distinct configurations
Use parameterized configurations — avoid hardcoding workspace IDs, names, or environment-specific values
Validate before deployment — check JSON payloads, test API calls with dry-run where possible
Implement proper RBAC — assign minimum required permissions to users and service principals
Prefer
Declarative infrastructure over imperative scripts — define desired state, let automation converge
Automated CI/CD over manual deployments — reduce human error, increase consistency
Idempotent operations — scripts should be safe to run multiple times without side effects
Avoid
Don't hardcode secrets in scripts or configurations — use Azure Key Vault, environment variables
Don't skip testing infrastructure changes — validate in dev before promoting to prod
Don't ignore capacity planning — understand SKU requirements, concurrent user limits, data volume
Don't create orphaned resources — track workspace-lakehouse-notebook relationships, clean up on teardown
Workspace Provisioning Principles
Environment Isolation Strategy
Guide LLM to create workspaces following:
Naming convention:
{project}-{environment}(e.g.,sales-analytics-dev,sales-analytics-prod)Separate capacity: Dev uses lower-tier capacity (F2/F4), prod uses dedicated higher-tier (F64+)
Access control: Limit prod access to service principals and specific admins, dev is broader
Data segregation: Dev uses synthetic/sample data, prod uses real data with compliance controls
Workspace Configuration
Prompt LLM to configure:
Display name: Human-readable, follows naming convention
Description: Document purpose, owning team, environment type
Capacity assignment: Assign to appropriate Fabric capacity for the environment
Default lakehouse: Create primary lakehouse during workspace setup for consistency
RBAC Patterns
Tell LLM to assign roles appropriately:
Admin: Full control, can manage access — limit to 2-3 people
Member: Can create and edit items — developers, data engineers
Contributor: Can edit items but not create new — analysts, data scientists
Viewer: Read-only access to reports — business users
API Approach
Guide LLM to use Fabric REST API:
Create workspace: POST
/v1/workspaceswithdisplayNameand optionaldescriptionAssign capacity: Use capacity assignment endpoint if not using default
List workspaces: GET
/v1/workspacesto discover existing workspaces
Lakehouse Configuration Guidance
When to Create Separate Lakehouses
Guide LLM based on use case:
Single lakehouse when:
Small project with <10 tables, single data pipeline
All data has same security requirements
Team is small, no cross-team collaboration
Medallion architecture with schema-enabled lakehouse — create
bronze,silver,goldschemas within one lakehouse; MLVs with incremental refresh make cross-schema transformations efficient
Multiple lakehouses when:
Large project with distinct data domains (sales, marketing, finance)
Different security/compliance requirements per domain
Different retention policies per data type
Avoid creating separate lakehouses for:
Medallion layers (bronze/silver/gold) when using schema-enabled lakehouses — use schemas within one lakehouse instead
Derived/transformed tables within the same layer/schema — use notebooks, MLVs, or standard tables within the existing lakehouse/schema, not separate lakehouses
Lakehouse Naming Conventions
Prompt LLM to follow pattern:
Medallion architecture with schema-enabled lakehouse: Single lakehouse named
{project}_lakehouse, with schemasbronze,silver,goldinsideMedallion architecture without schema-enabled lakehouse (legacy):
{project}_bronze,{project}_silver,{project}_goldas separate lakehousesDomain separation:
sales_lakehouse,marketing_lakehouse,shared_dimensionsEnvironment suffix: Include env if workspace spans environments (rare)
Configuration Considerations
Tell LLM to think about:
OneLake path: Lakehouse automatically gets
Files/andTables/foldersShortcuts: Create shortcuts to external ADLS Gen2 or other OneLake lakehouses for federated queries
Default lakehouse: Set one as default for notebooks to simplify path references
SQL endpoint: Every lakehouse automatically gets SQL Analytics Endpoint for T-SQL queries
Schema Management
Guide LLM for table organization:
Bronze schema: Raw data, minimal transformation, original data types
Silver schema: Cleaned, validated, conformed types, deduplication
Gold schema: Business-logic enriched, aggregated, optimized for analytics
Naming: Use lowercase with underscores:
customer_transactions, notCustomerTransactions
Pipeline Design Patterns
Orchestration vs Transformation Logic
Critical principle for LLM to understand:
Pipelines (orchestration): Define when and what order to run tasks
Schedule/trigger configuration
Activity dependencies (Task A → Task B → Task C)
Parameter flow between activities
Retry and error handling policies
Notifications on success/failure
Notebooks (transformation): Contain what to transform and how
Read data from source
Apply business logic transformations
Write to destination
No orchestration concerns
Guide LLM to separate these: Don't put scheduling logic in notebooks; don't put transformation logic in pipelines.
Activity Types and When to Use
Notebook Activity:
Use for: Data ingestion, transformation, ML training, custom PySpark logic
Parameterization: Pass date ranges, paths, table names from pipeline
Output: Can output values for downstream activities to consume
Copy Activity:
Use for: Simple data movement without transformation (ADLS → Lakehouse, Lakehouse → Azure SQL)
Efficient for large-volume copies with schema mapping
Built-in retry and throttling handling
ForEach Activity:
Use for: Batch processing multiple files, tables, or partitions
Iterates over array, executes nested activity for each item
Can run sequentially or in parallel (set batchCount)
If/Switch Conditions:
Use for: Conditional logic (e.g., different processing for weekday vs weekend)
Evaluate expressions based on pipeline parameters or activity outputs
Wait/Webhook:
Use for: External system coordination, delays between activities
Webhook calls external REST endpoint, waits for callback before proceeding
Parameter Flow Pattern
Guide LLM to design parameter flow:
Pipeline parameters: Define at pipeline level (e.g.,
ProcessingDate,Environment)Pass to activities: Map pipeline params to notebook params in activity configuration
Default values: Notebooks should have sensible defaults if pipeline doesn't override
Expressions: Use
@formatDateTime(utcnow(), 'yyyy-MM-dd')for dynamic valuesOutput consumption: Capture notebook outputs, use in downstream activities
Error Handling Strategy
Prompt LLM to configure:
Activity retry: Set retry count (3) and interval (30s) for transient failures
Timeout: Set max execution time to prevent runaway processes
On failure paths: Use activity dependencies to execute cleanup/notification on error
Dead letter: Write failed records to error table for investigation
Alerting: Configure pipeline failure notifications to Teams/email
CI/CD Integration Strategy
Infrastructure as Code Benefits
Explain to LLM why IaC matters:
Reproducibility: Deploy same config across dev/test/prod consistently
Version control: Track changes, review PRs, rollback bad changes
Automation: Reduce manual steps, increase deployment frequency
Testing: Validate infrastructure changes before production deployment
Deployment Patterns
Pattern 1: API-Driven Deployment
Use Fabric REST API to create/update notebooks, lakehouses, pipelines
Store item definitions in Git repository
CI/CD pipeline reads definitions, calls API to deploy
Best for: Notebooks, pipelines, simple infrastructure
Pattern 2: ARM/Bicep Templates
Define Azure resources declaratively (capacity, workspace assignments)
Use Azure DevOps or GitHub Actions to deploy templates
Best for: Azure-level resources, capacity management
Pattern 3: Hybrid Approach
ARM templates for Azure resources and capacity
Fabric REST API for workspace items (notebooks, pipelines, lakehouses)
Separation of concerns: infrastructure vs data artifacts
Git Workflow
Guide LLM for branching strategy:
Main branch: Protected, reflects production state
Feature branches: Develop changes in isolation, PR review before merge
Environment branches: Optional dev/test/prod branches for staged deployments
Tag releases: Tag commits with version numbers for rollback reference
Automated Testing in CI/CD
Prompt LLM to implement:
Lint/validate: Check JSON syntax, YAML format, notebook structure
Unit tests: Run local PySpark tests with sample data
Integration tests: Deploy to dev workspace, execute pipeline, validate output
Smoke tests: Post-deployment checks (workspace accessible, pipelines runnable)
Rollback capability: Automated rollback if deployment tests fail
Deployment Stages
Typical progression LLM should generate:
Dev deployment: Automatic on every commit to feature branch
Test deployment: Automatic on merge to main, runs full integration tests
Prod deployment: Manual approval gate, requires test pass + human review
Monitoring: Post-deployment validation, alerting on anomalies
Secrets Management
Tell LLM to handle secrets via:
Azure Key Vault: Store connection strings, SAS tokens, API keys
Service principals: Use for automation authentication, not personal accounts
Environment variables: Pass secrets to pipelines at runtime, never hardcode
Audit logging: Track who accessed secrets, when, for what purpose
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