az deployment group create error message was insufficient.

[lovettchris]

Describe the bug

I had some square brackets missing in my ARM template and the deployment failed with an obscure error message.

The problem is the error does not include the "invalid computer name" value that I was trying to set. This bug was hard to find because my template contained:

"virtualMachineComputerName": "parameters('virtualMachineName')",

instead of

"virtualMachineComputerName": "[parameters('virtualMachineName')]",

If the error had shown the string "parameters('virtualMachineName')" as the invalid computer name I would have known instantly how to fix it. It would be awesome if the error message could be improved to include this information.

Related command

az deployment group create

Errors

{"status":"Failed","error":{"code":"DeploymentFailed","target":"/subscriptions/0533c3bf-0d48-47d3-8002-7d58f1ff38f0/resourceGroups/GCRIaaSLoanT4p2/providers/Microsoft.Resources/deployments/gamevm_deployment_windows11_template","message":"At least one resource deployment operation failed. Please list deployment operations for details. Please see https://aka.ms/arm-deployment-operations for usage details.","details":[{"code":"InvalidParameter","target":"computerName","message":"Windows computer name cannot be more than 15 characters long, be entirely numeric, or contain the following characters: ` ~ ! @ # $ % ^ & * ( ) = + _ [ ] { } \ | ; : . ' " , < > / ?."}]}}

Issue script & Debug output

same as Errors

Expected behavior

A better error.

Environment Summary

azure-cli 2.55.0 *

core 2.55.0 *
telemetry 1.1.0
Extensions:
account 0.2.5
azure-devops 0.26.0
bastion 0.2.5
ssh 2.0.2
storage-preview 1.0.0b1

Dependencies:
msal 1.24.0b2
azure-mgmt-resource 23.1.0b2

Python location 'C:\Program Files\Microsoft SDKs\Azure\CLI2\python.exe'
Extensions directory 'C:\Users\clovett.REDMOND.azure\cliextensions'

Python (Windows) 3.11.5 (tags/v3.11.5:cce6ba9, Aug 24 2023, 14:38:34) [MSC v.1936 64 bit (AMD64)]

Additional context

No response

[azure-client-tools-bot-prd]

Hi @lovettchris,

2.55.0 is not the latest Azure CLI(2.61.0).

If you haven't already attempted to do so, please upgrade to the latest Azure CLI version by following https://learn.microsoft.com/en-us/cli/azure/update-azure-cli.

[azure-client-tools-bot-prd]

Hi @lovettchris
Find similar issue #22434.

Issue title	Deployments failing on App GW NSG rule validation after initial deployment
Create time	2022-05-13
Comment number	7

---

Please confirm if this resolves your issue.

[yonzhan]

Thank you for opening this issue, we will look into it.

[microsoft-github-policy-service]

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @Azure/deployments-owners.