Add comprehensive documentation for Azure Resource Graph payload size limit errors in Governance and Workload Optimization reports #1849
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
Users with large Azure environments are encountering payload size limit errors when attempting to load the Governance and Workload Optimization Power BI reports. The error message appears as:
This occurs because both reports use Azure Resource Graph queries with
[resultTruncated = false]to retrieve comprehensive resource details. For organizations with millions of resources, the response payload exceeds Azure Resource Graph's 16 MB limit, preventing the reports from loading.Root Cause
Azure Resource Graph enforces a 16 MB (16,777,216 bytes) response payload limit per query. The Governance and Workload Optimization reports are designed to show detailed resource-level information and are optimized for small to medium-sized environments. When used in large enterprise environments with millions of resources, the unfiltered queries exceed this limit.
This is a by-design limitation of Azure Resource Graph, not a bug in the FinOps toolkit.
Solution
This PR provides comprehensive documentation and practical guidance to help users understand and mitigate the payload size limit error. Since this is a platform limitation, the solution focuses on empowering users with actionable workarounds.
Changes Made
1. Enhanced Error Documentation (
help/errors.md)Expanded the existing "Response payload size exceeded" error section with detailed, step-by-step mitigation strategies:
Option 1: Filter by Subscription
Option 2: Filter by Tags
Option 3: Remove Unnecessary Columns
Option 4: Disable Problematic Queries
Each option includes:
2. Updated Report Documentation
Added "Known limitations" sections to both affected reports:
power-bi/governance.md)power-bi/workload-optimization.md)These sections:
3. Changelog Entry
Added documentation improvements to the Unreleased section of
changelog.md, following the repository's documentation standards.Impact
References
This documentation is based on and links to official Microsoft documentation:
Testing
Future Enhancements (Out of Scope)
Potential product improvements to consider in future releases:
Fixes: Provides mitigation guidance for the Governance Report payload size limit error reported in the issue.
Original prompt
Fixes #1768
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.