feat: Expand usage of UDT for the AVNM Bicep Module - avm/res/network/network-manager

avm/res/network/network-manager/connectivity-configuration/README.md

@@ -23,7 +23,7 @@ Connectivity configurations define hub-and-spoke or mesh topologies applied to o
 
 | Parameter | Type | Description |
 | :-- | :-- | :-- |
-| [`appliesToGroups`](#parameter-appliestogroups) | array | Network Groups for the configuration. |
+| [`appliesToGroups`](#parameter-appliestogroups) | array | Network Groups for the configuration. A connectivity configuration must be associated to at least one network group. |
 | [`connectivityTopology`](#parameter-connectivitytopology) | string | Connectivity topology type. "Mesh" IS CURRENTLY A PREVIEW SERVICE/FEATURE, MICROSOFT MAY NOT PROVIDE SUPPORT FOR THIS, PLEASE CHECK THE PRODUCT DOCS FOR CLARIFICATION. |
 | [`name`](#parameter-name) | string | The name of the connectivity configuration. |
 
@@ -44,11 +44,73 @@ Connectivity configurations define hub-and-spoke or mesh topologies applied to o
 
 ### Parameter: `appliesToGroups`
 
-Network Groups for the configuration.
+Network Groups for the configuration. A connectivity configuration must be associated to at least one network group.
 
-- Required: No
+- Required: Yes
 - Type: array
-- Default: `[]`
+
+**Required parameters**
+
+| Parameter | Type | Description |
+| :-- | :-- | :-- |
+| [`groupConnectivity`](#parameter-appliestogroupsgroupconnectivity) | string | Group connectivity type. |
+| [`networkGroupId`](#parameter-appliestogroupsnetworkgroupid) | string | Network group Id. |
+
+**Optional parameters**
+
+| Parameter | Type | Description |
+| :-- | :-- | :-- |
+| [`isGlobal`](#parameter-appliestogroupsisglobal) | string | Flag if global is supported. |
+| [`useHubGateway`](#parameter-appliestogroupsusehubgateway) | string | Flag if use hub gateway. |
+
+### Parameter: `appliesToGroups.groupConnectivity`
+
+Group connectivity type.
+
+- Required: Yes
+- Type: string
+- Allowed:
+  ```Bicep
+  [
+    'DirectlyConnected'
+    'None'
+  ]
+  ```
+
+### Parameter: `appliesToGroups.networkGroupId`
+
+Network group Id.
+
+- Required: Yes
+- Type: string
+
+### Parameter: `appliesToGroups.isGlobal`
+
+Flag if global is supported.
+
+- Required: No
+- Type: string
+- Allowed:
+  ```Bicep
+  [
+    'False'
+    'True'
+  ]
+  ```
+
+### Parameter: `appliesToGroups.useHubGateway`
+
+Flag if use hub gateway.
+
+- Required: No
+- Type: string
+- Allowed:
+  ```Bicep
+  [
+    'False'
+    'True'
+  ]
+  ```
 
 ### Parameter: `connectivityTopology`
 
@@ -77,7 +139,33 @@ List of hub items. This will create peerings between the specified hub and the v
 
 - Required: No
 - Type: array
-- Default: `[]`
+
+**Required parameters**
+
+| Parameter | Type | Description |
+| :-- | :-- | :-- |
+| [`resourceId`](#parameter-hubsresourceid) | string | Resource Id of the hub. |
+| [`resourceType`](#parameter-hubsresourcetype) | string | Resource type of the hub. |
+
+### Parameter: `hubs.resourceId`
+
+Resource Id of the hub.
+
+- Required: Yes
+- Type: string
+
+### Parameter: `hubs.resourceType`
+
+Resource type of the hub.
+
+- Required: Yes
+- Type: string
+- Allowed:
+  ```Bicep
+  [
+    'Microsoft.Network/virtualNetworks'
+  ]
+  ```
 
 ### Parameter: `networkManagerName`
 
@@ -107,7 +195,6 @@ A description of the connectivity configuration.
 
 - Required: No
 - Type: string
-- Default: `''`
 
 ### Parameter: `isGlobal`
 

avm/res/network/network-manager/connectivity-configuration/main.bicep

@@ -12,10 +12,10 @@ param name string
 
 @maxLength(500)
 @sys.description('Optional. A description of the connectivity configuration.')
-param description string = ''
+param description string?
 
-@sys.description('Required. Network Groups for the configuration.')
-param appliesToGroups array = []
+@sys.description('Required. Network Groups for the configuration. A connectivity configuration must be associated to at least one network group.')
+param appliesToGroups appliesToGroupsType
 
 @allowed([
   'HubAndSpoke'
@@ -25,7 +25,7 @@ param appliesToGroups array = []
 param connectivityTopology string
 
 @sys.description('Conditional. List of hub items. This will create peerings between the specified hub and the virtual networks in the network group specified. Required if connectivityTopology is of type "HubAndSpoke".')
-param hubs array = []
+param hubs hubsType
 
 @allowed([
   'True'
@@ -52,7 +52,7 @@ resource connectivityConfiguration 'Microsoft.Network/networkManagers/connectivi
     appliesToGroups: appliesToGroups
     connectivityTopology: connectivityTopology
     deleteExistingPeering: connectivityTopology == 'HubAndSpoke' ? deleteExistingPeering : 'False'
-    description: description
+    description: description ?? ''
     hubs: connectivityTopology == 'HubAndSpoke' ? hubs : []
     isGlobal: isGlobal
   }
@@ -66,3 +66,29 @@ output resourceId string = connectivityConfiguration.id
 
 @sys.description('The resource group the connectivity configuration was deployed into.')
 output resourceGroupName string = resourceGroup().name
+
+// =============== //
+//   Definitions   //
+// =============== //
+
+type appliesToGroupsType = {
+  @sys.description('Required. Group connectivity type.')
+  groupConnectivity: ('DirectlyConnected' | 'None')
+
+  @sys.description('Optional. Flag if global is supported.')
+  isGlobal: ('True' | 'False')?
+
+  @sys.description('Required. Network group Id.')
+  networkGroupId: string
+
+  @sys.description('Optional. Flag if use hub gateway.')
+  useHubGateway: ('True' | 'False')?
+}[]
+
+type hubsType = {
+  @sys.description('Required. Resource Id of the hub.')
+  resourceId: string
+
+  @sys.description('Required. Resource type of the hub.')
+  resourceType: 'Microsoft.Network/virtualNetworks'
+}[]?

avm/res/network/network-manager/connectivity-configuration/main.json

@@ -1,16 +1,89 @@
 {
   "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
+  "languageVersion": "2.0",
   "contentVersion": "1.0.0.0",
   "metadata": {
     "_generator": {
       "name": "bicep",
-      "version": "0.26.54.24096",
-      "templateHash": "3569964888966454016"
+      "version": "0.26.170.59819",
+      "templateHash": "730590109700461307"
     },
     "name": "Network Manager Connectivity Configurations",
     "description": "This module deploys a Network Manager Connectivity Configuration.\nConnectivity configurations define hub-and-spoke or mesh topologies applied to one or more network groups.",
     "owner": "Azure/module-maintainers"
   },
+  "definitions": {
+    "appliesToGroupsType": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "groupConnectivity": {
+            "type": "string",
+            "allowedValues": [
+              "DirectlyConnected",
+              "None"
+            ],
+            "metadata": {
+              "description": "Required. Group connectivity type."
+            }
+          },
+          "isGlobal": {
+            "type": "string",
+            "allowedValues": [
+              "False",
+              "True"
+            ],
+            "nullable": true,
+            "metadata": {
+              "description": "Optional. Flag if global is supported."
+            }
+          },
+          "networkGroupId": {
+            "type": "string",
+            "metadata": {
+              "description": "Required. Network group Id."
+            }
+          },
+          "useHubGateway": {
+            "type": "string",
+            "allowedValues": [
+              "False",
+              "True"
+            ],
+            "nullable": true,
+            "metadata": {
+              "description": "Optional. Flag if use hub gateway."
+            }
+          }
+        }
+      }
+    },
+    "hubsType": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "resourceId": {
+            "type": "string",
+            "metadata": {
+              "description": "Required. Resource Id of the hub."
+            }
+          },
+          "resourceType": {
+            "type": "string",
+            "allowedValues": [
+              "Microsoft.Network/virtualNetworks"
+            ],
+            "metadata": {
+              "description": "Required. Resource type of the hub."
+            }
+          }
+        }
+      },
+      "nullable": true
+    }
+  },
   "parameters": {
     "networkManagerName": {
       "type": "string",
@@ -27,17 +100,16 @@
     },
     "description": {
       "type": "string",
-      "defaultValue": "",
+      "nullable": true,
       "maxLength": 500,
       "metadata": {
         "description": "Optional. A description of the connectivity configuration."
       }
     },
     "appliesToGroups": {
-      "type": "array",
-      "defaultValue": [],
+      "$ref": "#/definitions/appliesToGroupsType",
       "metadata": {
-        "description": "Required. Network Groups for the configuration."
+        "description": "Required. Network Groups for the configuration. A connectivity configuration must be associated to at least one network group."
       }
     },
     "connectivityTopology": {
@@ -51,8 +123,7 @@
       }
     },
     "hubs": {
-      "type": "array",
-      "defaultValue": [],
+      "$ref": "#/definitions/hubsType",
       "metadata": {
         "description": "Conditional. List of hub items. This will create peerings between the specified hub and the virtual networks in the network group specified. Required if connectivityTopology is of type \"HubAndSpoke\"."
       }
@@ -80,21 +151,30 @@
       }
     }
   },
-  "resources": [
-    {
+  "resources": {
+    "networkManager": {
+      "existing": true,
+      "type": "Microsoft.Network/networkManagers",
+      "apiVersion": "2023-04-01",
+      "name": "[parameters('networkManagerName')]"
+    },
+    "connectivityConfiguration": {
       "type": "Microsoft.Network/networkManagers/connectivityConfigurations",
       "apiVersion": "2023-04-01",
       "name": "[format('{0}/{1}', parameters('networkManagerName'), parameters('name'))]",
       "properties": {
         "appliesToGroups": "[parameters('appliesToGroups')]",
         "connectivityTopology": "[parameters('connectivityTopology')]",
         "deleteExistingPeering": "[if(equals(parameters('connectivityTopology'), 'HubAndSpoke'), parameters('deleteExistingPeering'), 'False')]",
-        "description": "[parameters('description')]",
+        "description": "[coalesce(parameters('description'), '')]",
         "hubs": "[if(equals(parameters('connectivityTopology'), 'HubAndSpoke'), parameters('hubs'), createArray())]",
         "isGlobal": "[parameters('isGlobal')]"
-      }
+      },
+      "dependsOn": [
+        "networkManager"
+      ]
     }
-  ],
+  },
   "outputs": {
     "name": {
       "type": "string",