You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: includes/resource-manager-quickstart-introduction.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -6,4 +6,4 @@ ms.date: 02/26/2020
6
6
ms.author: jgao
7
7
---
8
8
9
-
[Resource Manager template](/azure/azure-resource-manager/templates/overview) is a JavaScript Object Notation (JSON) file that defines the infrastructure and configuration for your project. The template uses declarative syntax, which lets you state what you intend to deploy without having to write the sequence of programming commands to create it. If you want to learn more about developing Resource Manager templates, see [Resource Manager documentation](/azure/azure-resource-manager/) and the [template reference](/azure/templates).
9
+
A [Resource Manager template](/azure/azure-resource-manager/templates/overview) is a JavaScript Object Notation (JSON) file that defines the infrastructure and configuration for your project. The template uses declarative syntax, which lets you state what you intend to deploy without having to write the sequence of programming commands to create it. If you want to learn more about developing Resource Manager templates, see [Resource Manager documentation](/azure/azure-resource-manager/) and the [template reference](/azure/templates).
Copy file name to clipboardExpand all lines: markdown templates/arm-template/quickstart-resource-manager-template.md
+43-20
Original file line number
Diff line number
Diff line change
@@ -14,37 +14,49 @@ ms.date: 03/17/22
14
14
15
15
# The H1 heading must include words "Resource Manager template"
16
16
17
-
<!-- The second paragraph must be the following include file. You might need to change the file path of the include file depending on your content structure. This include is a paragraph that consistently introduces ARM concepts before doing a deployment and includes all our desired links to ARM content.-->
17
+
<!--
18
+
The second paragraph must be the following include file. You might need to change the file path of the include file depending on your content structure. This include is a paragraph that consistently introduces ARM concepts before doing a deployment and includes all our desired links to ARM content.-->
<!-- If your service has prerequisites you can include the free account link in that section. -->
22
23
23
24
If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
24
25
25
-
## Prerequisites
26
+
<!--
27
+
The final paragraph explains that readers who are experienced with templates can continue to the deployment.
26
28
27
-
<!-- If there aren't any prerequisites, just place "None" in the section. -->
29
+
For information about the button image and how to create the template's URI, see the section "Deploy the template" for Portal.
30
+
-->
28
31
29
-
## Create a ...
32
+
If your environment meets the prerequisites and you're familiar with using Azure Resource Manager templates, select the **Deploy to Azure** button. The template will open in the Azure portal.
30
33
31
-
<!-- The second H2 must start with "Create a". For example, 'Create a Key Vault', 'Create a virtual machine', etc. -->
34
+
[](https://portal.azure.com/#create/Microsoft.Template/uri/<template's URI>)
32
35
33
-
### Review the template
36
+
##Prerequisites
34
37
35
-
<!-- The first sentence must be the following sentence. Use a link to the quickstart gallery that begins with https://azure.microsoft.com/resources/templates/. -->
38
+
<!-- If there aren't any prerequisites, just place "None" in the section. -->
39
+
40
+
## Review the template
41
+
42
+
<!--
43
+
The first sentence must be the following sentence. Use a link to the quickstart gallery that begins with https://azure.microsoft.com/resources/templates/.
44
+
-->
36
45
37
46
The template used in this quickstart is from [Azure Quickstart Templates]().
38
47
39
-
<!-- After the first sentence, add a JSON code fence that links to the quickstart template. Customers have provided feedback that they prefer to see the whole template. We recommend you include the entire template in your article. If your template is too long to show in the quickstart (more than 250 lines), you can instead add a sentence that says - `The template for this article is too long to show here. To view the template, see [azuredeploy.json](link to template's raw output)`.
48
+
<!--
49
+
After the first sentence, add a JSON code fence that links to the quickstart template. Customers have provided feedback that they prefer to see the whole template. We recommend you include the entire template in your article. If your template is too long to show in the quickstart (more than 250 lines), you can instead add a sentence that says - `The template for this article is too long to show here. To view the template, see [azuredeploy.json](link to template's raw output)`.
<!-- For visibility, use highlight for the template's "resources": section. -->
46
57
47
-
<!-- After the JSON code fence, a list of each resourceType from the JSON must exist with a link to the template reference starting with /azure/templates. List the resourceType links in the same order as in the template.
58
+
<!--
59
+
After the JSON code fence, a list of each resourceType from the JSON must exist with a link to the template reference starting with /azure/templates. List the resourceType links in the same order as in the template.
48
60
49
61
For example:
50
62
@@ -57,16 +69,20 @@ The URL usually appears as, for example, https://docs.microsoft.com/en-us/azure/
57
69
*[Azure resource type](link to the template reference)
58
70
*[Azure resource type](link to the template reference)
59
71
60
-
<!-- List additional quickstart templates. For example: [Azure Quickstart Templates](https://azure.microsoft.com/resources/templates/?resourceType=Microsoft.Keyvault&pageNumber=1&sort=Popular).
72
+
<!--
73
+
List additional quickstart templates. For example: [Azure Quickstart Templates](https://azure.microsoft.com/resources/templates/?resourceType=Microsoft.Keyvault&pageNumber=1&sort=Popular).
61
74
Notice the resourceType and sort elements in the URL.
62
75
-->
63
76
64
-
###Deploy the template
77
+
## Deploy the template
65
78
66
79
<!--
67
80
One of the following options must be included:
68
81
69
-
- **CLI**: In an Azure CLI Interactive code fence must contain **az deployment group create**. For example:
82
+
- **CLI**: In an Azure CLI interactive code fence must contain **az deployment group create**.
83
+
- Use Azure CLI version 2.6 or later. To display the version: az --version
84
+
85
+
For example:
70
86
71
87
```azurecli-interactive
72
88
read -p "Enter a project name that is used for generating resource names:" projectName &&
@@ -79,7 +95,7 @@ Notice the resourceType and sort elements in the URL.
79
95
read
80
96
```
81
97
82
-
- **PowerShell**: In an Azure PowerShell Interactive code fence must contain **New-AzResourceGroupDeployment**. For example:
98
+
- **PowerShell**: In an Azure PowerShell interactive code fence must contain **New-AzResourceGroupDeployment**. For example:
83
99
84
100
```azurepowershell-interactive
85
101
$projectName = Read-Host -Prompt "Enter a project name that is used for generating resource names"
@@ -100,20 +116,26 @@ Notice the resourceType and sort elements in the URL.
100
116
[](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2F101-key-vault-create%2Fazuredeploy.json)
101
117
```
102
118
103
-
The shared button image is in [GitHub](https://github.com/MicrosoftDocs/azure-docs-pr/blob/master/articles/media/template-deployments/deploy-to-azure.svg). To find more information about this deployment option, see [Use a deployment button to deploy templates from GitHub repository](https://docs.microsoft.com/azure/azure-resource-manager/templates/deploy-to-azure-button).
119
+
To find more information about this deployment option, see [Use a deployment button to deploy templates from GitHub repository](https://docs.microsoft.com/azure/azure-resource-manager/templates/deploy-to-azure-button).
120
+
121
+
The shared button image is in [GitHub](https://github.com/MicrosoftDocs/azure-docs-pr/blob/master/articles/media/template-deployments/deploy-to-azure.svg).
104
122
-->
105
123
106
124
## Review deployed resources
107
125
108
-
<!--You can also use the title "Validate the deployment". -->
126
+
<!--This heading must be titled "Review deployed resources" or "Validate the deployment". -->
109
127
110
-
<!-- Include a portal screenshot of the resources or use interactive Azure CLI and Azure PowerShell commands to show the deployed resources. -->
128
+
<!--
129
+
Include at least one method that displays the deployed resources. Use a portal screenshot of the resources, or interactive code fences for Azure CLI (`azurecli-interactive`) or Azure PowerShell (`azurepowershell-interactive`).
130
+
-->
111
131
112
132
You can either use the Azure portal to check the deployed resources, or use Azure CLI or Azure PowerShell script to list the deployed resources.
113
133
114
134
## Clean up resources
115
135
116
-
<!-- Include a paragraph that explains how to delete unneeded resources. Add a portal screenshot or use interactive Azure CLI and Azure PowerShell commands to clean up the resources. -->
136
+
<!--
137
+
The Clean up resources section includes a paragraph that explains how to delete unneeded resources. Include at least one method that shows how to clean up resources. Use a portal screenshot, or interactive code fences for Azure CLI (`azurecli-interactive`) or Azure PowerShell (`azurepowershell-interactive`).
138
+
-->
117
139
118
140
When no longer needed, delete the resource group, which deletes the resources in the resource group.
119
141
@@ -140,9 +162,10 @@ Write-Host "Press [ENTER] to continue..."
140
162
141
163
## Next steps
142
164
143
-
<!-- You can either make the next steps similar to the next steps in your other quickstarts, or point users to the following tutorial.
165
+
<!--
166
+
Make the next steps similar to other quickstarts and use a blue button to link to the next article for your service. Or direct readers to the article: "Tutorial: Create and deploy your first Azure Resource Manager template" to follow the process of creating a template.
144
167
145
-
If you want to include links to more information about the service, it's acceptable to use a paragraph and bullet points.
168
+
To include additional links for more information about the service, it's acceptable to use a paragraph and bullet points.
146
169
-->
147
170
148
171
For a step-by-step tutorial that guides you through the process of creating a template, see:
0 commit comments