Skip to content

Well-Architected assessment collector ​

Generated by scripts/docs/New-CollectorReferencePages.ps1 from the collector definitions. Do not edit by hand.

PropertyValue
Idwaf-assessment
FunctionInvoke-RangerWafAssessmentCollector
Classoptional
Coverswaf-assessment
Required targetazure
Required credentialazure
Manifest domainsdomains.wafAssessment

Access and permissions ​

Evaluates the manifest with the rule engine and reads Azure Advisor recommendations (Reader). No node access.

Output ​

Top-level keys of each domain, as seen in the fixture manifest (tests/maproom/Fixtures/synthetic-manifest.json). Collectors can add keys between releases; the manifest schema keeps domain payloads open.

domains.wafAssessment ​

advisorRecommendations, byPillar, summary

When it is skipped, degraded or failed ​

Optional: skipped when Azure is not reachable; the rule engine part still runs from the manifest.

The collector status in the manifest is one of success, partial, failed, skipped or not-applicable. Since v2.7.0 the entry also carries degraded, degradationCount and degradations (source and message of every non-fatal read that failed), and a degraded collector adds an informational finding. Debug-level detail is in ranger.log.

Released under the MIT License.