fix: Minor edits to get version publishing working (Azure#1953)

## Description Minor change to resolve version publishing issues. ## Pipeline Reference | Pipeline | | -------- | | [![avm.res.network.azure-firewall](https://github.com/hundredacres/bicep-registry-modules/actions/workflows/avm.res.network.azure-firewall.yml/badge.svg?branch=fix%2Fazure_firewall%2Fversion)](https://github.com/hundredacres/bicep-registry-modules/actions/workflows/avm.res.network.azure-firewall.yml) | ## Type of Change  - [X] Update to CI Environment or utlities (Non-module effecting changes) - [ ] Azure Verified Module updates: - [ ] Bugfix containing backwards compatible bug fixes, and I have NOT bumped the MAJOR or MINOR version in `version.json`: - [ ] Someone has opened a bug report issue, and I have included "Closes #{bug_report_issue_number}" in the PR description. - [ ] The bug was found by the module author, and no one has opened an issue to report it yet. - [ ] Feature update backwards compatible feature updates, and I have bumped the MINOR version in `version.json`. - [ ] Breaking changes and I have bumped the MAJOR version in `version.json`. - [X] Update to documentation ## Checklist - [X] I'm sure there are no other open Pull Requests for the same update/change - [X] I have run `Set-AVMModule` locally to generate the supporting module files. - [X] My corresponding pipelines / checks run clean and green without any errors or warnings --------- Co-authored-by: Máté Barabás <[email protected]> Co-authored-by: Rainer Halanek <[email protected]> Co-authored-by: JFolberth <[email protected]>
hundredacres · Jun 19, 2024 · 2a23902 · 2a23902
1 parent 03ec3a5
commit 2a23902
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 123 deletions.
diff --git a/avm/res/network/azure-firewall/README.md b/avm/res/network/azure-firewall/README.md
@@ -29,113 +29,16 @@ The following section provides usage examples for the module, which were used to
 
 >**Note**: To reference the module, please use the following syntax `br/public:avm/res/network/azure-firewall:<version>`.
 
-- [Issue-1867](#example-1-issue-1867)
-- [Add-PIP](#example-2-add-pip)
-- [Custom-PIP](#example-3-custom-pip)
-- [Using only defaults](#example-4-using-only-defaults)
-- [Hub-commom](#example-5-hub-commom)
-- [Hub-min](#example-6-hub-min)
-- [Using large parameter set](#example-7-using-large-parameter-set)
-- [Public-IP-Prefix](#example-8-public-ip-prefix)
-- [WAF-aligned](#example-9-waf-aligned)
+- [Add-PIP](#example-1-add-pip)
+- [Custom-PIP](#example-2-custom-pip)
+- [Using only defaults](#example-3-using-only-defaults)
+- [Hub-commom](#example-4-hub-commom)
+- [Hub-min](#example-5-hub-min)
+- [Using large parameter set](#example-6-using-large-parameter-set)
+- [Public-IP-Prefix](#example-7-public-ip-prefix)
+- [WAF-aligned](#example-8-waf-aligned)
 
-### Example 1: _Issue-1867_
-
-Validating reported bug 1867
-
-
-<details>
-
-<summary>via Bicep module</summary>
-
-```bicep
-module azureFirewall 'br/public:avm/res/network/azure-firewall:<version>' = {
-  name: 'azureFirewallDeployment'
-  params: {
-    // Required parameters
-    name: 'nafcustom001'
-    // Non-required parameters
-    azureSkuTier: 'Basic'
-    firewallPolicyId: '<firewallPolicyId>'
-    location: '<location>'
-    managementIPAddressObject: {
-      managementIPAllocationMethod: 'Static'
-      managementIPPrefixResourceId: '<managementIPPrefixResourceId>'
-      name: 'managementIP01'
-      skuName: 'Standard'
-      skuTier: 'Regional'
-    }
-    publicIPAddressObject: {
-      name: 'publicIP01'
-      publicIPAllocationMethod: 'Static'
-      publicIPPrefixResourceId: '<publicIPPrefixResourceId>'
-      skuName: 'Standard'
-      skuTier: 'Regional'
-    }
-    virtualNetworkResourceId: '<virtualNetworkResourceId>'
-    zones: []
-  }
-}
-```
-
-</details>
-<p>
-
-<details>
-
-<summary>via JSON Parameter file</summary>
-
-```json
-{
-  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
-  "contentVersion": "1.0.0.0",
-  "parameters": {
-    // Required parameters
-    "name": {
-      "value": "nafcustom001"
-    },
-    // Non-required parameters
-    "azureSkuTier": {
-      "value": "Basic"
-    },
-    "firewallPolicyId": {
-      "value": "<firewallPolicyId>"
-    },
-    "location": {
-      "value": "<location>"
-    },
-    "managementIPAddressObject": {
-      "value": {
-        "managementIPAllocationMethod": "Static",
-        "managementIPPrefixResourceId": "<managementIPPrefixResourceId>",
-        "name": "managementIP01",
-        "skuName": "Standard",
-        "skuTier": "Regional"
-      }
-    },
-    "publicIPAddressObject": {
-      "value": {
-        "name": "publicIP01",
-        "publicIPAllocationMethod": "Static",
-        "publicIPPrefixResourceId": "<publicIPPrefixResourceId>",
-        "skuName": "Standard",
-        "skuTier": "Regional"
-      }
-    },
-    "virtualNetworkResourceId": {
-      "value": "<virtualNetworkResourceId>"
-    },
-    "zones": {
-      "value": []
-    }
-  }
-}
-```
-
-</details>
-<p>
-
-### Example 2: _Add-PIP_
+### Example 1: _Add-PIP_
 
 This instance deploys the module and attaches an existing public IP address.
 
@@ -227,7 +130,7 @@ module azureFirewall 'br/public:avm/res/network/azure-firewall:<version>' = {
 </details>
 <p>
 
-### Example 3: _Custom-PIP_
+### Example 2: _Custom-PIP_
 
 This instance deploys the module and will create a public IP address.
 
@@ -337,7 +240,7 @@ module azureFirewall 'br/public:avm/res/network/azure-firewall:<version>' = {
 </details>
 <p>
 
-### Example 4: _Using only defaults_
+### Example 3: _Using only defaults_
 
 This instance deploys the module with the minimum set of required parameters.
 
@@ -389,7 +292,7 @@ module azureFirewall 'br/public:avm/res/network/azure-firewall:<version>' = {
 </details>
 <p>
 
-### Example 5: _Hub-commom_
+### Example 4: _Hub-commom_
 
 This instance deploys the module a vWAN in a typical hub setting.
 
@@ -457,7 +360,7 @@ module azureFirewall 'br/public:avm/res/network/azure-firewall:<version>' = {
 </details>
 <p>
 
-### Example 6: _Hub-min_
+### Example 5: _Hub-min_
 
 This instance deploys the module a vWAN minimum hub setting.
 
@@ -521,7 +424,7 @@ module azureFirewall 'br/public:avm/res/network/azure-firewall:<version>' = {
 </details>
 <p>
 
-### Example 7: _Using large parameter set_
+### Example 6: _Using large parameter set_
 
 This instance deploys the module with most of its features enabled.
 
@@ -875,7 +778,7 @@ module azureFirewall 'br/public:avm/res/network/azure-firewall:<version>' = {
 </details>
 <p>
 
-### Example 8: _Public-IP-Prefix_
+### Example 7: _Public-IP-Prefix_
 
 This instance deploys the module and will use a public IP prefix.
 
@@ -967,7 +870,7 @@ module azureFirewall 'br/public:avm/res/network/azure-firewall:<version>' = {
 </details>
 <p>
 
-### Example 9: _WAF-aligned_
+### Example 8: _WAF-aligned_
 
 This instance deploys the module in alignment with the best-practices of the Azure Well-Architected Framework.
 
@@ -2234,12 +2137,12 @@ Zone numbers e.g. 1,2,3.
 
 | Output | Type | Description |
 | :-- | :-- | :-- |
-| `applicationRuleCollections` | array | List of Application Rule Collections. |
+| `applicationRuleCollections` | array | List of Application Rule Collections used by Azure Firewall. |
 | `ipConfAzureFirewallSubnet` | object | The Public IP configuration object for the Azure Firewall Subnet. |
 | `location` | string | The location the resource was deployed into. |
 | `name` | string | The name of the Azure Firewall. |
-| `natRuleCollections` | array | Collection of NAT rule collections used by Azure Firewall. |
-| `networkRuleCollections` | array | List of Network Rule Collections. |
+| `natRuleCollections` | array | List of NAT rule collections used by Azure Firewall. |
+| `networkRuleCollections` | array | List of Network Rule Collections used by Azure Firewall. |
 | `privateIp` | string | The private IP of the Azure firewall. |
 | `resourceGroupName` | string | The resource group the Azure firewall was deployed into. |
 | `resourceId` | string | The resource ID of the Azure Firewall. |

diff --git a/avm/res/network/azure-firewall/main.bicep b/avm/res/network/azure-firewall/main.bicep
@@ -372,13 +372,13 @@ output ipConfAzureFirewallSubnet object = contains(azureFirewall.properties, 'ip
   ? azureFirewall.properties.ipConfigurations[0]
   : {}
 
-@description('List of Application Rule Collections.')
+@description('List of Application Rule Collections used by Azure Firewall.')
 output applicationRuleCollections array = applicationRuleCollections ?? []
 
-@description('List of Network Rule Collections.')
+@description('List of Network Rule Collections used by Azure Firewall.')
 output networkRuleCollections array = networkRuleCollections ?? []
 
-@description('Collection of NAT rule collections used by Azure Firewall.')
+@description('List of NAT rule collections used by Azure Firewall.')
 output natRuleCollections array = natRuleCollections ?? []
 
 @description('The location the resource was deployed into.')

diff --git a/avm/res/network/azure-firewall/main.json b/avm/res/network/azure-firewall/main.json
@@ -6,7 +6,7 @@
     "_generator": {
       "name": "bicep",
       "version": "0.27.1.19265",
-      "templateHash": "5299175231300175796"
+      "templateHash": "18119107920030966169"
     },
     "name": "Azure Firewalls",
     "description": "This module deploys an Azure Firewall.",
@@ -2280,21 +2280,21 @@
     "applicationRuleCollections": {
       "type": "array",
       "metadata": {
-        "description": "List of Application Rule Collections."
+        "description": "List of Application Rule Collections used by Azure Firewall."
       },
       "value": "[coalesce(parameters('applicationRuleCollections'), createArray())]"
     },
     "networkRuleCollections": {
       "type": "array",
       "metadata": {
-        "description": "List of Network Rule Collections."
+        "description": "List of Network Rule Collections used by Azure Firewall."
       },
       "value": "[coalesce(parameters('networkRuleCollections'), createArray())]"
     },
     "natRuleCollections": {
       "type": "array",
       "metadata": {
-        "description": "Collection of NAT rule collections used by Azure Firewall."
+        "description": "List of NAT rule collections used by Azure Firewall."
       },
       "value": "[coalesce(parameters('natRuleCollections'), createArray())]"
     },