Skip to content

Commit ae98bf9

Browse files
committed
edit pass: six-bicep-articles
1 parent 3988134 commit ae98bf9

File tree

3 files changed

+75
-73
lines changed

3 files changed

+75
-73
lines changed

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ For a step-by-step tutorial that guides you through the process of creating a Bi
1616

1717
Bicep is a declarative language, which means the elements can appear in any order. Unlike imperative languages, the order of elements doesn't affect how deployment is processed.
1818

19-
A Bicep file has the following elements.
19+
A Bicep file has the following elements:
2020

2121
```bicep
2222
@<decorator>(<argument>)
@@ -122,7 +122,7 @@ The decorators include:
122122

123123
| Decorator | Apply to element | Apply to data type | Argument | Description |
124124
| --------- | ---- | ----------- | ------- |
125-
| 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). You can also use union type syntax in `param` statements.|
125+
| allowed | [param](./parameters.md#allowed-values) | all | array | Use this decorator to make sure the user provides correct values. This decorator is permitted only 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). You can also use union type syntax in `param` statements.|
126126
| batchSize |[module](./modules.md#batchsize), [resource](./resource-declaration.md#batchsize) | N/A | integer | Set up instances to deploy sequentially. |
127127
| description | [func](./user-defined-functions.md#description), [param](./parameters.md#description), [module](./modules.md#description), [output](./outputs.md#description), [resource](./resource-declaration.md#description), [type](./user-defined-data-types.md#description), [var](./variables.md#description) | all | string | Provide descriptions for the elements. Use Markdown-formatted text for the description text. |
128128
| discriminator | [param](./parameters.md#discriminator), [type](./user-defined-data-types.md#discriminator), [output](./outputs.md#discriminator) | object | string | Use this decorator to ensure that the correct subclass is identified and managed. For more information, see [Custom-tagged union data type](./data-types.md#custom-tagged-union-data-type).|
@@ -132,7 +132,7 @@ The decorators include:
132132
| metadata | [func](./user-defined-functions.md#metadata), [output](./outputs.md#metadata), [param](./parameters.md#metadata), [type](./user-defined-data-types.md#metadata) | all | object | Custom properties to apply to the elements. Can include a description property that's equivalent to the description decorator. |
133133
| minLength | [param](./parameters.md#length-constraints), [output](./outputs.md#length-constraints), [type](./user-defined-data-types.md#length-constraints) | array, string | int | The minimum length for string and array elements. The value is inclusive. |
134134
| minValue | [param](./parameters.md#integer-constraints), [output](./outputs.md#integer-constraints), [type](./user-defined-data-types.md#integer-constraints) | int | int | The minimum value for the integer elements. This value is inclusive. |
135-
| 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). |
135+
| 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 user-defined data type is likely a typo. For more information, see [Elevate error level](./user-defined-data-types.md#elevate-error-level). |
136136
| secure | [param](./parameters.md#secure-parameters), [type](./user-defined-data-types.md#secure-types) | 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). |
137137

138138
## Parameters
@@ -450,13 +450,13 @@ var foo = resourceGroup(
450450
myRgName)
451451
```
452452

453-
For multiple-line declaration samples, see [Arrays](./data-types.md#arrays) and [Objects](./data-types.md#objects).
453+
For multiple-line declaration samples, see [arrays](./data-types.md#arrays) and [objects](./data-types.md#objects).
454454

455455
## Known limitations
456456

457-
* No support for the concept of `apiProfile`, which is used to map a single `apiProfile` to a set `apiVersion` for each resource type.
457+
* No support is available for the concept of `apiProfile`, which is used to map a single `apiProfile` to a set `apiVersion` for each resource type.
458458
* User-defined functions aren't supported at the moment. An experimental feature is currently accessible. For more information, see [User-defined functions in Bicep](./user-defined-functions.md).
459-
* Some Bicep features require a corresponding change to the intermediate language (Azure Resource Manager JSON templates). We announce these features as available after all the required updates are deployed to global Azure. If you use a different environment, such as Azure Stack, there might be a delay in the availability of the feature. The Bicep feature is only available after the intermediate language is also updated in that environment.
459+
* Some Bicep features require a corresponding change to the intermediate language (Azure Resource Manager JSON templates). We announce these features as available after all the required updates are deployed to global Azure. If you use a different environment, such as Azure Stack, there might be a delay in the availability of the feature. The Bicep feature is available only after the intermediate language is also updated in that environment.
460460

461461
## Next steps
462462

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
---
2-
title: Linter rule - secure secrets in parameters
3-
description: Linter rule - secure secrets in parameters
2+
title: 'Linter rule: Secure secrets in parameters'
3+
description: This article describes the linter rule, secure secrets in parameters.
44
ms.topic: reference
55
ms.custom: devx-track-bicep
66
ms.date: 03/20/2024
77
---
88

9-
# Linter rule - secure secrets in parameters
9+
# Linter rule: Secure secrets in parameters
1010

11-
This rule finds parameters whose names look like secrets but without the [secure decorator](./parameters.md#use-decorators), for example: a parameter name contains the following keywords:
11+
This rule finds parameters whose names look like secrets but without the [secure decorator](./parameters.md#use-decorators). For example, a parameter name contains the following keywords:
1212

13-
- password
14-
- pwd
15-
- secret
16-
- accountkey
17-
- acctkey
13+
- `password`
14+
- `pwd`
15+
- `secret`
16+
- `accountkey`
17+
- `acctkey`
1818

1919
## Linter rule code
2020

21-
Use the following value in the [Bicep configuration file](bicep-config-linter.md) to customize rule settings:
21+
To customize rule settings, use the following value in the [Bicep configuration file](bicep-config-linter.md):
2222

2323
`secure-secrets-in-params`
2424

2525
## Solution
2626

2727
Use the [secure decorator](./parameters.md#use-decorators) for the parameters that contain secrets. The secure decorator marks the parameter as secure. The value for a secure parameter isn't saved to the deployment history and isn't logged.
2828

29-
The following example fails this test because the parameter name may contain secrets.
29+
The following example fails this test because the parameter name might contain secrets.
3030

3131
```bicep
3232
param mypassword string
@@ -39,21 +39,21 @@ You can fix it by adding the secure decorator:
3939
param mypassword string
4040
```
4141

42-
Optionally, you can use **Quick Fix** to add the secure decorator:
42+
Optionally, you can use **Quick Fix** to add the secure decorator.
4343

44-
:::image type="content" source="./media/linter-rule-secure-secrets-in-parameters/linter-rule-secure-secrets-in-parameters-quick-fix.png" alt-text="The screenshot of Secured default value linter rule quick fix.":::
44+
:::image type="content" source="./media/linter-rule-secure-secrets-in-parameters/linter-rule-secure-secrets-in-parameters-quick-fix.png" alt-text="Screenshot that shows the secured default value for the linter rule Quick Fix.":::
4545

46-
## Silencing false positives
46+
## Silence false positives
4747

48-
Sometimes this rule alerts on parameters that don't actually contain secrets. In these cases, you can disable the warning for this line by adding `#disable-next-line secure-secrets-in-params` before the line with the warning. For example:
48+
Sometimes this rule alerts on parameters that don't contain secrets. In these cases, disable the warning for this line by adding `#disable-next-line secure-secrets-in-params` before the line with the warning. For example:
4949

5050
```bicep
5151
#disable-next-line secure-secrets-in-params // Doesn't contain a secret
5252
param mypassword string
5353
```
5454

55-
It's good practice to add a comment explaining why the rule doesn't apply to this line.
55+
It's good practice to add a comment that explains why the rule doesn't apply to this line.
5656

57-
## Next steps
57+
## Related content
5858

5959
For more information about the linter, see [Use Bicep linter](./linter.md).

0 commit comments

Comments
 (0)