Updated deployed resource names in parameter files (#801)

* Update to latest * Update to latest * Update to latest * Update arm/Microsoft.DocumentDB/databaseAccounts/.parameters/plain.parameters.json Co-authored-by: Erika Gressi <56914614+eriqua@users.noreply.github.com> * Update arm/Microsoft.DocumentDB/databaseAccounts/.parameters/sqldb.parameters.json Co-authored-by: Erika Gressi <56914614+eriqua@users.noreply.github.com> * Update arm/Microsoft.Network/privateEndpoints/.parameters/min.parameters.json Co-authored-by: Erika Gressi <56914614+eriqua@users.noreply.github.com> * Update arm/Microsoft.Network/privateEndpoints/.parameters/parameters.json Co-authored-by: Erika Gressi <56914614+eriqua@users.noreply.github.com> * Update arm/Microsoft.Network/virtualNetworkGateways/.parameters/vpn.parameters.json Co-authored-by: Erika Gressi <56914614+eriqua@users.noreply.github.com> * Update arm/Microsoft.Network/virtualNetworkGateways/.parameters/expressRoute.parameters.json Co-authored-by: Erika Gressi <56914614+eriqua@users.noreply.github.com> * Update arm/Microsoft.Network/virtualNetworkGateways/.parameters/expressRoute.parameters.json Co-authored-by: Erika Gressi <56914614+eriqua@users.noreply.github.com> * Update arm/Microsoft.DocumentDB/databaseAccounts/.parameters/mongodb.parameters.json Co-authored-by: Erika Gressi <56914614+eriqua@users.noreply.github.com> * Update arm/Microsoft.Compute/galleries/.parameters/images.parameters.json Co-authored-by: Erika Gressi <56914614+eriqua@users.noreply.github.com> * Update arm/Microsoft.AnalysisServices/servers/.parameters/min.parameters.json Co-authored-by: Erika Gressi <56914614+eriqua@users.noreply.github.com> Co-authored-by: Erika Gressi <56914614+eriqua@users.noreply.github.com>
Azure · Dec 12, 2021 · 426ace2 · 426ace2
1 parent 07c6042
commit 426ace2
Show file tree

Hide file tree

Showing 27 changed files with 38 additions and 29 deletions.
diff --git a/arm/Microsoft.AnalysisServices/servers/.parameters/min.parameters.json b/arm/Microsoft.AnalysisServices/servers/.parameters/min.parameters.json
@@ -3,7 +3,7 @@
     "contentVersion": "1.0.0.0",
     "parameters": {
         "name": {
-            "value": "sxxazasweux003"
+            "value": "sxxazasweumin001"
         }
     }
 }
diff --git a/arm/Microsoft.ApiManagement/service/.parameters/max.parameters.json b/arm/Microsoft.ApiManagement/service/.parameters/max.parameters.json
@@ -3,7 +3,7 @@
     "contentVersion": "1.0.0.0",
     "parameters": {
         "name": {
-            "value": "sxx-az-am-x-002"
+            "value": "sxx-az-am-max-001"
         },
         "publisherEmail": {
             "value": "apimgmt-noreply@mail.windowsazure.com"

diff --git a/arm/Microsoft.Automation/automationAccounts/.parameters/min.parameters.json b/arm/Microsoft.Automation/automationAccounts/.parameters/min.parameters.json
@@ -3,7 +3,7 @@
     "contentVersion": "1.0.0.0",
     "parameters": {
         "name": {
-            "value": "sxx-wd-aut-x-002"
+            "value": "sxx-wd-aut-min-001"
         }
     }
 }
diff --git a/arm/Microsoft.Compute/galleries/.parameters/images.parameters.json b/arm/Microsoft.Compute/galleries/.parameters/images.parameters.json
@@ -3,7 +3,7 @@
     "contentVersion": "1.0.0.0",
     "parameters": {
         "name": {
-            "value": "sxxazsigweux002"
+            "value": "sxxazsigweuimages001"
         },
         "images": {
             "value": [

diff --git a/arm/Microsoft.ContainerService/managedClusters/.parameters/azure.parameters.json b/arm/Microsoft.ContainerService/managedClusters/.parameters/azure.parameters.json
@@ -3,7 +3,7 @@
     "contentVersion": "1.0.0.0",
     "parameters": {
         "name": {
-            "value": "sxx-az-aks-azure"
+            "value": "sxx-az-aks-azure-001"
         },
         "primaryAgentPoolProfile": {
             "value": [

diff --git a/arm/Microsoft.ContainerService/managedClusters/.parameters/kubenet.parameters.json b/arm/Microsoft.ContainerService/managedClusters/.parameters/kubenet.parameters.json
@@ -3,7 +3,7 @@
     "contentVersion": "1.0.0.0",
     "parameters": {
         "name": {
-            "value": "sxx-az-aks-kubenet"
+            "value": "sxx-az-aks-kubenet-001"
         },
         "primaryAgentPoolProfile": {
             "value": [

diff --git a/arm/Microsoft.DesktopVirtualization/applicationgroups/.parameters/min.parameters.json b/arm/Microsoft.DesktopVirtualization/applicationgroups/.parameters/min.parameters.json
@@ -3,7 +3,7 @@
     "contentVersion": "1.0.0.0",
     "parameters": {
         "name": {
-            "value": "sxx-az-avdag-x-002"
+            "value": "sxx-az-avdag-min-001"
         },
         "applicationGroupType": {
             "value": "RemoteApp"

diff --git a/arm/Microsoft.DocumentDB/databaseAccounts/.parameters/mongodb.parameters.json b/arm/Microsoft.DocumentDB/databaseAccounts/.parameters/mongodb.parameters.json
@@ -3,7 +3,7 @@
     "contentVersion": "1.0.0.0",
     "parameters": {
         "name": {
-            "value": "sxx-az-cdb-x-002"
+            "value": "sxx-az-cdb-mongodb-001"
         },
         "location": {
             "value": "West Europe"

diff --git a/arm/Microsoft.DocumentDB/databaseAccounts/.parameters/plain.parameters.json b/arm/Microsoft.DocumentDB/databaseAccounts/.parameters/plain.parameters.json
@@ -3,7 +3,7 @@
     "contentVersion": "1.0.0.0",
     "parameters": {
         "name": {
-            "value": "sxx-az-cdb-x-003"
+            "value": "sxx-az-cdb-plain-001"
         },
         "locations": {
             "value": [

diff --git a/arm/Microsoft.DocumentDB/databaseAccounts/.parameters/sqldb.parameters.json b/arm/Microsoft.DocumentDB/databaseAccounts/.parameters/sqldb.parameters.json
@@ -3,7 +3,7 @@
     "contentVersion": "1.0.0.0",
     "parameters": {
         "name": {
-            "value": "sxx-az-cdb-x-001"
+            "value": "sxx-az-cdb-sqldb-001"
         },
         "location": {
             "value": "West Europe"

diff --git a/arm/Microsoft.NetApp/netAppAccounts/.parameters/min.parameters.json b/arm/Microsoft.NetApp/netAppAccounts/.parameters/min.parameters.json
@@ -3,7 +3,7 @@
     "contentVersion": "1.0.0.0",
     "parameters": {
         "name": {
-            "value": "sxx-az-anf-x-002"
+            "value": "sxx-az-anf-min-001"
         }
     }
 }
diff --git a/arm/Microsoft.NetApp/netAppAccounts/.parameters/nfs3.parameters.json b/arm/Microsoft.NetApp/netAppAccounts/.parameters/nfs3.parameters.json
@@ -3,7 +3,7 @@
     "contentVersion": "1.0.0.0",
     "parameters": {
         "name": {
-            "value": "sxx-az-anf-x-003"
+            "value": "sxx-az-anf-nfs3-001"
         },
         "capacityPools": {
             "value": [

diff --git a/arm/Microsoft.NetApp/netAppAccounts/.parameters/nfs41.parameters.json b/arm/Microsoft.NetApp/netAppAccounts/.parameters/nfs41.parameters.json
@@ -3,7 +3,7 @@
     "contentVersion": "1.0.0.0",
     "parameters": {
         "name": {
-            "value": "sxx-az-anf-x-004"
+            "value": "sxx-az-anf-nfs41-001"
         },
         "capacityPools": {
             "value": [

diff --git a/arm/Microsoft.Network/bastionHosts/.parameters/min.parameters.json b/arm/Microsoft.Network/bastionHosts/.parameters/min.parameters.json
@@ -3,7 +3,7 @@
     "contentVersion": "1.0.0.0",
     "parameters": {
         "name": {
-            "value": "sxx-az-bas-x-002"
+            "value": "sxx-az-bas-min-001"
         },
         "vNetId": {
             "value": "/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/virtualNetworks/adp-sxx-az-vnet-x-002"

diff --git a/arm/Microsoft.Network/firewallPolicies/.parameters/min.parameters.json b/arm/Microsoft.Network/firewallPolicies/.parameters/min.parameters.json
@@ -3,7 +3,7 @@
     "contentVersion": "1.0.0.0",
     "parameters": {
         "name": {
-            "value": "sxx-az-fwpol-x-001"
+            "value": "sxx-az-fwpol-min-001"
         }
     }
 }
diff --git a/arm/Microsoft.Network/privateEndpoints/.parameters/min.parameters.json b/arm/Microsoft.Network/privateEndpoints/.parameters/min.parameters.json
@@ -3,7 +3,7 @@
     "contentVersion": "1.0.0.0",
     "parameters": {
         "name": {
-            "value": "iacs-keyvault-endpoint-simple"
+            "value": "sxx-az-pe-kvlt-min-001"
         },
         "targetSubnetResourceId": {
             "value": "/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/virtualNetworks/adp-sxx-az-vnet-x-001/subnets/sxx-az-subnet-x-005-privateEndpoints"

diff --git a/arm/Microsoft.Network/privateEndpoints/.parameters/parameters.json b/arm/Microsoft.Network/privateEndpoints/.parameters/parameters.json
@@ -3,7 +3,7 @@
     "contentVersion": "1.0.0.0",
     "parameters": {
         "name": {
-            "value": "iacs-keyvault-endpoint"
+            "value": "sxx-az-pe-kvlt-001"
         },
         "targetSubnetResourceId": {
             "value": "/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/virtualNetworks/adp-sxx-az-vnet-x-001/subnets/sxx-az-subnet-x-005-privateEndpoints"

diff --git a/arm/Microsoft.Network/virtualNetworkGateways/.parameters/expressRoute.parameters.json b/arm/Microsoft.Network/virtualNetworkGateways/.parameters/expressRoute.parameters.json
@@ -3,16 +3,16 @@
     "contentVersion": "1.0.0.0",
     "parameters": {
         "name": {
-            "value": "vnet-validate-01-ergw-01"
+            "value": "sxx-az-gw-er-001"
         },
         "gatewayPipName": {
             "value": [
-                "vnet-validate-01-ergw-01-pip-s-02"
+                "sxx-az-gw-er-001-pip"
             ]
         },
         "domainNameLabel": {
             "value": [
-                "vnet-validate-01-ergw-01-pip-s-02"
+                "sxx-az-gw-er-dm-001"
             ]
         },
         "virtualNetworkGatewayType": {

diff --git a/arm/Microsoft.Network/virtualNetworkGateways/.parameters/vpn.parameters.json b/arm/Microsoft.Network/virtualNetworkGateways/.parameters/vpn.parameters.json
@@ -3,11 +3,11 @@
     "contentVersion": "1.0.0.0",
     "parameters": {
         "name": {
-            "value": "sxx-az-vnet-vpn-gw-p-001"
+            "value": "sxx-az-gw-vpn-001"
         },
         "domainNameLabel": {
             "value": [
-                "sxx-az-vnet-vpn-gw-p-001-pip-99"
+                "sxx-az-gw-vpn-dm-001"
             ]
         },
         "virtualNetworkGatewayType": {

diff --git a/arm/Microsoft.Network/virtualNetworks/.parameters/vnetPeering.parameters.json b/arm/Microsoft.Network/virtualNetworks/.parameters/vnetPeering.parameters.json
@@ -3,7 +3,7 @@
     "contentVersion": "1.0.0.0",
     "parameters": {
         "name": {
-            "value": "sxx-az-vnet-peer-x-002"
+            "value": "sxx-az-vnet-peer-001"
         },
         "addressPrefixes": {
             "value": [

diff --git a/arm/Microsoft.OperationalInsights/workspaces/.parameters/min.parameters.json b/arm/Microsoft.OperationalInsights/workspaces/.parameters/min.parameters.json
@@ -3,7 +3,7 @@
     "contentVersion": "1.0.0.0",
     "parameters": {
         "name": {
-            "value": "sxx-az-la-x-002"
+            "value": "sxx-az-la-min-001"
         }
     }
 }
diff --git a/arm/Microsoft.RecoveryServices/vaults/.parameters/min.parameters.json b/arm/Microsoft.RecoveryServices/vaults/.parameters/min.parameters.json
@@ -3,7 +3,7 @@
     "contentVersion": "1.0.0.0",
     "parameters": {
         "name": {
-            "value": "sxx-az-rsv-x-002"
+            "value": "sxx-az-rsv-min-001"
         }
     }
 }
diff --git a/arm/Microsoft.Resources/deploymentScripts/.parameters/cli.parameters.json b/arm/Microsoft.Resources/deploymentScripts/.parameters/cli.parameters.json
@@ -3,7 +3,7 @@
     "contentVersion": "1.0.0.0",
     "parameters": {
         "name": {
-            "value": "sxx-az-ds-cli-x-001"
+            "value": "sxx-az-ds-cli-001"
         },
         "userAssignedIdentities": {
             "value": {

diff --git a/arm/Microsoft.Resources/deploymentScripts/.parameters/ps.parameters.json b/arm/Microsoft.Resources/deploymentScripts/.parameters/ps.parameters.json
@@ -3,7 +3,7 @@
     "contentVersion": "1.0.0.0",
     "parameters": {
         "name": {
-            "value": "sxx-az-ds-ps-x-001"
+            "value": "sxx-az-ds-ps-001"
         },
         "userAssignedIdentities": {
             "value": {

diff --git a/arm/Microsoft.Web/sites/.parameters/fa.min.parameters.json b/arm/Microsoft.Web/sites/.parameters/fa.min.parameters.json
@@ -3,7 +3,7 @@
     "contentVersion": "1.0.0.0",
     "parameters": {
         "name": {
-            "value": "sxx-az-fa-x-002"
+            "value": "sxx-az-fa-min-001"
         },
         "kind": {
             "value": "functionapp"

diff --git a/arm/Microsoft.Web/sites/.parameters/wa.min.parameters.json b/arm/Microsoft.Web/sites/.parameters/wa.min.parameters.json
@@ -3,7 +3,7 @@
     "contentVersion": "1.0.0.0",
     "parameters": {
         "name": {
-            "value": "sxx-az-wa-x-002"
+            "value": "sxx-az-wa-min-001"
         },
         "kind": {
             "value": "app"

diff --git a/docs/wiki/ModulesDesign.md b/docs/wiki/ModulesDesign.md
@@ -17,6 +17,7 @@ This section gives you an overview of the design principals the bicep modules fo
   - [Resource](#resource)
   - [Outputs](#outputs)
 - [ReadMe](#readme)
+- [Parameter files](#parameter-files)
 
 ---
 
@@ -528,3 +529,11 @@ Its primary components are in order:
 Note the following recommendations
 - Use our module generation script `Set-ModuleReadMe` that will do most of the work for you. Currently you can find it at 'utilities\tools\Set-ModuleReadMe.ps1'. Just load the file and invoke the function like this `Set-ModuleReadMe -TemplateFilePath '<pathToModule>/deploy.bicep'`
 - It is not recommended to describe how to use child resources in the parent readme file (for example 'How to define a [container] entry for the [storage account]'). Instead it is recommended to reference the child resource's ReadMe instead (for example 'container/readme.md').
+
+# Parameter files
+
+Parameter files in CARML leverage the common `deploymentParameters.json` schema for ARM deployments. As parameters are usually specific to their corresponding template, we have only very few general recommendations:
+- Parameter file names should ideally relate to the content they deploy. For example, a parameter file `min.parameters.json` should be chosen for a parameter file that contains only the minimum set of parameter to deploy the module.
+- Likewise, the `name` parameter we have in most modules should give some indication of the file it was deployed with. For example, a `min.parameters.json` parameter file for the virtual network module may have a `name` property with the value `sxx-az-vnet-min-001` where `min` relates to the prefix of the parameter file itself.
+- A module should have as many parameter files as it needs to evaluate all parts of the module's functionality.
+- Sensitive data should not be stored inside the parameter file but rather be injected by the use of [tokens](./ParameterFileTokens.md) or via a [key vault reference](https://docs.microsoft.com/en-us/azure/azure-resource-manager/templates/key-vault-parameter?tabs=azure-cli#reference-secrets-with-static-id).