Skip to content

Commit a38c798

Browse files
committed
update
1 parent f269c90 commit a38c798

File tree

10 files changed

+69
-69
lines changed

10 files changed

+69
-69
lines changed

articles/azure-resource-manager/bicep/bicep-import.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.date: 08/20/2024
88

99
# Imports in Bicep
1010

11-
This article describes the syntax you use to export and import shared functionality, as well as namespaces for Bicep extensions.
11+
This article describes the syntax you use to export and import shared functionality, and namespaces for Bicep extensions.
1212

1313
## Export variables, types, and functions
1414

articles/azure-resource-manager/bicep/data-types.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,7 @@ is ${blocked}'''
319319

320320
## Union types
321321

322-
In Bicep, a union type allows the creation of a combined type consisting of a set of sub-types. An assignment is valid if any of the individual sub-type assignments are permitted. The `|` character separates individual sub-types using an _or_ condition. For example, the syntax _'a' | 'b'_ means that a valid assignment could be either _'a'_ or _'b'_. Union types are translated into the [allowed-value](../templates/definitions.md#allowed-values) constraint in Bicep, so only literals are permitted as members. Unions can include any number of literal-typed expressions.
322+
In Bicep, a union type allows the creation of a combined type consisting of a set of subtypes. An assignment is valid if any of the individual subtype assignments are permitted. The `|` character separates individual subtypes using an _or_ condition. For example, the syntax _'a' | 'b'_ means that a valid assignment could be either _'a'_ or _'b'_. Union types are translated into the [allowed-value](../templates/definitions.md#allowed-values) constraint in Bicep, so only literals are permitted as members. Unions can include any number of literal-typed expressions.
323323

324324
```bicep
325325
type color = 'Red' | 'Blue' | 'White'
@@ -335,7 +335,7 @@ Type unions must be reducible to a single ARM type, such as 'string', 'int', or
335335
type foo = 'a' | 1
336336
```
337337

338-
Any type expression can be used as a sub-type in a union type declaration (between `|` characters). For example, the following examples are all valid:
338+
Any type expression can be used as a subtype in a union type declaration (between `|` characters). For example, the following examples are all valid:
339339

340340
```bicep
341341
type foo = 1 | 2
@@ -379,7 +379,7 @@ There are some limitations with union type.
379379
```
380380

381381
* Only literals are permitted as members.
382-
* All literals must be of the same primitive data type (e.g., all strings or all integers).
382+
* All literals must be of the same primitive data type (for example, all strings or all integers).
383383

384384
The union type syntax can be used in [user-defined data types](./user-defined-data-types.md).
385385

articles/azure-resource-manager/bicep/file.md

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -104,31 +104,32 @@ The allowed values are:
104104

105105
In a module, you can specify a scope that is different than the scope for the rest of the Bicep file. For more information, see [Configure module scope](modules.md#set-module-scope)
106106

107-
## Decorator
107+
## Decorators
108108

109109
You can add one or more decorators for each of the following elements:
110110

111-
* [Parameter](#parameters)
112-
* [Variable](#variables)
113-
* [Resource](#resources)
114-
* [Module](#modules)
115-
* [Output](#outputs)
116-
* [Type](#types)
111+
* [param](#parameters)
112+
* [var](#variables)
113+
* [resource](#resources)
114+
* [module](#modules)
115+
* [output](#outputs)
116+
* [func](#functions)
117+
* [type](#types)
117118

118119
| Decorator | Apply to element | Apply to data type | Argument | Description |
119120
| --------- | ---- | ----------- | ------- |
120-
| allowed | [parameter](./parameters.md#allowed-values) | all | array | Use this decorator to make sure the user provides correct values. This decorator is only permitted on `param` statements. To declare that a property must be one of a set of predefined values in a [`type`](./user-defined-data-types.md) or [`output`](./outputs.md) statement, use [union type syntax](./data-types.md#union-types). Union type syntax can also be used in `param` statements.|
121+
| allowed | [param](./parameters.md#allowed-values) | all | array | Use this decorator to make sure the user provides correct values. This decorator is only permitted on `param` statements. To declare that a property must be one of a set of predefined values in a [`type`](./user-defined-data-types.md) or [`output`](./outputs.md) statement, use [union type syntax](./data-types.md#union-types). Union type syntax can also be used in `param` statements.|
121122
| batchSize |[resource](./resource-declaration.md#batchsize), [module](./modules.md#batchsize)| N/A | integer | Set up instances to deploy sequentially. |
122-
| description | [parameter](./parameters.md#description), [variable](./variables.md#description), [resource](./resource-declaration.md#description), [module](./modules.md#description), [output](./outputs.md#description), [type](./user-defined-data-types.md#description), [function](./user-defined-functions.md#description) | all | string | Text that explains how to use the element. |
123-
| discriminator | [parameter](./parameters.md#discriminator, [type](./user-defined-data-types.md#discriminator), [output](./outputs.md#discriminator) | object | string | Use this decorator to ensure the correct subclass is identified and managed. For more information, see [Custom-tagged union data type](./data-types.md#custom-tagged-union-data-type).|
124-
| export | [variable](./variables.md#export), [type](./user-defined-data-types.md#export), [function](./user-defined-functions.md#export) | all | none| Indicates that the element can be imported by another Bicep file. |
125-
| maxLength | [parameter](./parameters.md#length-constraints), [output](./outputs.md#length-constraints) | array, string | int | The maximum length for string and array elemenets. The value is inclusive. |
126-
| maxValue | [parameter](./parameters.md#integer-constraints), [output](./outputs.md#integer-constraints) | int | int | The maximum value for the integer elements. This value is inclusive. |
127-
| metadata | [parameter](./parameters.md#metadata), [output](./outputs.md#metadata) | all | object | Custom properties to apply to the elements. Can include a description property that is equivalent to the description decorator. |
128-
| minLength | [parameter](./parameters.md#length-constraints), [output](./outputs.md#length-constraints) | array, string | int | The minimum length for string and array elements. The value is inclusive. |
129-
| minValue | [parameter](./parameters.md#integer-constraints), [output](./outputs.md#integer-constraints) | int | int | The minimum value for the integer elements. This value is inclusive. |
130-
| sealed | [parameter](./parameters.md#sealed), [type](./user-defined-data-types.md#sealed), [output](./outputs.md#sealed) | object | none | Elevate [BCP089](./diagnostics/bcp089.md) from a warning to an error when a property name of a use-define data type is likely a typo. For more information, see [Elevate error level](./user-defined-data-types.md#elevate-error-level). |
131-
| secure | [parameter](./parameters.md#secure-parameters) | string, object | none | Marks the parameter as secure. The value for a secure parameter isn't saved to the deployment history and isn't logged. For more information, see [Secure strings and objects](data-types.md#secure-strings-and-objects). |
123+
| description | [param](./parameters.md#description), [var](./variables.md#description), [resource](./resource-declaration.md#description), [module](./modules.md#description), [output](./outputs.md#description), [type](./user-defined-data-types.md#description), [func](./user-defined-functions.md#description) | all | string | Text that explains how to use the element. |
124+
| discriminator | [param](./parameters.md#discriminator), [type](./user-defined-data-types.md#discriminator), [output](./outputs.md#discriminator) | object | string | Use this decorator to ensure the correct subclass is identified and managed. For more information, see [Custom-tagged union data type](./data-types.md#custom-tagged-union-data-type).|
125+
| export | [var](./variables.md#export), [type](./user-defined-data-types.md#export), [func](./user-defined-functions.md#export) | all | none| Indicates that the element can be imported by another Bicep file. |
126+
| maxLength | [param](./parameters.md#length-constraints), [output](./outputs.md#length-constraints) | array, string | int | The maximum length for string and array elements. The value is inclusive. |
127+
| maxValue | [param](./parameters.md#integer-constraints), [output](./outputs.md#integer-constraints) | int | int | The maximum value for the integer elements. This value is inclusive. |
128+
| metadata | [param](./parameters.md#metadata), [output](./outputs.md#metadata) | all | object | Custom properties to apply to the elements. Can include a description property that is equivalent to the description decorator. |
129+
| minLength | [param](./parameters.md#length-constraints), [output](./outputs.md#length-constraints) | array, string | int | The minimum length for string and array elements. The value is inclusive. |
130+
| minValue | [param](./parameters.md#integer-constraints), [output](./outputs.md#integer-constraints) | int | int | The minimum value for the integer elements. This value is inclusive. |
131+
| sealed | [param](./parameters.md#sealed), [type](./user-defined-data-types.md#sealed), [output](./outputs.md#sealed) | object | none | Elevate [BCP089](./diagnostics/bcp089.md) from a warning to an error when a property name of a use-define data type is likely a typo. For more information, see [Elevate error level](./user-defined-data-types.md#elevate-error-level). |
132+
| secure | [param](./parameters.md#secure-parameters) | string, object | none | Marks the parameter as secure. The value for a secure parameter isn't saved to the deployment history and isn't logged. For more information, see [Secure strings and objects](data-types.md#secure-strings-and-objects). |
132133

133134
## Parameters
134135

@@ -435,7 +436,7 @@ The preceding example is equivalent to the following JSON.
435436

436437
## Multiple-line declarations
437438

438-
You can now use multiple lines in function, array and object declarations. This feature requires [Bicep CLI version 0.7.X or higher](./install.md).
439+
You can now use multiple lines in function, array, and object declarations. This feature requires [Bicep CLI version 0.7.X or higher](./install.md).
439440

440441
In the following example, the `resourceGroup()` definition is broken into multiple lines.
441442

@@ -450,7 +451,7 @@ See [Arrays](./data-types.md#arrays) and [Objects](./data-types.md#objects) for
450451
## Known limitations
451452

452453
* No support for the concept of apiProfile, which is used to map a single apiProfile to a set apiVersion for each resource type.
453-
* User-defined functions are not supported at the moment. However, an experimental feature is currently accessible. For more information, see [User-defined functions in Bicep](./user-defined-functions.md).
454+
* User-defined functions aren't supported at the moment. However, an experimental feature is currently accessible. For more information, see [User-defined functions in Bicep](./user-defined-functions.md).
454455
* Some Bicep features require a corresponding change to the intermediate language (Azure Resource Manager JSON templates). We announce these features as available when all of the required updates have been deployed to global Azure. If you're using a different environment, such as Azure Stack, there may be a delay in the availability of the feature. The Bicep feature is only available when the intermediate language has also been updated in that environment.
455456

456457
## Next steps

articles/azure-resource-manager/bicep/modules.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ module <symbolic-name> '<path-to-file>' = {
132132

133133
## Path to module
134134

135-
The file for the module can be either a local file or an external file. The external file can be in template spec or a Bicep module registry.
135+
The file for the module can be either a local file or an external file. The external file can be in template spec or a Bicep module registry.
136136

137137
### Local file
138138

@@ -156,7 +156,7 @@ module stgModule '../storageAccount.bicep' = {
156156
> [!NOTE]
157157
> Non-AVM (Azure Verified Modules) modules are retired from the public module registry.
158158
159-
[Azure Verified Modules](https://azure.github.io/Azure-Verified-Modules/) are prebuilt, pretested, and preverified modules for deploying resources on Azure. Created and owned by Microsoft employees, these modules are designed to simplify and accelerate the deployment process for common Azure resources and configurations whilst also aligning to best practices; such as the Well-Architected Framework.
159+
[Azure Verified Modules](https://azure.github.io/Azure-Verified-Modules/) are prebuilt, pretested, and preverified modules for deploying resources on Azure. Created and owned by Microsoft employees, these modules are designed to simplify and accelerate the deployment process for common Azure resources and configurations while also aligning to best practices; such as the Well-Architected Framework.
160160

161161
Browse to the [Azure Verified Modules Bicep Index](https://azure.github.io/Azure-Verified-Modules/indexes/bicep/)to see the list of modules available, select the highlighted numbers in the following screenshot to be taken directly to that filtered view.
162162

@@ -275,44 +275,44 @@ Decorators are written in the format `@expression` and are placed above module d
275275

276276
| Decorator | Argument | Description |
277277
| --------- | ----------- | ------- |
278-
| [description](#description) | string |Provide descriptions for the module.|
279278
| [batchSize](./bicep-import.md#export-variables-types-and-functions) | none | Set up instances to deploy sequentially. |
279+
| [description](#description) | string |Provide descriptions for the module.|
280280

281281
Decorators are in the [sys namespace](bicep-functions.md#namespaces-for-functions). If you need to differentiate a decorator from another item with the same name, preface the decorator with `sys`. For example, if your Bicep file includes a parameter named `description`, you must add the sys namespace when using the **description** decorator.
282282

283-
### Description
283+
### BatchSize
284284

285-
To add explaination, add a description to module declarations. For example:
285+
You can only apply `@batchSize()` to a resource or module definition that uses a [`for` expression](./loops.md).
286+
287+
By default, modules are deployed in parallel. When you add the `@batchSize(int)` decorator, you deploy instances serially.
286288

287289
```bicep
288-
@description('Create storage accounts referencing an AVM.')
289-
module storage 'br/public:avm/res/storage/storage-account:0.9.0' = {
290+
@batchSize(3)
291+
module storage 'br/public:avm/res/storage/storage-account:0.11.1' = [for storageName in storageAccounts: {
290292
name: 'myStorage'
291293
params: {
292294
name: 'store${resourceGroup().name}'
293295
}
294-
}
296+
}]
295297
```
296298

297-
Markdown-formatted text can be used for the description text.
298-
299-
### BatchSize
299+
For more information, see [Deploy in batches](loops.md#deploy-in-batches).
300300

301-
You can only apply `@batchSize()` to a resource or module definition that uses a [`for` expression](./loops.md).
301+
### Description
302302

303-
By default, modules are deployed in parallel. When you add the `@batchSize(int)` decorator, you deploy instances serially.
303+
To add explanation, add a description to module declarations. For example:
304304

305305
```bicep
306-
@batchSize(3)
307-
module storage 'br/public:avm/res/storage/storage-account:0.11.1' = [for storageName in storageAccounts: {
306+
@description('Create storage accounts referencing an AVM.')
307+
module storage 'br/public:avm/res/storage/storage-account:0.9.0' = {
308308
name: 'myStorage'
309309
params: {
310310
name: 'store${resourceGroup().name}'
311311
}
312-
}]
312+
}
313313
```
314314

315-
For more information, see [Deploy in batches](loops.md#deploy-in-batches).
315+
Markdown-formatted text can be used for the description text.
316316

317317
## Parameters
318318

articles/azure-resource-manager/bicep/outputs.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.date: 08/20/2024
88

99
# Outputs in Bicep
1010

11-
This article describes how to define output values in a Bicep file. You use outputs when you need to return values from the deployed resources. You are limited to 64 outputs in a Bicep file. For more information, see [Template limits](../templates/best-practices.md#template-limits).
11+
This article describes how to define output values in a Bicep file. You use outputs when you need to return values from the deployed resources. You're limited to 64 outputs in a Bicep file. For more information, see [Template limits](../templates/best-practices.md#template-limits).
1212

1313
## Define outputs
1414

@@ -58,7 +58,7 @@ For more information, see [User-defined data types](./user-defined-data-types.md
5858

5959
## Use decorators
6060

61-
Decorators are written in the format `@expression` and are placed above ouput declarations. The following table shows the available decorators for outputs.
61+
Decorators are written in the format `@expression` and are placed above output declarations. The following table shows the available decorators for outputs.
6262

6363
| Decorator | Apply to | Argument | Description |
6464
| --------- | ---- | ----------- | ------- |
@@ -82,7 +82,7 @@ param description string
8282

8383
### Description
8484

85-
To add explaination, add a description to output declarations. For example:
85+
To add explanation, add a description to output declarations. For example:
8686

8787
```bicep
8888
@description('Conditionally output the endpoint.')

articles/azure-resource-manager/bicep/parameters.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ param storageAccountConfig {
6060
}
6161
```
6262

63-
For more information, see [User-defined data types](./user-defined-data-types.md#syntax).
63+
For more information, see [User-defined data types](./user-defined-data-types.md#define-types).
6464

6565
## Set default values
6666

articles/azure-resource-manager/bicep/resource-declaration.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.date: 08/20/2024
88

99
# Resource declaration in Bicep
1010

11-
This article describes the syntax you use to add a resource to your Bicep file. You are limited to 800 resources in a Bicep file. For more information, see [Template limits](../templates/best-practices.md#template-limits).
11+
This article describes the syntax you use to add a resource to your Bicep file. You're limited to 800 resources in a Bicep file. For more information, see [Template limits](../templates/best-practices.md#template-limits).
1212

1313
## Define resources
1414

@@ -66,38 +66,38 @@ Decorators are written in the format `@expression` and are placed above resource
6666

6767
| Decorator | Argument | Description |
6868
| --------- | ----------- | ------- |
69-
| [description](#description) | string | Provide descriptions for the resource. |
7069
| [batchSize](./bicep-import.md#export-variables-types-and-functions) | none | Set up instances to deploy sequentially. |
70+
| [description](#description) | string | Provide descriptions for the resource. |
7171

7272
Decorators are in the [sys namespace](bicep-functions.md#namespaces-for-functions). If you need to differentiate a decorator from another item with the same name, preface the decorator with `sys`. For example, if your Bicep file includes a parameter named `description`, you must add the sys namespace when using the **description** decorator.
7373

74-
### Description
74+
### BatchSize
75+
76+
You can only apply `@batchSize()` to a resource or module definition that uses a [`for` expression](./loops.md).
7577

76-
To add explaination, add a description to resource declarations. For example:
78+
By default, resources are deployed in parallel. When you add the `batchSize(int)` decorator, you deploy instances serially.
7779

7880
```bicep
79-
@description('Create a number of storage accounts')
81+
@batchSize(3)
8082
resource storageAccountResources 'Microsoft.Storage/storageAccounts@2023-04-01' = [for storageName in storageAccounts: {
8183
...
8284
}]
8385
```
8486

85-
Markdown-formatted text can be used for the description text.
86-
87-
### BatchSize
87+
For more information, see [Deploy in batches](loops.md#deploy-in-batches).
8888

89-
You can only apply `@batchSize()` to a resource or module definition that uses a [`for` expression](./loops.md).
89+
### Description
9090

91-
By default, resources are deployed in parallel. When you add the `batchSize(int)` decorator, you deploy instances serially.
91+
To add explanation, add a description to resource declarations. For example:
9292

9393
```bicep
94-
@batchSize(3)
94+
@description('Create a number of storage accounts')
9595
resource storageAccountResources 'Microsoft.Storage/storageAccounts@2023-04-01' = [for storageName in storageAccounts: {
9696
...
9797
}]
9898
```
9999

100-
For more information, see [Deploy in batches](loops.md#deploy-in-batches).
100+
Markdown-formatted text can be used for the description text.
101101

102102
## Resource name
103103

0 commit comments

Comments
 (0)