Skip to content

Commit 4e36752

Browse files
committed
content review and updates
1 parent 6fef328 commit 4e36752

File tree

7 files changed

+84
-45
lines changed

7 files changed

+84
-45
lines changed

articles/azure-resource-manager/troubleshooting/create-troubleshooting-template.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Create a troubleshooting template
33
description: Describes how to create a template to troubleshoot Azure resource deployed with Azure Resource Manager templates (ARM templates) or Bicep files.
44
tags: top-support-issue
55
ms.topic: troubleshooting
6-
ms.date: 11/02/2021
6+
ms.date: 09/14/2022
77
---
88

99
# Create a troubleshooting template
@@ -32,7 +32,7 @@ The following ARM template and Bicep file get information from an existing stora
3232
"resources": [],
3333
"outputs": {
3434
"exampleOutput": {
35-
"value": "[reference(resourceId(parameters('storageResourceGroup'), 'Microsoft.Storage/storageAccounts', parameters('storageName')), '2021-04-01')]",
35+
"value": "[reference(resourceId(parameters('storageResourceGroup'), 'Microsoft.Storage/storageAccounts', parameters('storageName')), '2022-05-01')]",
3636
"type": "object"
3737
}
3838
}
@@ -44,7 +44,7 @@ In Bicep, use the `existing` keyword and run the deployment from the resource gr
4444
```bicep
4545
param storageName string
4646
47-
resource stg 'Microsoft.Storage/storageAccounts@2021-04-01' existing = {
47+
resource stg 'Microsoft.Storage/storageAccounts@2022-05-01' existing = {
4848
name: storageName
4949
}
5050

articles/azure-resource-manager/troubleshooting/enable-debug-logging.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Enable debug logging
33
description: Describes how to enable debug logging to troubleshoot Azure resources deployed with Bicep files or Azure Resource Manager templates (ARM templates).
44
tags: top-support-issue
55
ms.topic: troubleshooting
6-
ms.date: 06/20/2022
6+
ms.date: 09/14/2022
77
ms.custom: devx-track-azurepowershell
88
---
99

@@ -47,7 +47,7 @@ The `DeploymentDebugLogLevel` parameter is available for other deployment scopes
4747

4848
# [Azure CLI](#tab/azure-cli)
4949

50-
You can't enable debug logging with Azure CLI but you can get debug logging data using the `request` and `response` properties.
50+
You can't enable debug logging with Azure CLI but you can get the debug log's data using the `request` and `response` properties.
5151

5252

5353
---

articles/azure-resource-manager/troubleshooting/find-error-code.md

Lines changed: 42 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Find error codes
33
description: Describes how to find error codes to troubleshoot Azure resources deployed with Azure Resource Manager templates (ARM templates) or Bicep files.
44
tags: top-support-issue
55
ms.topic: troubleshooting
6-
ms.date: 05/16/2022
6+
ms.date: 09/14/2022
77
ms.custom: devx-track-azurepowershell
88
---
99

@@ -15,17 +15,17 @@ When an Azure resource deployment fails using Azure Resource Manager templates (
1515

1616
There are three types of errors that are related to a deployment:
1717

18-
- **Validation errors** occur before a deployment begins and are caused by syntax errors in your file. Your editor can identify these errors.
18+
- **Validation errors** occur before a deployment begins and are caused by syntax errors in your file. A code editor like Visual Studio Code can identify these errors.
1919
- **Preflight validation errors** occur when a deployment command is run but resources aren't deployed. These errors are found without starting the deployment. For example, if a parameter value is incorrect, the error is found in preflight validation.
20-
- **Deployment errors** occur during the deployment process and can only be found by assessing the deployment's progress.
20+
- **Deployment errors** occur during the deployment process and can only be found by assessing the deployment's progress in your Azure environment.
2121

2222
All types of errors return an error code that you use to troubleshoot the deployment. Validation and preflight errors are shown in the activity log but don't appear in your deployment history. A Bicep file with syntax errors doesn't compile into JSON and isn't shown in the activity log.
2323

2424
To identify syntax errors, you can use [Visual Studio Code](https://code.visualstudio.com) with the latest [Bicep extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-bicep) or [Azure Resource Manager Tools extension](https://marketplace.visualstudio.com/items?itemName=msazurermtools.azurerm-vscode-tools).
2525

2626
## Validation errors
2727

28-
Templates are validated during the deployment process and error codes are displayed. Before you run a deployment, you can run validation tests with Azure PowerShell or Azure CLI to identify validation and preflight errors.
28+
Templates are validated during the deployment process and error codes are displayed. Before you run a deployment, you can identify validation and preflight errors by running validation tests with Azure PowerShell or Azure CLI.
2929

3030
# [Portal](#tab/azure-portal)
3131

@@ -70,11 +70,15 @@ bicep build main.bicep
7070
unexpected new line character.
7171
```
7272

73-
There are more PowerShell cmdlets available to validate deployment templates:
73+
### Other scopes
7474

75-
- [Test-AzDeployment](/powershell/module/az.resources/test-azdeployment) for subscription level deployments.
76-
- [Test-AzManagementGroupDeployment](/powershell/module/az.resources/test-azmanagementgroupdeployment)
77-
- [Test-AzTenantDeployment](/powershell/module/az.resources/test-aztenantdeployment)
75+
There are Azure PowerShell cmdlets to validate deployment templates for the subscription, management group, and tenant scopes.
76+
77+
| Scope | Cmdlets |
78+
| ---- | ---- |
79+
| Subscription | [Test-AzDeployment](/powershell/module/az.resources/test-azdeployment) |
80+
| Management group | [Test-AzManagementGroupDeployment](/powershell/module/az.resources/test-azmanagementgroupdeployment) |
81+
| Tenant | [Test-AzTenantDeployment](/powershell/module/az.resources/test-aztenantdeployment) |
7882

7983
# [Azure CLI](#tab/azure-cli)
8084

@@ -102,11 +106,16 @@ az deployment group validate \
102106
unexpected new line character.
103107
```
104108

105-
There are more Azure CLI commands available to validate deployment templates:
109+
### Other scopes
110+
111+
There are Azure CLI commands to validate deployment templates for the subscription, management group, and tenant scopes.
112+
113+
| Scope | Commands |
114+
| ---- | ---- |
115+
| Subscription | [az deployment sub validate](/cli/azure/deployment/sub#az-deployment-sub-validate) |
116+
| Management group | [az deployment mg validate](/cli/azure/deployment/mg#az-deployment-mg-validate) |
117+
| Tenant | [az deployment tenant validate](/cli/azure/deployment/tenant#az-deployment-tenant-validate) |
106118

107-
- [az deployment sub validate](/cli/azure/deployment/sub#az-deployment-sub-validate)
108-
- [az deployment mg validate](/cli/azure/deployment/mg#az-deployment-mg-validate)
109-
- [az deployment tenant validate](/cli/azure/deployment/tenant#az-deployment-tenant-validate)
110119

111120
---
112121

@@ -169,6 +178,17 @@ Get-AzResourceGroupDeployment `
169178
-ResourceGroupName examplegroup
170179
```
171180

181+
### Other scopes
182+
183+
There are Azure PowerShell cmdlets to get deployment information for the subscription, management group, and tenant scopes.
184+
185+
| Scope | Cmdlets |
186+
| ---- | ---- |
187+
| Subscription | [Get-AzDeploymentOperation](/powershell/module/az.resources/get-azdeploymentoperation) <br> [Get-AzDeployment](/powershell/module/az.resources/get-azdeployment) |
188+
| Management group | [Get-AzManagementGroupDeploymentOperation](/powershell/module/az.resources/get-azmanagementgroupdeploymentoperation) <br> [Get-AzManagementGroupDeployment](/powershell/module/az.resources/get-azmanagementgroupdeployment) |
189+
| Tenant | [Get-AzTenantDeploymentOperation](/powershell/module/az.resources/get-aztenantdeploymentoperation) <br> [Get-AzTenantDeployment](/powershell/module/az.resources/get-aztenantdeployment) |
190+
191+
172192
# [Azure CLI](#tab/azure-cli)
173193

174194
To see a deployment's operations messages with Azure CLI, use [az deployment operation group list](/cli/azure/deployment/operation/group#az-deployment-operation-group-list).
@@ -199,6 +219,16 @@ az deployment group show \
199219
--name exampledeployment
200220
```
201221

222+
### Other scopes
223+
224+
There are Azure CLI commands to get deployment information for the subscription, management group, and tenant scopes.
225+
226+
| Scope | Commands |
227+
| ---- | ---- |
228+
| Subscription | [az deployment operation sub list](/cli/azure/deployment/operation/sub#az-deployment-operation-sub-list) <br> [az deployment sub show](/cli/azure/deployment/sub#az-deployment-sub-show) |
229+
| Management group | [az deployment operation mg list](/cli/azure/deployment/operation/mg#az-deployment-operation-mg-list) <br> [az deployment mg show](/cli/azure/deployment/mg#az-deployment-mg-show) |
230+
| Tenant | [az deployment operation tenant list](/cli/azure/deployment/operation/tenant#az-deployment-operation-tenant-list) <br> [az deployment tenant show](/cli/azure/deployment/tenant#az-deployment-tenant-show) |
231+
202232
---
203233

204234
## Next steps

articles/azure-resource-manager/troubleshooting/index.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
### YamlMime:Landing
22

33
title: Deployment troubleshooting documentation
4-
summary: Troubleshoot Azure deployments for Azure Resource Manager templates and Bicep files.
4+
summary: Troubleshoot Azure deployments for Bicep files and Azure Resource Manager templates.
55

66
metadata:
77
title: Deployment troubleshooting documentation
8-
description: "Learn how to troubleshoot deployments for Azure Resource Manager templates and Bicep files."
8+
description: "Learn how to troubleshoot deployments for Bicep files and Azure Resource Manager templates."
99
services: azure-resource-manager
1010
ms.service: azure-resource-manager
1111
ms.subservice: troubleshooting
1212
ms.topic: landing-page
1313
ms.collection: na
14-
author: mumian
15-
ms.author: jgao
16-
ms.date: 12/08/2021
14+
author: davidsmatlak
15+
ms.author: davidsmatlak
16+
ms.date: 09/14/2022
1717

1818
# linkListType: architecture | concept | deploy | download | get-started | how-to-guide | learn | overview | quickstart | reference | tutorial | video | whats-new
1919

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,49 @@
11
---
2-
title: Overview of ARM template and Bicep file troubleshooting
3-
description: Describes troubleshooting for Azure resource deployment with Azure Resource Manager templates (ARM templates) and Bicep files.
2+
title: Overview of deployment troubleshooting for Bicep files and ARM templates
3+
description: Describes deployment troubleshooting when you use Bicep files or Azure Resource Manager templates (ARM templates) to deploy Azure resources.
44
ms.topic: overview
5-
ms.date: 10/26/2021
5+
ms.date: 09/14/2022
66
ms.custom: troubleshooting-overview
77
---
88

99
# What is deployment troubleshooting?
1010

11-
When you deploy Bicep files or Azure Resource Manager templates (ARM templates), you may get an error. This documentation helps you find possible solutions for the error.
11+
When you deploy Azure resources with Bicep files or Azure Resource Manager templates (ARM templates), you may get an error. There are troubleshooting tools available to help you resolve syntax errors before deployment. You can get more information about error codes and deployment errors from the Azure portal, Azure PowerShell, and Azure CLI. This documentation helps you find solutions to troubleshoot errors.
1212

1313
## Error types
1414

15-
There are two types of errors you can get - **validation errors** and **deployment errors**.
15+
Validation errors occur before a deployment begins and are caused by incorrect syntax that can be identified by a code editor like Visual Studio Code. For example, a misspelled property name or a function that's missing an argument.
1616

17-
Validation errors happen before the deployment is started. These errors can be determined without interacting with your current Azure environment. For example, validation makes you aware of syntax errors or missing arguments for a function before your deployment starts.
17+
Preflight validation errors occur when a deployment command is run but resources aren't deployed in Azure. For example, if an incorrect parameter value is used, the deployment command returns an error message.
1818

1919
Deployment errors can only be determined by attempting the deployment and interacting with your Azure environment. For example, a virtual machine (VM) requires a network interface card (NIC). If the NIC doesn't exist when the VM is deployed, you get a deployment error.
2020

2121
## Troubleshooting tools
2222

23-
To help identify syntax errors before a deployment, use the latest version of [Visual Studio Code](https://code.visualstudio.com). Install the latest version of either:
23+
There are several troubleshooting tools available to resolve errors.
2424

25-
* [Bicep extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-bicep)
26-
* [Azure Resource Manager Tools extension](https://marketplace.visualstudio.com/items?itemName=msazurermtools.azurerm-vscode-tools)
25+
### Syntax errors
2726

28-
To troubleshoot deployments, it's helpful to learn about a resource provider's properties or API versions. For more information, see [Define resources with Bicep and ARM templates](/azure/templates).
27+
To help identify syntax errors before a deployment, use the latest version of [Visual Studio Code](https://code.visualstudio.com). Install the latest version of the extension for Bicep or ARM templates.
28+
29+
- [Bicep](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-bicep)
30+
- [Azure Resource Manager Tools](https://marketplace.visualstudio.com/items?itemName=msazurermtools.azurerm-vscode-tools)
31+
32+
To follow best practices for developing your deployment templates, use the following tools:
2933

30-
To follow best practices for developing your templates, use either:
34+
- [Bicep linter](../bicep/linter.md)
35+
- [ARM template test toolkit](../templates/test-toolkit.md)
36+
37+
### Resource provider and API version
38+
39+
To troubleshoot deployments, it's helpful to learn about a resource provider's properties or API versions. For more information, see [Define resources with Bicep and ARM templates](/azure/templates).
3140

32-
* [Bicep linter](../bicep/linter.md)
33-
* [ARM template test toolkit](../templates/test-toolkit.md)
41+
### Error details
3442

3543
When you deploy, you can find the cause of errors from the Azure portal in a resource group's **Deployments** or **Activity log**. If you're using Azure PowerShell, use commands like [Get-AzResourceGroupDeploymentOperation](/powershell/module/az.resources/get-azresourcegroupdeploymentoperation) and [Get-AzActivityLog](/powershell/module/az.monitor/get-azactivitylog). For Azure CLI, use commands like [az deployment operation group](/cli/azure/deployment/operation/group) and [az monitor activity-log list](/cli/azure/monitor/activity-log#az-monitor-activity-log-list).
3644

3745
## Next steps
3846

47+
- To learn more about how to find deployment error codes and troubleshoot deployment problems, see [Find error codes](find-error-code.md).
3948
- For solutions based on the error code, see [Troubleshoot common Azure deployment errors](common-deployment-errors.md).
40-
- For an introduction to finding the error code, see [Quickstart: Troubleshoot ARM template deployments](quickstart-troubleshoot-arm-deployment.md) or [Quickstart: Troubleshoot Bicep file deployments](quickstart-troubleshoot-bicep-deployment.md).
49+
- For an introduction to finding the error code, see [Quickstart: Troubleshoot ARM template JSON deployments](quickstart-troubleshoot-arm-deployment.md) or [Quickstart: Troubleshoot Bicep file deployments](quickstart-troubleshoot-bicep-deployment.md).

articles/azure-resource-manager/troubleshooting/quickstart-troubleshoot-arm-deployment.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Troubleshoot ARM template JSON deployments
33
description: Learn how to troubleshoot Azure Resource Manager template (ARM template) JSON deployments.
4-
ms.date: 12/08/2021
4+
ms.date: 09/14/2022
55
ms.topic: quickstart
66
ms.custom: devx-track-azurepowershell, mode-arm
77
---
@@ -14,9 +14,9 @@ This quickstart describes how to troubleshoot Azure Resource Manager template (A
1414

1515
There are three types of errors that are related to a deployment:
1616

17-
- **Validation errors** occur before a deployment begins and are caused by syntax errors in your file. Your editor can identify these errors.
17+
- **Validation errors** occur before a deployment begins and are caused by syntax errors in your file. A code editor like Visual Studio Code can identify these errors.
1818
- **Preflight validation errors** occur when a deployment command is run but resources aren't deployed. These errors are found without starting the deployment. For example, if a parameter value is incorrect, the error is found in preflight validation.
19-
- **Deployment errors** occur during the deployment process and can only be found by assessing the deployment's progress.
19+
- **Deployment errors** occur during the deployment process and can only be found by assessing the deployment's progress in your Azure environment.
2020

2121
All types of errors return an error code that you use to troubleshoot the deployment. Validation and preflight errors are shown in the activity log but don't appear in your deployment history.
2222

@@ -142,7 +142,7 @@ The template fails preflight validation and the deployment isn't run. The `prefi
142142

143143
Storage names must be between 3 and 24 characters and use only lowercase letters and numbers. The prefix value created an invalid storage name. For more information, see [Resolve errors for storage account names](error-storage-account-name.md). To fix the preflight error, use a prefix that's 11 characters or less and contains only lowercase letters or numbers.
144144

145-
Because the deployment didn't run there's no deployment history.
145+
Because the deployment didn't run, there's no deployment history.
146146

147147
:::image type="content" source="media/quickstart-troubleshoot-arm-deployment/preflight-no-deploy.png" alt-text="Screenshot of resource group overview that shows no deployment for preflight error.":::
148148

@@ -180,7 +180,7 @@ The deployment begins and is visible in the deployment history. The deployment f
180180

181181
:::image type="content" source="media/quickstart-troubleshoot-arm-deployment/deployment-failed.png" alt-text="Screenshot of resource group overview that shows a failed deployment.":::
182182

183-
To fix the deployment error you would change the reference function to use a valid resource. For more information, see [Resolve resource not found errors](error-not-found.md). For this quickstart, delete the comma that precedes `vnetResult` and all of `vnetResult`. Save the file and rerun the deployment.
183+
To fix the deployment error, change the reference function to use a valid resource. For more information, see [Resolve resource not found errors](error-not-found.md). For this quickstart, delete the comma that precedes `vnetResult` and all of `vnetResult`. Save the file and rerun the deployment.
184184

185185
```json
186186
"vnetResult": {

0 commit comments

Comments
 (0)