Add links to AVM modules (#40)

* Add a section for Bicep & Terraform AVM modules.
* Update `UpdateSamples.ps1` script to support updating the list of AVM
modules.

Examples:
* Bicep:
https://github.com/Azure/bicep-refdocs-generator/blob/ant/avm/src/TemplateRefGenerator.Tests/Files/markdown/microsoft.compute/2024-03-02/disks.md#azure-verified-modules
* Terraform:
https://github.com/Azure/bicep-refdocs-generator/blob/ant/avm/src/TemplateRefGenerator.Tests/Files/markdown/microsoft.compute/2024-03-02/disks.md#azure-verified-modules-1

Closes #26

Author: anthony-c-martin

docs/configuration.md

@@ -10,6 +10,9 @@ This file can be found under [settings/samples/samples.json](../settings/samples
 
 `samples.json` is not manually maintained. It can be updated by running [scripts/UpdateSamples.ps1](../scripts/UpdateSamples.ps1).
 
+> [!NOTE]
+> This process is not currently automated. The script needs to be re-run to pick up the latest set of samples.
+
 ## Config
 
 This file can be found under [settings/config/config.json](../settings/config/config.json), and can be used to configure the generation process. The schema is available [here](../settings/config.schema.json).

scripts/UpdateSamples.ps1

@@ -7,50 +7,92 @@ $ErrorActionPreference = "Stop"
 $QuickStartsRepoPath = Resolve-Path $QuickStartsRepoPath
 $OutputPath = Join-Path $PSScriptRoot "../settings/samples/samples.json"
 
-function GetResourceTypes {
-    param([PSCustomObject] $template)
-
-    $resourceTypes = @()
-    foreach ($resource in $template.resources) {
-        if ($resource.type -ieq "Microsoft.Resources/deployments") {
-            foreach ($resourceType in GetResourceTypes($resource.properties.template)) {
-                $resourceTypes += $resourceType
+function GetQuickstartLinks {
+    function GetResourceTypes {
+        param([PSCustomObject] $template)
+
+        $resourceTypes = @()
+        foreach ($resource in $template.resources) {
+            if ($resource.type -ieq "Microsoft.Resources/deployments") {
+                foreach ($resourceType in GetResourceTypes($resource.properties.template)) {
+                    $resourceTypes += $resourceType
+                }
+            } else {
+                $resourceTypes += $resource.type
             }
-        } else {
-            $resourceTypes += $resource.type
         }
+
+        return $resourceTypes | Sort-Object -Unique
     }
 
-    return $resourceTypes | Sort-Object -Unique
+    $links = @()
+    $metadataPaths = Get-ChildItem $QuickStartsRepoPath -File -Recurse -Include "metadata.json" | Sort-Object FullName
+    foreach ($metadataPath in $metadataPaths) {
+        Write-Host "Processing $metadataPath"
+        $templatePath = Join-Path $metadataPath.DirectoryName "azuredeploy.json" -Resolve
+        $bicepPath = Join-Path $metadataPath.DirectoryName "main.bicep"
+        $hasBicep = (Test-Path $bicepPath -PathType Leaf)
+
+        $metadataContent = Get-Content $metadataPath.FullName | ConvertFrom-Json
+        $description = $metadataContent.description
+        $displayName = $metadataContent.itemDisplayName
+
+        $templateContent = Get-Content $templatePath | ConvertFrom-Json
+        $resourceTypes = GetResourceTypes($templateContent)
+
+        $links += [ordered]@{
+            Title = $displayName;
+            Description = $description;
+            Path = [System.IO.Path]::GetRelativePath($QuickStartsRepoPath, "$templatePath/..").Replace("\", "/")
+            ResourceTypes = @($resourceTypes);
+            HasBicep = $hasBicep;
+        }
+    }
+
+    return $links
 }
 
-$quickstartLinks = @()
-$metadataPaths = Get-ChildItem $QuickStartsRepoPath -File -Recurse -Include "metadata.json" | Sort-Object FullName
-foreach ($metadataPath in $metadataPaths) {
-    Write-Host "Processing $metadataPath"
-    $templatePath = Join-Path $metadataPath.DirectoryName "azuredeploy.json" -Resolve
-    $bicepPath = Join-Path $metadataPath.DirectoryName "main.bicep"
-    $hasBicep = (Test-Path $bicepPath -PathType Leaf)
-
-    $metadataContent = Get-Content $metadataPath.FullName | ConvertFrom-Json
-    $description = $metadataContent.description
-    $displayName = $metadataContent.itemDisplayName
-
-    $templateContent = Get-Content $templatePath | ConvertFrom-Json
-    $resourceTypes = GetResourceTypes($templateContent)
-
-    $quickstartLinks += [ordered]@{
-        Title = $displayName;
-        Description = $description;
-        Path = [System.IO.Path]::GetRelativePath($QuickStartsRepoPath, "$templatePath/..").Replace("\\", "/")
-        ResourceTypes = @($resourceTypes);
-        HasBicep = $hasBicep;
+function GetAvmLinks {
+    $bicepLinks = "https://raw.githubusercontent.com/Azure/Azure-Verified-Modules/refs/heads/main/docs/static/module-indexes/BicepResourceModules.csv"
+    $tfLinks = "https://raw.githubusercontent.com/Azure/Azure-Verified-Modules/refs/heads/main/docs/static/module-indexes/TerraformResourceModules.csv"
+
+    $bicepModules = ConvertFrom-Csv (Invoke-WebRequest -Uri $bicepLinks).Content
+    $tfModules = ConvertFrom-Csv (Invoke-WebRequest -Uri $tfLinks).Content
+
+    $links = @()
+    foreach ($bicepModule in $bicepModules) {
+        Write-Host "Processing $($bicepModule.RepoURL)"
+
+        $links += [ordered]@{
+            Type = "Bicep";
+            Title = $bicepModule.ModuleDisplayName;
+            Description = $bicepModule.Description;
+            ResourceType = "$($bicepModule.ProviderNamespace)/$($bicepModule.ResourceType)";
+            RepoUrl = $bicepModule.RepoURL;
+        }
+    }
+    foreach ($tfModule in $tfModules) {
+        Write-Host "Processing $($tfModule.RepoURL)"
+
+        $links += [ordered]@{
+            Type = "Terraform";
+            Title = $tfModule.ModuleDisplayName;
+            Description = $tfModule.Description;
+            ResourceType = "$($tfModule.ProviderNamespace)/$($tfModule.ResourceType)";
+            RepoUrl = $tfModule.RepoURL;
+        }
     }
+
+    return $links
 }
 
+$quickstartLinks = GetQuickstartLinks
+$avmLinks = GetAvmLinks
+
 $samples = [ordered]@{
     "`$schema" = "../schemas/samples.schema.json";
     QuickstartLinks = $quickstartLinks;
+    AvmLinks = $avmLinks;
 }
 
 $samples | ConvertTo-Json -depth 100 | Out-File $OutputPath