Skip to content

Commit 6976863

Browse files
committed
contributing docs - add naming guidance on ID references
1 parent 9b1411e commit 6976863

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

contributing/topics/reference-naming.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@ Here are some general guidelines you can turn to when naming properties:
3232
* Properties that represent percentage values should be appended with `_percentage` e.g.
3333
> `sampling_percentage`
3434
35+
## Resource ID Reference
36+
37+
Properties that are a reference to another resource's ID should be in the format of `{resource_name}_id` where `{resource_name}` is the full name minus the provider prefix (`azurerm_`). e.g.
38+
> A property that expects a reference to the `azurerm_api_management` ID becomes `api_management_id`
39+
3540
## Boolean Property Naming Conventions
3641

3742
* As a general rule, booleans should be appended with `_enabled` e.g.

0 commit comments

Comments
 (0)