You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/azure-portal/azure-portal-dashboards-structure.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -283,49 +283,49 @@ Let’s break down the relevant sections of the JSON. The top-level properties,
283
283
284
284
The Azure resource ID, subject to the [naming conventions of Azure resources](/azure/architecture/best-practices/resource-naming). When the portal creates a dashboard, it generally chooses an ID in the form of a guid, but you can use any valid name when you create them programmatically.
285
285
286
-
### name
286
+
### Name
287
287
288
288
The name is the segment of the resource ID that does not include the subscription, resource type, or resource group information. Essentially, it's the last segment of the resource ID.
289
289
290
-
### type
290
+
### Type
291
291
292
292
All dashboards are of type __Microsoft.Portal/dashboards__.
293
293
294
-
### location
294
+
### Location
295
295
296
296
Unlike other resources, dashboards don’t have a runtime component. For dashboards, the location indicates the primary geographic location that stores the dashboard’s JSON representation. The value should be one of the location codes that can be fetched using the [locations API on the subscriptions resource](/rest/api/resources/subscriptions).
297
297
298
-
### tags
298
+
### Tags
299
299
300
300
Tags are a common feature of Azure resources that let you organize your resource by arbitrary name value pairs. Dashboards include one special tag called __hidden-title__. If your dashboard has this property populated, then that value is used as the display name for your dashboard in the portal. Azure resource IDs cannot be renamed, but tags can. This tag gives you a way to have a renamable display name for your dashboard.
301
301
302
302
`"tags": { "hidden-title": "Created via API" }`
303
303
304
-
### properties
304
+
### Properties
305
305
306
306
The properties object contains two properties, __lenses__ and __metadata__. The __lenses__ property contains information about the tiles on the dashboard. The __metadata__ property is there for potential future features.
307
307
308
-
### lenses
308
+
### Lenses
309
309
310
310
The __lenses__ property contains the dashboard. The lens object in this example contains a single property called “0”. Lenses are a grouping concept that isn't currently implemented. For now, all of your dashboards have this single property on the lens object, again, called "0".
311
311
312
-
### parts
312
+
### Parts
313
313
314
314
The object underneath the “0” contains two properties, __order__ and __parts__. In the current version of dashboards, __order__ is always 0. The __parts__ property contains an object that defines the individual parts (also referred to as tiles) on the dashboard.
315
315
316
316
The __parts__ object contains a property for each part, where the name of the property is a number. The number isn't significant.
317
317
318
318
Each individual part object has a __position__, and __metadata__.
319
319
320
-
### position
320
+
### Position
321
321
322
322
The __position__ property contains the size and location information for the part expressed as __x__, __y__, __rowSpan__, and __colSpan__. The values are in terms of grid units. These grid units are visible when the dashboard is in the customize mode as shown here. If you want a tile to have a width of two grid units, a height of one grid unit, and a location in the top left corner of the dashboard then the position object looks like this:

326
+
:::image type="content" source="media/azure-portal-dashboards-structure/grid-units.png" alt-text="Screenshot showing the grid units for a dashboard in the Azure portal.":::
327
327
328
-
### metadata
328
+
### Metadata
329
329
330
330
Each part has a metadata property, an object has only one required property called __type__. This string tells the portal which tile to show. Our example dashboard uses these types of tiles:
331
331
@@ -336,7 +336,7 @@ Each part has a metadata property, an object has only one required property call
336
336
337
337
Each type of part has its own configuration. The possible configuration properties are called __inputs__, __settings__, and __asset__.
338
338
339
-
### inputs
339
+
### Inputs
340
340
341
341
The inputs object generally contains information that binds a tile to a resource instance. The virtual machine part in our sample dashboard contains a single input that uses the Azure resource ID to express the binding. This resource ID format is consistent across all Azure resources.
342
342
@@ -385,7 +385,7 @@ The metrics chart part has a single input that expresses the resource to bind to
385
385
386
386
```
387
387
388
-
### settings
388
+
### Settings
389
389
390
390
The settings object contains the configurable elements of a part. In our sample dashboard, the Markdown part uses settings to store the custom markdown content along with a configurable title and subtitle.
391
391
@@ -424,7 +424,7 @@ Similarly, the video tile has its own settings that contain a pointer to the vid
424
424
425
425
```
426
426
427
-
### asset
427
+
### Asset
428
428
429
429
Tiles that are bound to first class manageable portal objects (called assets) have this relationship expressed via the asset object. In our example dashboard, the virtual machine tile contains this asset description. The __idInputName__ property tells the portal that the ID input contains the unique identifier for the asset, in this case the resource ID. Most Azure resource types have assets defined in the portal.
0 commit comments