Skip to content

Commit 71ce046

Browse files
committed
acrolinx
1 parent f16c696 commit 71ce046

File tree

3 files changed

+24
-24
lines changed

3 files changed

+24
-24
lines changed

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

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ var mixedArray = ['abc', 'def'
3939
'ghi']
4040
```
4141

42-
In an array, each item is represented by the [any type](bicep-functions-any.md). You can have an array where each item is the same data type, or an array that holds different data types.
42+
Each array element can be of any type. You can have an array where each item is the same data type, or an array that holds different data types.
4343

4444
The following example shows an array of integers and an array different types.
4545

@@ -58,7 +58,7 @@ var mixedArray = [
5858
]
5959
```
6060

61-
Arrays in Bicep are zero-based. In the following example, the expression `exampleArray[0]` evaluates to 1 and `exampleArray[2]` evaluates to 3. The index of the indexer may itself be another expression. The expression `exampleArray[index]` evaluates to 2. Integer indexers are only allowed on expression of array types.
61+
Arrays in Bicep are zero-based. In the following example, the expression `exampleArray[0]` evaluates to 1 and `exampleArray[2]` evaluates to 3. The index of the indexer can be another expression. The expression `exampleArray[index]` evaluates to 2. Integer indexers are only allowed on expression of array types.
6262

6363
```bicep
6464
var index = 1
@@ -102,15 +102,15 @@ When specifying integer values, don't use quotation marks.
102102
param exampleInt int = 1
103103
```
104104

105-
In Bicep, integers are 64-bit integers. When passed as inline parameters, the range of values may be limited by the SDK or command-line tool you use for deployment. For example, when using PowerShell to deploy a Bicep, integer types can range from -2147483648 to 2147483647. To avoid this limitation, specify large integer values in a [parameter file](parameter-files.md). Resource types apply their own limits for integer properties.
105+
Bicep integers are 64-bit integers. When passed as inline parameters, the range of values can be limited by the SDK or command-line tool you use for deployment. For example, when using PowerShell to deploy a Bicep, integer types can range from -2147483648 to 2147483647. To avoid this limitation, specify large integer values in a [parameter file](parameter-files.md). Resource types apply their own limits for integer properties.
106106

107-
Bicep supports integer literal type which refers to a specific value that is an exact integer. In the following example, `1` is an integer literal type, `foo` can only be assigned the value `1` and no other value.
107+
Bicep supports integer literal type that refers to a specific value that is an exact integer. In the following example, _1_ is an integer literal type, _foo_ can only be assigned the value _1_ and no other value.
108108

109109
```bicep
110110
output foo 1 = 1
111111
```
112112

113-
An integer literal type can either be declared inline, as shown in the preceeding example, or in a [`type` statement](./user-defined-data-types.md).
113+
An integer literal type can either be declared inline, as shown in the preceding example, or in a [`type` statement](./user-defined-data-types.md).
114114

115115
```bicep
116116
type oneType = 1
@@ -119,9 +119,9 @@ output foo oneType = 1
119119
output bar oneType = 2
120120
```
121121

122-
In the preceeding example, assigning `2` to `bar` will result in results in a [BCP033](./bicep-error-bcp033.md) error - _Expected a value of type "1" but the provided value is of type "2"_.
122+
In the preceding example, assigning _2_ to _bar_ results in a [BCP033](./bicep-error-bcp033.md) error - _Expected a value of type "1" but the provided value is of type "2"_.
123123

124-
The following example, shows using integer literal type with [union type](#union-types):
124+
The following example shows using integer literal type with [union type](#union-types):
125125

126126
```bicep
127127
output bar 1 | 2 | 3 = 3
@@ -155,7 +155,7 @@ var test = {
155155
}
156156
```
157157

158-
In the preceding example, quotes are used when the object property keys contain special characters. For example space, '-', or '.'. The following example shows how to use interpolation in object property keys.
158+
In the preceding example, quotes are used when the object property keys contain special characters. For example space, '-', or '.'. The following example shows how to use interpolation in object property keys.
159159

160160
```bicep
161161
var stringVar = 'example value'
@@ -199,7 +199,7 @@ output accessorResult string = environmentSettings['dev'].name
199199

200200
[!INCLUDE [JSON object ordering](../../../includes/resource-manager-object-ordering-bicep.md)]
201201

202-
You will get the following error when accessing an nonexisting property of an object:
202+
You get the following error when accessing a nonexisting property of an object:
203203

204204
```error
205205
The language expression property 'foo' doesn't exist
@@ -219,7 +219,7 @@ output bar bool = contains(objectToTest, 'four') && objectToTest.four == 4
219219

220220
## Strings
221221

222-
In Bicep, strings are marked with singled quotes, and must be declared on a single line. All Unicode characters with code points between *0* and *10FFFF* are allowed.
222+
In Bicep, strings are marked with singled quotes, and must be declared on a single line. All Unicode characters with code points between _0_ and _10FFFF_ are allowed.
223223

224224
```bicep
225225
param exampleString string = 'test value'
@@ -234,21 +234,21 @@ The following table lists the set of reserved characters that must be escaped by
234234
| `\n` | line feed (LF) ||
235235
| `\r` | carriage return (CR) ||
236236
| `\t` | tab character ||
237-
| `\u{x}` | Unicode code point `x` | **x** represents a hexadecimal code point value between *0* and *10FFFF* (both inclusive). Leading zeros are allowed. Code points above *FFFF* are emitted as a surrogate pair.
237+
| `\u{x}` | Unicode code point `x` | **x** represents a hexadecimal code point value between _0_ and _10FFFF_ (both inclusive). Leading zeros are allowed. Code points above _FFFF_ are emitted as a surrogate pair. |
238238
| `\$` | `$` | Only escape when followed by `{`. |
239239

240240
```bicep
241241
// evaluates to "what's up?"
242242
var myVar = 'what\'s up?'
243243
```
244244

245-
Bicep supports string literal type which refers to a specific string value. In the following example, `red` is a string literal type, `redColor` can only be assigned the value `red` and no other value.
245+
Bicep supports string literal type that refers to a specific string value. In the following example, _red_ is a string literal type, _redColor_ can only be assigned the value _red_ and no other value.
246246

247247
```bicep
248248
output redColor 'red' = 'red'
249249
```
250250

251-
An string literal type can either be declared inline, as shown in the preceeding example, or in a [`type` statement](./user-defined-data-types.md).
251+
A string literal type can either be declared inline, as shown in the preceding example, or in a [`type` statement](./user-defined-data-types.md).
252252

253253
```bicep
254254
type redColor = 'red'
@@ -257,9 +257,9 @@ output colorRed redColor = 'red'
257257
output colorBlue redColor = 'blue'
258258
```
259259

260-
In the preceeding example, assigning `blue` to `colorBlue` will result in results in a [BCP033](./bicep-error-bcp033.md) error - _Expected a value of type "'red'" but the provided value is of type "'blue'"_.
260+
In the preceding example, assigning _blue_ to _colorBlue_ results in a [BCP033](./bicep-error-bcp033.md) error - _Expected a value of type "'red'" but the provided value is of type "'blue'"_.
261261

262-
The following example, shows using string literal type with [union type](#union-types):
262+
The following example shows using string literal type with [union type](#union-types):
263263

264264
```bicep
265265
type direction = 'north' | 'south' | 'east' | 'west'
@@ -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 constraint in Bicep, so only literals are permitted as members. Unions may 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 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 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'
@@ -362,11 +362,11 @@ type BarConfig = {
362362
param ServiceConfig FooConfig | BarConfig | { type: 'baz', *: string } = { type: 'bar', value: true }
363363
```
364364

365-
The parameter value is validated based on the discriminated property value. For instance, in the preceding example, if the _serviceConfig_ parameter is of type _foo_, it is validated using the _FooConfig_ type. Similarly, if the parameter is of type _bar_, it is validated using the _BarConfig_ type. This pattern applies to other types as well.
365+
The parameter value is validated based on the discriminated property value. For instance, in the preceding example, if the _serviceConfig_ parameter is of type _foo_, it's validated using the _FooConfig_ type. Similarly, if the parameter is of type _bar_, it's validated using the _BarConfig_ type. This pattern applies to other types as well.
366366

367367
There are some limitations with union type.
368368

369-
* Union types must be reduceable to a single ARM type. The following definition is invalid:
369+
* Union types must be reducible to a single Azure Resource Manager (ARM) type. The following definition is invalid:
370370

371371
```bicep
372372
type foo = 'a' | 1

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Resource Manager resolves parameter values before starting the deployment operat
1414

1515
Each parameter must be set to one of the [data types](data-types.md).
1616

17-
You're limited to 256 parameters in a Bicep file. For more information, see [Template limits](../templates/best-practices.md#template-limits).
17+
Bicep allows a maximum of 256 parameters. For more information, see [Template limits](../templates/best-practices.md#template-limits).
1818

1919
For parameter best practices, see [Parameters](./best-practices.md#parameters).
2020

@@ -59,7 +59,7 @@ param storageAccountConfig {
5959
}
6060
```
6161

62-
For more information, see [User-defined data types](./user-defined-data-types.md#user-defined-data-type-syntax).
62+
For more information, see [User-defined data types](./user-defined-data-types.md#syntax).
6363

6464
## Default value
6565

@@ -105,7 +105,7 @@ The following table describes the available decorators and how to use them.
105105

106106
| Decorator | Apply to | Argument | Description |
107107
| --------- | ---- | ----------- | ------- |
108-
| [allowed](#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 may also be used in `param` statements.|
108+
| [allowed](#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.|
109109
| [description](#description) | all | string | Text that explains how to use the parameter. The description is displayed to users through the portal. |
110110
| [maxLength](#length-constraints) | array, string | int | The maximum length for string and array parameters. The value is inclusive. |
111111
| [maxValue](#integer-constraints) | int | int | The maximum value for the integer parameter. This value is inclusive. |
@@ -203,7 +203,7 @@ When you hover your cursor over **storageAccountName** in VS Code, you see the f
203203

204204
:::image type="content" source="./media/parameters/vscode-bicep-extension-description-decorator-markdown.png" alt-text="Use Markdown-formatted text in VSCode":::
205205

206-
Make sure the text follows proper Markdown formatting; otherwise, it may not display correctly when rendered
206+
Make sure the text follows proper Markdown formatting; otherwise, it may not display correctly when rendered.
207207

208208
### Metadata
209209

@@ -220,7 +220,7 @@ You might use this decorator to track information about the parameter that doesn
220220
param settings object
221221
```
222222

223-
When you provide a `@metadata()` decorator with a property that conflicts with another decorator, that decorator always takes precedence over anything in the `@metadata()` decorator. So, the conflicting property within the @metadata() value is redundant and will be replaced. For more information, see [No conflicting metadata](./linter-rule-no-conflicting-metadata.md).
223+
When you provide a `@metadata()` decorator with a property that conflicts with another decorator, that decorator always takes precedence over anything in the `@metadata()` decorator. So, the conflicting property within the `@metadata()` value is redundant and will be replaced. For more information, see [No conflicting metadata](./linter-rule-no-conflicting-metadata.md).
224224

225225
## Use parameter
226226

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Learn how to use user-defined data types in Bicep. For system-defined data types
1212

1313
[Bicep CLI version 0.12.X or higher](./install.md) is required to use this feature.
1414

15-
## The syntax
15+
## Syntax
1616

1717
You can use the `type` statement to define user-defined data types. In addition, you can also use type expressions in some places to define custom types.
1818

0 commit comments

Comments
 (0)