Merge pull request #211209 from davidsmatlak/ds-tsdocs-0913

ARM troubleshooting content review

Author: LJSpiller

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

@@ -3,7 +3,7 @@ title: Create a troubleshooting template
 description: Describes how to create a template to troubleshoot Azure resource deployed with Azure Resource Manager templates (ARM templates) or Bicep files.
 tags: top-support-issue
 ms.topic: troubleshooting
-ms.date: 11/02/2021
+ms.date: 09/14/2022
 ---
 
 # Create a troubleshooting template
@@ -32,7 +32,7 @@ The following ARM template and Bicep file get information from an existing stora
   "resources": [],
   "outputs": {
     "exampleOutput": {
-      "value": "[reference(resourceId(parameters('storageResourceGroup'), 'Microsoft.Storage/storageAccounts', parameters('storageName')), '2021-04-01')]",
+      "value": "[reference(resourceId(parameters('storageResourceGroup'), 'Microsoft.Storage/storageAccounts', parameters('storageName')), '2022-05-01')]",
       "type": "object"
     }
   }
@@ -44,7 +44,7 @@ In Bicep, use the `existing` keyword and run the deployment from the resource gr
 ```bicep
 param storageName string
 
-resource stg 'Microsoft.Storage/storageAccounts@2021-04-01' existing = {
+resource stg 'Microsoft.Storage/storageAccounts@2022-05-01' existing = {
   name: storageName
 }
 

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

@@ -3,7 +3,7 @@ title: Enable debug logging
 description: Describes how to enable debug logging to troubleshoot Azure resources deployed with Bicep files or Azure Resource Manager templates (ARM templates).
 tags: top-support-issue
 ms.topic: troubleshooting
-ms.date: 06/20/2022
+ms.date: 09/14/2022
 ms.custom: devx-track-azurepowershell
 ---
 
@@ -47,7 +47,7 @@ The `DeploymentDebugLogLevel` parameter is available for other deployment scopes
 
 # [Azure CLI](#tab/azure-cli)
 
-You can't enable debug logging with Azure CLI but you can get debug logging data using the `request` and `response` properties.
+You can't enable debug logging with Azure CLI but you can get the debug log's data using the `request` and `response` properties.
 
 
 ---

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

@@ -3,7 +3,7 @@ title: Find error codes
 description: Describes how to find error codes to troubleshoot Azure resources deployed with Azure Resource Manager templates (ARM templates) or Bicep files.
 tags: top-support-issue
 ms.topic: troubleshooting
-ms.date: 05/16/2022
+ms.date: 09/14/2022
 ms.custom: devx-track-azurepowershell
 ---
 
@@ -15,17 +15,17 @@ When an Azure resource deployment fails using Azure Resource Manager templates (
 
 There are three types of errors that are related to a deployment:
 
-- **Validation errors** occur before a deployment begins and are caused by syntax errors in your file. Your editor can identify these errors.
+- **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.
 - **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.
-- **Deployment errors** occur during the deployment process and can only be found by assessing the deployment's progress.
+- **Deployment errors** occur during the deployment process and can only be found by assessing the deployment's progress in your Azure environment.
 
 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.
 
 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).
 
 ## Validation errors
 
-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.
+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.
 
 # [Portal](#tab/azure-portal)
 
@@ -70,11 +70,15 @@ bicep build main.bicep
   unexpected new line character.
 ```
 
-There are more PowerShell cmdlets available to validate deployment templates:
+### Other scopes
 
-- [Test-AzDeployment](/powershell/module/az.resources/test-azdeployment) for subscription level deployments.
-- [Test-AzManagementGroupDeployment](/powershell/module/az.resources/test-azmanagementgroupdeployment)
-- [Test-AzTenantDeployment](/powershell/module/az.resources/test-aztenantdeployment)
+There are Azure PowerShell cmdlets to validate deployment templates for the subscription, management group, and tenant scopes.
+
+| Scope | Cmdlets |
+| ---- | ---- |
+| Subscription | [Test-AzDeployment](/powershell/module/az.resources/test-azdeployment) |
+| Management group | [Test-AzManagementGroupDeployment](/powershell/module/az.resources/test-azmanagementgroupdeployment) |
+| Tenant | [Test-AzTenantDeployment](/powershell/module/az.resources/test-aztenantdeployment) |
 
 # [Azure CLI](#tab/azure-cli)
 
@@ -102,11 +106,16 @@ az deployment group validate \
   unexpected new line character.
 ```
 
-There are more Azure CLI commands available to validate deployment templates:
+### Other scopes
+
+There are Azure CLI commands to validate deployment templates for the subscription, management group, and tenant scopes.
+
+| Scope | Commands |
+| ---- | ---- |
+| Subscription | [az deployment sub validate](/cli/azure/deployment/sub#az-deployment-sub-validate) |
+| Management group | [az deployment mg validate](/cli/azure/deployment/mg#az-deployment-mg-validate) |
+| Tenant | [az deployment tenant validate](/cli/azure/deployment/tenant#az-deployment-tenant-validate) |
 
-- [az deployment sub validate](/cli/azure/deployment/sub#az-deployment-sub-validate)
-- [az deployment mg validate](/cli/azure/deployment/mg#az-deployment-mg-validate)
-- [az deployment tenant validate](/cli/azure/deployment/tenant#az-deployment-tenant-validate)
 
 ---
 
@@ -169,6 +178,17 @@ Get-AzResourceGroupDeployment `
   -ResourceGroupName examplegroup
 ```
 
+### Other scopes
+
+There are Azure PowerShell cmdlets to get deployment information for the subscription, management group, and tenant scopes.
+
+| Scope | Cmdlets |
+| ---- | ---- |
+| Subscription | [Get-AzDeploymentOperation](/powershell/module/az.resources/get-azdeploymentoperation) <br> [Get-AzDeployment](/powershell/module/az.resources/get-azdeployment) |
+| Management group | [Get-AzManagementGroupDeploymentOperation](/powershell/module/az.resources/get-azmanagementgroupdeploymentoperation) <br> [Get-AzManagementGroupDeployment](/powershell/module/az.resources/get-azmanagementgroupdeployment) |
+| Tenant | [Get-AzTenantDeploymentOperation](/powershell/module/az.resources/get-aztenantdeploymentoperation) <br> [Get-AzTenantDeployment](/powershell/module/az.resources/get-aztenantdeployment) |
+
+
 # [Azure CLI](#tab/azure-cli)
 
 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 \
   --name exampledeployment
 ```
 
+### Other scopes
+
+There are Azure CLI commands to get deployment information for the subscription, management group, and tenant scopes.
+
+| Scope | Commands |
+| ---- | ---- |
+| 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) |
+| 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) |
+| 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) |
+
 ---
 
 ## Next steps

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

@@ -1,19 +1,19 @@
 ### YamlMime:Landing
 
 title: Deployment troubleshooting documentation
-summary: Troubleshoot Azure deployments for Azure Resource Manager templates and Bicep files.
+summary: Troubleshoot Azure deployments for Bicep files and Azure Resource Manager templates.
 
 metadata:
   title: Deployment troubleshooting documentation
-  description: "Learn how to troubleshoot deployments for Azure Resource Manager templates and Bicep files."
+  description: "Learn how to troubleshoot deployments for Bicep files and Azure Resource Manager templates."
   services: azure-resource-manager
   ms.service: azure-resource-manager
   ms.subservice: troubleshooting
   ms.topic: landing-page
   ms.collection: na
-  author: mumian
-  ms.author: jgao
-  ms.date: 12/08/2021
+  author: davidsmatlak
+  ms.author: davidsmatlak
+  ms.date: 09/14/2022
 
 # linkListType: architecture | concept | deploy | download | get-started | how-to-guide | learn | overview | quickstart | reference | tutorial | video | whats-new
 

articles/azure-resource-manager/troubleshooting/overview.md

@@ -1,40 +1,49 @@
 ---
-title: Overview of ARM template and Bicep file troubleshooting
-description: Describes troubleshooting for Azure resource deployment with Azure Resource Manager templates (ARM templates) and Bicep files.
+title: Overview of deployment troubleshooting for Bicep files and ARM templates
+description: Describes deployment troubleshooting when you use Bicep files or Azure Resource Manager templates (ARM templates) to deploy Azure resources.
 ms.topic: overview
-ms.date: 10/26/2021
+ms.date: 09/14/2022
 ms.custom: troubleshooting-overview
 ---
 
 # What is deployment troubleshooting?
 
-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.
+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.
 
 ## Error types
 
-There are two types of errors you can get - **validation errors** and **deployment errors**.
+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.
 
-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.
+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.
 
 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.
 
 ## Troubleshooting tools
 
-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:
+There are several troubleshooting tools available to resolve errors.
 
-* [Bicep extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-bicep)
-* [Azure Resource Manager Tools extension](https://marketplace.visualstudio.com/items?itemName=msazurermtools.azurerm-vscode-tools)
+### Syntax errors
 
-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).
+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.
+
+- [Bicep](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-bicep)
+- [Azure Resource Manager Tools](https://marketplace.visualstudio.com/items?itemName=msazurermtools.azurerm-vscode-tools)
+
+To follow best practices for developing your deployment templates, use the following tools:
 
-To follow best practices for developing your templates, use either:
+- [Bicep linter](../bicep/linter.md)
+- [ARM template test toolkit](../templates/test-toolkit.md)
+
+### Resource provider and API version
+
+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).
 
-* [Bicep linter](../bicep/linter.md)
-* [ARM template test toolkit](../templates/test-toolkit.md)
+### Error details
 
 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).
 
 ## Next steps
 
+- To learn more about how to find deployment error codes and troubleshoot deployment problems, see [Find error codes](find-error-code.md).
 - For solutions based on the error code, see [Troubleshoot common Azure deployment errors](common-deployment-errors.md).
-- 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).
+- 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

@@ -1,7 +1,7 @@
 ---
 title: Troubleshoot ARM template JSON deployments
 description: Learn how to troubleshoot Azure Resource Manager template (ARM template) JSON deployments.
-ms.date: 12/08/2021
+ms.date: 09/14/2022
 ms.topic: quickstart
 ms.custom: devx-track-azurepowershell, mode-arm
 ---
@@ -14,9 +14,9 @@ This quickstart describes how to troubleshoot Azure Resource Manager template (A
 
 There are three types of errors that are related to a deployment:
 
-- **Validation errors** occur before a deployment begins and are caused by syntax errors in your file. Your editor can identify these errors.
+- **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.
 - **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.
-- **Deployment errors** occur during the deployment process and can only be found by assessing the deployment's progress.
+- **Deployment errors** occur during the deployment process and can only be found by assessing the deployment's progress in your Azure environment.
 
 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.
 
@@ -142,7 +142,7 @@ The template fails preflight validation and the deployment isn't run. The `prefi
 
 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.
 
-Because the deployment didn't run there's no deployment history.
+Because the deployment didn't run, there's no deployment history.
 
 :::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.":::
 
@@ -180,7 +180,7 @@ The deployment begins and is visible in the deployment history. The deployment f
 
 :::image type="content" source="media/quickstart-troubleshoot-arm-deployment/deployment-failed.png" alt-text="Screenshot of resource group overview that shows a failed deployment.":::
 
-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.
+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.
 
 ```json
 "vnetResult": {