search-consumption-cli

Name: search-consumption-cli
Author: microsoft

Search Microsoft Fabric items across workspaces and return locations and IDs.

Stars

★ 772

Source

GitHub

Updated

2026-07-13

// securityLow risk

Prompt only, no code
Open source
Community-trusted· 772

Running security audit…

Credentials
Network egress
Code execution
Data access
Supply chain

// install

Copy the install command and let the AI configure it · recommended for beginners

Please install the "search-consumption-cli" skill from askskill:
1. Download https://raw.githubusercontent.com/microsoft/skills-for-fabric/main/skills/search-consumption-cli/SKILL.md
2. Save it as ~/.claude/skills/search-consumption-cli/SKILL.md
3. Reload skills and tell me it's ready

// download

Download SKILL.mdInstall manifest ↗

// examples

Find an item by name

Prompt

Find the item named "Sales Lakehouse" across all Microsoft Fabric workspaces, and tell me the workspace name, item type, workspace ID, and item ID.

Expected

A list of matching items with item name, type, workspace, and related IDs.

List items of a specific type

Prompt

List all Lakehouse items I have across Microsoft Fabric workspaces, grouped by workspace with each item's name and ID.

Expected

A workspace-grouped inventory showing each Lakehouse name and ID.

Identify which workspace contains an item

Prompt

I want to know which Microsoft Fabric workspace contains "Marketing Dashboard". If multiple items have the same name, list them all and return the workspace ID and item ID.

Expected

Workspace details for the item; if duplicates exist, all matches and their IDs are returned.

// docs

Update Check — ONCE PER SESSION (mandatory) The first time this skill is used in a session, run the check-updates skill before proceeding.

GitHub Copilot CLI / VS Code: invoke the check-updates skill (e.g., /fabric-skills:check-updates).

Claude Code / Cowork / Cursor / Windsurf / Codex: read the local package.json version, then compare it against the remote version via git fetch origin main --quiet && git show origin/main:package.json (or the GitHub API). If the remote version is newer, show the changelog and update instructions.

Skip if the check was already performed earlier in this session.

CRITICAL NOTES

The Catalog Search API finds items, not workspaces. To find a workspace by name, use GET /v1/workspaces (see COMMON-CLI.md § Resolve Workspace Properties by Name).

The search text matches against item display name, description, and workspace name.

Dataflow (Gen1) and Dataflow (Gen2) are not supported.

Catalog Search — CLI Skill

Prerequisite Knowledge

COMMON-CORE.md — Fabric REST API patterns, auth
COMMON-CLI.md — CLI implementation (az, curl, jq)

Task	Reference	Notes
Search for an Item	SKILL.md § Search for an Item	By name, description, or workspace name
List All Items of a Type	SKILL.md § List All Items of a Type	Empty search + type filter
Pagination	SKILL.md § Pagination	Continuation token pattern
Agentic Workflow	SKILL.md § Agentic Workflow
Examples	SKILL.md § Examples
Gotchas and Troubleshooting	SKILL.md § Gotchas and Troubleshooting

Must/Prefer/Avoid

MUST DO

Authenticate first — see COMMON-CORE.md § Authentication & Token Acquisition and COMMON-CLI.md § Authentication Recipes. The Catalog Search API requires Catalog.Read.All scope.
Write the JSON body to a temp file — avoids shell quoting issues with filter strings.
Disambiguate — if multiple results match, present display name, type, and workspace name and ask the user to confirm.

PREFER

Catalog Search over list-and-filter — single cross-workspace call, no need to resolve workspace first.
Type filters — narrow results with "filter": "Type eq 'Lakehouse'" to reduce noise.
Empty search with type filter — to list all items of a type across workspaces.
jq for extracting IDs from the response — cleaner than JMESPath for nested hierarchy.workspace.

AVOID

Searching for workspaces — the Catalog Search API returns items, not workspaces. Use GET /v1/workspaces instead (see COMMON-CLI.md § Resolve Workspace Properties by Name).
Inventing filter syntax — only eq, ne, or, and parentheses are supported.
Assuming all item types are supported — Dataflow (Gen1) and Dataflow (Gen2) are not returned yet.

Search for an Item

cat > /tmp/body.json << 'EOF'
{"search": "SalesLakehouse", "filter": "Type eq 'Lakehouse'", "pageSize": 10}
EOF
az rest --method post \
  --resource "https://api.fabric.microsoft.com" \
  --url "https://api.fabric.microsoft.com/v1/catalog/search" \
  --body @/tmp/body.json

The search text matches against item display name, description and workspace name. Type filtering is optional. The response includes id, type, displayName, description, and hierarchy.workspace (with id and displayName) for each match.