Azure · AlexanderSehr · Sep 9, 2024 · Nov 9, 2023 · Nov 9, 2023 · Nov 10, 2023
@@ -140,7 +140,7 @@ jobs:
   job_publish_module: # Note: Please don't change this job name. It is used by the setEnvironment action to define which PS modules to install on runners.
     name: "Publishing"
     runs-on: ubuntu-latest
-    # Note: Below always() required in condition due to psrule jobs being skipped for ptn modules not having defaults or waf-aligned folders
+    # Note: Below always() required in condition due to psrule jobs being skipped for ptn & utl modules not having defaults or waf-aligned folders
     if: github.ref == 'refs/heads/main' &&
       github.repository	 == 'Azure/bicep-registry-modules' &&
       always() &&

@@ -15,7 +15,7 @@ on:
         type: string
         description: "RegEx which workflows are included"
         required: false
-        default: "avm\\.(?:res|ptn)"
+        default: "avm\\.(?:res|ptn|utl)"
       excludePattern:
         type: string
         description: "RegEx which workflows are excluded"

@@ -145,7 +145,6 @@ module containerApps 'br/public:avm/ptn/azd/container-apps:<version>' = {
 </details>
 <p>
 
-
 ## Parameters
 
 **Required parameters**
@@ -338,7 +337,6 @@ Zone redundancy setting.
 - Type: bool
 - Default: `True`
 
-
 ## Outputs
 
 | Output | Type | Description |

@@ -28,7 +28,7 @@ Cache for Azure Container Registry (Preview) feature allows users to cache conta
 
 | Parameter | Type | Description |
 | :-- | :-- | :-- |
-| [`name`](#parameter-name) | string | The name of the cache rule. Will be dereived from the source repository name if not defined. |
+| [`name`](#parameter-name) | string | The name of the cache rule. Will be derived from the source repository name if not defined. |
 | [`targetRepository`](#parameter-targetrepository) | string | Target repository specified in docker pull command. E.g.: docker pull myregistry.azurecr.io/{targetRepository}:{tag}. |
 
 ### Parameter: `credentialSetResourceId`
@@ -54,7 +54,7 @@ Source repository pulled from upstream.
 
 ### Parameter: `name`
 
-The name of the cache rule. Will be dereived from the source repository name if not defined.
+The name of the cache rule. Will be derived from the source repository name if not defined.
 
 - Required: No
 - Type: string

@@ -5,7 +5,7 @@ metadata owner = 'Azure/module-maintainers'
 @description('Required. The name of the parent registry. Required if the template is used in a standalone deployment.')
 param registryName string
 
-@description('Optional. The name of the cache rule. Will be dereived from the source repository name if not defined.')
+@description('Optional. The name of the cache rule. Will be derived from the source repository name if not defined.')
 param name string = replace(replace(sourceRepository, '/', '-'), '.', '-')
 
 @description('Required. Source repository pulled from upstream.')

@@ -5,7 +5,7 @@
     "_generator": {
       "name": "bicep",
       "version": "0.29.47.4906",
-      "templateHash": "4294329625336671928"
+      "templateHash": "14369419482171687857"
     },
     "name": "Container Registries Cache",
     "description": "Cache for Azure Container Registry (Preview) feature allows users to cache container images in a private container registry. Cache for ACR, is a preview feature available in Basic, Standard, and Premium service tiers ([ref](https://learn.microsoft.com/en-us/azure/container-registry/tutorial-registry-cache)).",
@@ -22,7 +22,7 @@
       "type": "string",
       "defaultValue": "[replace(replace(parameters('sourceRepository'), '/', '-'), '.', '-')]",
       "metadata": {
-        "description": "Optional. The name of the cache rule. Will be dereived from the source repository name if not defined."
+        "description": "Optional. The name of the cache rule. Will be derived from the source repository name if not defined."
       }
     },
     "sourceRepository": {

@@ -1479,7 +1479,7 @@
             "_generator": {
               "name": "bicep",
               "version": "0.29.47.4906",
-              "templateHash": "4294329625336671928"
+              "templateHash": "14369419482171687857"
             },
             "name": "Container Registries Cache",
             "description": "Cache for Azure Container Registry (Preview) feature allows users to cache container images in a private container registry. Cache for ACR, is a preview feature available in Basic, Standard, and Premium service tiers ([ref](https://learn.microsoft.com/en-us/azure/container-registry/tutorial-registry-cache)).",
@@ -1496,7 +1496,7 @@
               "type": "string",
               "defaultValue": "[replace(replace(parameters('sourceRepository'), '/', '-'), '.', '-')]",
               "metadata": {
-                "description": "Optional. The name of the cache rule. Will be dereived from the source repository name if not defined."
+                "description": "Optional. The name of the cache rule. Will be derived from the source repository name if not defined."
               }
             },
             "sourceRepository": {

@@ -66,7 +66,7 @@ function Get-AvailableResourceLocation {
     . (Join-Path $RepoRoot 'avm' 'utilities' 'pipelines' 'sharedScripts' 'helper' 'Get-SpecsAlignedResourceName.ps1')
 
     # Configure Resource Type
-    $fullModuleIdentifier = ($ModuleRoot -split '[\/|\\]{0,1}avm[\/|\\]{1}(res|ptn)[\/|\\]{1}')[2] -replace '\\', '/'
+    $fullModuleIdentifier = ($ModuleRoot -split '[\/|\\]{0,1}avm[\/|\\]{1}(res|ptn|utl)[\/|\\]{1}')[2] -replace '\\', '/'
 
     if ($ModuleRoot -like 'avm/res*') {
 

@@ -1,4 +1,4 @@
-#region helper
+#region helper
 <#
 .SYNOPSIS
 Get all deployment operations at a given scope

@@ -74,7 +74,7 @@ function Invoke-AvmJsonModuleIndexGeneration {
     $anyErrorsOccurred = $false
     $moduleIndexData = @()
 
-    foreach ($avmModuleRoot in @('avm/res', 'avm/ptn')) {
+    foreach ($avmModuleRoot in @('avm/res', 'avm/ptn', 'avm/utl')) {
         $avmModuleGroups = (Get-ChildItem -Path $avmModuleRoot -Directory).Name
 
         foreach ($moduleGroup in $avmModuleGroups) {

@@ -40,7 +40,7 @@ function Set-AvmGitHubIssueOwnerConfig {
     $issue = gh issue view $IssueUrl.Replace('api.', '').Replace('repos/', '') --json 'author,title,url,body,comments' --repo $Repo | ConvertFrom-Json -Depth 100
 
     if ($issue.title.StartsWith('[AVM Module Issue]')) {
-        $moduleName = ($issue.body.Split("`n") -match 'avm/(?:res|ptn)')[0].Trim().Replace(' ', '')
+        $moduleName = ($issue.body.Split("`n") -match 'avm/(?:res|ptn|utl)')[0].Trim().Replace(' ', '')
 
         if ([string]::IsNullOrEmpty($moduleName)) {
             throw 'No valid module name was found in the issue.'

@@ -100,7 +100,7 @@ function Set-AvmGithubIssueForWorkflow {
 > @Azure/avm-core-team-technical-bicep, the workflow for the ``$moduleName`` module has failed. Please investigate the failed workflow run.
 "@
 
-                    if ($workflowRun.workflowName -match 'avm.(?:res|ptn)') {
+                    if ($workflowRun.workflowName -match 'avm.(?:res|ptn|utl)') {
                         $moduleIndex = $moduleName.StartsWith('avm/res') ? 'Bicep-Resource' : 'Bicep-Pattern'
                         # get CSV data
                         $module = Get-AvmCsvData -ModuleIndex $moduleIndex | Where-Object ModuleName -EQ $moduleName

@@ -15,7 +15,7 @@ Mandatory. The owning organization of the repository. For example, 'MyOrg'.
 Optional. The name of the repository. Defaults to 'bicep-registry-modules'.
 
 .PARAMETER IncludePattern
-Optional. A regex pattern to match against the workflow names. Defaults to 'avm\.(?:res|ptn)' - avm.res & avm.ptn.
+Optional. A regex pattern to match against the workflow names. Defaults to 'avm\.(?:res|ptn|utl)' - avm.res, avm.ptn & avm.utl.
 
 .PARAMETER ExlcudePattern
 Optional. A regex pattern that should not match against the workflow names. Defaults to '^$' - empty.
@@ -26,7 +26,7 @@ Optional. The GitHub PAT token to use for authentication when interacting with G
 .EXAMPLE
 Switch-WorkflowState -RepositoryOwner 'Paul' -RepositoryName 'bicep-registry-modules' -TargetState 'enable' -GitHubToken ('iAmAToken' | ConvertTo-SecureString -AsPlainText -Force)
 
-Enable any AVM res/ptn workflow in the [Paul/bicep-registry-modules] repository that is not in state 'active' using a custom GitHub PAT token.
+Enable any AVM res/ptn/utl workflow in the [Paul/bicep-registry-modules] repository that is not in state 'active' using a custom GitHub PAT token.
 
 .EXAMPLE
 Switch-WorkflowState -RepositoryOwner 'Paul' -RepositoryName 'bicep-registry-modules' -TargetState 'disable'
@@ -58,7 +58,7 @@ function Switch-WorkflowState {
         [string] $RepositoryName = 'bicep-registry-modules',
 
         [Parameter(Mandatory = $false)]
-        [string] $IncludePattern = 'avm\.(?:res|ptn)',
+        [string] $IncludePattern = 'avm\.(?:res|ptn|utl)',
 
         [Parameter(Mandatory = $false)]
         [string] $ExlcudePattern = '^$',

@@ -33,6 +33,7 @@ function Sync-AvmModulesList {
     # get CSV data
     $targetModules = Get-AvmCsvData -ModuleIndex 'Bicep-Resource' | Where-Object { ($_.ModuleStatus -eq 'Available :green_circle:') -or ($_.ModuleStatus -eq 'Orphaned :eyes:') } | Select-Object -ExpandProperty 'ModuleName' | Sort-Object
     $targetPatterns = Get-AvmCsvData -ModuleIndex 'Bicep-Pattern' | Where-Object { ($_.ModuleStatus -eq 'Available :green_circle:') -or ($_.ModuleStatus -eq 'Orphaned :eyes:') } | Select-Object -ExpandProperty 'ModuleName' | Sort-Object
+    $targetUtilities = Get-AvmCsvData -ModuleIndex 'Bicep-Utility' | Where-Object { ($_.ModuleStatus -eq 'Available :green_circle:') -or ($_.ModuleStatus -eq 'Orphaned :eyes:') } | Select-Object -ExpandProperty 'ModuleName' | Sort-Object
 
     $issueTemplatePath = Join-Path $RepoRoot '.github' 'ISSUE_TEMPLATE' 'avm_module_issue.yml'
     $issueTemplateContent = Get-Content $issueTemplatePath
@@ -51,14 +52,21 @@ function Sync-AvmModulesList {
 
     $listedModules = $issueTemplateContent[$startIndex..$endIndex] | Where-Object { -not $_.Contains('#') } | ForEach-Object { $_ -replace '.*- "(avm\/.*)".*', '$1' } | Where-Object { $_ -match 'avm\/res\/.*' }
     $listedPatterns = $issueTemplateContent[$startIndex..$endIndex] | Where-Object { -not $_.Contains('#') } | ForEach-Object { $_ -replace '.*- "(avm\/.*)".*', '$1' } | Where-Object { $_ -match 'avm\/ptn\/.*' }
+    $listedUtilities = $issueTemplateContent[$startIndex..$endIndex] | Where-Object { -not $_.Contains('#') } | ForEach-Object { $_ -replace '.*- "(avm\/.*)".*', '$1' } | Where-Object { $_ -match 'avm\/utl\/.*' }
 
     $body = ''
 
     $missingModules = $targetModules | Where-Object { $listedModules -NotContains $_ }
     $unexpectedModules = $listedModules | Where-Object { $targetModules -NotContains $_ }
-    $unexpectedPatterns = $listedPatterns | Where-Object { $targetPatterns -NotContains $_ }
+
     $missingPatterns = $targetPatterns | Where-Object { $listedPatterns -NotContains $_ }
+    $unexpectedPatterns = $listedPatterns | Where-Object { $targetPatterns -NotContains $_ }
+
+    $missingUtilities = $targetUtilities | Where-Object { $listedUtilities -NotContains $_ }
+    $unexpectedUtilities = $listedUtilities | Where-Object { $targetUtilities -NotContains $_ }
 
+    # Resource modules
+    # ----------------
     if ($missingModules.Count -gt 0) {
         $body += @"
 **Missing resource modules:**
@@ -77,6 +85,8 @@ $([Environment]::NewLine)
 "@
     }
 
+    # Patterns
+    # --------
     if ($missingPatterns.Count -gt 0) {
         $body += @"
 **Missing pattern modules:**
@@ -95,6 +105,29 @@ $([Environment]::NewLine)
 "@
     }
 
+    # Utilities
+    # ---------
+    if ($missingUtilities.Count -gt 0) {
+        $body += @"
+**Missing utility modules:**
+
+$($missingUtilities -join ([Environment]::NewLine))
+$([Environment]::NewLine)
+"@
+    }
+
+    if ($unexpectedUtilities.Count -gt 0) {
+        $body += @"
+**Unexpected utility modules:**
+
+$($unexpectedUtilities -join ([Environment]::NewLine))
+$([Environment]::NewLine)
+"@
+    }
+
+
+    # Resource modules
+    # ----------------
     # Should be at correct location
     $incorrectModuleLines = @()
     foreach ($finding in (Compare-Object $listedModules ($listedModules | Sort-Object) -SyncWindow 0)) {
@@ -113,6 +146,8 @@ $([Environment]::NewLine)
 "@
     }
 
+    # Patterns
+    # --------
     $incorrectPatternLines = @()
     foreach ($finding in (Compare-Object $listedPatterns ($listedPatterns | Sort-Object) -SyncWindow 0)) {
         if ($finding.SideIndicator -eq '<=') {
@@ -130,6 +165,25 @@ $([Environment]::NewLine)
 "@
     }
 
+    # Utilities
+    # ---------
+    $incorrectUtilityLines = @()
+    foreach ($finding in (Compare-Object $listedUtilities ($listedUtilities | Sort-Object) -SyncWindow 0)) {
+        if ($finding.SideIndicator -eq '<=') {
+            $incorrectUtilityLines += $finding.InputObject
+        }
+    }
+    $incorrectUtilityLines = $incorrectUtilityLines | Sort-Object -Unique
+
+    if ($incorrectUtilityLines.Count -gt 0) {
+        $body += @"
+**Utility modules that are not correctly sorted:**
+
+$($incorrectUtilityLines -join ([Environment]::NewLine))
+$([Environment]::NewLine)
+"@
+    }
+
     $issuesFound = $body -ne ''
 
     $title = '[AVM core] AVM Module Issue template is not in sync with published resource modules and pattern modules list'
@@ -138,7 +192,7 @@ $([Environment]::NewLine)
 
     $body = @"
 > [!IMPORTANT]
-> The file [avm_module_issue.yml](https://github.com/Azure/bicep-registry-modules/blob/main/.github/ISSUE_TEMPLATE/avm_module_issue.yml?plain=1) which lists all modules when creating a new issue, is not in sync with the CSV files, that can be found under [resource modules](https://aka.ms/avm/index/bicep/res/csv) and [pattern modules](https://aka.ms/avm/index/bicep/ptn/csv). These CSV files are the single source of truth regarding published modules. Please update the ``avm_module_issue.yml`` accordingly. Please see the following differences that were found.
+> The file [avm_module_issue.yml](https://github.com/Azure/bicep-registry-modules/blob/main/.github/ISSUE_TEMPLATE/avm_module_issue.yml?plain=1) which lists all modules when creating a new issue, is not in sync with the CSV files, that can be found under [resource modules](https://aka.ms/avm/index/bicep/res/csv), [pattern modules](https://aka.ms/avm/index/bicep/ptn/csv) and [utility modules](https://aka.ms/avm/index/bicep/utl/csv). These CSV files are the single source of truth regarding published modules. Please update the ``avm_module_issue.yml`` accordingly. Please see the following differences that were found.
 $([Environment]::NewLine)
 "@ + $body
 

@@ -33,6 +33,6 @@ function Get-ModuleReadmeLink {
         [string] $RegistryBaseUri = 'https://github.com/Azure/bicep-registry-modules/tree'
     )
 
-    $ModuleRelativeFolderPath = ('avm/{0}' -f ($ModuleFolderPath -split '[\/|\\]avm[\/|\\]')[-1]) -replace '\\', '/'
+    $ModuleRelativeFolderPath = (($ModuleFolderPath -split '[\/|\\](avm)[\/|\\](res|ptn|utl)[\/|\\]')[-3..-1] -join '/') -replace '\\', '/'
     return (('{0}/{1}/{2}/README.md' -f $RegistryBaseUri, $TagName, $ModuleRelativeFolderPath) -replace '\\', '/')
 }
@@ -38,7 +38,7 @@ function Get-ModuleTargetPatchVersion {
         [string] $MajMinVersion
     )
 
-    $ModuleRelativeFolderPath = ('avm/{0}' -f ($ModuleFolderPath -split '[\/|\\]avm[\/|\\]')[-1]) -replace '\\', '/'
+    $ModuleRelativeFolderPath = (($ModuleFolderPath -split '[\/|\\](avm)[\/|\\](res|ptn|utl)[\/|\\]')[-3..-1] -join '/') -replace '\\', '/'
 
     # Get all released module tags (using upstream specifically to work in forks)
     $existingTagList = git ls-remote --tag 'https://github.com/Azure/bicep-registry-modules.git' "$ModuleRelativeFolderPath/$MajMinVersion*"

@@ -84,7 +84,7 @@ function Get-TemplateFileToPublish {
         [string[]] $PathsToInclude = @()
     )
 
-    $ModuleRelativeFolderPath = ('avm/{0}' -f ($ModuleFolderPath -split '[\/|\\]avm[\/|\\]')[-1]) -replace '\\', '/'
+    $ModuleRelativeFolderPath = (($ModuleFolderPath -split '[\/|\\](avm)[\/|\\](res|ptn|utl)[\/|\\]')[-3..-1] -join '/') -replace '\\', '/'
     $ModifiedFiles = Get-ModifiedFileList -Verbose
     Write-Verbose "Looking for modified files under: [$ModuleRelativeFolderPath]" -Verbose
     $modifiedModuleFiles = $ModifiedFiles.FullName | Where-Object { $_ -like "*$ModuleFolderPath*" }
@@ -110,7 +110,7 @@ function Get-TemplateFileToPublish {
 
     Write-Verbose ('Modified modules found: [{0}]' -f $TemplateFilesToPublish.count) -Verbose
     $TemplateFilesToPublish | ForEach-Object {
-        $RelPath = ('avm/{0}' -f ($_ -split '[\/|\\]avm[\/|\\]')[-1]) -replace '\\', '/'
+        $RelPath = (($_ -split '[\/|\\](avm)[\/|\\](res|ptn|utl)[\/|\\]')[-3..-1] -join '/') -replace '\\', '/'
         $RelPath = $RelPath.Split('/main.')[0]
         Write-Verbose " - [$RelPath]" -Verbose
     }

@@ -28,7 +28,7 @@ function New-ModuleReleaseTag {
         [string] $TargetVersion
     )
 
-    $ModuleRelativeFolderPath = ('avm/{0}' -f ($ModuleFolderPath -split '[\/|\\]avm[\/|\\]')[-1]) -replace '\\', '/'
+    $ModuleRelativeFolderPath = (($ModuleFolderPath -split '[\/|\\](avm)[\/|\\](res|ptn|utl)[\/|\\]')[-3..-1] -join '/') -replace '\\', '/'
 
     # 1 Build Tag
     $tagName = '{0}/{1}' -f $ModuleRelativeFolderPath, $TargetVersion

@@ -21,6 +21,6 @@ function Get-BRMRepositoryName {
         [string] $TemplateFilePath
     )
 
-    $moduleIdentifier = (Split-Path $TemplateFilePath -Parent) -split '[\/|\\]avm[\/|\\](res|ptn)[\/|\\]'
+    $moduleIdentifier = (Split-Path $TemplateFilePath -Parent) -split '[\/|\\]avm[\/|\\](res|ptn|utl)[\/|\\]'
     return ('avm/{0}/{1}' -f $moduleIdentifier[1], $moduleIdentifier[2]) -replace '\\', '/'
 }
@@ -148,7 +148,7 @@ function Get-CrossReferencedModuleList {
         [string] $Path = (Get-Item $PSScriptRoot).Parent.Parent.Parent.Parent
     )
 
-    $repoRoot = ($Path -split '[\/|\\]{1}avm[\/|\\]{1}')[0]
+    $repoRoot = ($Path -split '[\/|\\]avm[\/|\\](res|ptn|utl)[\/|\\]')[0]
     $resultSet = [ordered]@{}
 
     # Collect data
@@ -176,7 +176,7 @@ function Get-CrossReferencedModuleList {
 
         $moduleFolderPath = Split-Path $moduleTemplatePath -Parent
         ## avm/res/<provider>/<resourceType>
-        $resourceTypeIdentifier = ($moduleFolderPath -split '[\/|\\]{1}avm[\/|\\]{1}(res|ptn)[\/|\\]{1}')[2] -replace '\\', '/'
+        $resourceTypeIdentifier = ($moduleFolderPath -split '[\/|\\]avm[\/|\\](res|ptn|utl)[\/|\\]')[2] -replace '\\', '/'
 
         $providerNamespace = ($resourceTypeIdentifier -split '[\/|\\]')[0]
         $resourceType = $resourceTypeIdentifier -replace "$providerNamespace[\/|\\]", ''

@@ -100,7 +100,7 @@ function Set-PesterGitHubOutput {
     Write-Verbose ('Formatting [{0}] skipped tests' -f $skippedTests.Count)
     Write-Verbose ('Formatting [{0}] tests with explicit warnings' -f $warnings.Count)
 
-    $moduleSplitRegex = '[\/|\\]avm[\/|\\](res|ptn)[\/|\\]'
+    $moduleSplitRegex = '[\/|\\]avm[\/|\\](res|ptn|utl)[\/|\\]'
 
     ######################
     # Set output content #

@@ -221,7 +221,10 @@ function Resolve-ReadMeParameterList {
 
     $parameterSet = @{}
 
-    if (-not $Properties) {
+    if (-not $Properties -and -not $TemplateFileContent.parameters) {
+        # no Parameters / properties on this level or in the template
+        return $parameterSet
+    } elseif (-not $Properties) {
         # Top-level invocation
         # Add name as property for later reference
         $TemplateFileContent.parameters.Keys | ForEach-Object { $TemplateFileContent.parameters[$_]['name'] = $_ }