Skip to content

Commit 1a3b312

Browse files
committed
On branch edburns-msft-96155-jsonc-mention Apply suggestion from @tfitzmack
modified: articles/azure-resource-manager/templates/best-practices.md modified: articles/azure-resource-manager/templates/deploy-cli.md Signed-off-by: Ed Burns <[email protected]>
1 parent 638c03a commit 1a3b312

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

articles/azure-resource-manager/templates/best-practices.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,8 @@ The following information can be helpful when you work with [resources](./syntax
204204
]
205205
```
206206

207+
For more details about comments and metadata see [Understand the structure and syntax of ARM templates](/azure/azure-resource-manager/templates/syntax#comments-and-metadata).
208+
207209
* If you use a *public endpoint* in your template (such as an Azure Blob storage public endpoint), *don't hard-code* the namespace. Use the `reference` function to dynamically retrieve the namespace. You can use this approach to deploy the template to different public namespace environments without manually changing the endpoint in the template. Set the API version to the same version that you're using for the storage account in your template.
208210

209211
```json
@@ -289,7 +291,7 @@ The following information can be helpful when you work with [resources](./syntax
289291

290292
## Comments
291293

292-
In addition to the `comments` property, if your ARM template is stored in a `.jsonc` file, comments using the `//` syntax are supported.
294+
In addition to the `comments` property, if your ARM template is stored in a `.jsonc` file, comments using the `//` syntax are supported. For more details about comments and metadata see [Understand the structure and syntax of ARM templates](/azure/azure-resource-manager/templates/syntax#comments-and-metadata).
293295

294296
## Use test toolkit
295297

articles/azure-resource-manager/templates/deploy-cli.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ az deployment group create \
7979
--parameters storageAccountType=Standard_GRS
8080
```
8181

82-
The value of the `--template-file` parameter must be a Bicep file or a `.json` or `.jsonc` file. The `.jsonc` file extension indicates the file can contain `//` style comments.
82+
The value of the `--template-file` parameter must be a Bicep file or a `.json` or `.jsonc` file. The `.jsonc` file extension indicates the file can contain `//` style comments. For more details about comments and metadata see [Understand the structure and syntax of ARM templates](/azure/azure-resource-manager/templates/syntax#comments-and-metadata).
8383

8484
The Azure deployment template can take a few minutes to complete. When it finishes, you see a message that includes the result:
8585

@@ -281,6 +281,7 @@ az deployment group create \
281281
--template-file storage.json \
282282
--parameters '@storage.parameters.jsonc'
283283
```
284+
For more details about comments and metadata see [Understand the structure and syntax of ARM templates](/azure/azure-resource-manager/templates/syntax#comments-and-metadata).
284285

285286
If you are using Azure CLI with version 2.3.0 or older, you can deploy a template with multi-line strings or comments using the `--handle-extended-json-format` switch. For example:
286287

0 commit comments

Comments
 (0)