How can I troubleshoot Azure ARM template validation errors?

Question

I have made some small changes to an Azure ARM template file and now when I try to deploy or validate via the xplat cli I get this message.

error: InvalidTemplateDeployment : The template deployment 'fakedDeploymentName' is not valid according to the validation procedure. The tracking id is '\some kind of GUID here\'. See inner errors for details. Please see http://aka.ms/arm-deploy for usage details.

error: PreflightValidationCheckFailed : Preflight validation failed. Please refer to the details for the specific errors.

I would love to troubleshoot this problem, but I don't see any "inner errors" on the console. It even gives me a unique GUID each time, implying that I could use this GUID to look up a more informative message. Where can I view a more detailed error? (not looking for help on the real source of the error yet)

Answer 1

Make sure you're running the latest version of the CLI, we're working on bubbling up the detailed error. If that's still not catching it, let us know https://github.com/Azure/azure-xplat-cli/issues

Then if the log isn't showing you the detail, run the deployment with the -vv switch, the detailed debug output (while verbose) will have all the error messages and you can usually sift through and find the specific failure.

azure group deployment create ... --debug

Powershell:

New-AzResourceGroupDeployment ... -debug

Answer 2

Log into the azure portal portal.azure.com.

Open the Activity log

Find the record with Operation Name of Validate in the list of activities. It should have a red exclamation mark because it failed.

Click on it that record. Then click on the JSON tab at the bottom. Get reading and somewhere deep down in returned Json you might find an error in the statusMessage such as "The storage account named helloworld is already taken."

Answer 3

Run the following PowerShell Azure cmdlet with the tracking ID supplied:

Get-AzureRMLog -CorrelationId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -DetailedOutput

Answer 4

Building on nftw's answer...

To make it faster/easier to find the error issue I used grep and less with a variable as follows:

$correlationId ='xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' # store your correlation ID here
Get-AzureRmLog -CorrelationId $correlationID -DetailedOutput | grep -C 10 $correlationID | less

In my testing the error was close to the top of the output. You could use less and the forward-slash key / and search "error" to find the error even quicker.

Answer 5

I believe that tracking ID is for technical support for looking at their logs, not for the user. Regarding your exact question, you need to take a look at logs - reference.

Another good way to validate the template is to use Resource Explorer.

Answer 6

Building on @nftw:

$deploymentGroupName = 'deploymentGroupName'
$correlationId = ((Get-AzureRMLog -ResourceGroup $deploymentGroupName)[0]).CorrelationId
$logentry = (Get-AzureRMLog -CorrelationId $correlationId -DetailedOutput)
#$logentry
$rawStatusMessage = $logentry.Properties
$status = $rawStatusMessage.Content.statusMessage | ConvertFrom-Json
$status.error.details
$status.error.details.details

Answer 7

I was running in the same issue. Basically, I couldn't get any details passed "InvalidTemplateDeployment".

I added my ARM template in a Visual Studio: Azure Resource Group project template and tried to deploy it. I got verbose details in the Output tab. That helped me solve my problem.

In my case it was the name of the cluster, it can only be small letters and numbers.

Answer 8

az vm list [--only-show-errors]
           [--resource-group]
           [--show-details]
           [--subscription]