Updated ARM/readme

krbar · Jan 3, 2024 · e3aae49 · e3aae49
1 parent 051edf6
commit e3aae49
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 35 deletions.
diff --git a/avm/res/compute/proximity-placement-group/README.md b/avm/res/compute/proximity-placement-group/README.md
@@ -24,7 +24,7 @@ The following section provides usage examples for the module, which were used to
 
 >**Note**: Each example lists all the required parameters first, followed by the rest - each in alphabetical order.
 
->**Note**: To reference the module, please use the following syntax `br:bicep/modules/compute.proximity-placement-group:1.0.0`.
+>**Note**: To reference the module, please use the following syntax `br/public:avm/res/compute/proximity-placement-group:<version>`.
 
 - [Using only defaults](#example-1-using-only-defaults)
 - [Using large parameter set](#example-2-using-large-parameter-set)
@@ -40,13 +40,13 @@ This instance deploys the module with the minimum set of required parameters.
 <summary>via Bicep module</summary>
 
 ```bicep
-module proximityPlacementGroup 'br:bicep/modules/compute.proximity-placement-group:1.0.0' = {
+module proximityPlacementGroup 'br/public:avm/res/compute/proximity-placement-group:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-cppgmin'
   params: {
     // Required parameters
     name: 'cppgmin001'
     // Non-required parameters
-    enableDefaultTelemetry: '<enableDefaultTelemetry>'
+    location: '<location>'
   }
 }
 ```
@@ -68,8 +68,8 @@ module proximityPlacementGroup 'br:bicep/modules/compute.proximity-placement-gro
       "value": "cppgmin001"
     },
     // Non-required parameters
-    "enableDefaultTelemetry": {
-      "value": "<enableDefaultTelemetry>"
+    "location": {
+      "value": "<location>"
     }
   }
 }
@@ -88,7 +88,7 @@ This instance deploys the module with most of its features enabled.
 <summary>via Bicep module</summary>
 
 ```bicep
-module proximityPlacementGroup 'br:bicep/modules/compute.proximity-placement-group:1.0.0' = {
+module proximityPlacementGroup 'br/public:avm/res/compute/proximity-placement-group:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-cppgmax'
   params: {
     // Required parameters
@@ -100,13 +100,13 @@ module proximityPlacementGroup 'br:bicep/modules/compute.proximity-placement-gro
       level: 'Info'
       message: 'I\'m a default error message'
     }
-    enableDefaultTelemetry: '<enableDefaultTelemetry>'
     intent: {
       vmSizes: [
         'Standard_B1ms'
         'Standard_B4ms'
       ]
     }
+    location: '<location>'
     lock: {
       kind: 'CanNotDelete'
       name: 'myCustomLockName'
@@ -166,9 +166,6 @@ module proximityPlacementGroup 'br:bicep/modules/compute.proximity-placement-gro
         "message": "I\"m a default error message"
       }
     },
-    "enableDefaultTelemetry": {
-      "value": "<enableDefaultTelemetry>"
-    },
     "intent": {
       "value": {
         "vmSizes": [
@@ -177,6 +174,9 @@ module proximityPlacementGroup 'br:bicep/modules/compute.proximity-placement-gro
         ]
       }
     },
+    "location": {
+      "value": "<location>"
+    },
     "lock": {
       "value": {
         "kind": "CanNotDelete",
@@ -234,7 +234,7 @@ This instance deploys the module in alignment with the best-practices of the Azu
 <summary>via Bicep module</summary>
 
 ```bicep
-module proximityPlacementGroup 'br:bicep/modules/compute.proximity-placement-group:1.0.0' = {
+module proximityPlacementGroup 'br/public:avm/res/compute/proximity-placement-group:<version>' = {
   name: '${uniqueString(deployment().name, location)}-test-cppgwaf'
   params: {
     // Required parameters
@@ -246,17 +246,13 @@ module proximityPlacementGroup 'br:bicep/modules/compute.proximity-placement-gro
       level: 'Info'
       message: 'I\'m a default error message'
     }
-    enableDefaultTelemetry: '<enableDefaultTelemetry>'
     intent: {
       vmSizes: [
         'Standard_B1ms'
         'Standard_B4ms'
       ]
     }
-    lock: {
-      kind: 'CanNotDelete'
-      name: 'myCustomLockName'
-    }
+    location: '<location>'
     tags: {
       'hidden-title': 'This is visible in the resource name'
       TagA: 'Would you kindly...'
@@ -295,9 +291,6 @@ module proximityPlacementGroup 'br:bicep/modules/compute.proximity-placement-gro
         "message": "I\"m a default error message"
       }
     },
-    "enableDefaultTelemetry": {
-      "value": "<enableDefaultTelemetry>"
-    },
     "intent": {
       "value": {
         "vmSizes": [
@@ -306,11 +299,8 @@ module proximityPlacementGroup 'br:bicep/modules/compute.proximity-placement-gro
         ]
       }
     },
-    "lock": {
-      "value": {
-        "kind": "CanNotDelete",
-        "name": "myCustomLockName"
-      }
+    "location": {
+      "value": "<location>"
     },
     "tags": {
       "value": {
@@ -348,7 +338,7 @@ module proximityPlacementGroup 'br:bicep/modules/compute.proximity-placement-gro
 | Parameter | Type | Description |
 | :-- | :-- | :-- |
 | [`colocationStatus`](#parameter-colocationstatus) | object | Describes colocation status of the Proximity Placement Group. |
-| [`enableDefaultTelemetry`](#parameter-enabledefaulttelemetry) | bool | Enable telemetry via a Globally Unique Identifier (GUID). |
+| [`enableTelemetry`](#parameter-enabletelemetry) | bool | Enable/Disable usage telemetry for module. |
 | [`intent`](#parameter-intent) | object | Specifies the user intent of the proximity placement group. |
 | [`location`](#parameter-location) | string | Resource location. |
 | [`lock`](#parameter-lock) | object | The lock settings of the service. |
@@ -372,9 +362,9 @@ Describes colocation status of the Proximity Placement Group.
 - Type: object
 - Default: `{}`
 
-### Parameter: `enableDefaultTelemetry`
+### Parameter: `enableTelemetry`
 
-Enable telemetry via a Globally Unique Identifier (GUID).
+Enable/Disable usage telemetry for module.
 
 - Required: No
 - Type: bool

diff --git a/avm/res/compute/proximity-placement-group/main.json b/avm/res/compute/proximity-placement-group/main.json
@@ -6,7 +6,7 @@
     "_generator": {
       "name": "bicep",
       "version": "0.23.1.45101",
-      "templateHash": "1474026739792714088"
+      "templateHash": "8593565517075405509"
     },
     "name": "Proximity Placement Groups",
     "description": "This module deploys a Proximity Placement Group.",
@@ -163,11 +163,11 @@
         "description": "Optional. Describes colocation status of the Proximity Placement Group."
       }
     },
-    "enableDefaultTelemetry": {
+    "enableTelemetry": {
       "type": "bool",
       "defaultValue": true,
       "metadata": {
-        "description": "Optional. Enable telemetry via a Globally Unique Identifier (GUID)."
+        "description": "Optional. Enable/Disable usage telemetry for module."
       }
     },
     "intent": {
@@ -188,17 +188,23 @@
     }
   },
   "resources": {
-    "defaultTelemetry": {
-      "condition": "[parameters('enableDefaultTelemetry')]",
+    "avmTelemetry": {
+      "condition": "[parameters('enableTelemetry')]",
       "type": "Microsoft.Resources/deployments",
-      "apiVersion": "2021-04-01",
-      "name": "[format('pid-47ed15a6-730a-4827-bcb4-0fd963ffbd82-{0}', uniqueString(deployment().name, parameters('location')))]",
+      "apiVersion": "2023-07-01",
+      "name": "[format('46d3xbcp.res.compute-proximityplacementgroup.{0}.{1}', replace('-..--..-', '.', '-'), substring(uniqueString(deployment().name, parameters('location')), 0, 4))]",
       "properties": {
         "mode": "Incremental",
         "template": {
           "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
           "contentVersion": "1.0.0.0",
-          "resources": []
+          "resources": [],
+          "outputs": {
+            "telemetry": {
+              "type": "String",
+              "value": "For more information, see https://aka.ms/avm/TelemetryInfo"
+            }
+          }
         }
       }
     },