Description
Are you submitting your tool or someone else's?
I'm submitting a tool that I own.
Tool ownership responsibilities (only applicable to tool owners)
- I acknowledge the responsibilities of a technical lead and agree to serve in this role for the proposed tool upon its approval.
Tool name
RecommendationTypes.csv
Description
Azure Advisor doesn't expose details about the different recommendations that are available. We should include a new open data file that includes the recommendation type details to describe each recommendation made available in Azure Advisor.
Use case
Organize and provide additional context for Azure Advisor recommendations.
Services used
None
Dependencies
This information can be parsed out of Microsoft Learn docs in GitHub via a PowerShell script. There are no runtime dependencies.
Metadata
Metadata
Assignees
Labels
Type
Projects
Relationships
Participants
Activity
flanakin commentedon Jan 20, 2025
Partial sample from the generated file (6 columns removed):
flanakin commentedon Jan 20, 2025
@arthurclares / @helderpinto / @nteyan, I figure y'all have spent the most time looking at the Advisor recommendations. I was thinking about adding more context to our Power BI report and wasn't able to find this level of detail. I haven't fully thought thru how we'd use it but I figure y'all are the best to review the proposal. Let me know if you have any questions.
arthurclares commentedon Jan 22, 2025
I don't think we have a central pace for these recommendations, so having this file seems to be a good idea. Hwoever, from a Hub perspective, we could simply have an ARG query that would surface these recommendations and then add it to the dashboards, wouldn't that be easier? Actually, if I'm not mistaken, Helder has done this already.
helderpinto commentedon Jan 26, 2025
@flanakin, I didn't find any GitHub docs reference where we could parse all the recommendation types columns. Can you share the source where you got the sample table from?
The
metadataAzure Advisor REST API endpoint would probably be the best source of truth for this information. However, it does not contain data for the recommendation version nor the learn more link.Alternatively, we could use Azure Resource Graph, but it only contains metadata for recommendations that have been generated in the context of the customer, which is only a subset of all possible recommendation types.
flanakin commentedon Feb 2, 2025
@helderpinto We talked about this, but sharing with others: I found the details in the MicrosoftDocs/SelfHelpContent repo. I believe the repo is private to FTEs only. This repo has self-help guidance for every Azure service used in the Azure portal.
I wasn't aware of the RecommendationMetadata API. I would agree that would be a better source for the core details. We can merge the self-help content as well.
This works for Power BI, but not ADX dashboards.
The question is, do we see value in providing a CSV dataset that we can ingest into Power BI and Data Explorer to improve our reports and dashboards? Power BI can call the current API, but not the self-help guidance, but I'm not sure I'd do this for the self-help guidance only. I don't know if ADX dashboards can call ARM APIs.