Merge branch 'main' into custom-role-def-type

This commit is contained in:
Eskil Uhlving Larsen 2023-11-06 11:03:54 +01:00 коммит произвёл GitHub
Родитель 11402dfd84 87e138c9d2
Коммит 63ab7a4900
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
1 изменённых файлов: 11 добавлений и 2 удалений

Просмотреть файл

@ -77,6 +77,7 @@ Throughout the development of Bicep code you should follow the [Bicep Best Pract
- Strict `camelCasing` must be used for all elements:
- Symbolic names for:
- Types
- Parameters
- Variables
- Resource
@ -102,6 +103,7 @@ Throughout the development of Bicep code you should follow the [Bicep Best Pract
| Element Type | Naming Prefix | Example |
| :----------: | :-----------: | :------------------------------------------------------------------- |
| Types | `typ` | `typCustomRole`, `typSubnetOptions` |
| Parameters | `par` | `parLocation`, `parManagementGroupsNamePrefix` |
| Variables | `var` | `varConditionExpression`, `varIntermediateRootManagementGroupName` |
| Resources | `res` | `resIntermediateRootManagementGroup`, `resResourceGroupLogAnalytics` |
@ -122,7 +124,7 @@ For all Bicep files created as part of this project they will follow the structu
![Bicep File Structure By Element Type Image](media/bicep-structure.png)
> Parameters, Variables, Resources, Modules & Outputs are all types of elements.
> Types, Parameters, Variables, Resources, Modules & Outputs are all types of elements.
### Bicep File Structure Example
@ -132,9 +134,16 @@ Below is an example of Bicep file complying with the structure and styling guide
// SCOPE
targetScope = 'subscription' //Deploying at Subscription scope to allow resource groups to be created and resources in one deployment
// METADATA
metadata name = 'ALZ Bicep - Example Module'
metadata description = 'ALZ Bicep Module used as an example'
// TYPES
@minValue(0)
type typExampleNonNegativeInteger = int
// PARAMETERS
@sys.description('Example description for parameter. - DEFAULT VALUE: "TEST"')
@sys.description('Example description for parameter.') // Avoid describing default values
param parExampleResourceGroupNamePrefix string = 'TEST'