Skip to content

Commit acd9bd9

Browse files
authored
Update workbooks-resources.md to include note about resource naming
The exiting docs don't make it clear that resource parameter names always come from the resource id and cannot be overwritten with other values
1 parent cbb54ef commit acd9bd9

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

articles/azure-monitor/visualize/workbooks-resources.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ Resource parameters allow picking of resources in workbooks. This functionality
1313

1414
Values from resource pickers can come from the workbook context, static list, or Azure Resource Graph queries.
1515

16+
> [!NOTE]
17+
> For resource parameters, the label for each resource in the parameter always comes from the resource id. It is not possible to replace that name with another value. Examples below will show the label field being set to the id for clarity, but that value will not be used in the parameter.
18+
19+
1620
## Create a resource parameter (workbook resources)
1721

1822
1. Start with an empty workbook in edit mode.
@@ -44,15 +48,13 @@ Values from resource pickers can come from the workbook context, static list, or
4448

4549
```kusto
4650
where type == 'microsoft.insights/components'
47-
| project value = id, label = name, selected = false, group = resourceGroup
51+
| project value = id, label = id, selected = false, group = resourceGroup
4852
```
4953
5054
1. Select **Save** to create the parameter.
5155
5256
:::image type="content" source="./media/workbooks-resources/resource-query.png" lightbox="./media/workbooks-resources/resource-query.png" alt-text="Screenshot that shows the creation of a resource parameter by using Azure Resource Graph.":::
5357
54-
> [!NOTE]
55-
> Azure Resource Graph isn't yet available in all clouds. Ensure that it's supported in your target cloud if you choose this approach.
5658
5759
For more information on Azure Resource Graph, see [What is Azure Resource Graph?](../../governance/resource-graph/overview.md).
5860
@@ -70,8 +72,8 @@ For more information on Azure Resource Graph, see [What is Azure Resource Graph?
7072
7173
```json
7274
[
73-
{ "value":"/subscriptions/<sub-id>/resourceGroups/<resource-group>/providers/<resource-type>/acmeauthentication", "label": "acmeauthentication", "selected":true, "group":"Acme Backend" },
74-
{ "value":"/subscriptions/<sub-id>/resourceGroups/<resource-group>/providers/<resource-type>/acmeweb", "label": "acmeweb", "selected":false, "group":"Acme Frontend" }
75+
{ "value":"/subscriptions/<sub-id>/resourceGroups/<resource-group>/providers/<resource-type>/acmeauthentication", "selected":true, "group":"Acme Backend" },
76+
{ "value":"/subscriptions/<sub-id>/resourceGroups/<resource-group>/providers/<resource-type>/acmeweb", "selected":false, "group":"Acme Frontend" }
7577
]
7678
```
7779
@@ -102,7 +104,7 @@ This approach can be used to bind resources to other controls like metrics.
102104
| Parameter | Description | Example |
103105
| ------------- |:-------------|:-------------|
104106
| `{Applications}` | The selected resource ID. | _/subscriptions/\<sub-id\>/resourceGroups/\<resource-group\>/providers/\<resource-type\>/acmeauthentication_ |
105-
| `{Applications:label}` | The label of the selected resource. | `acmefrontend` |
107+
| `{Applications:label}` | The label of the selected resource. | `acmefrontend` Note: for multi-value resource parameters, this label may be shortened like `acmefrontend (+3 others)` and may not include all labels of all selected values |
106108
| `{Applications:value}` | The value of the selected resource. | _'/subscriptions/\<sub-id\>/resourceGroups/\<resource-group\>/providers/\<resource-type\>/acmeauthentication'_ |
107109
| `{Applications:name}` | The name of the selected resource. | `acmefrontend` |
108110
| `{Applications:resourceGroup}` | The resource group of the selected resource. | `acmegroup` |

0 commit comments

Comments
 (0)