Reputation: 1262

Reference docs for Azure Resource Templates

I am looking for reference docs for the Azure Resource Manager JSON templates. Does anyone know if there is reference material for these templates?

There is general reference for required parameters etc like at Create a template deployment.

I am basically looking for the full availability so I can correspond setup on the portal to the JSON template. Also availability of features with apiVersion releases. I remember there being a MSDN documentation for the changelog with api version releases but cannot find it now.

Upvotes: 7

Answers (6)

Damien Pontifex

Reputation: 1262

Microsoft has finally created what I was looking for 🎉: full documentation is now available at https://learn.microsoft.com/en-au/azure/templates/

Upvotes: 2

Thibault Deheurles

Reputation: 1269

To my mind we can dig that way:

open the azure-resource-manager schemas
Look at the main form below:
If you open properties, you will find the format that we need to fill:
open parameters and look at the structure:
$ref: #/definitions/parameter invite us to look at the same documents in definitions.parameters where you will find some documentation (like value you can use etc):

finally, if you look to properties.resources, you will find a list of url like:
- { "$ref": "http://schema.management.azure.com/schemas/2015-07-01-preview/Microsoft.ServerManagement.json#/resourceDefinitions/node" }
- { "$ref": "http://schema.management.azure.com/schemas/2015-07-01-preview/Microsoft.ServerManagement.json#/resourceDefinitions/gateway" }
if you open one of these url, you will find the JSON format you are looking for (here is a part of the first one):

Upvotes: 2

AndyHerb

Reputation: 700

All of the ARM templates can be found on GitHub here: https://github.com/Azure/azure-resource-manager-schemas.

It includes preview templates and should provide all the information you're after to determine which features are present in which apiVersion release.

Upvotes: 4

NoOneSpecial

Reputation: 755

There is not much available...

Azure Resource Manager Template Language
https://azure.microsoft.com/en-us/documentation/articles/resource-group-authoring-templates/

And then you can look at the different json.schemas that I have managed to find

deploymentTemplate
http://schema.management.azure.com/schemas/2014-04-01-preview/deploymentTemplate.json

visualstudio
http://schema.management.azure.com/schemas/2014-02-26/microsoft.visualstudio.json

Sql
http://schema.management.azure.com/schemas/2014-06-01/2014-04-01-preview/Microsoft.Sql.json

Web
http://schema.management.azure.com/schemas/2014-06-01/Microsoft.Web.json

deploymentParameters
http://schema.management.azure.com/schemas/2014-04-01-preview/deploymentParameters.json

If you use Visual Studio to edit the json-template file you get intellisense (sometimes) which help a bit. But the lack of documentation is really annoying...for example I have no clue if the schemas listed above are the most recent or not, and I have no idea where to find which one is the most resent.

Edit: I came across the list of additions and changes to the Service Management APIs. Seems to be a bit outdated, 2015-01-01 is the current version and it's not there.

Edit2: With the Iaas updates at Build 2015, there seems to also be a lot of Azure Quickstart Templates. At minimum, they have the particular cases I was looking for with storage accounts.

Upvotes: 1