From 8eb61368715a3920f6dc64b0e79151e24e39f41a Mon Sep 17 00:00:00 2001 From: MrMCake Date: Sun, 4 Sep 2022 14:27:10 +0200 Subject: [PATCH 01/12] Updated VirtualNetwork to new dependency approach --- .../workflows/ms.network.virtualnetworks.yml | 3 +- .../.test/default/dependencies.bicep | 33 ++++ .../.test/default/deploy.test.bicep | 129 ++++++++++++++ .../virtualNetworks/.test/min.parameters.json | 14 -- .../.test/min/deploy.test.bicep | 40 +++++ .../virtualNetworks/.test/parameters.json | 96 ---------- .../.test/vnetPeering.parameters.json | 52 ------ .../.test/vnetPeering/dependencies.bicep | 28 +++ .../.test/vnetPeering/deploy.test.bicep | 67 +++++++ .../virtualNetworks/readme.md | 164 ++++++++---------- 10 files changed, 370 insertions(+), 256 deletions(-) create mode 100644 modules/Microsoft.Network/virtualNetworks/.test/default/dependencies.bicep create mode 100644 modules/Microsoft.Network/virtualNetworks/.test/default/deploy.test.bicep delete mode 100644 modules/Microsoft.Network/virtualNetworks/.test/min.parameters.json create mode 100644 modules/Microsoft.Network/virtualNetworks/.test/min/deploy.test.bicep delete mode 100644 modules/Microsoft.Network/virtualNetworks/.test/parameters.json delete mode 100644 modules/Microsoft.Network/virtualNetworks/.test/vnetPeering.parameters.json create mode 100644 modules/Microsoft.Network/virtualNetworks/.test/vnetPeering/dependencies.bicep create mode 100644 modules/Microsoft.Network/virtualNetworks/.test/vnetPeering/deploy.test.bicep diff --git a/.github/workflows/ms.network.virtualnetworks.yml b/.github/workflows/ms.network.virtualnetworks.yml index a5dd9d634a..dcd2810438 100644 --- a/.github/workflows/ms.network.virtualnetworks.yml +++ b/.github/workflows/ms.network.virtualnetworks.yml @@ -106,8 +106,7 @@ jobs: - name: 'Using test file [${{ matrix.moduleTestFilePaths }}]' uses: ./.github/actions/templates/validateModuleDeployment with: - templateFilePath: '${{ env.modulePath }}/deploy.bicep' - parameterFilePath: '${{ env.modulePath }}/${{ matrix.moduleTestFilePaths }}' + templateFilePath: '${{ env.modulePath }}/${{ matrix.moduleTestFilePaths }}' location: '${{ env.location }}' resourceGroupName: '${{ env.resourceGroupName }}' subscriptionId: '${{ secrets.ARM_SUBSCRIPTION_ID }}' diff --git a/modules/Microsoft.Network/virtualNetworks/.test/default/dependencies.bicep b/modules/Microsoft.Network/virtualNetworks/.test/default/dependencies.bicep new file mode 100644 index 0000000000..9d59f33d4b --- /dev/null +++ b/modules/Microsoft.Network/virtualNetworks/.test/default/dependencies.bicep @@ -0,0 +1,33 @@ +@description('Optional. The location to deploy to.') +param location string = resourceGroup().location + +@description('Required. The name of the Managed Identity to create.') +param managedIdentityName string + +@description('Required. The name of the Route Table to create.') +param routeTableName string + +@description('Required. The name of the Network Security Group to create.') +param networkSecurityGroupName string + +resource managedIdentity 'Microsoft.ManagedIdentity/userAssignedIdentities@2018-11-30' = { + name: managedIdentityName + location: location +} + +resource routeTable 'Microsoft.Network/routeTables@2022-01-01' = { + name: routeTableName +} + +resource networkSecurityGroup 'Microsoft.Network/networkSecurityGroups@2022-01-01' = { + name: networkSecurityGroupName +} + +@description('The resource ID of the created Route Table.') +output routeTableResourceId string = routeTable.id + +@description('The resource ID of the created Route Table.') +output networkSecurityGroupResourceId string = routeTable.id + +@description('The principal ID of the created Managed Identity.') +output managedIdentityPrincipalId string = managedIdentity.properties.principalId diff --git a/modules/Microsoft.Network/virtualNetworks/.test/default/deploy.test.bicep b/modules/Microsoft.Network/virtualNetworks/.test/default/deploy.test.bicep new file mode 100644 index 0000000000..da32464815 --- /dev/null +++ b/modules/Microsoft.Network/virtualNetworks/.test/default/deploy.test.bicep @@ -0,0 +1,129 @@ +targetScope = 'subscription' + +// ========== // +// Parameters // +// ========== // +@description('Optional. The name of the resource group to deploy for a testing purposes') +@maxLength(90) +param resourceGroupName string = 'ms.network.virtualnetworks-${serviceShort}-rg' + +@description('Optional. The location to deploy resources to') +param location string = deployment().location + +@description('Optional. A short identifier for the kind of deployment .Should be kept short to not run into resource-name length-constraints') +param serviceShort string = 'nvndef' + +// =========== // +// Deployments // +// =========== // + +// General resources +// ================= +resource resourceGroup 'Microsoft.Resources/resourceGroups@2021-04-01' = { + name: resourceGroupName + location: location +} + +module resourceGroupResources 'dependencies.bicep' = { + scope: resourceGroup + name: '${uniqueString(deployment().name, location)}-paramNested' + params: { + virtualNetworkName: 'dep-<>-vnet-${serviceShort}' + managedIdentityName: 'dep-<>-msi-${serviceShort}' + routeTableName: 'dep-<>-rt-${serviceShort}' + networkSecurityGroupName: 'dep-<>-nsg-${serviceShort}' + } +} + +// Diagnostics +// =========== +module diagnosticDependencies '../../../../.shared/dependencyConstructs/diagnostic.dependencies.bicep' = { + scope: resourceGroup + name: '${uniqueString(deployment().name, location)}-diagnosticDependencies' + params: { + storageAccountName: 'dep<>diasa${serviceShort}01' + logAnalyticsWorkspaceName: 'dep-<>-law-${serviceShort}' + eventHubNamespaceEventHubName: 'dep-<>-evh-${serviceShort}' + eventHubNamespaceName: 'dep-<>-evhns-${serviceShort}' + location: location + } +} + +// ============== // +// Test Execution // +// ============== // + +module testDeployment '../../deploy.bicep' = { + scope: resourceGroup + name: '${uniqueString(deployment().name)}-test-${serviceShort}' + params: { + name: '<>${serviceShort}001' + addressPrefixes: [ + '10.0.0.0/16' + ] + diagnosticLogsRetentionInDays: 7 + diagnosticStorageAccountId: diagnosticDependencies.outputs.storageAccountResourceId + diagnosticWorkspaceId: diagnosticDependencies.outputs.logAnalyticsWorkspaceResourceId + diagnosticEventHubAuthorizationRuleId: diagnosticDependencies.outputs.eventHubAuthorizationRuleId + diagnosticEventHubName: diagnosticDependencies.outputs.eventHubNamespaceEventHubName + dnsServers: [ + '10.0.1.4' + '10.0.1.5' + ] + lock: 'CanNotDelete' + roleAssignments: [ + { + principalIds: [ + resourceGroupResources.outputs.managedIdentityPrincipalId + ] + roleDefinitionIdOrName: 'Reader' + } + ] + subnets: [ + { + addressPrefix: '10.0.255.0/24' + name: 'GatewaySubnet' + } + { + addressPrefix: '10.0.0.0/24' + name: '<>-az-subnet-x-001' + networkSecurityGroupId: resourceGroupResources.outputs.networkSecurityGroupResourceId + roleAssignments: [ + { + principalIds: [ + resourceGroupResources.outputs.managedIdentityPrincipalId + ] + roleDefinitionIdOrName: 'Reader' + } + ] + routeTableId: resourceGroupResources.outputs.routeTableResourceId + serviceEndpoints: [ + { + service: 'Microsoft.Storage' + } + { + service: 'Microsoft.Sql' + } + ] + } + { + addressPrefix: '10.0.3.0/24' + delegations: [ + { + name: 'netappDel' + properties: { + serviceName: 'Microsoft.Netapp/volumes' + } + } + ] + name: '<>-az-subnet-x-002' + } + { + addressPrefix: '10.0.6.0/24' + name: '<>-az-subnet-x-003' + privateEndpointNetworkPolicies: 'Disabled' + privateLinkServiceNetworkPolicies: 'Enabled' + } + ] + } +} diff --git a/modules/Microsoft.Network/virtualNetworks/.test/min.parameters.json b/modules/Microsoft.Network/virtualNetworks/.test/min.parameters.json deleted file mode 100644 index 2d50642770..0000000000 --- a/modules/Microsoft.Network/virtualNetworks/.test/min.parameters.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - "name": { - "value": "<>-az-vnet-min-001" - }, - "addressPrefixes": { - "value": [ - "10.0.0.0/16" - ] - } - } -} diff --git a/modules/Microsoft.Network/virtualNetworks/.test/min/deploy.test.bicep b/modules/Microsoft.Network/virtualNetworks/.test/min/deploy.test.bicep new file mode 100644 index 0000000000..eeded8a3c4 --- /dev/null +++ b/modules/Microsoft.Network/virtualNetworks/.test/min/deploy.test.bicep @@ -0,0 +1,40 @@ +targetScope = 'subscription' + +// ========== // +// Parameters // +// ========== // +@description('Optional. The name of the resource group to deploy for a testing purposes') +@maxLength(90) +param resourceGroupName string = 'ms.network.virtualnetworks-${serviceShort}-rg' + +@description('Optional. The location to deploy resources to') +param location string = deployment().location + +@description('Optional. A short identifier for the kind of deployment .Should be kept short to not run into resource-name length-constraints') +param serviceShort string = 'nvnmin' + +// =========== // +// Deployments // +// =========== // + +// General resources +// ================= +resource resourceGroup 'Microsoft.Resources/resourceGroups@2021-04-01' = { + name: resourceGroupName + location: location +} + +// ============== // +// Test Execution // +// ============== // + +module testDeployment '../../deploy.bicep' = { + scope: resourceGroup + name: '${uniqueString(deployment().name)}-test-${serviceShort}' + params: { + name: '<>${serviceShort}001' + addressPrefixes: [ + '10.0.0.0/16' + ] + } +} diff --git a/modules/Microsoft.Network/virtualNetworks/.test/parameters.json b/modules/Microsoft.Network/virtualNetworks/.test/parameters.json deleted file mode 100644 index 6cb5292ceb..0000000000 --- a/modules/Microsoft.Network/virtualNetworks/.test/parameters.json +++ /dev/null @@ -1,96 +0,0 @@ -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - "name": { - "value": "<>-az-vnet-x-001" - }, - "lock": { - "value": "CanNotDelete" - }, - "addressPrefixes": { - "value": [ - "10.0.0.0/16" - ] - }, - "subnets": { - "value": [ - { - "name": "GatewaySubnet", - "addressPrefix": "10.0.255.0/24" - }, - { - "name": "<>-az-subnet-x-001", - "addressPrefix": "10.0.0.0/24", - "networkSecurityGroupId": "/subscriptions/<>/resourceGroups/validation-rg/providers/Microsoft.Network/networkSecurityGroups/adp-<>-az-nsg-x-001", - "serviceEndpoints": [ - { - "service": "Microsoft.Storage" - }, - { - "service": "Microsoft.Sql" - } - ], - "roleAssignments": [ - { - "roleDefinitionIdOrName": "Reader", - "principalIds": [ - "<>" - ] - } - ], - "routeTableId": "/subscriptions/<>/resourceGroups/validation-rg/providers/Microsoft.Network/routeTables/adp-<>-az-udr-x-001" - }, - { - "name": "<>-az-subnet-x-002", - "addressPrefix": "10.0.3.0/24", - "delegations": [ - { - "name": "netappDel", - "properties": { - "serviceName": "Microsoft.Netapp/volumes" - } - } - ] - }, - { - "name": "<>-az-subnet-x-003", - "addressPrefix": "10.0.6.0/24", - "privateEndpointNetworkPolicies": "Disabled", - "privateLinkServiceNetworkPolicies": "Enabled" - } - ] - }, - "dnsServers": { - "value": [ - "10.0.1.4", - "10.0.1.5" - ] - }, - "roleAssignments": { - "value": [ - { - "roleDefinitionIdOrName": "Reader", - "principalIds": [ - "<>" - ] - } - ] - }, - "diagnosticLogsRetentionInDays": { - "value": 7 - }, - "diagnosticStorageAccountId": { - "value": "/subscriptions/<>/resourceGroups/validation-rg/providers/Microsoft.Storage/storageAccounts/adp<>azsax001" - }, - "diagnosticWorkspaceId": { - "value": "/subscriptions/<>/resourcegroups/validation-rg/providers/microsoft.operationalinsights/workspaces/adp-<>-az-law-x-001" - }, - "diagnosticEventHubAuthorizationRuleId": { - "value": "/subscriptions/<>/resourceGroups/validation-rg/providers/Microsoft.EventHub/namespaces/adp-<>-az-evhns-x-001/AuthorizationRules/RootManageSharedAccessKey" - }, - "diagnosticEventHubName": { - "value": "adp-<>-az-evh-x-001" - } - } -} diff --git a/modules/Microsoft.Network/virtualNetworks/.test/vnetPeering.parameters.json b/modules/Microsoft.Network/virtualNetworks/.test/vnetPeering.parameters.json deleted file mode 100644 index f8faae3175..0000000000 --- a/modules/Microsoft.Network/virtualNetworks/.test/vnetPeering.parameters.json +++ /dev/null @@ -1,52 +0,0 @@ -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - "name": { - "value": "<>-az-vnet-peer-001" - }, - "addressPrefixes": { - "value": [ - "10.0.0.0/24" - ] - }, - "subnets": { - "value": [ - { - "name": "GatewaySubnet", - "addressPrefix": "10.0.0.0/26" - } - ] - }, - "virtualNetworkPeerings": { - "value": [ - { - "remoteVirtualNetworkId": "/subscriptions/<>/resourceGroups/validation-rg/providers/Microsoft.Network/virtualNetworks/adp-<>-az-vnet-x-peer01", - "allowForwardedTraffic": true, - "allowGatewayTransit": false, - "allowVirtualNetworkAccess": true, - "useRemoteGateways": false, - "remotePeeringEnabled": true, - "remotePeeringName": "customName", - "remotePeeringAllowVirtualNetworkAccess": true, - "remotePeeringAllowForwardedTraffic": true - } - ] - }, - "diagnosticLogsRetentionInDays": { - "value": 7 - }, - "diagnosticStorageAccountId": { - "value": "/subscriptions/<>/resourceGroups/validation-rg/providers/Microsoft.Storage/storageAccounts/adp<>azsax001" - }, - "diagnosticWorkspaceId": { - "value": "/subscriptions/<>/resourcegroups/validation-rg/providers/microsoft.operationalinsights/workspaces/adp-<>-az-law-x-001" - }, - "diagnosticEventHubAuthorizationRuleId": { - "value": "/subscriptions/<>/resourceGroups/validation-rg/providers/Microsoft.EventHub/namespaces/adp-<>-az-evhns-x-001/AuthorizationRules/RootManageSharedAccessKey" - }, - "diagnosticEventHubName": { - "value": "adp-<>-az-evh-x-001" - } - } -} diff --git a/modules/Microsoft.Network/virtualNetworks/.test/vnetPeering/dependencies.bicep b/modules/Microsoft.Network/virtualNetworks/.test/vnetPeering/dependencies.bicep new file mode 100644 index 0000000000..60f4350ac5 --- /dev/null +++ b/modules/Microsoft.Network/virtualNetworks/.test/vnetPeering/dependencies.bicep @@ -0,0 +1,28 @@ +@description('Optional. The location to deploy to.') +param location string = resourceGroup().location + +@description('Required. The name of the Virtual Network to create.') +param virtualNetworkName string + +resource virtualNetwork 'Microsoft.Network/virtualNetworks@2022-01-01' = { + name: virtualNetworkName + location: location + properties: { + addressSpace: { + addressPrefixes: [ + '10.1.0.0/24' + ] + } + subnets: [ + { + name: 'defaultSubnet' + properties: { + addressPrefix: '10.1.0.0/24' + } + } + ] + } +} + +@description('The resource ID of the created Virtual Network.') +output virtualNetworkResourceId string = virtualNetwork.id diff --git a/modules/Microsoft.Network/virtualNetworks/.test/vnetPeering/deploy.test.bicep b/modules/Microsoft.Network/virtualNetworks/.test/vnetPeering/deploy.test.bicep new file mode 100644 index 0000000000..847783e2b6 --- /dev/null +++ b/modules/Microsoft.Network/virtualNetworks/.test/vnetPeering/deploy.test.bicep @@ -0,0 +1,67 @@ +targetScope = 'subscription' + +// ========== // +// Parameters // +// ========== // +@description('Optional. The name of the resource group to deploy for a testing purposes') +@maxLength(90) +param resourceGroupName string = 'ms.network.virtualnetworks-${serviceShort}-rg' + +@description('Optional. The location to deploy resources to') +param location string = deployment().location + +@description('Optional. A short identifier for the kind of deployment .Should be kept short to not run into resource-name length-constraints') +param serviceShort string = 'nvnpeer' + +// =========== // +// Deployments // +// =========== // + +// General resources +// ================= +resource resourceGroup 'Microsoft.Resources/resourceGroups@2021-04-01' = { + name: resourceGroupName + location: location +} + +module resourceGroupResources 'dependencies.bicep' = { + scope: resourceGroup + name: '${uniqueString(deployment().name, location)}-paramNested' + params: { + virtualNetworkName: 'dep-<>-vnet-${serviceShort}' + } +} + +// ============== // +// Test Execution // +// ============== // + +module testDeployment '../../deploy.bicep' = { + scope: resourceGroup + name: '${uniqueString(deployment().name)}-test-${serviceShort}' + params: { + name: '<>${serviceShort}001' + addressPrefixes: [ + '10.0.0.0/24' + ] + subnets: [ + { + addressPrefix: '10.0.0.0/26' + name: 'GatewaySubnet' + } + ] + virtualNetworkPeerings: [ + { + allowForwardedTraffic: true + allowGatewayTransit: false + allowVirtualNetworkAccess: true + remotePeeringAllowForwardedTraffic: true + remotePeeringAllowVirtualNetworkAccess: true + remotePeeringEnabled: true + remotePeeringName: 'customName' + remoteVirtualNetworkId: resourceGroupResources.outputs.virtualNetworkResourceId + useRemoteGateways: false + } + ] + } +} diff --git a/modules/Microsoft.Network/virtualNetworks/readme.md b/modules/Microsoft.Network/virtualNetworks/readme.md index 11acf83a4c..42cdfdbe2f 100644 --- a/modules/Microsoft.Network/virtualNetworks/readme.md +++ b/modules/Microsoft.Network/virtualNetworks/readme.md @@ -357,7 +357,7 @@ The following module usage examples are retrieved from the content of the files >**Note**: The name of each example is based on the name of the file from which it is taken. >**Note**: Each example lists all the required parameters first, followed by the rest - each in alphabetical order. -

Example 1: Min

+

Example 1: Default

@@ -365,66 +365,19 @@ The following module usage examples are retrieved from the content of the files ```bicep module virtualNetworks './Microsoft.Network/virtualNetworks/deploy.bicep' = { - name: '${uniqueString(deployment().name)}-VirtualNetworks' + name: '${uniqueString(deployment().name)}-test-nvndef' params: { // Required parameters addressPrefixes: [ '10.0.0.0/16' ] - name: '<>-az-vnet-min-001' - } -} -``` - -
-

- -

- -via JSON Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - // Required parameters - "addressPrefixes": { - "value": [ - "10.0.0.0/16" - ] - }, - "name": { - "value": "<>-az-vnet-min-001" - } - } -} -``` - -
-

- -

Example 2: Parameters

- -
- -via Bicep module - -```bicep -module virtualNetworks './Microsoft.Network/virtualNetworks/deploy.bicep' = { - name: '${uniqueString(deployment().name)}-VirtualNetworks' - params: { - // Required parameters - addressPrefixes: [ - '10.0.0.0/16' - ] - name: '<>-az-vnet-x-001' + name: '<>nvndef001' // Non-required parameters - diagnosticEventHubAuthorizationRuleId: '/subscriptions/<>/resourceGroups/validation-rg/providers/Microsoft.EventHub/namespaces/adp-<>-az-evhns-x-001/AuthorizationRules/RootManageSharedAccessKey' - diagnosticEventHubName: 'adp-<>-az-evh-x-001' + diagnosticEventHubAuthorizationRuleId: '' + diagnosticEventHubName: '' diagnosticLogsRetentionInDays: 7 - diagnosticStorageAccountId: '/subscriptions/<>/resourceGroups/validation-rg/providers/Microsoft.Storage/storageAccounts/adp<>azsax001' - diagnosticWorkspaceId: '/subscriptions/<>/resourcegroups/validation-rg/providers/microsoft.operationalinsights/workspaces/adp-<>-az-law-x-001' + diagnosticStorageAccountId: '' + diagnosticWorkspaceId: '' dnsServers: [ '10.0.1.4' '10.0.1.5' @@ -433,7 +386,7 @@ module virtualNetworks './Microsoft.Network/virtualNetworks/deploy.bicep' = { roleAssignments: [ { principalIds: [ - '<>' + '' ] roleDefinitionIdOrName: 'Reader' } @@ -446,16 +399,16 @@ module virtualNetworks './Microsoft.Network/virtualNetworks/deploy.bicep' = { { addressPrefix: '10.0.0.0/24' name: '<>-az-subnet-x-001' - networkSecurityGroupId: '/subscriptions/<>/resourceGroups/validation-rg/providers/Microsoft.Network/networkSecurityGroups/adp-<>-az-nsg-x-001' + networkSecurityGroupId: '' roleAssignments: [ { principalIds: [ - '<>' + '' ] roleDefinitionIdOrName: 'Reader' } ] - routeTableId: '/subscriptions/<>/resourceGroups/validation-rg/providers/Microsoft.Network/routeTables/adp-<>-az-udr-x-001' + routeTableId: '' serviceEndpoints: [ { service: 'Microsoft.Storage' @@ -507,23 +460,23 @@ module virtualNetworks './Microsoft.Network/virtualNetworks/deploy.bicep' = { ] }, "name": { - "value": "<>-az-vnet-x-001" + "value": "<>nvndef001" }, // Non-required parameters "diagnosticEventHubAuthorizationRuleId": { - "value": "/subscriptions/<>/resourceGroups/validation-rg/providers/Microsoft.EventHub/namespaces/adp-<>-az-evhns-x-001/AuthorizationRules/RootManageSharedAccessKey" + "value": "" }, "diagnosticEventHubName": { - "value": "adp-<>-az-evh-x-001" + "value": "" }, "diagnosticLogsRetentionInDays": { "value": 7 }, "diagnosticStorageAccountId": { - "value": "/subscriptions/<>/resourceGroups/validation-rg/providers/Microsoft.Storage/storageAccounts/adp<>azsax001" + "value": "" }, "diagnosticWorkspaceId": { - "value": "/subscriptions/<>/resourcegroups/validation-rg/providers/microsoft.operationalinsights/workspaces/adp-<>-az-law-x-001" + "value": "" }, "dnsServers": { "value": [ @@ -538,7 +491,7 @@ module virtualNetworks './Microsoft.Network/virtualNetworks/deploy.bicep' = { "value": [ { "principalIds": [ - "<>" + "" ], "roleDefinitionIdOrName": "Reader" } @@ -553,16 +506,16 @@ module virtualNetworks './Microsoft.Network/virtualNetworks/deploy.bicep' = { { "addressPrefix": "10.0.0.0/24", "name": "<>-az-subnet-x-001", - "networkSecurityGroupId": "/subscriptions/<>/resourceGroups/validation-rg/providers/Microsoft.Network/networkSecurityGroups/adp-<>-az-nsg-x-001", + "networkSecurityGroupId": "", "roleAssignments": [ { "principalIds": [ - "<>" + "" ], "roleDefinitionIdOrName": "Reader" } ], - "routeTableId": "/subscriptions/<>/resourceGroups/validation-rg/providers/Microsoft.Network/routeTables/adp-<>-az-udr-x-001", + "routeTableId": "", "serviceEndpoints": [ { "service": "Microsoft.Storage" @@ -599,6 +552,53 @@ module virtualNetworks './Microsoft.Network/virtualNetworks/deploy.bicep' = {

+

Example 2: Min

+ +
+ +via Bicep module + +```bicep +module virtualNetworks './Microsoft.Network/virtualNetworks/deploy.bicep' = { + name: '${uniqueString(deployment().name)}-test-nvnmin' + params: { + // Required parameters + addressPrefixes: [ + '10.0.0.0/16' + ] + name: '<>nvnmin001' + } +} +``` + +
+

+ +

+ +via JSON Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "parameters": { + // Required parameters + "addressPrefixes": { + "value": [ + "10.0.0.0/16" + ] + }, + "name": { + "value": "<>nvnmin001" + } + } +} +``` + +
+

+

Example 3: Vnetpeering

@@ -607,19 +607,14 @@ module virtualNetworks './Microsoft.Network/virtualNetworks/deploy.bicep' = { ```bicep module virtualNetworks './Microsoft.Network/virtualNetworks/deploy.bicep' = { - name: '${uniqueString(deployment().name)}-VirtualNetworks' + name: '${uniqueString(deployment().name)}-test-nvnpeer' params: { // Required parameters addressPrefixes: [ '10.0.0.0/24' ] - name: '<>-az-vnet-peer-001' + name: '<>nvnpeer001' // Non-required parameters - diagnosticEventHubAuthorizationRuleId: '/subscriptions/<>/resourceGroups/validation-rg/providers/Microsoft.EventHub/namespaces/adp-<>-az-evhns-x-001/AuthorizationRules/RootManageSharedAccessKey' - diagnosticEventHubName: 'adp-<>-az-evh-x-001' - diagnosticLogsRetentionInDays: 7 - diagnosticStorageAccountId: '/subscriptions/<>/resourceGroups/validation-rg/providers/Microsoft.Storage/storageAccounts/adp<>azsax001' - diagnosticWorkspaceId: '/subscriptions/<>/resourcegroups/validation-rg/providers/microsoft.operationalinsights/workspaces/adp-<>-az-law-x-001' subnets: [ { addressPrefix: '10.0.0.0/26' @@ -635,7 +630,7 @@ module virtualNetworks './Microsoft.Network/virtualNetworks/deploy.bicep' = { remotePeeringAllowVirtualNetworkAccess: true remotePeeringEnabled: true remotePeeringName: 'customName' - remoteVirtualNetworkId: '/subscriptions/<>/resourceGroups/validation-rg/providers/Microsoft.Network/virtualNetworks/adp-<>-az-vnet-x-peer01' + remoteVirtualNetworkId: '' useRemoteGateways: false } ] @@ -662,24 +657,9 @@ module virtualNetworks './Microsoft.Network/virtualNetworks/deploy.bicep' = { ] }, "name": { - "value": "<>-az-vnet-peer-001" + "value": "<>nvnpeer001" }, // Non-required parameters - "diagnosticEventHubAuthorizationRuleId": { - "value": "/subscriptions/<>/resourceGroups/validation-rg/providers/Microsoft.EventHub/namespaces/adp-<>-az-evhns-x-001/AuthorizationRules/RootManageSharedAccessKey" - }, - "diagnosticEventHubName": { - "value": "adp-<>-az-evh-x-001" - }, - "diagnosticLogsRetentionInDays": { - "value": 7 - }, - "diagnosticStorageAccountId": { - "value": "/subscriptions/<>/resourceGroups/validation-rg/providers/Microsoft.Storage/storageAccounts/adp<>azsax001" - }, - "diagnosticWorkspaceId": { - "value": "/subscriptions/<>/resourcegroups/validation-rg/providers/microsoft.operationalinsights/workspaces/adp-<>-az-law-x-001" - }, "subnets": { "value": [ { @@ -698,7 +678,7 @@ module virtualNetworks './Microsoft.Network/virtualNetworks/deploy.bicep' = { "remotePeeringAllowVirtualNetworkAccess": true, "remotePeeringEnabled": true, "remotePeeringName": "customName", - "remoteVirtualNetworkId": "/subscriptions/<>/resourceGroups/validation-rg/providers/Microsoft.Network/virtualNetworks/adp-<>-az-vnet-x-peer01", + "remoteVirtualNetworkId": "", "useRemoteGateways": false } ] From 564ef49a4626ec87fd6378312d1d2f917c8056a9 Mon Sep 17 00:00:00 2001 From: MrMCake Date: Sun, 4 Sep 2022 14:27:43 +0200 Subject: [PATCH 02/12] Updated VirtualNetwork to new dependency approach --- .../virtualNetworks/.test/default/deploy.test.bicep | 1 - 1 file changed, 1 deletion(-) diff --git a/modules/Microsoft.Network/virtualNetworks/.test/default/deploy.test.bicep b/modules/Microsoft.Network/virtualNetworks/.test/default/deploy.test.bicep index da32464815..40cd9163f0 100644 --- a/modules/Microsoft.Network/virtualNetworks/.test/default/deploy.test.bicep +++ b/modules/Microsoft.Network/virtualNetworks/.test/default/deploy.test.bicep @@ -28,7 +28,6 @@ module resourceGroupResources 'dependencies.bicep' = { scope: resourceGroup name: '${uniqueString(deployment().name, location)}-paramNested' params: { - virtualNetworkName: 'dep-<>-vnet-${serviceShort}' managedIdentityName: 'dep-<>-msi-${serviceShort}' routeTableName: 'dep-<>-rt-${serviceShort}' networkSecurityGroupName: 'dep-<>-nsg-${serviceShort}' From 950e684015bc6b9b670545d00b9c39167f25fca3 Mon Sep 17 00:00:00 2001 From: MrMCake Date: Sun, 4 Sep 2022 14:42:21 +0200 Subject: [PATCH 03/12] Update to latest --- .../virtualNetworks/.test/default/dependencies.bicep | 2 ++ 1 file changed, 2 insertions(+) diff --git a/modules/Microsoft.Network/virtualNetworks/.test/default/dependencies.bicep b/modules/Microsoft.Network/virtualNetworks/.test/default/dependencies.bicep index 9d59f33d4b..1ca2b29b3a 100644 --- a/modules/Microsoft.Network/virtualNetworks/.test/default/dependencies.bicep +++ b/modules/Microsoft.Network/virtualNetworks/.test/default/dependencies.bicep @@ -17,10 +17,12 @@ resource managedIdentity 'Microsoft.ManagedIdentity/userAssignedIdentities@2018- resource routeTable 'Microsoft.Network/routeTables@2022-01-01' = { name: routeTableName + location: location } resource networkSecurityGroup 'Microsoft.Network/networkSecurityGroups@2022-01-01' = { name: networkSecurityGroupName + location: location } @description('The resource ID of the created Route Table.') From 2366b0deb7b9b79a6d7add9a3f3d241d2d83426e Mon Sep 17 00:00:00 2001 From: MrMCake Date: Sun, 4 Sep 2022 14:59:39 +0200 Subject: [PATCH 04/12] Update to latest --- .../virtualNetworks/.test/default/dependencies.bicep | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/Microsoft.Network/virtualNetworks/.test/default/dependencies.bicep b/modules/Microsoft.Network/virtualNetworks/.test/default/dependencies.bicep index 1ca2b29b3a..bc81ed6535 100644 --- a/modules/Microsoft.Network/virtualNetworks/.test/default/dependencies.bicep +++ b/modules/Microsoft.Network/virtualNetworks/.test/default/dependencies.bicep @@ -29,7 +29,7 @@ resource networkSecurityGroup 'Microsoft.Network/networkSecurityGroups@2022-01-0 output routeTableResourceId string = routeTable.id @description('The resource ID of the created Route Table.') -output networkSecurityGroupResourceId string = routeTable.id +output networkSecurityGroupResourceId string = networkSecurityGroup.id @description('The principal ID of the created Managed Identity.') output managedIdentityPrincipalId string = managedIdentity.properties.principalId From f75b999054901bde3653e82b601f81601c83cf0a Mon Sep 17 00:00:00 2001 From: MrMCake Date: Thu, 8 Sep 2022 19:16:08 +0200 Subject: [PATCH 05/12] Updated folder default to common. --- .../.test/{default => common}/dependencies.bicep | 0 .../virtualNetworks/.test/{default => common}/deploy.test.bicep | 0 modules/Microsoft.Network/virtualNetworks/readme.md | 2 +- 3 files changed, 1 insertion(+), 1 deletion(-) rename modules/Microsoft.Network/virtualNetworks/.test/{default => common}/dependencies.bicep (100%) rename modules/Microsoft.Network/virtualNetworks/.test/{default => common}/deploy.test.bicep (100%) diff --git a/modules/Microsoft.Network/virtualNetworks/.test/default/dependencies.bicep b/modules/Microsoft.Network/virtualNetworks/.test/common/dependencies.bicep similarity index 100% rename from modules/Microsoft.Network/virtualNetworks/.test/default/dependencies.bicep rename to modules/Microsoft.Network/virtualNetworks/.test/common/dependencies.bicep diff --git a/modules/Microsoft.Network/virtualNetworks/.test/default/deploy.test.bicep b/modules/Microsoft.Network/virtualNetworks/.test/common/deploy.test.bicep similarity index 100% rename from modules/Microsoft.Network/virtualNetworks/.test/default/deploy.test.bicep rename to modules/Microsoft.Network/virtualNetworks/.test/common/deploy.test.bicep diff --git a/modules/Microsoft.Network/virtualNetworks/readme.md b/modules/Microsoft.Network/virtualNetworks/readme.md index 42cdfdbe2f..829939b504 100644 --- a/modules/Microsoft.Network/virtualNetworks/readme.md +++ b/modules/Microsoft.Network/virtualNetworks/readme.md @@ -357,7 +357,7 @@ The following module usage examples are retrieved from the content of the files >**Note**: The name of each example is based on the name of the file from which it is taken. >**Note**: Each example lists all the required parameters first, followed by the rest - each in alphabetical order. -

Example 1: Default

+

Example 1: Common

From f9249ea4e37217bdc380d1334e0c3e00ac4f5664 Mon Sep 17 00:00:00 2001 From: MrMCake Date: Fri, 9 Sep 2022 12:52:09 +0200 Subject: [PATCH 06/12] Update to latest --- .../virtualNetworks/.test/common/deploy.test.bicep | 4 ++-- .../virtualNetworks/.test/min/deploy.test.bicep | 2 +- .../virtualNetworks/.test/vnetPeering/deploy.test.bicep | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/modules/Microsoft.Network/virtualNetworks/.test/common/deploy.test.bicep b/modules/Microsoft.Network/virtualNetworks/.test/common/deploy.test.bicep index 40cd9163f0..9f61af2205 100644 --- a/modules/Microsoft.Network/virtualNetworks/.test/common/deploy.test.bicep +++ b/modules/Microsoft.Network/virtualNetworks/.test/common/deploy.test.bicep @@ -10,8 +10,8 @@ param resourceGroupName string = 'ms.network.virtualnetworks-${serviceShort}-rg' @description('Optional. The location to deploy resources to') param location string = deployment().location -@description('Optional. A short identifier for the kind of deployment .Should be kept short to not run into resource-name length-constraints') -param serviceShort string = 'nvndef' +@description('Optional. A short identifier for the kind of deployment. Should be kept short to not run into resource-name length-constraints') +param serviceShort string = 'nvncom' // =========== // // Deployments // diff --git a/modules/Microsoft.Network/virtualNetworks/.test/min/deploy.test.bicep b/modules/Microsoft.Network/virtualNetworks/.test/min/deploy.test.bicep index eeded8a3c4..a8b43f5a2d 100644 --- a/modules/Microsoft.Network/virtualNetworks/.test/min/deploy.test.bicep +++ b/modules/Microsoft.Network/virtualNetworks/.test/min/deploy.test.bicep @@ -10,7 +10,7 @@ param resourceGroupName string = 'ms.network.virtualnetworks-${serviceShort}-rg' @description('Optional. The location to deploy resources to') param location string = deployment().location -@description('Optional. A short identifier for the kind of deployment .Should be kept short to not run into resource-name length-constraints') +@description('Optional. A short identifier for the kind of deployment. Should be kept short to not run into resource-name length-constraints') param serviceShort string = 'nvnmin' // =========== // diff --git a/modules/Microsoft.Network/virtualNetworks/.test/vnetPeering/deploy.test.bicep b/modules/Microsoft.Network/virtualNetworks/.test/vnetPeering/deploy.test.bicep index 847783e2b6..781b44e2fc 100644 --- a/modules/Microsoft.Network/virtualNetworks/.test/vnetPeering/deploy.test.bicep +++ b/modules/Microsoft.Network/virtualNetworks/.test/vnetPeering/deploy.test.bicep @@ -10,7 +10,7 @@ param resourceGroupName string = 'ms.network.virtualnetworks-${serviceShort}-rg' @description('Optional. The location to deploy resources to') param location string = deployment().location -@description('Optional. A short identifier for the kind of deployment .Should be kept short to not run into resource-name length-constraints') +@description('Optional. A short identifier for the kind of deployment. Should be kept short to not run into resource-name length-constraints') param serviceShort string = 'nvnpeer' // =========== // From d017f8b37fdc0da8f8fad83ef99e57e59e26f23f Mon Sep 17 00:00:00 2001 From: MrMCake Date: Fri, 9 Sep 2022 13:05:24 +0200 Subject: [PATCH 07/12] Update to latest --- .../virtualNetworks/.test/common/deploy.test.bicep | 6 +++--- .../virtualNetworks/.test/min/deploy.test.bicep | 6 +++--- .../virtualNetworks/.test/vnetPeering/deploy.test.bicep | 6 +++--- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/modules/Microsoft.Network/virtualNetworks/.test/common/deploy.test.bicep b/modules/Microsoft.Network/virtualNetworks/.test/common/deploy.test.bicep index 9f61af2205..7518c2e63e 100644 --- a/modules/Microsoft.Network/virtualNetworks/.test/common/deploy.test.bicep +++ b/modules/Microsoft.Network/virtualNetworks/.test/common/deploy.test.bicep @@ -3,14 +3,14 @@ targetScope = 'subscription' // ========== // // Parameters // // ========== // -@description('Optional. The name of the resource group to deploy for a testing purposes') +@description('Optional. The name of the resource group to deploy for a testing purposes.') @maxLength(90) param resourceGroupName string = 'ms.network.virtualnetworks-${serviceShort}-rg' -@description('Optional. The location to deploy resources to') +@description('Optional. The location to deploy resources to.') param location string = deployment().location -@description('Optional. A short identifier for the kind of deployment. Should be kept short to not run into resource-name length-constraints') +@description('Optional. A short identifier for the kind of deployment. Should be kept short to not run into resource-name length-constraints.') param serviceShort string = 'nvncom' // =========== // diff --git a/modules/Microsoft.Network/virtualNetworks/.test/min/deploy.test.bicep b/modules/Microsoft.Network/virtualNetworks/.test/min/deploy.test.bicep index a8b43f5a2d..b4e9325f33 100644 --- a/modules/Microsoft.Network/virtualNetworks/.test/min/deploy.test.bicep +++ b/modules/Microsoft.Network/virtualNetworks/.test/min/deploy.test.bicep @@ -3,14 +3,14 @@ targetScope = 'subscription' // ========== // // Parameters // // ========== // -@description('Optional. The name of the resource group to deploy for a testing purposes') +@description('Optional. The name of the resource group to deploy for a testing purposes.') @maxLength(90) param resourceGroupName string = 'ms.network.virtualnetworks-${serviceShort}-rg' -@description('Optional. The location to deploy resources to') +@description('Optional. The location to deploy resources to.') param location string = deployment().location -@description('Optional. A short identifier for the kind of deployment. Should be kept short to not run into resource-name length-constraints') +@description('Optional. A short identifier for the kind of deployment. Should be kept short to not run into resource-name length-constraints.') param serviceShort string = 'nvnmin' // =========== // diff --git a/modules/Microsoft.Network/virtualNetworks/.test/vnetPeering/deploy.test.bicep b/modules/Microsoft.Network/virtualNetworks/.test/vnetPeering/deploy.test.bicep index 781b44e2fc..40c642d683 100644 --- a/modules/Microsoft.Network/virtualNetworks/.test/vnetPeering/deploy.test.bicep +++ b/modules/Microsoft.Network/virtualNetworks/.test/vnetPeering/deploy.test.bicep @@ -3,14 +3,14 @@ targetScope = 'subscription' // ========== // // Parameters // // ========== // -@description('Optional. The name of the resource group to deploy for a testing purposes') +@description('Optional. The name of the resource group to deploy for a testing purposes.') @maxLength(90) param resourceGroupName string = 'ms.network.virtualnetworks-${serviceShort}-rg' -@description('Optional. The location to deploy resources to') +@description('Optional. The location to deploy resources to.') param location string = deployment().location -@description('Optional. A short identifier for the kind of deployment. Should be kept short to not run into resource-name length-constraints') +@description('Optional. A short identifier for the kind of deployment. Should be kept short to not run into resource-name length-constraints.') param serviceShort string = 'nvnpeer' // =========== // From 5572427454757dd00987b15fb6197bd73b959609 Mon Sep 17 00:00:00 2001 From: MrMCake Date: Fri, 9 Sep 2022 13:58:56 +0200 Subject: [PATCH 08/12] Update to latest --- modules/Microsoft.Network/virtualNetworks/readme.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/Microsoft.Network/virtualNetworks/readme.md b/modules/Microsoft.Network/virtualNetworks/readme.md index d4c191751e..325be20e03 100644 --- a/modules/Microsoft.Network/virtualNetworks/readme.md +++ b/modules/Microsoft.Network/virtualNetworks/readme.md @@ -366,13 +366,13 @@ The following module usage examples are retrieved from the content of the files ```bicep module virtualNetworks './Microsoft.Network/virtualNetworks/deploy.bicep' = { - name: '${uniqueString(deployment().name)}-test-nvndef' + name: '${uniqueString(deployment().name)}-test-nvncom' params: { // Required parameters addressPrefixes: [ '10.0.0.0/16' ] - name: '<>nvndef001' + name: '<>nvncom001' // Non-required parameters diagnosticEventHubAuthorizationRuleId: '' diagnosticEventHubName: '' @@ -461,7 +461,7 @@ module virtualNetworks './Microsoft.Network/virtualNetworks/deploy.bicep' = { ] }, "name": { - "value": "<>nvndef001" + "value": "<>nvncom001" }, // Non-required parameters "diagnosticEventHubAuthorizationRuleId": { From 30e55dd6fd576f87b06be1d3cc3eba7c4663a9d2 Mon Sep 17 00:00:00 2001 From: Alexander Sehr Date: Sun, 18 Sep 2022 22:31:01 +0200 Subject: [PATCH 09/12] Update modules/Microsoft.Network/virtualNetworks/.test/common/deploy.test.bicep Co-authored-by: Erika Gressi <56914614+eriqua@users.noreply.github.com> --- .../virtualNetworks/.test/common/deploy.test.bicep | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/Microsoft.Network/virtualNetworks/.test/common/deploy.test.bicep b/modules/Microsoft.Network/virtualNetworks/.test/common/deploy.test.bicep index 7518c2e63e..43b21531e8 100644 --- a/modules/Microsoft.Network/virtualNetworks/.test/common/deploy.test.bicep +++ b/modules/Microsoft.Network/virtualNetworks/.test/common/deploy.test.bicep @@ -3,7 +3,7 @@ targetScope = 'subscription' // ========== // // Parameters // // ========== // -@description('Optional. The name of the resource group to deploy for a testing purposes.') +@description('Optional. The name of the resource group to deploy for testing purposes.') @maxLength(90) param resourceGroupName string = 'ms.network.virtualnetworks-${serviceShort}-rg' From f3153572c02f1b6ec1cecb69a04942cb72b4460a Mon Sep 17 00:00:00 2001 From: Alexander Sehr Date: Sun, 18 Sep 2022 22:37:01 +0200 Subject: [PATCH 10/12] Update modules/Microsoft.Network/virtualNetworks/.test/min/deploy.test.bicep Co-authored-by: Erika Gressi <56914614+eriqua@users.noreply.github.com> --- .../virtualNetworks/.test/min/deploy.test.bicep | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/Microsoft.Network/virtualNetworks/.test/min/deploy.test.bicep b/modules/Microsoft.Network/virtualNetworks/.test/min/deploy.test.bicep index b4e9325f33..bb1b2263da 100644 --- a/modules/Microsoft.Network/virtualNetworks/.test/min/deploy.test.bicep +++ b/modules/Microsoft.Network/virtualNetworks/.test/min/deploy.test.bicep @@ -3,7 +3,7 @@ targetScope = 'subscription' // ========== // // Parameters // // ========== // -@description('Optional. The name of the resource group to deploy for a testing purposes.') +@description('Optional. The name of the resource group to deploy for testing purposes.') @maxLength(90) param resourceGroupName string = 'ms.network.virtualnetworks-${serviceShort}-rg' From 0de87bc2a95f6af8628caefd978202ef30843f94 Mon Sep 17 00:00:00 2001 From: Alexander Sehr Date: Sun, 18 Sep 2022 22:37:11 +0200 Subject: [PATCH 11/12] Update modules/Microsoft.Network/virtualNetworks/.test/vnetPeering/deploy.test.bicep Co-authored-by: Erika Gressi <56914614+eriqua@users.noreply.github.com> --- .../virtualNetworks/.test/vnetPeering/deploy.test.bicep | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/Microsoft.Network/virtualNetworks/.test/vnetPeering/deploy.test.bicep b/modules/Microsoft.Network/virtualNetworks/.test/vnetPeering/deploy.test.bicep index 40c642d683..283ff8b692 100644 --- a/modules/Microsoft.Network/virtualNetworks/.test/vnetPeering/deploy.test.bicep +++ b/modules/Microsoft.Network/virtualNetworks/.test/vnetPeering/deploy.test.bicep @@ -3,7 +3,7 @@ targetScope = 'subscription' // ========== // // Parameters // // ========== // -@description('Optional. The name of the resource group to deploy for a testing purposes.') +@description('Optional. The name of the resource group to deploy for testing purposes.') @maxLength(90) param resourceGroupName string = 'ms.network.virtualnetworks-${serviceShort}-rg' From 70f8383c6a4d0f76f0ee66021dab472046b84ff5 Mon Sep 17 00:00:00 2001 From: Alexander Sehr Date: Sun, 18 Sep 2022 22:38:02 +0200 Subject: [PATCH 12/12] Update modules/Microsoft.Network/virtualNetworks/.test/common/dependencies.bicep Co-authored-by: Erika Gressi <56914614+eriqua@users.noreply.github.com> --- .../virtualNetworks/.test/common/dependencies.bicep | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/Microsoft.Network/virtualNetworks/.test/common/dependencies.bicep b/modules/Microsoft.Network/virtualNetworks/.test/common/dependencies.bicep index bc81ed6535..a2fb172d43 100644 --- a/modules/Microsoft.Network/virtualNetworks/.test/common/dependencies.bicep +++ b/modules/Microsoft.Network/virtualNetworks/.test/common/dependencies.bicep @@ -28,7 +28,7 @@ resource networkSecurityGroup 'Microsoft.Network/networkSecurityGroups@2022-01-0 @description('The resource ID of the created Route Table.') output routeTableResourceId string = routeTable.id -@description('The resource ID of the created Route Table.') +@description('The resource ID of the created Network Security Group.') output networkSecurityGroupResourceId string = networkSecurityGroup.id @description('The principal ID of the created Managed Identity.')