Docs: azurerm_firewall_policy - add comprehensive example

[jhern61]

Community Note

• Please vote on this PR by adding a 👍 reaction to the original PR to help the community and maintainers prioritize for review
• Please do not leave comments along the lines of "+1", "me too" or "any updates", they generate extra noise for PR followers and do not help prioritize for review

Description

This PR enhances the documentation for the azurerm_firewall_policy resource by adding a comprehensive example that demonstrates all available optional configuration blocks and features.

Changes made:

• Added a detailed example showing all optional configuration sections including DNS settings, threat intelligence, intrusion detection, SNAT configuration, analytics/monitoring, and managed identity
• Reorganized the example structure to show supporting resources first, followed by the main firewall policy resource
• Used working configuration that has been tested and validated

This improvement helps users understand the full capabilities of Azure Firewall Policy

PR Checklist

• I have followed the guidelines in our Contributing Documentation.
• I have checked to ensure there aren't other open Pull Requests for the same update/change.
• I have checked if my changes close any open issues. If so please include appropriate closing keywords below.
• I have updated/added Documentation as required written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source.
• I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work.
  For example: "azurerm_firewall_policy - add comprehensive documentation example with all optional configurations"

Changes to existing Resource / Data Source

• I have added an explanation of what my changes do and why I'd like you to include them (This may be covered by linking to an issue above, but may benefit from additional explanation).
• I have written new tests for my resource or datasource changes & updated any relevant documentation.
• I have successfully run tests with my changes locally. If not, please provide details on testing challenges that prevented you running the tests.
• (For changes that include a state migration only). I have manually tested the migration path between relevant versions of the provider.

Testing

• My submission includes Test coverage as described in the Contribution Guide and the tests pass. (if this is not possible for any reason, please include details of why you did or could not add test coverage)

Testing Evidence:
This is a documentation-only change.

Change Log

Below please provide what should go into the changelog (if anything) conforming to the Changelog Format documented here.

• azurerm_firewall_policy - enhance documentation with comprehensive example showing all optional configuration blocks

This is a (please select all that apply):

• Bug Fix
• New Feature (ie adding a service, resource, or data source)
• Enhancement
• Breaking Change

Related Issue(s)

Resolves #15585

AI Assistance Disclosure

• AI Assisted - This contribution was made by, or with the assistance of, AI/LLMs

Rollback Plan

If a change needs to be reverted, we will publish an updated version of the provider.

Changes to Security Controls

Are there any changes to security controls (access controls, encryption, logging) in this pull request? If so, explain.

No changes to security controls. This is a documentation-only enhancement that does not modify any functional code or security mechanisms.

[sreallymatt]

Hi @jhern61 - To avoid overwhelming users with massive examples in the documentation, we generally only add examples for basic configuration (i.e. only the minimum required properties)

Full usage examples shouldn't go in the resource documentation, instead they can be added to the examples directory within the provider

[github-actions]

This PR is being labeled as "stale" because it has not been updated for 30 or more days.

If this PR is still valid, please remove the "stale" label. If this PR is blocked, please add it to the "Blocked" milestone.

If you need some help completing this PR, please leave a comment letting us know. Thank you!

[sreallymatt]

Closing as this PR is stale