Skip to content

Commit bcda33b

Browse files
authored
Merge pull request #184943 from JnHs/jh-portal-cliqref
review and refresh quickstart
2 parents ac55c45 + 9642fd0 commit bcda33b

12 files changed

+66
-95
lines changed

articles/azure-portal/azure-portal-markdown-tile.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ You can add a markdown tile to your Azure dashboards to display custom, static c
1414

1515
1. Select **Dashboard** from the Azure portal menu.
1616

17-
1817
1. In the dashboard view, select the dashboard where the custom markdown tile should appear, then select **Edit**.
1918

2019
![Screenshot showing dashboard edit view](./media/azure-portal-markdown-tile/azure-portal-dashboard-edit.png)
-680 Bytes
Loading
Binary file not shown.
8.91 KB
Loading
Binary file not shown.
946 Bytes
Loading

articles/azure-portal/quick-create-template.md

Lines changed: 20 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Create an Azure portal dashboard by using an Azure Resource Manager templ
33
description: Learn how to create an Azure portal dashboard by using an Azure Resource Manager template.
44
ms.topic: quickstart
55
ms.custom: subject-armqs, mode-arm
6-
ms.date: 03/15/2021
6+
ms.date: 01/13/2022
77
---
88

99
# 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
1818

1919
## Prerequisites
2020

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).
2322

2423
## Create a virtual machine
2524

2625
The dashboard you create in the next part of this quickstart requires an existing VM. Create a VM by following these steps.
2726

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.
2928

30-
![Select Cloud shell from the Azure portal ribbon](media/quick-create-template/cloud-shell.png)
29+
:::image type="content" source="media/quick-create-template/cloud-shell.png" alt-text="Screenshot showing the Cloud Shell option in the Azure portal.":::
3130

3231
1. In the **Cloud Shell** window, select **PowerShell**.
3332

34-
![Select PowerShell in the terminal window](media/quick-create-template/powershell.png)
33+
:::image type="content" source="media/quick-create-template/powershell.png" alt-text="Screenshot showing the PowerShell option in Cloud Shell.":::
3534

3635
1. Copy the following command and enter it at the command prompt to create a resource group.
3736

3837
```powershell
3938
New-AzResourceGroup -Name SimpleWinVmResourceGroup -Location EastUS
4039
```
4140
42-
![Copy a command into the command prompt](media/quick-create-template/command-prompt.png)
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.
4542
4643
```powershell
4744
New-AzVm `
4845
-ResourceGroupName "SimpleWinVmResourceGroup" `
49-
-Name "SimpleWinVm" `
46+
-Name "myVM1" `
5047
-Location "East US"
5148
```
5249
5350
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-).
5451
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.
5653
5754
## Review the template
5855
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.
6057
6158
## Deploy the template
6259
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+
6362
1. Select the following image to sign in to Azure and open a template.
6463
6564
[![Deploy to Azure](../media/template-deployments/deploy-to-azure.svg)](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)
6665
6766
1. Select or enter the following values, then select **Review + create**.
6867
69-
![ARM template, create dashboard, deploy portal](media/quick-create-template/create-dashboard-using-template-portal.png)
68+
:::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.":::
7069
7170
Unless it's specified, use the default values to create the dashboard.
7271
73-
* **Subscription**: select an Azure subscription.
74-
* **Resource group**: select **SimpleWinVmResourceGroup**.
75-
* **Location**: select **East US**.
76-
* **Virtual Machine Name**: enter **SimpleWinVm**.
77-
* **Virtual Machine Resource Group**: enter **SimpleWinVmResourceGroup**.
78-
79-
1. Select **Create** or **Purchase**. After the dashboard has been deployed successfully, you get a notification:
80-
81-
![ARM template, create dashboard, deploy portal notification](media/quick-create-template/resource-manager-template-portal-deployment-notification.png)
72+
- **Subscription**: select the Azure subscription.
73+
- **Resource group**: select **SimpleWinVmResourceGroup**.
74+
- **Location**: If not automatically selected, choose **East US**.
75+
- **Virtual Machine Name**: enter **myVM1**.
76+
- **Virtual Machine Resource Group**: enter **SimpleWinVmResourceGroup**.
8277
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.
8479
8580
## Review deployed resources
8681
@@ -94,7 +89,8 @@ If you want to remove the VM and associated dashboard, delete the resource group
9489
9590
1. On the **SimpleWinVmResourceGroup** page, select **Delete resource group**, enter the resource group name to confirm, then select **Delete**.
9691
97-
![Delete resource group](media/quick-create-template/delete-resource-group.png)
92+
> [!CAUTION]
93+
> 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.
9894
9995
## Next steps
10096

articles/azure-portal/quickstart-portal-dashboard-azure-cli.md

Lines changed: 29 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -3,115 +3,107 @@ title: Create an Azure portal dashboard with Azure CLI
33
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."
44
ms.topic: quickstart
55
ms.custom: devx-track-azurepowershell, devx-track-azurecli, mode-api
6-
ms.date: 12/4/2020
6+
ms.date: 01/13/2022
77
---
88

99
# Quickstart: Create an Azure portal dashboard with Azure CLI
1010

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.
1512

13+
- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
1614

1715
[!INCLUDE [azure-cli-prepare-your-environment.md](../../includes/azure-cli-prepare-your-environment.md)]
1816

1917
- 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:
2119

2220
```azurecli
2321
az account set --subscription 00000000-0000-0000-0000-000000000000
2422
```
2523

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):
2725

2826
```azurecli
2927
az group create --name myResourceGroup --location centralus
3028
```
3129

32-
A resource group is a logical container in which Azure resources are deployed and managed as a group.
33-
3430
## Create a virtual machine
3531

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:
3733

3834
```azurecli
39-
az vm create --resource-group myResourceGroup --name SimpleWinVM --image win2016datacenter \
35+
az vm create --resource-group myResourceGroup --name myVM1 --image win2016datacenter \
4036
--admin-username azureuser --admin-password 1StrongPassword$
4137
```
4238

4339
> [!Note]
44-
> The password must be complex.
45-
> This is a new user name and password.
46-
> 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-)
4841
and [password requirements](../virtual-machines/windows/faq.yml#what-are-the-password-requirements-when-creating-a-vm-).
4942

5043
The deployment starts and typically takes a few minutes to complete.
51-
After deployment completes, move on to the next section.
5244

5345
## Download the dashboard template
5446

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).
5748

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).
5950

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:
6152

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`
6758

6859
For more information, see [Microsoft portal dashboards template reference](/azure/templates/microsoft.portal/dashboards).
6960

7061
## Deploy the dashboard template
7162

7263
You can now deploy the template from within Azure CLI.
7364

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:
7566

7667
```azurecli
7768
az portal dashboard create --resource-group myResourceGroup --name 'Simple VM Dashboard' \
7869
--input-path portal-dashboard-template-testvm.json --location centralus
7970
```
8071

81-
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:
8273

8374
```azurecli
8475
az portal dashboard show --resource-group myResourceGroup --name 'Simple VM Dashboard'
8576
```
8677

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):
8879

8980
```azurecli
9081
az portal dashboard list
9182
```
9283

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:
9485

9586
```azurecli
9687
az portal dashboard list --resource-group myResourceGroup
9788
```
9889

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:
10091

10192
```azurecli
10293
az portal dashboard update --resource-group myResourceGroup --name 'Simple VM Dashboard' \
10394
--input-path portal-dashboard-template-testvm.json --location centralus
10495
```
10596

97+
## Review deployed resources
98+
10699
[!INCLUDE [azure-portal-review-deployed-resources](../../includes/azure-portal-review-deployed-resources.md)]
107100

108101
## Clean up resources
109102

110-
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.
111104

112105
> [!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.
115107
116108
```azurecli
117109
az group delete --name myResourceGroup
@@ -125,4 +117,7 @@ az portal dashboard delete --resource-group myResourceGroup --name "Simple VM Da
125117

126118
## Next steps
127119

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

Comments
 (0)