Merge pull request #225563 from mumian/0130-linter-parent

New linter rule - use parent-property

Author: v-regandowner

articles/azure-resource-manager/bicep/bicep-config-linter.md

@@ -2,7 +2,7 @@
 title: Linter settings for Bicep config
 description: Describes how to customize configuration values for the Bicep linter
 ms.topic: conceptual
-ms.date: 11/01/2022
+ms.date: 01/30/2023
 ---
 
 # Add linter settings in the Bicep config file
@@ -89,6 +89,9 @@ The following example shows the rules that are available for configuration.
         "simplify-interpolation": {
           "level": "warning"
         },
+        "use-parent-property": {
+          "level": "warning"
+        },
         "use-protectedsettings-for-commandtoexecute-secrets": {
           "level": "warning"
         },

articles/azure-resource-manager/bicep/child-resource-name-type.md

@@ -17,11 +17,11 @@ This article show different ways you can declare a child resource.
 
 ### Training resources
 
-If you would rather learn about about child resources through step-by-step guidance, see [Deploy child and extension resources by using Bicep](/training/modules/child-extension-bicep-templates).
+If you would rather learn about child resources through step-by-step guidance, see [Deploy child and extension resources by using Bicep](/training/modules/child-extension-bicep-templates).
 
 ## Name and type pattern
 
-In Bicep, you can specify the child resource either within the parent resource or outside of the parent resource. The values you provide for the resource name and resource type vary based on how you declare the child resource. However, the full name and type always resolve to the same pattern. 
+In Bicep, you can specify the child resource either within the parent resource or outside of the parent resource. The values you provide for the resource name and resource type vary based on how you declare the child resource. However, the full name and type always resolve to the same pattern.
 
 The **full name** of the child resource uses the pattern:
 
@@ -47,7 +47,7 @@ If you have more than two levels in the hierarchy, keep repeating parent resourc
 {resource-provider-namespace}/{parent-resource-type}/{child-level1-resource-type}/{child-level2-resource-type}
 ```
 
-If you count the segments between `/` characters, the number of segments in the type is always one more than the number of segments in the name. 
+If you count the segments between `/` characters, the number of segments in the type is always one more than the number of segments in the name.
 
 ## Within parent resource
 
@@ -113,7 +113,7 @@ You can also use the full resource name and type when declaring the child resour
 :::code language="bicep" source="~/azure-docs-bicep-samples/syntax-samples/child-resource-name-type/fullnamedeclaration.bicep" highlight="10,11,17,18":::
 
 > [!IMPORTANT]
-> Setting the full resource name and type isn't the recommended approach. It's not as type safe as using one of the other approaches.
+> Setting the full resource name and type isn't the recommended approach. It's not as type safe as using one of the other approaches. For more information, see [Linter rule: use parent property](./linter-rule-use-parent-property.md).
 
 ## Next steps
 

articles/azure-resource-manager/bicep/linter-rule-use-parent-property.md

@@ -0,0 +1,82 @@
+---
+title: Linter rule - use parent property
+description: Linter rule - use parent property
+ms.topic: conceptual
+ms.date: 01/30/2023
+---
+
+# Linter rule - use parent property
+
+When defined outside of the parent resource, you format name of the child resource with slashes to include the parent name. Setting the full resource name isn't the recommended approach. The syntax can be simplified by using the `parent` property. For more information, see [Full resource name outside parent](./child-resource-name-type.md#full-resource-name-outside-parent).
+
+When defined outside of the parent resource, you use slashes to include the parent name in the name of the child resource. Setting the full resource name with parent resource name is not recommended. The `parent` property can be used to simplify the syntax. See [Full resource name outside parent](./child-resource-name-type.md#full-resource-name-outside-parent).
+
+## Linter rule code
+
+Use the following value in the [Bicep configuration file](bicep-config-linter.md) to customize rule settings:
+
+`use-parent-property`
+
+## Solution
+
+The following example fails this test because of the name values for `service` and `share`:
+
+```bicep
+param location string = resourceGroup().location
+
+resource storage 'Microsoft.Storage/storageAccounts@2021-02-01' = {
+  name: 'examplestorage'
+  location: location
+  kind: 'StorageV2'
+  sku: {
+    name: 'Standard_LRS'
+  }
+}
+
+resource service 'Microsoft.Storage/storageAccounts/fileServices@2021-02-01' = {
+  name: 'examplestorage/default'
+  dependsOn: [
+    storage
+  ]
+}
+
+resource share 'Microsoft.Storage/storageAccounts/fileServices/shares@2021-02-01' = {
+  name: 'examplestorage/default/exampleshare'
+  dependsOn: [
+    service
+  ]
+}
+```
+
+You can fix the problem by using the `parent` property:
+
+```bicep
+param location string = resourceGroup().location
+
+resource storage 'Microsoft.Storage/storageAccounts@2021-02-01' = {
+  name: 'examplestorage'
+  location: location
+  kind: 'StorageV2'
+  sku: {
+    name: 'Standard_LRS'
+  }
+}
+
+resource service 'Microsoft.Storage/storageAccounts/fileServices@2021-02-01' = {
+  parent: storage
+  name: 'default'
+}
+
+resource share 'Microsoft.Storage/storageAccounts/fileServices/shares@2021-02-01' = {
+  parent: service
+  name: 'exampleshare'
+}
+```
+
+You can fix the issue automatically by selecting **Quick Fix** as shown on the following screenshot:
+
+:::image type="content" source="./media/linter-rule-use-parent-property/bicep-linter-rule-use-parent-property-quick-fix.png" alt-text="Screenshot of use parent property quick fix.":::
+
+## Next steps
+
+For more information about the linter, see [Use Bicep linter](./linter.md).

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

@@ -2,7 +2,7 @@
 title: Use Bicep linter
 description: Learn how to use Bicep linter.
 ms.topic: conceptual
-ms.date: 11/01/2022
+ms.date: 01/30/2023
 ---
 
 # Use Bicep linter
@@ -39,6 +39,7 @@ The default set of linter rules is minimal and taken from [arm-ttk test cases](.
 - [secure-params-in-nested-deploy](./linter-rule-secure-params-in-nested-deploy.md)
 - [secure-secrets-in-params](./linter-rule-secure-secrets-in-parameters.md)
 - [simplify-interpolation](./linter-rule-simplify-interpolation.md)
+- [use-parent-property](./linter-rule-use-parent-property.md)
 - [use-protectedsettings-for-commandtoexecute-secrets](./linter-rule-use-protectedsettings-for-commandtoexecute-secrets.md)
 - [use-recent-api-versions](./linter-rule-use-recent-api-versions.md)
 - [use-resource-id-functions](./linter-rule-use-resource-id-functions.md)

articles/azure-resource-manager/bicep/media/linter-rule-use-parent-property/bicep-linter-rule-use-parent-property-quick-fix.png

@@ -458,6 +458,9 @@
       - name: Use explicit values for module location parameters
         displayName: linter
         href: linter-rule-explicit-values-for-loc-params.md
+      - name: Use parent property
+        displayName: linter
+        href: linter-rule-use-parent-property.md
       - name: use recent API versions
         displayName: linter
         href: linter-rule-use-recent-api-versions.md