Azure/ResourceModules v0.8.0

on GitHub

Highlights

📯Self-contained dependencies approach to module deployment validation: All tests are now deploying their own resource dependencies together with the target test resource in a dedicated resource group and removed afterwards. In addition, module test JSON parameter files have been converted to Bicep test files:

When you onboarded CARML in version 0.7.0 and before, you had to first run a dependency pipeline that would deploy a set of 'persistent' Azure services we'd then use in subsequent module tests as references (for example to deploy a VM into a VNET) as seen in the following image.

Now, from version 0.8.0 onward, these dependencies (if any) are deployed as part of each module's test. This means, the VM test would deploy itself the aforementioned VNET and all resources would be removed after:

📯Deployment history cleanup: A scheduled pipeline has been introduced to automatically cleanup deployment history for Management Group and Subscription scopes.
📯Alignment with latest Bicep linter rules: Fixes have been implemented throughout the library to comply with decompiler-cleanup and prefer-unquoted-property-names linter rules. In particular, a new utility Update-RoleAssignmentList allows to update latest available Role Definitions for each module nested Role Assignments while complying with the prefer-unquoted-property-names linter rule.

Modules

• Update all modules' tests to new dependencies approach
• New modules:
  • Microsoft.Network/applicationGatewayWebApplicationFirewallPolicies
  • Microsoft.Network/dnsResolvers
  • Microsoft.Maintenance/maintenanceConfigurations
• Updated API version for several modules: ACR, RSV, VMSS, AKS, ML Workspaces, Private Endpoints, Virtual Hubs, Locks, Compute Images, Policy Exemptions, Role Definitions, Proximity Placement Groups
• Extend modules with child resources and new features:
  • Multi additions to staticSites
  • Add TLS setting support to SQLMI
  • Extend Web Sites with kvrefidentity
  • Updated virtualNetworkGateways to support AAD VPN
  • Enable Key Vault Purge Protection per default (disable in tests)
  • Update ubuntu and windows OS images used for tests to latest versions
  • Added Elastic Pool support to SQL Server
  • Added replication alerts to Recovery Services Vault
  • Allow upgrading all node pools in an AKS cluster to the same Kubernetes version
  • Allow creating a ContainerGroup with one or more containers
• Add missing tags to Key Vaults, User Assigned Identities and Web Server Farms common test
• Align networkAcls implementation for StorageAccounts, KeyVaults and CognitiveServices modules
• Update nested_roleAssignment to comply with prefer-unquoted-property-names linter rule
• Fixing linter warning decompiler-cleanup
• Replacing hardcoded environment URLs with the environment() function
• Updated MS.AuthZ namespace modules to use .id for ResourceID outputs

CI environment

• Added scheduled pipelines for Subscription & Management-Group Deployment history cleanup
• Updated the deployment name generation to be more detailed
• Broken links pipeline update
• Updated GitHub workflows to use actions-checkout@v3
• Replace set-output commands with GH environment file $env:GITHUB_OUTPUT
• Update static validation result publish version to v2
• Update removal to support Azure Security Center module
• Updated RBAC tests to be more explicit about the principal type
• Extend and optimize resource removal of nested deployments with higher scope than the parent
• Remove support to previous deployment validation approach

Wiki

• Solution creation section: Azure DevOps example for pipeline-orchestration
• Update Fetch latest updates section and fix broken links
• Additional cleanup after converted test files

Utilities

• Added utility Update-RoleAssignmentList
• Updated compatability of Set-ModuleReadMe utility to new dependencies approach, handle inline quotations and improved function identification regex
• Updated compatability of Test-NamePrefixAvailability utility to new dependencies approach
• Updated compatability of ConvertTo-ARMTemplate utility to new dependencies approach

Fixes

• Improve disk encryption options to VM and VMSS
• Fix typo in readmes and parameter files: privateDnsZoneGroups to privateDnsZoneGroup
• Fixed RBAC File Names & Roles accross multiple modules
• Key Vault - Fix parameter usage section
• Fixed usage of deployment name in Test-Deployment script
• Update Linter pipeline filename and trigger
• Updated the way child module readmes are referenced
• Fixed location of settings

New Contributors

• @tyconsulting made their first contribution in #2037
• @cjnova made their first contribution in #2092
• @oliverlabs made their first contribution in #2120
• @ehanlon made their first contribution in #2164
• @coolhome made their first contribution in #2262

All merged PRs

Full Changelog: v0.7.0...v0.8.0

• [Modules] Updated KeyVault vaults to new dependencies approach by @AlexanderSehr in #2002
• [Utilities] Update script to generate custom release notes by @eriqua in #2063
• [Modules] Updated Resources ResourceGroups to new dependencies approach by @AlexanderSehr in #2062
• [Modules] Updated VirtualNetwork to new dependency approach by @AlexanderSehr in #1884
• [Modules] Update ACR module api version to 2022-02-01-preview by @tyconsulting in #2037
• [Modules] Updated API reference (Microsoft.Authorization/roleDefinition) to the newest one. Issue #1998 by @cjnova in #2092
• [Fixes] Fixed Readme files and Pester tests after recent new line change by @ahmadabdalla in #2132
• [Utilities] Increased flexibility on parameter table search by @AlexanderSehr in #2133
• [Fixes] Virtual Machine - fixed the subnetId (should be subnetResourceId) old reference for the… by @oliverlabs in #2120
• [Modules] Updated KubernetesConfiguration/Extensions to new dependency approach by @AlexanderSehr in #1827
• [Modules] Updated KubernetesConfiguration/FluxConfigurations to new dependency approach by @AlexanderSehr in #1828
• [Modules] Updated Consumption budgets to new dependencies approach by @AlexanderSehr in #1962
• [Modules] Updated Insight MetricAlertsto new dependencies approach by @AlexanderSehr in #2108
• [Utilities] Enabled no-param blocks by @AlexanderSehr in #2134
• [Modules] Updated Web/StaticSites to new dependencies approach by @AlexanderSehr in #1898
• [Modules] Updated Network/Connections to new dependency approach by @AlexanderSehr in #1829
• [Fixes] Fix typo in readmes and parameter files: "privateDnsZoneGroups" to "privateDnsZoneGroup" by @rahalan in #2137
• [Wiki] Azure DevOps example for pipeline-orchestration by @segraef in #1862
• [Modules] Update Network Public IP Addresses to new dependencies approach by @AlexanderSehr in #2080
• [Modules] Add new module: WAF policy by @rahalan in #2138
• [Fixes] Consumption Budget readme update by @eriqua in #2141
• [Fixes] Fix WAF policy readme by @rahalan in #2145
• [Fixes] Fixed incorrect depenency variable reference by @AlexanderSehr in #2146
• [Fixes] Fixed ADO Pipeline & Readme for AppGW WAF Policy by @AlexanderSehr in #2147
• [Modules] Updated Network/VPNSites to new dependency approach by @AlexanderSehr in #1834
• [Modules] Updated Network/VirtualHubs to new dependency approach by @AlexanderSehr in #1831
• [CI environment] Extend and optimize resource removal of nested deployments with higher scope than the parent by @eriqua in #2148
• [CI environment] Removed checkout repository leftovers by @AlexanderSehr in #2155
• [Modules] Updated web connection to new dependencies approach by @elanzel in #2154
• [Fixes] Fixed RBAC File Names & Roles accross multiple modules by @AlexanderSehr in #2158
• [Modules] Updated DataProtection Backup Vaults to new dependency approach by @AlexanderSehr in #1876
• [Modules] Updated RecoveryServices Vault to new dependency approach by @AlexanderSehr in #2011
• [Modules] Updated Insight Components to new dependencies approach by @AlexanderSehr in #2104
• [Fixes] Update WAF readme by @eriqua in #2162
• [Modules] Updated ContainerRegistry/Registries to new dependency approach by @AlexanderSehr in #1823
• [Modules] Updated Compute Images to new dependency approach by @eriqua in #2019
• [Modules] Multi additions to staticSites by @AlexanderSehr in #1662
• [Fixes] Fix Web StaticSites readme by @eriqua in #2167
• [Modules] RSV API version update by @eriqua in #2165
• [Modules] Update Network PrivateDNSZones to new dependencies approach by @AlexanderSehr in #2084
• [Modules] Updated Insight DiagnosticSettings to new dependencies approach by @AlexanderSehr in #2106
• [Modules] Updated EventHub Namespaces to new dependencies approach & extended readme script by @AlexanderSehr in #2088
• [Modules] Updated EventGrid Topics to new dependencies approach by @AlexanderSehr in #2086
• [Modules] Update VMSS API version by @ehanlon in #2164
• [Modules] Update Network PrivateEndpoints to new dependencies approach by @AlexanderSehr in #2082
• [Modules] Updated Network PublicIPPrefixes to new dependencies approach by @AlexanderSehr in #2078
• [Modules] Update Network Route Tables to new dependencies approach by @AlexanderSehr in #2076
• [Modules] Updated Resources Tags to new dependency approach by @AlexanderSehr in #2074
• [Fixes] Key Vault - Fix parameter usage section by @eriqua in #2171
• [Modules] Updated CognitiveServices/Accounts to new dependency approach by @AlexanderSehr in #1825
• [Modules] Align networkAcls implementation and update parameter usage by @eriqua in #2173
• [Modules] Updated Insights ScheduledQueryRules to new dependencies approach & increased test robustness by @AlexanderSehr in #2096
• [Modules] Updated HealthBots to new dependencies approach by @AlexanderSehr in #2098
• [Modules] Removed generated name feature from EventHub by @eriqua in #2174
• [Modules] Update Parameters to create a ContainerGroup with one or more containers by @JPEasier in #1868
• [Modules] Updated Authorization/Locks to new dependency approach by @AlexanderSehr in #1812
• [Modules] Updated ApplicationSecurityGroups to new dependency approach by @AlexanderSehr in #1889
• [Modules] Updated Managed Identity to new dependency approach by @AlexanderSehr in #1882
• [Modules] Update Network FrontDoors to new dependency approach by @AlexanderSehr in #2050
• [Modules] Updated ProximityPlacementGroup to new dependency approach by @AlexanderSehr in #1870
• [Modules] Updated Network FirewallPolicies to new dependencies approach by @AlexanderSehr in #2058
• [Modules] Updated Network DDOS Proction Plans to new dependencies approach by @AlexanderSehr in #2054
• [Modules] Updated EventGrid SystemTopics to new dependencies approach by @AlexanderSehr in #2060
• [Modules] Updated DesktopVirtualization HostPools to new dependency approach by @AlexanderSehr in #1878
• [Modules] Update Network TrafficmanagerProfiles to new dependency approach by @AlexanderSehr in #2052
• [Modules] Updated Analysis Services to new dependencies approach by @AlexanderSehr in #1807
• [Modules] Updated Network ExpressRouteCircuits to new dependencies approach by @AlexanderSehr in #2056
• [Modules] Update Web ServerFarm to new dependency approach by @AlexanderSehr in #2044
• [Modules] Update Network IP Groups to new dependency approach by @AlexanderSehr in #2048
• [Modules] Updated API Management to new dependencies approach by @AlexanderSehr in #1809
• [Modules] Updated ContainerService/ManagedClusters to new dependency approach by @AlexanderSehr in #1824
• [Modules] Add tags to Microsoft.KeyVault\vaults common test by @eriqua in #2195
• [Modules] Update Network LocalNetworkGateway to new dependency approach by @AlexanderSehr in #2046
• [Modules] Updated ManagementGroup to new dependency approach by @AlexanderSehr in #1995
• [Modules] Update Network NATGateway to new dependency approach by @AlexanderSehr in #2042
• [Modules] Updated Scaling Plans to new dependency approach by @AlexanderSehr in #1887
• [Modules] Updated VirtualWAN to new dependency approach by @AlexanderSehr in #1885
• [Modules] Updated Insights/PrivateLinkScopes to new dependencies approach by @ahmadabdalla in #2198
• [Modules] Updated AVD Workspace to new dependency approach by @AlexanderSehr in #1888
• [Modules] Updated Logic Workflows to new dependency approach by @AlexanderSehr in #1880
• [Modules] Updated ContainerInstances ContainerGroups to new dependency approach by @AlexanderSehr in #1874
• [Modules] Refactored Network Application Gateway to new dependency approach by @AlexanderSehr in #1871
• [Modules] Update AKS API version by @eriqua in #2201
• [Modules] Update Network LoadBalancer to new dependency approach by @AlexanderSehr in #2040
• [Modules] Updated AzureBastion to new dependency approach by @AlexanderSehr in #1891
• [Modules] Updated DataFactory/Factories to new dependency approach by @AlexanderSehr in #1826
• [Modules] Updated DesktopVirtualization ApplicationGroups to new dependency approach by @AlexanderSehr in #1879
• [Modules] Updated AzureFirewall to new dependency approach by @AlexanderSehr in #1890
• [Modules] Updated NetApp to new dependency approach by @AlexanderSehr in #1883
• [Modules] Updated DiskEncryptionSet to new dependency approach by @AlexanderSehr in #1872
• [Modules] Updated NSG to new dependency approach by @AlexanderSehr in #1886
• [Fixes] Regenerating DataFactory factory readme file by @eriqua in #2212
• [Modules] NetApp nfs41 adding principalType to RBAC by @eriqua in #2213
• [Modules] New module DNS Private Resolvers with new dependency approach by @ChrisSidebotham in #2202
• [Modules] Updated AppConfig to new dependencies approach by @AlexanderSehr in #1810
• [Modules] Updated Automation/AutomationAccounts to new dependency approach by @AlexanderSehr in #1818
• [Modules] Updated Compute/AvailabilitySets to new dependency approach by @AlexanderSehr in #1821
• [Modules] Updated Resources/DeploymentScripts to new dependency approach by @AlexanderSehr in #1835
• [Modules] Updated Sql/Servers to new dependency approach by @AlexanderSehr in #1836
• [Modules] Updated Storage Account to new dependencies approach by @ahmadabdalla in #2207
• [Modules] Updated Compute Galleries to new dependencies approach by @AlexanderSehr in #1873
• [Modules] Updated Web/Sites to new dependency approach by @AlexanderSehr in #1837
• [Modules] Updated Databricks Workspaces to new dependencies approach by @AlexanderSehr in #1875
• [Fixes] Update latest az cli version for Deployment Scripts cli test by @eriqua in #2225
• [Fixes] Update Sql Server PrivateDNSZone dependency name by @eriqua in #2223
• [Modules] Updated Service Bus Namespace to new dependencies approach by @ahmadabdalla in #2220
• [Modules] Updated OperationalInsights/workspaces to new dependencies approach #2177 by @elanzel in #2178
• [Modules] Updated ManagedServices RegistrationDefinitions to new dependency app… by @AlexanderSehr in #1997
• [Modules] Updated MachineLearningServices workspaces to new dependency approach by @AlexanderSehr in #1881
• [Modules] Updated DBforPostgreSQL flexibleServers to new dependencies approach by @AlexanderSehr in #1877
• [Modules] Update Web/hostingEnvironments to new dependencies approach by @elbatane in #2170
• [Modules] Updated Synapse Privatelink Hubs (Azure Synapse Analytics) to new dependencies approach by @elanzel in #2228
• [Modules] Updated Compute/VirtualMachines to new dependency approach by @AlexanderSehr in #1822
• [Modules] Extend Web Sites with kvrefidentity by @fblix in #2236
• [Modules] Update Compute Disks to new dependencies approach by @eriqua in #2239
• [Fixes] Fixed test DNS name by @AlexanderSehr in #2238
• [Modules] Add tags to Microsoft.ManagedIdentity\userAssignedIdentities common test by @MrRoundRobin in #2241
• [Fixes] Addressed warning of Bicep resource ref by @AlexanderSehr in #2246
• [Modules] Add tags to Microsoft.web\serverfarms common test by @MrRoundRobin in #2243
• [Modules] Updated Cache/Redis to new dependency approach by @AlexanderSehr in #1819
• [Fixes] Fix failing Synapse Workspaces by @eriqua in #2172
• [Modules] Updated & extended ML Workspaces API version by @AlexanderSehr in #2240
• [Modules] Updated Authorization/RoleDefinitions to new dependency approach by @AlexanderSehr in #1817
• [Modules] Updated Authorization/PolicySetDefinitions to new dependency approach by @AlexanderSehr in #1815
• [Modules] Updated Policy Assignments to new dependency approach by @AlexanderSehr in #1811
• [Modules] Updated Authorization/PolicyExemptions to new dependency approach by @AlexanderSehr in #1814
• [Modules] Updated Authorization/policyDefinitions to new dependency approach by @AlexanderSehr in #1813
• [Modules] Updated Authorization/RoleAssignments to new dependency approach by @AlexanderSehr in #1816
• [Modules] Updated Network/NetworkInterfaces to new dependency approach by @AlexanderSehr in #1830
• [Modules] Updated Cosmos DB to new dependencies approach by @AlexanderSehr in #1993
• [Modules] Updated VirtualMachineImages\ImageTemplate to new dependencies approach by @fabmas in #2250
• [Modules] Updated API version for Private Endpoints and enabled custom NIC name, ASG and Static IP support by @ahmadabdalla in #2229
• [CI environment] updated GitHub workflows to use actions-checkout@v3 by @ahmadabdalla in #2249
• [Modules] Updated Service Fabric Clusters to new dependencies approach by @elbatane in #2245
• [Modules] Updates ServiceFabric to use storage resource ID & implemented a required fix for the readme script by @AlexanderSehr in #2259
• [Modules] Updated Insight ActivityLogAlerts to new dependencies approach by @lsnoddy in #2203
• [Modules] Managed instance support TLS setting by @coolhome in #2262
• [Modules] Updated Insight ActionGroups to new dependencies approach by @AlexanderSehr in #2102
• [Modules] Updated Batch/BatchAccounts to new dependency approach by @AlexanderSehr in #1820
• [Modules] Updated virtualNetworkGateways to support AAD VPN by @ChrisSidebotham in #1844
• [Modules] Update the API version for Virtual Hubs to latest version by @AlexanderSehr in #2264
• [Modules] Updated AzureSecurityCenter module to new dependencies approach by @eriqua in #2272
• [Modules] Updated OperationsManagement Solutions to new dependency approach by @AlexanderSehr in #2013
• [Modules] OPT2 - Update nested_roleAssignment to comply with prefer-unquoted-property-names linter rule by @eriqua in #2200
• [Modules] KeyVault: Changed resource names to account for conflicts by @AlexanderSehr in #2283
• [Modules] Lighthouse - fix group object IDs by @MariusStorhaug in #2286
• [Fixes] Applied a fix to handle inline quotations (e.g. for commands) by @AlexanderSehr in #2280
• [Modules] Updated RSV to latest API version & added test by @AlexanderSehr in #2289
• [Modules] Updated Network/VirtualNetworkGateways to new dependency approach by @AlexanderSehr in #1832
• [Utilities] Updated the deployment name generation to be more detailed by @AlexanderSehr in #2282
• [CI environment] Replace set-output commands with GH environment file $env:GITHUB_OUTPUT by @eriqua in #2301
• [Fixes] missing kind property for microsoft web site module by @fblix in #2308
• [Modules] Recovery Services Vault : Added replication alerts by @karthikvenkat17 in #2303
• [Modules] Converted Network NetworkWatcher to new dependencies approach by @AlexanderSehr in #2273
• [CI environment] Update static validation result publish version to v2 by @eriqua in #2314
• [CI environment] Update removal to support Azure Security Center module by @eriqua in #2313
• [Modules] Updated Locks to new API version by @AlexanderSehr in #2318
• [Modules] Update AKS Orchestrator version when upgrade. by @JPEasier in #2312
• [Modules] Update SQL MI to new dependencies approach by @eriqua in #2316
• [Modules] Updated PPG API Version by @AlexanderSehr in #2324
• [Fixes] Update version of platform pipelines external actions by @eriqua in #2328
• [Modules] Updated Compute Image API Version by @AlexanderSehr in #2325
• [Wiki] Update Fetch latest updates section and fix broken links by @eriqua in #2322
• [Fixes] Fixed incorrect parameter usage example by @AlexanderSehr in #2306
• [Utilities] Aligned deployment name generation of Test-TemplateDeployment & New-TemplateDeployment by @AlexanderSehr in #2311
• [Utilities] Set-ModuleReadMe Improved function identification regex by @AlexanderSehr in #2294
• [Modules] Fixing linter warning "decompiler-cleanup" by @krbar in #2329
• [Modules] Updated ReadMes based on latest main by @AlexanderSehr in #2341
• [Modules] Updated dependency references to not pass a resource ID unless required by @AlexanderSehr in #2275
• [Modules] Updated Policy Exemption API version by @AlexanderSehr in #2317
• [Fixes] Fix DataProtection Backup Vaults by @JPEasier in #2307
• [Modules] Updated Compute/VirtualMachineScaleSets to new dependency approach by @AlexanderSehr in #1865
• [Modules] Updated to new dependencies approach SignalRService #2230 by @elanzel in #2333
• [Modules] Updated Private Link Services to new dependencies approach by @ahmadabdalla in #2342
• [Modules] Created module MaintenanceConfiguration & added missing closing dots for metadata by @AlexanderSehr in #2266
• [Modules] Enable Key Vault Purge Protection per default (disable in tests) by @SeSeicht in #2343
• [CI Environment] Updated RBAC tests to be more explicit about the principal type by @AlexanderSehr in #2263
• [Modules] Updated AAD Domain Services module to new dependency approach by @AlexanderSehr in #1869
• [Modules] Updated PowerBI Dedicated - capacities to new dependencies approach by @AlexanderSehr in #2345
• [CI environment] Broken links pipeline update by @eriqua in #2349
• [Fixes] Updated the way child module readmes are referenced by @AlexanderSehr in #2352
• [Fixes] Update home readme status badges by @eriqua in #2354
• [Fixes] Fixed incorrect child module references by @AlexanderSehr in #2357
• [Fixes] Fixed usage of deployment name in Test-Deployment script by @AlexanderSehr in #2353
• [Modules] Update ubuntu and windows os images used for tests to latest versions by @eriqua in #2359
• [Fixes] Fix Network Watcher dependency ubuntu VM offer update by @eriqua in #2360
• [Modules] Replacing hardcoded environment URLs with the environment() function by @krbar in #2358
• [Modules] Updated Network/VPNGateways to new dependency approach by @AlexanderSehr in #1833
• [Modules] Update dependency & documentation for module by @AlexanderSehr in #2364
• [Modules] Improve disk encryption options to VM and VMSS by @eriqua in #2366
• [Modules] Added Elastic Pool support to SQL Server by @AlexanderSehr in #2371
• [Modules] Update reference usage in template by @AlexanderSehr in #2365
• [Fixes] Fixed location of settings by @AlexanderSehr in #2346
• [Fixes] Update Linter pipeline filename and trigger by @eriqua in #2368
• [CI environment] Old dependencies approach clean up by @eriqua in #2297
• [Utilities] Fixing Update-NestedRoleAssignmentList.ps1 script to support 'Microsoft.Authorization/roleAssignments' module by @krbar in #2369
• [CI Environment] Remove original test approach from test template & update telemetry to work with new dependency approach by @AlexanderSehr in #2374
• [CI Environment] Added scheduled pipelines for Subscription & Management-Group Deployment removals by @AlexanderSehr in #2310
• [Modules] Update of the built-in roles across the module library by @krbar in #2372
• [Fixes] Fixed failing pipelines by @AlexanderSehr in #2380
• [Wiki] Additional cleanup after converted test files by @eriqua in #2377
• [Modules] Update Synapse Worskpace to new dependencies approach by @elbatane in #2350
• [Wiki] Re-apply suggested changes by @AlexanderSehr in #2383
• [CI environment] Remove resourceGroupName token references by @eriqua in #2300
• [Utilities] Fix for test name prefix availability by @fblix in #2330
• [Fixes] Fixed excess column on deployment test by @AlexanderSehr in #2386
• [Utilities] Renamed Deployment History Removal functions & fixed reference by @AlexanderSehr in #2385
• [CI environment] Exclude changes to deployment history cleanup from module pipeline triggers by @eriqua in #2387
• [Modules] Updated MS.AuthZ namespace modules to use .id for ResourceID outputs by @ahmadabdalla in #2362
• [Fixes] Fixes Role Assignment module tests by @AlexanderSehr in #2390
• [Utilities] Updated compatability of ConvertTo-ARMTemplate utility to new dependencies approach by @AlexanderSehr in #2375
• [Modules] Remove identity from RSV common test by @eriqua in #2388
• [Fixes] Fix deployment error with flexible server configurations by @JPEasier in #2394
• [Wiki] Updated deployment & usage examples & further cleanup by @AlexanderSehr in #2389
• [Utilities] Set-ModuleReadme Several smaller improvements for the JSON-Template case by @AlexanderSehr in #2381