search-consumption-cliby 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

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

  1. 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).
  2. The search text matches against item display name, description, and workspace name.
  3. Dataflow (Gen1) and Dataflow (Gen2) are not supported.

Catalog Search — CLI Skill

Prerequisite Knowledge

Table of Contents

TaskReferenceNotes
Search for an ItemSKILL.md § Search for an ItemBy name, description, or workspace name
List All Items of a TypeSKILL.md § List All Items of a TypeEmpty search + type filter
PaginationSKILL.md § PaginationContinuation token pattern
Agentic WorkflowSKILL.md § Agentic Workflow
ExamplesSKILL.md § Examples
Gotchas and TroubleshootingSKILL.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

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.

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

Filter Examples

GoalFilter
Only lakehousesType eq 'Lakehouse'
Reports or semantic modelsType eq 'Report' or Type eq 'SemanticModel'
Exclude notebooksType ne 'Notebook'

For the full list of supported item types, see the Catalog Search API reference.


List All Items of a Type

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

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

Pagination

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

cat > /tmp/body.json << 'EOF'
{"search": "", "filter": "Type eq 'Lakehouse'", "pageSize": 100, "continuationToken": "<token>"}
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

  1. Ask — user provides an item name, type, or description keywords.
  2. Search — call Catalog Search with the user's input and optional type filter.
  3. Disambiguate — if multiple matches, present results (name, type, workspace) and ask the user to pick.
  4. Return — provide the search results, include the item id and hierarchy.workspace.id for downstream use.

Examples

Find a specific report

cat > /tmp/body.json << 'EOF'
{"search": "Monthly Sales Revenue", "filter": "Type eq 'Report'", "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 \
  --query "value[].{name:displayName, type:type, workspace:hierarchy.workspace.displayName}" \
  --output table

List all semantic models across workspaces

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

Save search results to file

cat > /tmp/body.json << 'EOF'
{"search": "", "filter": "Type eq 'Lakehouse'", "pageSize": 1000}
EOF
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[].{name:displayName, type:type, workspace:hierarchy.workspace.displayName, id:id}" \
  --output json > /tmp/search_results.json

Gotchas and Troubleshooting

SymptomCauseFix
401 UnauthorizedWrong token audience or expired sessionVerify --resource "https://api.fabric.microsoft.com". Run az login.
InvalidPageSizepageSize outside 1–1000Use a value between 1 and 1000.
InvalidFilterBad filter syntaxOnly eq, ne, or, and parentheses. Don't mix eq with and, or ne with or. Don't mix eq and ne in the same filter.
TypeNotFoundUnrecognized item type in filterCheck spelling (case-sensitive). See API reference for valid types.
FilterTooManyValuesFilter has more than 500 valuesReduce the number of type values in the filter.
InvalidRequestMissing request bodyEnsure --body points to a valid JSON file.
Empty results for known itemItem type not supportedDataflow Gen1/Gen2 are excluded. Use GET /v1/workspaces/{id}/items instead.
New item not foundCatalog index propagation delayNewly created items can take up to 24 hours to appear in search results. Verify the item exists via GET /v1/workspaces/{id}/items instead.
Too many resultsSearch text too broadAdd a type filter or use more specific search text.

NotebookLM Web Importer

Import web pages and YouTube videos to NotebookLM with one click. Trusted by 200,000+ users.

Install Chrome Extension