docs: fix variable name in config examples (#190)

# Pull Request ## Issue Issue #, if available: N/A ## Description Description of changes: This updates the `complete` config examples to use the correct location variable name. ## License By submitting this pull request, I confirm that my contribution is made under the terms of the projects associated license.
Azure · Sep 23, 2024 · a1ac8b6 · a1ac8b6
1 parent aa0f60e
commit a1ac8b6
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 18 deletions.
diff --git a/docs/wiki/examples/starter-module-config/complete/config-hub-spoke.yaml b/docs/wiki/examples/starter-module-config/complete/config-hub-spoke.yaml
@@ -1,6 +1,6 @@
 # This file contains templated variables to avoid repeating the same hard-coded values.
 # Templated variables are denoted by the dollar curly braces token. The following details each templated variable that you can use:
-# `default_location`: This is an Azure location sourced from the `default_location` variable. This can be used to set the location of resources.
+# `starter_location`: This is an Azure location sourced from the `starter_location` variable. This can be used to set the location of resources.
 # `default_postfix`: This is a string sourced from the variable `default_postfix`. This can be used to append to resource names for consistency.
 # `root_parent_management_group_id`: This is the id of the management group that the ALZ hierarchy will be nested under.
 # `subscription_id_identity`: The subscription ID of the subscription to deploy the identity resources to, sourced from the variable `subscription_id_identity`.
@@ -18,15 +18,15 @@ archetypes:  # `caf-enterprise-scale` module, add inputs as listed on the module
   deploy_core_landing_zones: true
   deploy_corp_landing_zones: true
   deploy_online_landing_zones: true
-  default_location: ${default_location}
+  default_location: ${starter_location}
   deploy_management_resources: true
   deploy_connectivity_resources: true
   deploy_identity_resources: true
   disable_telemetry: true
 
   # Management
   configure_management_resources:
-    location: ${default_location}
+    location: ${starter_location}
     settings:
       log_analytics:
         enabled: true
@@ -63,7 +63,7 @@ archetypes:  # `caf-enterprise-scale` module, add inputs as listed on the module
           enable_defender_for_sql_servers: true
           enable_defender_for_sql_server_vms: true
           enable_defender_for_storage: true
-      location: ${default_location}
+      location: ${starter_location}
       tags: null
     advanced:
       asc_export_resource_group_name: rg-asc-export
@@ -85,7 +85,7 @@ archetypes:  # `caf-enterprise-scale` module, add inputs as listed on the module
         - config:
             address_space:
               - 10.100.0.0/16
-            location: ${default_location}
+            location: ${starter_location}
             link_to_ddos_protection_plan: false
             dns_servers: []
             bgp_community: ""
@@ -125,7 +125,7 @@ archetypes:  # `caf-enterprise-scale` module, add inputs as listed on the module
       ddos_protection_plan:
         enabled: false
         config:
-          location: ${default_location}
+          location: ${starter_location}
       dns:
         enabled: true
         config:
@@ -190,13 +190,13 @@ archetypes:  # `caf-enterprise-scale` module, add inputs as listed on the module
             signalr_webpubsub: true
             storage_account_blob: true
       private_link_locations:
-        - ${default_location}
+        - ${starter_location}
       public_dns_zones: []
       private_dns_zones: []
       enable_private_dns_zone_virtual_network_link_on_hubs: true
       enable_private_dns_zone_virtual_network_link_on_spokes: true
       virtual_network_resource_ids_to_link: []
-    location: ${default_location}
+    location: ${starter_location}
     tags: null
     advanced: null
 
@@ -220,7 +220,7 @@ archetypes:  # `caf-enterprise-scale` module, add inputs as listed on the module
 #      primary:
 #        name: vnet-hub
 #        resource_group_name: rg-connectivity
-#        location: ${default_location}
+#        location: ${starter_location}
 #        address_space:
 #          - 10.0.0.0/16
 #        firewall:

diff --git a/docs/wiki/examples/starter-module-config/complete/config-vwan.yaml b/docs/wiki/examples/starter-module-config/complete/config-vwan.yaml
@@ -1,6 +1,6 @@
 # This file contains templated variables to avoid repeating the same hard-coded values.
 # Templated variables are denoted by the dollar curly braces token. The following details each templated variable that you can use:
-# `default_location`: This is an Azure location sourced from the `default_location` variable. This can be used to set the location of resources.
+# `starter_location`: This is an Azure location sourced from the `starter_location` variable. This can be used to set the location of resources.
 # `default_postfix`: This is a string sourced from the variable `default_postfix`. This can be used to append to resource names for consistency.
 # `root_parent_management_group_id`: This is the id of the management group that the ALZ hierarchy will be nested under.
 # `subscription_id_identity`: The subscription ID of the subscription to deploy the identity resources to, sourced from the variable `subscription_id_identity`.
@@ -18,15 +18,15 @@ archetypes:  # `caf-enterprise-scale` module, add inputs as listed on the module
   deploy_core_landing_zones: true
   deploy_corp_landing_zones: true
   deploy_online_landing_zones: true
-  default_location: ${default_location}
+  default_location: ${starter_location}
   deploy_management_resources: true
   deploy_connectivity_resources: true
   deploy_identity_resources: true
   disable_telemetry: true
 
   # Management
   configure_management_resources:
-    location: ${default_location}
+    location: ${starter_location}
     settings:
       log_analytics:
         enabled: true
@@ -63,7 +63,7 @@ archetypes:  # `caf-enterprise-scale` module, add inputs as listed on the module
           enable_defender_for_sql_servers: true
           enable_defender_for_sql_server_vms: true
           enable_defender_for_storage: true
-      location: ${default_location}
+      location: ${starter_location}
       tags: null
     advanced:
       asc_export_resource_group_name: rg-asc-export
@@ -86,7 +86,7 @@ archetypes:  # `caf-enterprise-scale` module, add inputs as listed on the module
         - enabled: true
           config:
             address_prefix: 10.200.0.0/22
-            location: ${default_location}
+            location: ${starter_location}
             sku: ""
             routes: []
             expressroute_gateway:
@@ -119,7 +119,7 @@ archetypes:  # `caf-enterprise-scale` module, add inputs as listed on the module
       ddos_protection_plan:
         enabled: false
         config:
-          location: ${default_location}
+          location: ${starter_location}
       dns:
         enabled: true
         config:
@@ -184,13 +184,13 @@ archetypes:  # `caf-enterprise-scale` module, add inputs as listed on the module
             signalr_webpubsub: true
             storage_account_blob: true
       private_link_locations:
-        - ${default_location}
+        - ${starter_location}
       public_dns_zones: []
       private_dns_zones: []
       enable_private_dns_zone_virtual_network_link_on_hubs: true
       enable_private_dns_zone_virtual_network_link_on_spokes: true
       virtual_network_resource_ids_to_link: []
-    location: ${default_location}
+    location: ${starter_location}
     tags: null
     advanced: null
 
@@ -214,7 +214,7 @@ archetypes:  # `caf-enterprise-scale` module, add inputs as listed on the module
 #      primary:
 #        name: vnet-hub
 #        resource_group_name: rg-connectivity
-#        location: ${default_location}
+#        location: ${starter_location}
 #        address_space:
 #          - 10.0.0.0/16
 #        firewall: