Skip to content

Commit 6cad790

Browse files
authored
Merge pull request #287440 from mumian/0926-arm-freshness
refresh ARM template content
2 parents 8003a81 + ea58d7e commit 6cad790

18 files changed

+52
-54
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Best practices for templates
33
description: Describes recommended approaches for authoring Azure Resource Manager templates (ARM templates). Offers suggestions to avoid common problems when using templates.
44
ms.topic: best-practice
55
ms.custom: devx-track-arm-template
6-
ms.date: 09/25/2024
6+
ms.date: 09/26/2024
77
---
88
# ARM template best practices
99

@@ -206,7 +206,7 @@ The following information can be helpful when you work with [resources](./syntax
206206
]
207207
```
208208

209-
For more details about comments and metadata see [Understand the structure and syntax of ARM templates](./syntax.md#comments-and-metadata).
209+
For more details about comments and metadata, see [Understand the structure and syntax of ARM templates](./syntax.md#comments-and-metadata).
210210

211211
* 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.
212212

@@ -293,11 +293,11 @@ The following information can be helpful when you work with [resources](./syntax
293293

294294
## Comments
295295

296-
In addition to the `comments` property, comments using the `//` syntax are supported. For more details about comments and metadata see [Understand the structure and syntax of ARM templates](./syntax.md#comments-and-metadata). You may choose to save JSON files that contain `//` comments using the `.jsonc` file extension, to indicate the JSON file contains comments. The ARM service will also accept comments in any JSON file including parameters files.
296+
In addition to the `comments` property, comments using the `//` syntax are supported. For more details about comments and metadata, see [Understand the structure and syntax of ARM templates](./syntax.md#comments-and-metadata). You may choose to save JSON files that contain `//` comments using the `.jsonc` file extension, to indicate the JSON file contains comments. The ARM service will also accept comments in any JSON file including parameters files.
297297

298298
## Visual Studio Code ARM Tools
299299

300-
Working with ARM templates is much easier with the Azure Resource Manager (ARM) Tools for Visual Studio Code. This extension provides language support, resource snippets, and resource auto-completion to help you create and validate Azure Resource Manager templates. To learn more and install the extension, see [Azure Resource Manager (ARM) Tools](https://marketplace.visualstudio.com/items?itemName=msazurermtools.azurerm-vscode-tools).
300+
Working with ARM templates is easier with the Azure Resource Manager (ARM) Tools for Visual Studio Code. This extension provides language support, resource snippets, and resource auto-completion to help you create and validate Azure Resource Manager templates. To learn more and install the extension, see [Azure Resource Manager (ARM) Tools](https://marketplace.visualstudio.com/items?itemName=msazurermtools.azurerm-vscode-tools).
301301

302302
## Use test toolkit
303303

articles/azure-resource-manager/templates/copy-resources.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Deploy multiple instances of resources
33
description: Use copy operation and arrays in an Azure Resource Manager template (ARM template) to deploy resource type many times.
44
ms.topic: how-to
55
ms.custom: devx-track-arm-template
6-
ms.date: 08/30/2023
6+
ms.date: 09/26/2024
77
---
88

99
# Resource iteration in ARM templates
@@ -14,7 +14,6 @@ You can also use copy loop with [properties](copy-properties.md), [variables](co
1414

1515
If you need to specify whether a resource is deployed at all, see [condition element](conditional-resource-deployment.md).
1616

17-
1817
> [!TIP]
1918
> We recommend [Bicep](../bicep/overview.md) because it offers the same capabilities as ARM templates and the syntax is easier to use. To learn more, see [loops](../bicep/loops.md).
2019

articles/azure-resource-manager/templates/definitions.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Type definitions in templates
33
description: Describes how to create type definitions in an Azure Resource Manager template (ARM template).
44
ms.topic: conceptual
55
ms.custom: devx-track-arm-template
6-
ms.date: 08/22/2023
6+
ms.date: 09/26/2024
77
---
88

99
# Type definitions in ARM templates
@@ -348,7 +348,6 @@ If the value is true, elements of the array whose index is greater than the larg
348348

349349
The nullable constraint indicates that the value may be `null` or omitted. See [Properties](#properties) for an example.
350350

351-
352351
## Description
353352

354353
You can add a description to a type definition to help users of your template understand the value to provide.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Azure deployment templates with Azure CLI – Azure Resource Manager | Microsoft Docs
33
description: Use Azure Resource Manager and Azure CLI to create and deploy resource groups to Azure. The resources are defined in an Azure deployment template.
44
ms.topic: how-to
5-
ms.date: 10/10/2023
5+
ms.date: 09/26/2024
66
ms.custom: devx-track-azurecli, seo-azure-cli, devx-track-arm-template
77
keywords: azure cli deploy arm template, create resource group azure, azure deployment template, deployment resources, arm template, azure arm template
88
---

articles/azure-resource-manager/templates/deploy-github-actions.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Deploy Resource Manager templates by using GitHub Actions
33
description: Describes how to deploy Azure Resource Manager templates (ARM templates) by using GitHub Actions.
44
ms.topic: how-to
5-
ms.date: 06/23/2023
5+
ms.date: 09/26/2024
66
ms.custom: github-actions-azure, devx-track-arm-template
77
---
88

@@ -46,7 +46,7 @@ Add a Resource Manager template to your GitHub repository. This template creates
4646
https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.storage/storage-account-create/azuredeploy.json
4747
```
4848

49-
You can put the file anywhere in the repository. The workflow sample in the next section assumes the template file is named **azuredeploy.json**, and it is stored at the root of your repository.
49+
You can put the file anywhere in the repository. The workflow sample in the next section assumes the template file is named **azuredeploy.json**, and it's stored at the root of your repository.
5050

5151
## Create workflow
5252

@@ -94,7 +94,7 @@ The workflow file must be stored in the **.github/workflows** folder at the root
9494
The first section of the workflow file includes:
9595

9696
- **name**: The name of the workflow.
97-
- **on**: The name of the GitHub events that triggers the workflow. The workflow is trigger when there is a push event on the main branch, which modifies at least one of the two files specified. The two files are the workflow file and the template file.
97+
- **on**: The name of the GitHub events that triggers the workflow. The workflow is trigger when there's a push event on the main branch, which modifies at least one of the two files specified. The two files are the workflow file and the template file.
9898

9999
# [OpenID Connect](#tab/openid)
100100

@@ -135,7 +135,7 @@ The workflow file must be stored in the **.github/workflows** folder at the root
135135
The first section of the workflow file includes:
136136

137137
- **name**: The name of the workflow.
138-
- **on**: The name of the GitHub events that triggers the workflow. The workflow is trigger when there is a push event on the main branch, which modifies at least one of the two files specified. The two files are the workflow file and the template file.
138+
- **on**: The name of the GitHub events that triggers the workflow. The workflow is trigger when there's a push event on the main branch, which modifies at least one of the two files specified. The two files are the workflow file and the template file.
139139
---
140140

141141
1. Select **Start commit**.
@@ -146,7 +146,7 @@ Because the workflow is configured to be triggered by either the workflow file o
146146

147147
## Check workflow status
148148

149-
1. Select the **Actions** tab. You will see a **Create deployStorageAccount.yml** workflow listed. It takes 1-2 minutes to run the workflow.
149+
1. Select the **Actions** tab. You see a **Create deployStorageAccount.yml** workflow listed. It takes 1-2 minutes to run the workflow.
150150
1. Select the workflow to open it.
151151
1. Select **Run ARM deploy** from the menu to verify the deployment.
152152

articles/azure-resource-manager/templates/deployment-tutorial-linked-template.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Tutorial - Deploy a linked template
33
description: Learn how to deploy a linked template
4-
ms.date: 10/05/2023
4+
ms.date: 09/26/2024
55
ms.topic: tutorial
66
ms.custom: devx-track-azurepowershell
77
---
@@ -26,7 +26,7 @@ You can separate the storage account resource into a linked template:
2626

2727
:::code language="json" source="~/resourcemanager-templates/get-started-deployment/linked-template/linkedStorageAccount.json":::
2828

29-
The following template is the main template. The highlighted `Microsoft.Resources/deployments` object shows how to call a linked template. The linked template cannot be stored as a local file or a file that is only available on your local network. You can either provide a URI value of the linked template that includes either HTTP or HTTPS, or use the _relativePath_ property to deploy a remote linked template at a location relative to the parent template. One option is to place both the main template and the linked template in a storage account.
29+
The following template is the main template. The highlighted `Microsoft.Resources/deployments` object shows how to call a linked template. The linked template can't be stored as a local file or a file that is only available on your local network. You can either provide a URI value of the linked template that includes either HTTP or HTTPS, or use the _relativePath_ property to deploy a remote linked template at a location relative to the parent template. One option is to place both the main template and the linked template in a storage account.
3030

3131
:::code language="json" source="~/resourcemanager-templates/get-started-deployment/linked-template/azuredeploy.json" highlight="34-52":::
3232

@@ -95,7 +95,7 @@ Write-Host "Press [ENTER] to continue ..."
9595

9696
## Deploy template
9797

98-
To deploy templates in a storage account, generate a SAS token and supply it to the _-QueryString_ parameter. Set the expiry time to allow enough time to complete the deployment. The blobs containing the templates are accessible to only the account owner. However, when you create a SAS token for a blob, the blob is accessible to anyone with that SAS token. If another user intercepts the URI and the SAS token, that user is able to access the template. A SAS token is a good way of limiting access to your templates, but you should not include sensitive data like passwords directly in the template.
98+
To deploy templates in a storage account, generate a SAS token and supply it to the _-QueryString_ parameter. Set the expiry time to allow enough time to complete the deployment. The blobs containing the templates are accessible to only the account owner. However, when you create a SAS token for a blob, the blob is accessible to anyone with that SAS token. If another user intercepts the URI and the SAS token, that user is able to access the template. A SAS token is a good way of limiting access to your templates, but you shouldn't include sensitive data like passwords directly in the template.
9999

100100
If you haven't created the resource group, see [Create resource group](./deployment-tutorial-local-template.md#create-resource-group).
101101

articles/azure-resource-manager/templates/deployment-tutorial-local-template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Tutorial - Deploy a local Azure Resource Manager template
33
description: Learn how to deploy an Azure Resource Manager template (ARM template) from your local computer
4-
ms.date: 10/05/2023
4+
ms.date: 09/26/2024
55
ms.topic: tutorial
66
ms.custom: devx-track-arm-template
77
---

articles/azure-resource-manager/templates/deployment-tutorial-pipeline.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Continuous integration with Azure Pipelines
33
description: Learn how to continuously build, test, and deploy Azure Resource Manager templates (ARM templates).
4-
ms.date: 06/20/2024
4+
ms.date: 09/26/2024
55
ms.topic: tutorial
66
ms.custom: devx-track-arm-template
77
---

articles/azure-resource-manager/templates/linked-templates.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Link templates for deployment
33
description: Describes how to use linked templates in an Azure Resource Manager template (ARM template) to create a modular template solution. Shows how to pass parameters values, specify a parameter file, and dynamically created URLs.
44
ms.topic: conceptual
5-
ms.date: 08/22/2023
5+
ms.date: 09/26/2024
66
ms.custom: devx-track-azurepowershell, devx-track-arm-template
77
---
88

@@ -94,7 +94,7 @@ The following example deploys a storage account through a nested template.
9494
}
9595
```
9696

97-
[Nested resources](./child-resource-name-type.md#within-parent-resource) can't be used in a [symbolic name](./resource-declaration.md#use-symbolic-name) template. In the following template, the nested storage account resource cannot use symbolic name:
97+
[Nested resources](./child-resource-name-type.md#within-parent-resource) can't be used in a [symbolic name](./resource-declaration.md#use-symbolic-name) template. In the following template, the nested storage account resource can't use symbolic name:
9898

9999
```json
100100
{
@@ -643,7 +643,7 @@ az deployment group create \
643643

644644
---
645645

646-
Make sure there is no leading "?" in QueryString. The deployment adds one when assembling the URI for the deployments.
646+
Make sure there's no leading "?" in QueryString. The deployment adds one when assembling the URI for the deployments.
647647

648648
## Template specs
649649

articles/azure-resource-manager/templates/parameter-file-test-cases.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Parameter file test cases for Azure Resource Manager test toolkit
33
description: Describes the parameter file tests that are run by the Azure Resource Manager template test toolkit.
44
ms.topic: conceptual
55
ms.custom: devx-track-arm-template
6-
ms.date: 06/23/2023
6+
ms.date: 09/26/2024
77
---
88

99
# Test cases for parameter files

0 commit comments

Comments
 (0)