[AVM Module Issue]: avm/res/network/azure-firewall - enhance documentation for parameter hubIPAddresses

[janegilring]

Check for previous/existing GitHub issues

• I have checked for previous/existing GitHub issues

Issue Type?

Feature Request

Module Name

avm/res/network/azure-firewall

(Optional) Module Version

No response

Description

The documentation for the following parameter should be improved:

Parameter	Type	Description
hubIPAddresses	object	IP addresses associated with AzureFirewall. Required if virtualHubId is supplied.

There are no information about the schema for the parameter, and looking at the Bicep code reveals no information about the expected syntax:
https://github.com/Azure/bicep-registry-modules/blob/main/avm/res/network/azure-firewall/main.bicep#L296

In order to determine this, we had to lookup the documentation:

    hubIPAddresses: {
      privateIPAddress: 'string'
      publicIPs: {
        addresses: [
          {
            address: 'string'
          }
        ]
        count: int
      }
    }

(Optional) Correlation Id

No response

[avm-team-linter]

@janegilring, thanks for submitting this issue for the avm/res/network/azure-firewall module!

Important

A member of the @Azure/avm-res-network-azurefirewall-module-owners-bicep or @Azure/avm-res-network-azurefirewall-module-contributors-bicep team will review it soon!

[microsoft-github-policy-service]

Important

The "Needs: Triage 🔍" label must be removed once the triage process is complete!

Tip

For additional guidance on how to triage this issue/PR, see the BRM Issue Triage documentation.

[microsoft-github-policy-service]

Warning

Tagging the AVM Core Team (@Azure/avm-core-team-technical-bicep) due to a module owner or contributor having not responded to this issue within 3 business days. The AVM Core Team will attempt to contact the module owners/contributors directly.

Tip

• To prevent further actions to take effect, the "Status: Response Overdue 🚩" label must be removed, once this issue has been responded to.
• To avoid this rule being (re)triggered, the ""Needs: Triage 🔍" label must be removed as part of the triage process (when the issue is first responded to)!

[eriqua]

Related to the more general #3641