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/quick-create-template.md
+20-24Lines changed: 20 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: Create an Azure portal dashboard by using an Azure Resource Manager templ
3
3
description: Learn how to create an Azure portal dashboard by using an Azure Resource Manager template.
4
4
ms.topic: quickstart
5
5
ms.custom: subject-armqs, mode-arm
6
-
ms.date: 03/15/2021
6
+
ms.date: 01/13/2022
7
7
---
8
8
9
9
# Quickstart: Create a dashboard in the Azure portal by using an ARM template
@@ -18,69 +18,64 @@ If your environment meets the prerequisites and you're familiar with using ARM t
18
18
19
19
## Prerequisites
20
20
21
-
- If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
22
-
- An existing VM.
21
+
- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
23
22
24
23
## Create a virtual machine
25
24
26
25
The dashboard you create in the next part of this quickstart requires an existing VM. Create a VM by following these steps.
27
26
28
-
1. In the Azure portal, select **Cloud Shell**.
27
+
1. In the Azure portal, select **Cloud Shell** from the global controls at the top of the page.
29
28
30
-

29
+
:::image type="content" source="media/quick-create-template/cloud-shell.png" alt-text="Screenshot showing the Cloud Shell option in the Azure portal.":::
31
30
32
31
1. In the **Cloud Shell** window, select **PowerShell**.
33
32
34
-

33
+
:::image type="content" source="media/quick-create-template/powershell.png" alt-text="Screenshot showing the PowerShell option in Cloud Shell.":::
35
34
36
35
1. Copy the following command and enter it at the command prompt to create a resource group.

43
-
44
-
1. Copy the following command and enter it at the command prompt to create a VM in the resource group.
41
+
1. Next, copy the following command and enter it at the command prompt to create a VM in your new resource group.
45
42
46
43
```powershell
47
44
New-AzVm `
48
45
-ResourceGroupName "SimpleWinVmResourceGroup" `
49
-
-Name "SimpleWinVm" `
46
+
-Name "myVM1" `
50
47
-Location "East US"
51
48
```
52
49
53
50
1. Enter a username and password for the VM. This is a new user name and password; it's not, for example, the account you use to sign in to Azure. For more information, see [username requirements](../virtual-machines/windows/faq.yml#what-are-the-username-requirements-when-creating-a-vm-) and [password requirements](../virtual-machines/windows/faq.yml#what-are-the-password-requirements-when-creating-a-vm-).
54
51
55
-
The VM deployment now starts and typically takes a few minutes to complete. After deployment completes, move on to the next section.
52
+
After the VM has been created, move on to the next section.
56
53
57
54
## Review the template
58
55
59
-
The template used in this quickstart is from [Azure Quickstart Templates](https://azure.microsoft.com/resources/templates/azure-portal-dashboard/). The template for this article is too long to show here. To view the template, see [azuredeploy.json](https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.portal/azure-portal-dashboard/azuredeploy.json). One Azure resource is defined in the template, [Microsoft.Portal/dashboards](/azure/templates/microsoft.portal/dashboards) - Create a dashboard in the Azure portal.
56
+
The template used in this quickstart is from [Azure Quickstart Templates](https://azure.microsoft.com/resources/templates/azure-portal-dashboard/). The template for this article is too long to show here. To view the template, see [azuredeploy.json](https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.portal/azure-portal-dashboard/azuredeploy.json). The template defines one Azure resource, a dashboard that displays data about the VM you created.
60
57
61
58
## Deploy the template
62
59
60
+
This example uses the Azure portal to deploy the template. You can also use other methods to deploy ARM templates, such as [Azure PowerShell](../azure-resource-manager/templates/deploy-powershell.md), [Azure CLI](../azure-resource-manager/templates/deploy-cli.md), or [REST API](../azure-resource-manager/templates/deploy-rest.md).
61
+
63
62
1. Select the following image to sign in to Azure and open a template.
64
63
65
64
[](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fquickstarts%2Fmicrosoft.portal%2Fazure-portal-dashboard%2Fazuredeploy.json)
66
65
67
66
1. Select or enter the following values, then select **Review + create**.
:::image type="content" source="media/quick-create-template/create-dashboard-using-template-portal.png" alt-text="Screenshot of the dashboard template deployment screen in the Azure portal.":::
70
69
71
70
Unless it's specified, use the default values to create the dashboard.
- **Location**: If not automatically selected, choose **East US**.
75
+
- **Virtual Machine Name**: enter **myVM1**.
76
+
- **Virtual Machine Resource Group**: enter **SimpleWinVmResourceGroup**.
82
77
83
-
The Azure portal was used to deploy the template. In addition to the Azure portal, you can also use Azure PowerShell, Azure CLI, and REST API. To learn other deployment methods, see [Deploy templates](../azure-resource-manager/templates/deploy-powershell.md).
78
+
1. Select **Create**. You'll see a notification confirming when the dashboard has been deployed successfully.
84
79
85
80
## Review deployed resources
86
81
@@ -94,7 +89,8 @@ If you want to remove the VM and associated dashboard, delete the resource group
94
89
95
90
1. On the **SimpleWinVmResourceGroup** page, select **Delete resource group**, enter the resource group name to confirm, then select **Delete**.
> Deleting a resource group will delete all of the resources contained within it. If the resource group contains additional resources aside from your virtual machine and dashboard, those resources will also be deleted.
Copy file name to clipboardExpand all lines: articles/azure-portal/quickstart-portal-dashboard-azure-cli.md
+29-34Lines changed: 29 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,115 +3,107 @@ title: Create an Azure portal dashboard with Azure CLI
3
3
description: "Quickstart: Learn how to create a dashboard in the Azure portal using the Azure CLI. A dashboard is a focused and organized view of your cloud resources."
# Quickstart: Create an Azure portal dashboard with Azure CLI
10
10
11
-
A dashboard in the Azure portal is a focused and organized view of your cloud resources. This
12
-
article focuses on the process of using Azure CLI to create a dashboard.
13
-
The dashboard shows the performance of a virtual machine (VM), as well as some static information
14
-
and links.
11
+
A dashboard in the Azure portal is a focused and organized view of your cloud resources. This article shows you how to use Azure CLI to create a dashboard. In this example, the dashboard shows the performance of a virtual machine (VM), as well as some static information and links.
15
12
13
+
- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
- If you have multiple Azure subscriptions, choose the appropriate subscription in which to bill the resources.
20
-
Select a subscription by using the [az account set](/cli/azure/account#az_account_set) command:
18
+
Select a subscription by using the [az account set](/cli/azure/account#az-account-set) command:
21
19
22
20
```azurecli
23
21
az account set --subscription 00000000-0000-0000-0000-000000000000
24
22
```
25
23
26
-
- Create an [Azure resource group](../azure-resource-manager/management/overview.md) by using the [az group create](/cli/azure/group#az_group_create) command or use an existing resource group:
24
+
- Create an [Azure resource group](../azure-resource-manager/management/overview.md#resource-groups) by using the [az group create](/cli/azure/group#az-group-create) command (or use an existing resource group):
27
25
28
26
```azurecli
29
27
az group create --name myResourceGroup --location centralus
30
28
```
31
29
32
-
A resource group is a logical container in which Azure resources are deployed and managed as a group.
33
-
34
30
## Create a virtual machine
35
31
36
-
Create a virtual machine by using the [az vm create](/cli/azure/vm#az_vm_create) command:
32
+
Create a virtual machine by using the [az vm create](/cli/azure/vm#az-vm-create) command:
37
33
38
34
```azurecli
39
-
az vm create --resource-group myResourceGroup --name SimpleWinVM --image win2016datacenter \
35
+
az vm create --resource-group myResourceGroup --name myVM1 --image win2016datacenter \
> It's not, for example, the account you use to sign in to Azure.
47
-
> For more information, see [username requirements](../virtual-machines/windows/faq.yml#what-are-the-username-requirements-when-creating-a-vm-)
40
+
> This is a new username and password (not the account you use to sign in to Azure). The password must be complex. For more information, see [username requirements](../virtual-machines/windows/faq.yml#what-are-the-username-requirements-when-creating-a-vm-)
48
41
and [password requirements](../virtual-machines/windows/faq.yml#what-are-the-password-requirements-when-creating-a-vm-).
49
42
50
43
The deployment starts and typically takes a few minutes to complete.
51
-
After deployment completes, move on to the next section.
52
44
53
45
## Download the dashboard template
54
46
55
-
Since Azure dashboards are resources, they can be represented as JSON.
56
-
For more information, see [The structure of Azure Dashboards](./azure-portal-dashboards-structure.md).
47
+
Since Azure dashboards are resources, they can be represented as JSON. For more information, see [The structure of Azure dashboards](./azure-portal-dashboards-structure.md).
57
48
58
-
Download the following file:[portal-dashboard-template-testvm.json](https://raw.githubusercontent.com/Azure/azure-docs-powershell-samples/master/azure-portal/portal-dashboard-template-testvm.json).
49
+
Download the file [portal-dashboard-template-testvm.json](https://raw.githubusercontent.com/Azure/azure-docs-powershell-samples/master/azure-portal/portal-dashboard-template-testvm.json).
59
50
60
-
Customize the downloaded template by changing the following values to your values:
51
+
Then, customize the downloaded template file by changing the following to your values:
61
52
62
-
*`<subscriptionID>`: Your subscription
63
-
*`<rgName>`: Resource group, for example `myResourceGroup`
64
-
*`<vmName>`: Virtual machine name, for example `SimpleWinVM`
65
-
*`<dashboardTitle>`: Dashboard title, for example `Simple VM Dashboard`
66
-
*`<location>`: Your Azure region, for example,`centralus`
53
+
-`<subscriptionID>`: Your subscription
54
+
-`<rgName>`: Resource group, for example `myResourceGroup`
55
+
-`<vmName>`: Virtual machine name, for example `myVM1`
56
+
-`<dashboardTitle>`: Dashboard title, for example `Simple VM Dashboard`
57
+
-`<location>`: Your Azure region, for example `centralus`
67
58
68
59
For more information, see [Microsoft portal dashboards template reference](/azure/templates/microsoft.portal/dashboards).
69
60
70
61
## Deploy the dashboard template
71
62
72
63
You can now deploy the template from within Azure CLI.
73
64
74
-
1. Run the [az portal dashboard create](/cli/azure/portal/dashboard#az_portal_dashboard_create) command to deploy the template:
65
+
1. Run the [az portal dashboard create](/cli/azure/portal/dashboard#az-portal-dashboard-create) command to deploy the template:
75
66
76
67
```azurecli
77
68
az portal dashboard create --resource-group myResourceGroup --name 'Simple VM Dashboard' \
1. Check that the dashboard was created successfully by running the [az portal dashboard show](/cli/azure/portal/dashboard#az_portal_dashboard_show) command:
72
+
1. Check that the dashboard was created successfully by running the [az portal dashboard show](/cli/azure/portal/dashboard#az-portal-dashboard-show) command:
82
73
83
74
```azurecli
84
75
az portal dashboard show --resource-group myResourceGroup --name 'Simple VM Dashboard'
85
76
```
86
77
87
-
To see all the dashboards for the current subscription, use [az portal dashboard list](/cli/azure/portal/dashboard#az_portal_dashboard_list):
78
+
To see all the dashboards for the current subscription, use [az portal dashboard list](/cli/azure/portal/dashboard#az-portal-dashboard-list):
88
79
89
80
```azurecli
90
81
az portal dashboard list
91
82
```
92
83
93
-
You can also see all the dashboards for a resource group:
84
+
You can also see all the dashboards for a specific resource group:
94
85
95
86
```azurecli
96
87
az portal dashboard list --resource-group myResourceGroup
97
88
```
98
89
99
-
You can update a dashboard by using the [az portal dashboard update](/cli/azure/portal/dashboard#az_portal_dashboard_update) command:
90
+
To update a dashboard, use the [az portal dashboard update](/cli/azure/portal/dashboard#az-portal-dashboard-update) command:
100
91
101
92
```azurecli
102
93
az portal dashboard update --resource-group myResourceGroup --name 'Simple VM Dashboard' \
To remove the virtual machine and associated dashboard, delete the resource group that contains them.
103
+
To remove the virtual machine and associated dashboard that you created, delete the resource group that contains them.
111
104
112
105
> [!CAUTION]
113
-
> The following example deletes the specified resource group and all resources contained within it.
114
-
> If resources outside the scope of this article exist in the specified resource group, they will also be deleted.
106
+
> Deleting the resource group will delete all of the resources contained within it. If the resource group contains additional resources aside from your virtual machine and dashboard, those resources will also be deleted.
115
107
116
108
```azurecli
117
109
az group delete --name myResourceGroup
@@ -125,4 +117,7 @@ az portal dashboard delete --resource-group myResourceGroup --name "Simple VM Da
125
117
126
118
## Next steps
127
119
128
-
For more information about Azure CLI support for dashboards, see [az portal dashboard](/cli/azure/portal/dashboard).
120
+
For more information about Azure CLI commands for dashboards, see:
121
+
122
+
> [!div class="nextstepaction"]
123
+
> [Azure CLI: az portal dashboard](/cli/azure/portal/dashboard).
0 commit comments