Skip to content

Commit c0707ef

Browse files
authored
Merge pull request #108610 from mgblythe/mb-0323-dashboards
Freshness for dashboard articles
2 parents ccf113b + e619d4b commit c0707ef

File tree

9 files changed

+47
-78
lines changed

9 files changed

+47
-78
lines changed

articles/azure-portal/azure-portal-dashboard-share-access.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.devlang: NA
1313
ms.topic: conceptual
1414
ms.tgt_pltfrm: NA
1515
ms.workload: na
16-
ms.date: 01/29/2020
16+
ms.date: 03/23/2020
1717
ms.author: mblythe
1818

1919
---
@@ -36,7 +36,7 @@ With Role-Based Access Control (RBAC), you can assign users to roles at three di
3636
* resource group
3737
* resource
3838

39-
The permissions you assign inherit from subscription down to the resource. The published dashboard is a resource. You may already have users assigned to roles for the subscription that apply for the published dashboard.
39+
The permissions you assign inherit from the subscription down to the resource. The published dashboard is a resource. You may already have users assigned to roles for the subscription that apply for the published dashboard.
4040

4141
Let's say you have an Azure subscription and various members of your team have been assigned the roles of *owner*, *contributor*, or *reader* for the subscription. Users who are owners or contributors can list, view, create, modify, or delete dashboards within the subscription. Users who are readers can list and view dashboards, but can't modify or delete them. Users with reader access can make local edits to a published dashboard, such as when troubleshooting an issue, but they can't publish those changes back to the server. They can make a private copy of the dashboard for themselves.
4242

@@ -56,35 +56,31 @@ Before assigning access, you must publish the dashboard.
5656

5757
![publish your dashboard](./media/azure-portal-dashboard-share-access/publish-dashboard-for-access-control.png)
5858

59-
By default, sharing publishes your dashboard to a resource group named **dashboards**.
59+
By default, sharing publishes your dashboard to a resource group named **dashboards**. To select a different resource group, clear the checkbox.
6060

6161
Your dashboard is now published. If the permissions inherited from the subscription are suitable, you don't need to do anything more. Other users in your organization can access and modify the dashboard based on their subscription level role.
6262

6363
## Assign access to a dashboard
6464

6565
You can assign a group of users to a role for that dashboard.
6666

67-
1. After publishing the dashboard, in **Sharing + access control**, select **Manage users**.
67+
1. After publishing the dashboard, select the **Share** or **Unshare** option to access **Sharing + access control**.
6868

69-
![manage users for a dashboard](./media/azure-portal-dashboard-share-access/manage-users-for-access-control.png)
69+
1. In **Sharing + access control**, select **Manage users**.
7070

71-
To access **Sharing + access control** from a dashboard, select the **Share** or **Unshare** option.
71+
![manage users for a dashboard](./media/azure-portal-dashboard-share-access/manage-users-for-access-control.png)
7272

7373
1. Select **Role assignments** to see existing users that are already assigned a role for this dashboard.
7474

75-
1. To add a new user or group, select **Add**.
75+
1. To add a new user or group, select **Add** then **Add role assignment**.
7676

7777
![add a user for access to the dashboard](./media/azure-portal-dashboard-share-access/manage-users-existing-users.png)
7878

7979
1. Select the role that represents the permissions to grant. For this example, select **Contributor**.
8080

8181
1. Select the user or group to assign to the role. If you don't see the user or group you're looking for in the list, use the search box. Your list of available groups depends on the groups you've created in Active Directory.
8282

83-
1. When you have finished adding users or groups, select **OK**.
84-
85-
The new assignment is added to the list of users. Its **Access** is listed as **Assigned** rather than **Inherited**.
86-
87-
![assigned roles](./media/azure-portal-dashboard-share-access/assigned-roles.png)
83+
1. When you've finished adding users or groups, select **Save**.
8884

8985
## Next steps
9086

articles/azure-portal/azure-portal-dashboards-create-programmatically.md

Lines changed: 12 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -12,23 +12,23 @@ ms.devlang: NA
1212
ms.topic: conceptual
1313
ms.tgt_pltfrm: NA
1414
ms.workload: na
15-
ms.date: 01/29/2020
15+
ms.date: 03/23/2020
1616
ms.author: mblythe
1717

1818
---
1919
# Programmatically create Azure Dashboards
2020

21-
This document walks through the process of programmatically creating and publishing Azure dashboards. The dashboard shown below is referenced throughout the document.
21+
This article walks you through the process of programmatically creating and publishing Azure dashboards. The dashboard shown below is referenced throughout the document.
2222

2323
![sample dashboard](./media/azure-portal-dashboards-create-programmatically/sample-dashboard.png)
2424

2525
## Overview
2626

27-
Shared dashboards in the [Azure portal](https://portal.azure.com) are [resources](../azure-resource-manager/management/overview.md) just like virtual machines and storage accounts. You can manage resources programmatically by using the [Azure Resource Manager REST APIs](/rest/api/), the [Azure CLI](/cli/azure), and [Azure PowerShell commands](/powershell/azure/get-started-azureps).
27+
Shared dashboards in the [Azure portal](https://portal.azure.com) are [resources](../azure-resource-manager/management/overview.md) just like virtual machines and storage accounts. You can manage resources programmatically by using the [Azure Resource Manager REST APIs](/rest/api/), the [Azure CLI](/cli/azure), and [Azure PowerShell commands](/powershell/azure/get-started-azureps).
2828

2929
Many features build on these APIs to make resource management easier. Each of these APIs and tools offers ways to create, list, retrieve, modify, and delete resources. Since dashboards are resources, you can pick your favorite API or tool to use.
3030

31-
Whichever tools you use, you need to construct a JSON representation of your dashboard object. This object contains information about the tiles on the dashboard. It includes sizes, positions, resources they're bound to, and any user customizations.
31+
Whichever tools you use, to create a dashboard programmatically, you construct a JSON representation of your dashboard object. This object contains information about the tiles on the dashboard. It includes sizes, positions, resources they're bound to, and any user customizations.
3232

3333
The most practical way to build up this JSON document is to use the Azure portal. You can interactively add and position your tiles. Then export the JSON and create a template from the result for later use in scripts, programs, and deployment tools.
3434

@@ -48,7 +48,7 @@ Others have fixed sizes to choose from in their context menu.
4848

4949
## Share the dashboard
5050

51-
After you configure the dashboard, the next steps are to publish the dashboard using the **Share** command and then use the Resource Explorer to fetch the JSON.
51+
After you configure the dashboard, the next step is to publish the dashboard using the **Share** command.
5252

5353
![sharing a dashboard](./media/azure-portal-dashboards-create-programmatically/share-command.png)
5454

@@ -58,13 +58,9 @@ Selecting **Share** prompts you to choose which subscription and resource group
5858

5959
## Fetch the JSON representation of the dashboard
6060

61-
Publishing only takes a few seconds. When it's done, the next step is to go to the [Resource Explorer](https://portal.azure.com/#blade/HubsExtension/ArmExplorerBlade) to fetch the JSON.
61+
Publishing only takes a few seconds. When it's done, the next step is to fetch the JSON using the **Download** command.
6262

63-
![browse Resource Explorer](./media/azure-portal-dashboards-create-programmatically/search-resource-explorer.png)
64-
65-
From the Resource Explorer, navigate to the subscription and resource group that you chose. Next, select the newly published dashboard resource to reveal the JSON.
66-
67-
![view JSON in Resource Explorer](./media/azure-portal-dashboards-create-programmatically/resource-explorer-json-detail.png)
63+
![download JSON representation](./media/azure-portal-dashboards-create-programmatically/download-command.png)
6864

6965
## Create a template from the JSON
7066

@@ -123,21 +119,18 @@ Declare required template metadata and the parameters at the top of the JSON tem
123119

124120
... rest of template omitted ...
125121
```
126-
127-
You can see the full, working template at the end of this document.
128-
129122
Once you've configured your template, deploy it using any of the following methods:
130123

131124
* [REST APIs](/rest/api/resources/deployments)
132125
* [PowerShell](../azure-resource-manager/resource-group-template-deploy.md)
133126
* [Azure CLI](/cli/azure/group/deployment#az-group-deployment-create)
134127
* [The Azure portal template deployment page](https://portal.azure.com/#create/Microsoft.Template)
135128

136-
Here are two versions of our example dashboard JSON. The first is the version that we exported from the portal that was already bound to a resource. The second is the template version that can be programmatically bound to any virtual machine and deployed using Azure Resource Manager.
129+
Next you'll see two versions of our example dashboard JSON. The first is the version that we exported from the portal that was already bound to a resource. The second is the template version that can be programmatically bound to any virtual machine and deployed using Azure Resource Manager.
137130

138-
## JSON representation of our example dashboard before templating
131+
### JSON representation of our example dashboard before templating
139132

140-
This example shows what you can expect to see if you followed along with this article. The instructions exported the JSON representation of a dashboard that is already deployed. The hard-coded resource identifiers that show that this dashboard is pointing at a specific Azure virtual machine.
133+
This example shows what you can expect to see if you followed along with this article. The instructions exported the JSON representation of a dashboard that is already deployed. The hard-coded resource identifiers show that this dashboard is pointing at a specific Azure virtual machine.
141134

142135
```json
143136

@@ -659,6 +652,6 @@ This example deploys a dashboard by itself, but the template language lets you d
659652
}
660653
]
661654
}
662-
663-
664655
```
656+
657+
Now that you've seen an example of using a parameterized template to deploy a dashboard, you can try deploying the template by using the [Azure Resource Manager REST APIs](/rest/api/), the [Azure CLI](/cli/azure), or [Azure PowerShell commands](/powershell/azure/get-started-azureps).

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

Lines changed: 27 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.devlang: NA
1313
ms.topic: conceptual
1414
ms.tgt_pltfrm: NA
1515
ms.workload: na
16-
ms.date: 01/29/2020
16+
ms.date: 03/23/2020
1717
ms.author: mblythe
1818

1919
---
@@ -35,7 +35,7 @@ In this example, we create a new, private dashboard and assign a name. Follow th
3535

3636
1. Select **New dashboard**.
3737

38-
![Screenshot of default dashboard](./media/azure-portal-dashboards/create-new-dashboard.png)
38+
![Screenshot of new dashboard](./media/azure-portal-dashboards/create-new-dashboard.png)
3939

4040
This action opens the **Tile Gallery**, from which you'll select tiles, and an empty grid where you'll arrange the tiles.
4141

@@ -45,13 +45,13 @@ In this example, we create a new, private dashboard and assign a name. Follow th
4545

4646
1. Select **Done customizing** in the page header to exit edit mode.
4747

48-
The dashboard view now shows your empty dashboard. Select the arrow next to the dashboard name to see dashboards available to you. The list might include dashboards that other users have created and shared.
48+
The dashboard view now shows your new dashboard. Select the arrow next to the dashboard name to see dashboards available to you. The list might include dashboards that other users have created and shared.
4949

5050
## Edit a dashboard
5151

5252
Now, let's edit the dashboard to add, resize, and arrange tiles that represent your Azure resources.
5353

54-
### Add tiles
54+
### Add tiles from the dashboard
5555

5656
To add tiles to a dashboard, follow these steps:
5757

@@ -63,14 +63,14 @@ To add tiles to a dashboard, follow these steps:
6363

6464
1. Select **Add** to add the tile to the dashboard with a default size and location. Or, drag the tile to the grid and place it where you want.
6565

66-
Many resource pages include a pushpin icon in the command bar. If you select the icon, a tile representing the source page is pinned to the dashboard that is currently active. This method is an alternative way to add tiles to your dashboard.
67-
68-
![Screenshot of page command bar with pin icon](./media/azure-portal-dashboards/dashboard-pin-blade.png)
69-
7066
> [!TIP]
7167
> If you work with more than one organization, add the **Organization identity** tile to your dashboard to clearly show which organization the resources belong to.
72-
>
73-
>
68+
69+
### Add tiles from a resource page
70+
71+
There is an alternative way to add tiles to your dashboard. Many resource pages include a pushpin icon in the command bar. If you select the icon, a tile representing the source page is pinned to the dashboard that is currently active.
72+
73+
![Screenshot of page command bar with pin icon](./media/azure-portal-dashboards/dashboard-pin-blade.png)
7474

7575
### Resize or rearrange tiles
7676

@@ -88,14 +88,17 @@ To change the size of a tile or to rearrange the tiles on a dashboard, follow th
8888

8989
Some tiles might require more configuration to show the information you want. For example, the **Metrics chart** tile has to be set up to display a metric from **Azure Monitor**. You can also customize tile data to override the dashboard's default time settings.
9090

91-
Any tile that needs to be set up displays a **Configure tile** banner until you customize the tile. Select that banner, then do the required setup.
91+
Any tile that needs to be set up displays a **Configure tile** banner until you customize the tile. To customize the tile:
9292

93-
![Screenshot of tile that requires configuration](./media/azure-portal-dashboards/dashboard-configure-tile.png)
93+
1. Select **Done customizing** in the page header to exit edit mode.
94+
95+
1. Select the banner, then do the required setup.
96+
97+
![Screenshot of tile that requires configuration](./media/azure-portal-dashboards/dashboard-configure-tile.png)
9498

9599
> [!NOTE]
96100
> A markdown tile lets you display custom, static content on your dashboard. This could be basic instructions, an image, a set of hyperlinks, or even contact information. For more information about using a markdown tile, see [Use a markdown tile on Azure dashboards to show custom content](azure-portal-markdown-tile.md).
97-
>
98-
>
101+
99102
### Customize tile data
100103

101104
Data on the dashboard automatically shows activity for the past 24 hours. To show a different time span for just this tile, follow these steps:
@@ -136,50 +139,27 @@ To use an existing dashboard as a template for a new dashboard, follow these ste
136139

137140
## Publish and share a dashboard
138141

139-
When you create a dashboard, it's private by default, which means you're the only one who can see it. To make dashboards available to others, you can share them with other users. First, you have to publish the dashboard as an Azure resource. To publish and share a custom dashboard, follow these steps:
140-
141-
1. Select ![share icon](./media/azure-portal-dashboards/dashboard-share-icon.png) **Share** from the page header. **Sharing + access control** opens.
142-
143-
1. Verify that the correct dashboard name is shown.
144-
145-
1. Select a **Subscription name**. Users with access to the subscription can use the shared dashboard. Access to the resources represented by the individual tiles is determined by Azure role-based access control.
146-
147-
1. Select the checkbox to publish this dashboard to the 'dashboards' resource group for the selected subscription. Or, clear the checkbox and choose to publish to an existing resource group instead.
148-
149-
1. Choose a location for the dashboard resource. We recommend you locate the dashboard with other resources. If you choose from existing resource groups, the dashboard is automatically located with that resource group.
150-
151-
1. Select **Publish**.
152-
153-
![Screenshot of dashboard publishing dialog](./media/azure-portal-dashboards/dashboard-publish.png)
154-
155-
### Set access control on a shared dashboard
156-
157-
After the dashboard is published, manage who has access to the dashboard by following these steps:
158-
159-
1. In the **Sharing + access control** pane, select **Manage users**.
160-
161-
![Screenshot of dashboard sharing + access control dialog](./media/azure-portal-dashboards/dashboard-share-access-control.png)
162-
163-
1. The **Access Control** page opens. You can review the level of access for someone or add a new role assignment. When you add a role assignment here, you're granting permissions to the dashboard.
164-
165-
> [!NOTE]
166-
> Tiles are representative views of resources in your organization. Access to resources is managed through role-based access control assignment and permissions are inherited from the subscription down to the resource. Giving access to a dashboard doesn't automatically assign permissions to the resources shown on the dashboard. For more information about permissions to shared dashboards and role-based access control for resources, see [Share Azure dashboards by using Role-Based Access Control](azure-portal-dashboard-share-access.md).
142+
When you create a dashboard, it's private by default, which means you're the only one who can see it. To make dashboards available to others, you can publish and share them. For more information, see [Share Azure dashboards by using Role-Based Access Control](azure-portal-dashboard-share-access.md).
167143

168144
### Open a shared dashboard
169145

170146
To find and open a shared dashboard, follow these steps:
171147

172148
1. Select the arrow next to the dashboard name.
173149

174-
1. Select from the displayed list of dashboards or **Browse all dashboards** if the dashboard you want to open isn't listed.
150+
1. Select from the displayed list of dashboards. If the dashboard you want to open isn't listed:
151+
152+
1. select **Browse all dashboards**.
153+
154+
![Screenshot of dashboard selection menu](./media/azure-portal-dashboards/dashboard-browse.png)
175155

176-
![Screenshot of dashboard selection menu](./media/azure-portal-dashboards/dashboard-browse.png)
156+
1. In the **Type** field, select **Shared dashboards**.
177157

178-
1. In the **Type** field, select **Shared dashboards**.
158+
![Screenshot of all dashboards selection menu](./media/azure-portal-dashboards/dashboard-browse-all.png)
179159

180-
1. Select one or more subscriptions. You can also enter text to filter dashboards by name.
160+
1. Select one or more subscriptions. You can also enter text to filter dashboards by name.
181161

182-
1. Select a dashboard from the list of shared dashboards.
162+
1. Select a dashboard from the list of shared dashboards.
183163

184164
## Delete a dashboard
185165

8.7 KB
Loading
-7.16 KB
Loading
16.7 KB
Loading

0 commit comments

Comments
 (0)