Labsco
microsoft logo

search-consumption-cli

✓ Official★ 716

by microsoft · part of microsoft/skills-for-fabric

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

🔥🔥🔥FreeQuick setup
#automation#git
🧩 One of 7 skills in the microsoft/skills-for-fabric package — works on its own, and pairs well with its siblings.

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

Inspect the full instructions your agent will receiveExpand

This is the exact playbook injected into your agent when the skill activates — shown here so you can audit it before installing. You don't need to read it to use the skill.

by microsoft

Update Check — ONCE PER SESSION (mandatory) The first time this skill is used in a session, run the check-updates skill before proceeding. npx skills add https://github.com/microsoft/skills-for-fabric --skill search-consumption-cli Download ZIPGitHub716

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

Table of Contents

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

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

Copy & paste — that's it
cat > /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.

### Extract item and workspace IDs

az rest --method post
--resource "https://api.fabric.microsoft.com"
--url "https://api.fabric.microsoft.com/v1/catalog/search"
--body @/tmp/body.json
--query "value[0].{itemId:id, workspaceId:hierarchy.workspace.id, name:displayName}"
--output json

Copy & paste — that's it

 

### Filter Examples

 Goal Filter 
 Only lakehouses `Type eq 'Lakehouse'` 
 Reports or semantic models `Type eq 'Report' or Type eq 'SemanticModel'` 
 Exclude notebooks `Type ne 'Notebook'` 
 

 For the full list of supported item types, see the [Catalog Search API reference](https://learn.microsoft.com/en-us/rest/api/fabric/core/catalog/search).

## List All Items of a Type

Use an empty search string with a type filter (`pageSize` max is 1000):

cat > /tmp/body.json

Pagination

If the response includes a non-null continuationToken, pass it in the next request:

Copy & paste — that's it
cat > /tmp/body.json "}
EOF
az rest --method post \
 --resource "https://api.fabric.microsoft.com" \
 --url "https://api.fabric.microsoft.com/v1/catalog/search" \
 --body @/tmp/body.json

Continue until continuationToken is null.

Agentic Workflow

  • Ask — user provides an item name, type, or description keywords.

  • Search — call Catalog Search with the user's input and optional type filter.

  • Disambiguate — if multiple matches, present results (name, type, workspace) and ask the user to pick.

  • Return — provide the search results, include the item id and hierarchy.workspace.id for downstream use.

Examples

Find a specific report

Copy & paste — that's it
cat > /tmp/body.json /tmp/body.json /tmp/body.json /tmp/search_results.json