Skip to content

Commit 9685b6e

Browse files
authored
Merge pull request #176489 from JnHs/jh-portal-dashprfix1019
cap and image fix
2 parents 7d8e899 + d5dad03 commit 9685b6e

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

articles/azure-portal/azure-portal-dashboards-structure.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -283,49 +283,49 @@ Let’s break down the relevant sections of the JSON. The top-level properties,
283283

284284
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.
285285

286-
### name
286+
### Name
287287

288288
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.
289289

290-
### type
290+
### Type
291291

292292
All dashboards are of type __Microsoft.Portal/dashboards__.
293293

294-
### location
294+
### Location
295295

296296
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).
297297

298-
### tags
298+
### Tags
299299

300300
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.
301301

302302
`"tags": { "hidden-title": "Created via API" }`
303303

304-
### properties
304+
### Properties
305305

306306
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.
307307

308-
### lenses
308+
### Lenses
309309

310310
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".
311311

312-
### parts
312+
### Parts
313313

314314
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.
315315

316316
The __parts__ object contains a property for each part, where the name of the property is a number. The number isn't significant.
317317

318318
Each individual part object has a __position__, and __metadata__.
319319

320-
### position
320+
### Position
321321

322322
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:
323323

324324
`location: { x: 0, y: 0, rowSpan: 2, colSpan: 1 }`
325325

326-
![Screenshot shows a close up of the grid, with one square grid unit highlighted.](./media/azure-portal-dashboards-structure/grid-units.png)
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.":::
327327

328-
### metadata
328+
### Metadata
329329

330330
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:
331331

@@ -336,7 +336,7 @@ Each part has a metadata property, an object has only one required property call
336336

337337
Each type of part has its own configuration. The possible configuration properties are called __inputs__, __settings__, and __asset__.
338338

339-
### inputs
339+
### Inputs
340340

341341
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.
342342

@@ -385,7 +385,7 @@ The metrics chart part has a single input that expresses the resource to bind to
385385

386386
```
387387

388-
### settings
388+
### Settings
389389

390390
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.
391391

@@ -424,7 +424,7 @@ Similarly, the video tile has its own settings that contain a pointer to the vid
424424

425425
```
426426

427-
### asset
427+
### Asset
428428

429429
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.
430430

0 commit comments

Comments
 (0)