Skip to content

docs: Add reference documentation for Microsoft.Windows/FirewallRuleList#1523

Open
Gijsreyn wants to merge 3 commits intoPowerShell:mainfrom
Gijsreyn:update-winfirewall-docs
Open

docs: Add reference documentation for Microsoft.Windows/FirewallRuleList#1523
Gijsreyn wants to merge 3 commits intoPowerShell:mainfrom
Gijsreyn:update-winfirewall-docs

Conversation

@Gijsreyn
Copy link
Copy Markdown
Collaborator

@Gijsreyn Gijsreyn commented May 9, 2026

PR Summary

This pull request adds reference documentation for the built-in DSC resource Microsoft.Windows/FirewallRuleList.

Copilot AI review requested due to automatic review settings May 9, 2026 10:18
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds reference documentation and examples for the built-in DSC resource Microsoft.Windows/FirewallRuleList, describing its schema, capabilities, and common usage patterns for getting/setting/exporting Windows Firewall rules.

Changes:

  • Added a full resource reference page including properties, schema, exit codes, and links to examples.
  • Added a “get/toggle/export” CLI example page for dsc resource usage.
  • Added a configuration-document example (YAML) plus a walkthrough for dsc config test/set and rule removal.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

File Description
docs/reference/resources/Microsoft/Windows/FirewallRuleList/index.md New reference page for the resource (syntax, properties, schema, exit codes, links).
docs/reference/resources/Microsoft/Windows/FirewallRuleList/examples/get-firewall-rules.md New CLI-oriented example for get/set/export behavior.
docs/reference/resources/Microsoft/Windows/FirewallRuleList/examples/firewall.config.dsc.yaml New sample DSC config document defining two firewall rules.
docs/reference/resources/Microsoft/Windows/FirewallRuleList/examples/configure-firewall-rules.md New walkthrough demonstrating config test/set and rule removal.

@Gijsreyn
Copy link
Copy Markdown
Collaborator Author

Gijsreyn commented May 9, 2026

@SteveL-MSFT - one of the remarks from Copilot was the min/max on the protocol property. Even though, when running it, for example, with 257, the executable throws a useful error message. However, I have updated the resource manifest to include both minimum and maximum, as I do think it adds value for authoring-time feedback and fails early without spawning a process.

If not, let me know, and I'll remove it from the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants