Skip to content

Commit c5077b5

Browse files
[Doc-a-thon] Updating boot-diagnostics.md to remove Ubuntu
Removing ubuntu specific image details from the ARM template, make them generic
1 parent 8e08aaf commit c5077b5

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

articles/virtual-machines/boot-diagnostics.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,15 @@ ms.reviewer: mattmcinnes
1717
Boot diagnostics is a debugging feature for Azure virtual machines (VM) that allows diagnosis of VM boot failures. Boot diagnostics enables a user to observe the state of their VM as it is booting up by collecting serial log information and screenshots.
1818

1919
## Boot diagnostics storage account
20+
2021
When you create a VM in Azure portal, boot diagnostics is enabled by default. The recommended boot diagnostics experience is to use a managed storage account, as it yields significant performance improvements in the time to create an Azure VM. An Azure managed storage account is used, removing the time it takes to create a user storage account to store the boot diagnostics data.
2122

2223
> [!IMPORTANT]
2324
> The boot diagnostics data blobs (which comprise of logs and snapshot images) are stored in a managed storage account. Customers will be charged only on used GiBs by the blobs, not on the disk's provisioned size. The snapshot meters will be used for billing of the managed storage account. Because the managed accounts are created on either Standard LRS or Standard ZRS, customers will be charged at $0.05/GB per month for the size of their diagnostic data blobs only. For more information on this pricing, see [Managed disks pricing](https://azure.microsoft.com/pricing/details/managed-disks/). Customers see this charge tied to their VM resource URI.
2425
2526
An alternative boot diagnostic experience is to use a custom storage account. A user can either create a new storage account or use an existing one. When the storage firewall is enabled on the custom storage account (**Enabled from all networks** option isn't selected), you must:
2627

27-
- Make sure that access through the storage firewall is allowed for the Azure platform to publish the screenshot and serial log. To do this, go to the custom boot diagnostics storage account in the Azure portal and then select **Networking** from the **Security + networking** section. Check if the **Allow Azure services on the trusted services list to access this storage account** checkbox is selected.
28+
- Make sure that access through the storage firewall is allowed for the Azure platform to publish the screenshot and serial log. To do this, go to the custom boot diagnostics storage account in the Azure portal and then select **Networking** from the **Security + networking** section. Check if the **Allow Azure services on the trusted services list to access this storage account** checkbox is selected.
2829

2930
- Allow storage firewall for users to view the boot screenshots or serial logs. To do this, add your network or the client/browser's Internet IPs as firewall exclusions. For more information, see [Configure Azure Storage firewalls and virtual networks](../storage/common/storage-network-security.md).
3031

@@ -34,26 +35,32 @@ To configure the storage firewall for Azure Serial Console, see [Use Serial Cons
3435
> The custom storage account associated with boot diagnostics requires the storage account and the associated virtual machines reside in the same region and subscription.
3536
3637
## Boot diagnostics view
38+
3739
Go to the virtual machine blade in the Azure portal, the boot diagnostics option is under the *Support and Troubleshooting* section in the Azure portal. Selecting boot diagnostics display a screenshot and serial log information. The serial log contains kernel messaging and the screenshot is a snapshot of your VMs current state. Based on if the VM is running Windows or Linux determines what the expected screenshot would look like. For Windows, users see a desktop background and for Linux, users see a login prompt.
3840

3941
:::image type="content" source="./media/boot-diagnostics/boot-diagnostics-linux.png" alt-text="Screenshot of Linux boot diagnostics":::
4042
:::image type="content" source="./media/boot-diagnostics/boot-diagnostics-windows.png" alt-text="Screenshot of Windows boot diagnostics":::
4143

42-
## Enable managed boot diagnostics
44+
## Enable managed boot diagnostics
45+
4346
Managed boot diagnostics can be enabled through the Azure portal, CLI and ARM Templates.
4447

4548
### Enable managed boot diagnostics using the Azure portal
49+
4650
When you create a VM in the Azure portal, the default setting is to have boot diagnostics enabled using a managed storage account. Navigate to the *Management* tab during the VM creation to view it.
4751

4852
:::image type="content" source="./media/boot-diagnostics/boot-diagnostics-enable-portal.png" alt-text="Screenshot enabling managed boot diagnostics during VM creation.":::
4953

5054
### Enable managed boot diagnostics using CLI
55+
5156
Boot diagnostics with a managed storage account is supported in Azure CLI 2.12.0 and later. If you don't input a name or URI for a storage account, a managed account is used. For more information and code samples, see the [CLI documentation for boot diagnostics](/cli/azure/vm/boot-diagnostics).
5257

5358
### Enable managed boot diagnostics using PowerShell
59+
5460
Boot diagnostics with a managed storage account is supported in Azure PowerShell 6.6.0 and later. If you don't input a name or URI for a storage account, a managed account is used. For more information and code samples, see the [PowerShell documentation for boot diagnostics](/powershell/module/az.compute/set-azvmbootdiagnostic).
5561

5662
### Enable managed boot diagnostics using Azure Resource Manager (ARM) templates
63+
5764
Everything after API version 2020-06-01 supports managed boot diagnostics. For more information, see [boot diagnostics instance view](/rest/api/compute/virtualmachines/createorupdate#bootdiagnostics).
5865

5966
```ARM Template
@@ -76,10 +83,10 @@ Everything after API version 2020-06-01 supports managed boot diagnostics. For m
7683
}
7784
},
7885
"imageReference": {
79-
"publisher": "Canonical",
80-
"offer": "UbuntuServer",
81-
"sku": "18.04-LTS",
82-
"version": "latest"
86+
"publisher": "publisherName",
87+
"offer": "imageOffer",
88+
"sku": "imageSKU",
89+
"version": "imageVersion"
8390
}
8491
},
8592
"networkProfile": {
@@ -107,7 +114,11 @@ Everything after API version 2020-06-01 supports managed boot diagnostics. For m
107114
108115
```
109116

117+
> [!NOTE]
118+
> Replace publisherName, imageOffer, imageSKU and imageVersion accordingly.
119+
110120
## Limitations
121+
111122
- Managed boot diagnostics is only available for Azure Resource Manager VMs.
112123
- Managed boot diagnostics doesn't support VMs using unmanaged OS disks.
113124
- Boot diagnostics doesn't support premium storage accounts or zone redundant storage accounts. If either of these are used for boot diagnostics users receive an `StorageAccountTypeNotSupported` error when starting the VM.

0 commit comments

Comments
 (0)