Skip to content

Commit 5a0de83

Browse files
authored
Merge pull request #192060 from davidsmatlak/ds-bicep-links-0316
Adds Bicep links
2 parents c5b6f87 + 538ab0a commit 5a0de83

File tree

10 files changed

+48
-5
lines changed

10 files changed

+48
-5
lines changed

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ This article shows you how to create more than one value for an output in your A
1111

1212
You can also use copy loop with [resources](copy-resources.md), [properties in a resource](copy-properties.md), and [variables](copy-variables.md).
1313

14+
> [!TIP]
15+
> 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).
16+
1417
## Syntax
1518

1619
Add the `copy` element to the output section of your template to return a number of items. The copy element has the following general format:
@@ -167,4 +170,4 @@ The preceding example returns an array with the following values:
167170
- [Property iteration in ARM templates](copy-properties.md)
168171
- [Variable iteration in ARM templates](copy-variables.md)
169172
- If you want to learn about the sections of a template, see [Understand the structure and syntax of ARM templates](./syntax.md).
170-
- To learn how to deploy your template, see [Deploy resources with ARM templates and Azure PowerShell](deploy-powershell.md).
173+
- To learn how to deploy your template, see [Deploy resources with ARM templates and Azure PowerShell](deploy-powershell.md).

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ You can only use copy loop with top-level resources, even when applying copy loo
1313

1414
You can also use copy loop with [resources](copy-resources.md), [variables](copy-variables.md), and [outputs](copy-outputs.md).
1515

16+
> [!TIP]
17+
> 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).
18+
1619
## Syntax
1720

1821
Add the `copy` element to the resources section of your template to set the number of items for a property. The copy element has the following general format:

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ You can also use copy loop with [properties](copy-properties.md), [variables](co
1313

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

16+
17+
> [!TIP]
18+
> 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).
19+
1620
## Syntax
1721

1822
Add the `copy` element to the resources section of your template to deploy multiple instances of the resource. The `copy` element has the following general format:

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ This article shows you how to create more than one value for a variable in your
1010

1111
You can also use copy with [resources](copy-resources.md), [properties in a resource](copy-properties.md), and [outputs](copy-outputs.md).
1212

13+
> [!TIP]
14+
> 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).
15+
1316
## Syntax
1417

1518
The copy element has the following general format:

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ The deployment commands changed in Azure CLI version 2.2.0. The examples in this
1717

1818
If you don't have Azure CLI installed, you can use Azure Cloud Shell. For more information, see [Deploy ARM templates from Azure Cloud Shell](deploy-cloud-shell.md).
1919

20+
> [!TIP]
21+
> 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 [How to deploy resources with Bicep and Azure CLI](../bicep/deploy-cli.md).
22+
23+
2024
[!INCLUDE [permissions](../../../includes/template-deploy-permissions.md)]
2125

2226
## Deployment scope
@@ -244,7 +248,7 @@ az deployment group create \
244248
--resource-group testgroup \
245249
--template-file <path-to-template> \
246250
--parameters $params
247-
```
251+
```
248252

249253
However, if you're using Azure CLI with Windows Command Prompt (CMD) or PowerShell, set the variable to a JSON string. Escape the quotation marks: `$params = '{ \"prefix\": {\"value\":\"start\"}, \"suffix\": {\"value\":\"end\"} }'`.
250254

@@ -291,4 +295,4 @@ To deploy a template with multi-line strings or comments using Azure CLI with ve
291295
* To roll back to a successful deployment when you get an error, see [Rollback on error to successful deployment](rollback-on-error.md).
292296
* To specify how to handle resources that exist in the resource group but aren't defined in the template, see [Azure Resource Manager deployment modes](deployment-modes.md).
293297
* To understand how to define parameters in your template, see [Understand the structure and syntax of ARM templates](./syntax.md).
294-
* For tips on resolving common deployment errors, see [Troubleshoot common Azure deployment errors with Azure Resource Manager](common-deployment-errors.md).
298+
* For tips on resolving common deployment errors, see [Troubleshoot common Azure deployment errors with Azure Resource Manager](common-deployment-errors.md).

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ ms.custom: devx-track-azurepowershell
1010

1111
This article explains how to use Azure PowerShell with Azure Resource Manager templates (ARM templates) to deploy your resources to Azure. If you aren't familiar with the concepts of deploying and managing your Azure solutions, see [template deployment overview](overview.md).
1212

13+
> [!TIP]
14+
> 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 [Deploy resources with Bicep and Azure PowerShell](../bicep/deploy-powershell.md).
15+
1316
## Prerequisites
1417

1518
You need a template to deploy. If you don't already have one, download and save an [example template](https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.storage/storage-account-create/azuredeploy.json) from the Azure Quickstart templates repo. The local file name used in this article is _C:\MyTemplates\azuredeploy.json_.

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ For a tutorial, see [Tutorial: Deploy a linked template](./deployment-tutorial-l
2020
> If the linked or nested template targets a different resource group, that deployment uses incremental mode.
2121
>
2222
23+
> [!TIP]
24+
> 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 [modules](../bicep/modules.md).
25+
2326
## Nested template
2427

2528
To nest a template, add a [deployments resource](/azure/templates/microsoft.resources/deployments) to your main template. In the `template` property, specify the template syntax.

articles/azure-resource-manager/templates/parameter-files.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ ms.custom: devx-track-azurepowershell
1010

1111
Rather than passing parameters as inline values in your script, you can use a JSON file that contains the parameter values. This article shows how to create a parameter file that you use with a JSON template.
1212

13+
> [!TIP]
14+
> 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 [parameter files](../bicep/parameter-files.md).
15+
1316
## Parameter file
1417

1518
A parameter file uses the following format:
@@ -230,4 +233,4 @@ If your template includes a parameter with the same name as one of the parameter
230233
## Next steps
231234

232235
- For more information about how to define parameters in a template, see [Parameters in ARM templates](./parameters.md).
233-
- For more information about using values from a key vault, see [Use Azure Key Vault to pass secure parameter value during deployment](key-vault-parameter.md).
236+
- For more information about using values from a key vault, see [Use Azure Key Vault to pass secure parameter value during deployment](key-vault-parameter.md).

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ When deploying resources, you may need to make sure some resources exist before
1111

1212
Azure Resource Manager evaluates the dependencies between resources, and deploys them in their dependent order. When resources aren't dependent on each other, Resource Manager deploys them in parallel. You only need to define dependencies for resources that are deployed in the same template.
1313

14+
> [!TIP]
15+
> 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 [resource dependencies](../bicep/resource-dependencies.md).
16+
1417
## dependsOn
1518

1619
Within your Azure Resource Manager template (ARM template), the `dependsOn` element enables you to define one resource as a dependent on one or more resources. Its value is a JavaScript Object Notation (JSON) array of strings, each of which is a resource name or ID. The array can include resources that are [conditionally deployed](conditional-resource-deployment.md). When a conditional resource isn't deployed, Azure Resource Manager automatically removes it from the required dependencies.
@@ -213,4 +216,4 @@ For information about assessing the deployment order and resolving dependency er
213216
* For recommendations when setting dependencies, see [ARM template best practices](./best-practices.md).
214217
* To learn about troubleshooting dependencies during deployment, see [Troubleshoot common Azure deployment errors with Azure Resource Manager](common-deployment-errors.md).
215218
* To learn about creating Azure Resource Manager templates, see [Understand the structure and syntax of ARM templates](./syntax.md).
216-
* For a list of the available functions in a template, see [ARM template functions](template-functions.md).
219+
* For a list of the available functions in a template, see [ARM template functions](template-functions.md).

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,8 @@ The available properties for a parameter are:
8383

8484
For examples of how to use parameters, see [Parameters in ARM templates](./parameters.md).
8585

86+
In Bicep, see [parameters](../bicep/file.md#parameters).
87+
8688
## Variables
8789

8890
In the `variables` section, you construct values that can be used throughout your template. You don't need to define variables, but they often simplify your template by reducing complex expressions. The format of each variable matches one of the [data types](data-types.md).
@@ -118,6 +120,8 @@ For information about using `copy` to create several values for a variable, see
118120

119121
For examples of how to use variables, see [Variables in ARM template](./variables.md).
120122

123+
In Bicep, see [variables](../bicep/file.md#variables).
124+
121125
## Functions
122126

123127
Within your template, you can create your own functions. These functions are available for use in your template. Typically, you define complicated expressions that you don't want to repeat throughout your template. You create the user-defined functions from expressions and [functions](template-functions.md) that are supported in templates.
@@ -163,6 +167,8 @@ When defining a user function, there are some restrictions:
163167

164168
For examples of how to use custom functions, see [User-defined functions in ARM template](./user-defined-functions.md).
165169

170+
In Bicep, user-defined functions aren't supported. Bicep does support a variety of [functions](../bicep/bicep-functions.md) and [operators](../bicep/operators.md).
171+
166172
## Resources
167173

168174
In the `resources` section, you define the resources that are deployed or updated.
@@ -249,6 +255,8 @@ You define resources with the following structure:
249255
| properties |No |Resource-specific configuration settings. The values for the properties are the same as the values you provide in the request body for the REST API operation (PUT method) to create the resource. You can also specify a copy array to create several instances of a property. To determine available values, see [template reference](/azure/templates/). |
250256
| resources |No |Child resources that depend on the resource being defined. Only provide resource types that are permitted by the schema of the parent resource. Dependency on the parent resource isn't implied. You must explicitly define that dependency. See [Set name and type for child resources](child-resource-name-type.md). |
251257

258+
In Bicep, see [resources](../bicep/file.md#resources).
259+
252260
## Outputs
253261

254262
In the `outputs` section, you specify values that are returned from deployment. Typically, you return values from resources that were deployed.
@@ -279,6 +287,8 @@ The following example shows the structure of an output definition:
279287

280288
For examples of how to use outputs, see [Outputs in ARM template](./outputs.md).
281289

290+
In Bicep, see [outputs](../bicep/file.md#outputs).
291+
282292
<a id="comments"></a>
283293

284294
## Comments and metadata
@@ -309,6 +319,8 @@ In Visual Studio Code, the [Azure Resource Manager Tools extension](quickstart-c
309319

310320
![Visual Studio Code Azure Resource Manager template mode](./media/template-syntax/resource-manager-template-editor-mode.png)
311321

322+
In Bicep, see [comments](../bicep/file.md#comments).
323+
312324
### Metadata
313325

314326
You can add a `metadata` object almost anywhere in your template. Resource Manager ignores the object, but your JSON editor may warn you that the property isn't valid. In the object, define the properties you need.
@@ -409,6 +421,8 @@ You can break a string into multiple lines. For example, see the `location` prop
409421
],
410422
```
411423

424+
In Bicep, see [multi-line strings](../bicep/file.md#multi-line-strings).
425+
412426
## Next steps
413427

414428
* To view complete templates for many different types of solutions, see the [Azure Quickstart Templates](https://azure.microsoft.com/resources/templates/).

0 commit comments

Comments
 (0)