Workbook discovery notes¶

Use this reference when the caller has a portal blade URL but not a saved workbook resource ID.

Why blade URLs are insufficient¶

A URL ending in:

/providers/Microsoft.Insights/components/<component>/workbooks

opens the workbook blade for that component. It does not identify a specific workbook resource.

Deterministic workbook targeting options¶

Prefer explicit workbook ID:

/subscriptions/<sub>/resourceGroups/<rg>/providers/Microsoft.Insights/workbooks/<guid>

If ID is unavailable, use workbook display name with component-scoped sourceId matching.

Manual verification commands¶

List candidate workbooks in a subscription:

az resource list --resource-type Microsoft.Insights/workbooks --output table

Inspect one workbook:

az resource show --ids \
  /subscriptions/<sub>/resourceGroups/<rg>/providers/Microsoft.Insights/workbooks/<guid> \
  --api-version 2023-06-01 \
  --query "{id:id,displayName:properties.displayName,sourceId:properties.sourceId}" \
  --output json

Inspect workbook serialized data for KQL tiles:

az resource show --ids <workbook-id> --api-version 2023-06-01 --query properties.serializedData -o tsv

Cross-environment caution¶

Workbook display names are not globally unique. For repeatable automation:

pin --workbook-id whenever possible
keep --workbook-item-title explicit when extracting a specific tile query
record the --timespan used to avoid silent drift