Skip to content

Commit b947f6a

Browse files
authored
Merge pull request #107851 from tfitzmac/0316schema
update schema version
2 parents 7ef47ee + 5d6a12c commit b947f6a

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

articles/azure-resource-manager/templates/template-syntax.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,22 @@
22
title: Template structure and syntax
33
description: Describes the structure and properties of Azure Resource Manager templates using declarative JSON syntax.
44
ms.topic: conceptual
5-
ms.date: 02/25/2020
5+
ms.date: 03/16/2020
66
---
77

8-
# Understand the structure and syntax of Azure Resource Manager templates
8+
# Understand the structure and syntax of ARM templates
99

10-
This article describes the structure of an Azure Resource Manager template. It presents the different sections of a template and the properties that are available in those sections.
10+
This article describes the structure of an Azure Resource Manager (ARM) template. It presents the different sections of a template and the properties that are available in those sections.
1111

12-
This article is intended for users who have some familiarity with Resource Manager templates. It provides detailed information about the structure of the template. For a step-by-step tutorial that guides you through the process of creating a template, see [Tutorial: Create and deploy your first Azure Resource Manager template](template-tutorial-create-first-template.md).
12+
This article is intended for users who have some familiarity with ARM templates. It provides detailed information about the structure of the template. For a step-by-step tutorial that guides you through the process of creating a template, see [Tutorial: Create and deploy your first Azure Resource Manager template](template-tutorial-create-first-template.md).
1313

1414
## Template format
1515

1616
In its simplest structure, a template has the following elements:
1717

1818
```json
1919
{
20-
"$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
20+
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
2121
"contentVersion": "",
2222
"apiProfile": "",
2323
"parameters": { },
@@ -30,7 +30,7 @@ In its simplest structure, a template has the following elements:
3030

3131
| Element name | Required | Description |
3232
|:--- |:--- |:--- |
33-
| $schema |Yes |Location of the JSON schema file that describes the version of the template language.<br><br> For resource group deployments, use: `https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#`<br><br>For subscription deployments, use: `https://schema.management.azure.com/schemas/2018-05-01/subscriptionDeploymentTemplate.json#` |
33+
| $schema |Yes |Location of the JSON schema file that describes the version of the template language. The version number you use depends on the scope of the deployment and your JSON editor.<br><br>If you're using [VS Code with the Azure Resource Manager tools extension](use-vs-code-to-create-template.md), use the latest version for resource group deployments:<br>`https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#`<br><br>Other editors (including Visual Studio) may not be able to process this schema. For those editors, use:<br>`https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#`<br><br>For subscription deployments, use:<br>`https://schema.management.azure.com/schemas/2018-05-01/subscriptionDeploymentTemplate.json#`<br><br>For management group deployments, use:<br>`https://schema.management.azure.com/schemas/2019-08-01/managementGroupDeploymentTemplate.json#`<br><br>For tenant deployments, use:<br>`https://schema.management.azure.com/schemas/2019-08-01/tenantDeploymentTemplate.json#` |
3434
| contentVersion |Yes |Version of the template (such as 1.0.0.0). You can provide any value for this element. Use this value to document significant changes in your template. When deploying resources using the template, this value can be used to make sure that the right template is being used. |
3535
| apiProfile |No | An API version that serves as a collection of API versions for resource types. Use this value to avoid having to specify API versions for each resource in the template. When you specify an API profile version and don't specify an API version for the resource type, Resource Manager uses the API version for that resource type that is defined in the profile.<br><br>The API profile property is especially helpful when deploying a template to different environments, such as Azure Stack and global Azure. Use the API profile version to make sure your template automatically uses versions that are supported in both environments. For a list of the current API profile versions and the resources API versions defined in the profile, see [API Profile](https://github.com/Azure/azure-rest-api-specs/tree/master/profile).<br><br>For more information, see [Track versions using API profiles](templates-cloud-consistency.md#track-versions-using-api-profiles). |
3636
| [parameters](#parameters) |No |Values that are provided when deployment is executed to customize resource deployment. |

0 commit comments

Comments
 (0)