Enhance documentation for Azure Optimization Engine - #2267
Open
Hélder Pinto (helderpinto) wants to merge 6 commits into
Open
Enhance documentation for Azure Optimization Engine#2267Hélder Pinto (helderpinto) wants to merge 6 commits into
Hélder Pinto (helderpinto) wants to merge 6 commits into
Conversation
added 4 commits
August 17, 2026 15:23
Hélder Pinto (helderpinto)
requested review from
Roland Krummenacher (RolandKrummenacher)
and
a lite review from Copilot
August 18, 2026 14:35
Hélder Pinto (helderpinto)
requested review from
Brett Wilson (MSBrett) and
Michael Flanakin (flanakin)
as code owners
August 18, 2026 14:36
Copilot started reviewing on behalf of
Hélder Pinto (helderpinto)
August 18, 2026 14:36
View session
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves Microsoft Learn documentation for the Azure Optimization Engine (AOE) in the FinOps Toolkit by adding a dedicated reference page and wiring it into navigation and the changelog. It also includes a functional deployment template change removing a legacy Automation variable.
Changes:
- Added a new AOE “Reference” doc covering runbooks, schedules, variables, and data tables.
- Updated AOE customization guidance and the toolkit changelog/TOC to point to the new reference content.
- Removed the
AzureOptimization_LogAnalyticsWorkspaceKeyAutomation variable from the AOE nested deployment template.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| src/optimization-engine/azuredeploy-nested.bicep | Removes a legacy Automation variable from the deployment template. |
| docs-mslearn/toolkit/optimization-engine/reference.md | Adds the new AOE reference documentation page. |
| docs-mslearn/toolkit/optimization-engine/customize.md | Links readers to the new reference page for the full variable list. |
| docs-mslearn/toolkit/changelog.md | Announces the new AOE reference page and updates ms.date. |
| docs-mslearn/TOC.yml | Adds the new reference page to the AOE documentation TOC. |
💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
🛠️ Description
This pull request introduces documentation improvements to the FinOps toolkit, primarily by adding a comprehensive reference for the Azure Optimization Engine (AOE) and updating related documentation to reflect this addition. These changes enhance the discoverability and usability of AOE configuration details.
Documentation enhancements:
toolkit/optimization-engine/reference.md) to the AOE section in the table of contents, providing comprehensive documentation for runbooks, schedules, variables, Log Analytics tables, and SQL Database tables.Deployment fixes:
AzureOptimization_LogAnalyticsWorkspaceKeyautomation variable from deployment (leftover of upgrade to DCR-based ingestion) and updated variables documentation accordingly.Changelog update:
ms.datefield inchangelog.mdto reflect the latest documentation update.Fixes #1271
📋 Checklist
🔬 How did you test this change?
📦 Deploy to test?
🙋♀️ Do any of the following that apply?
📑 Did you update
docs/changelog.md?📖 Did you update documentation?