Azure Advisor Recommendations - List API: Question regarding properties.shortDescription

Ivan Zeljkovic 60

The Azure Advisor Recommendations - List API call will return a properties object with the rest of the data, in specific I'm interested in the results possible in the properties.shortDescription field.

I've been asked to fetch all possible values for this field, but I'm not sure if it's possible to get the data for this somehow? I feel like this is just a pre-defined key-value pairing in the backend depending on the affect resource rather than being procedurally generated. I'm just unsure if it's possible to access this data somehow.

Appreciate any help, thank you.

navba-MSFT 19,655 Microsoft Employee

@Ivan Zeljkovic Welcome to Microsoft Q&A Forum, Thank you for posting your query here!

I see that you have question regarding the properties.shortDescription returned while invoking the Azure Advisor Recommendations - List API.

Our documentation mentions the below. I am checking this internally again to confirm if it is procedurally generated or hardcoded. I will keep you posted.

ShortDescription

A summary of the recommendation.


problem	string	The issue or opportunity identified by the recommendation and proposed solution.
solution	string	The issue or opportunity identified by the recommendation and proposed solution.

Ivan Zeljkovic 60 Reputation points

2023-07-05T13:41:22.1233333+00:00

@navba-MSFT Yeah, that's the field I'm curious about.

Thank you for looking into it!
navba-MSFT 19,655 Reputation points Microsoft Employee

2023-07-05T16:14:47.01+00:00

@Ivan Zeljkovic As you rightly pointed it out. Yes, it’s pre-defined text but not necessarily for each Azure Resource Type but rather for each recommendation type (each Azure Resource Type can have multiple recommendation types defined for it).

Example:

For availability set: "shortDescription": { "problem": "To ensure high availability add one or more virtual machines to this availability set", "solution": "To ensure high availability add one or more virtual machines to this availability set" }

For VNETs: "shortDescription": { "problem": "Use NAT gateway for outbound connectivity", "solution": "Use NAT gateway for outbound connectivity" }

For Compute VMs: "shortDescription": { "problem": "Right-size or shutdown underutilized virtual machines", "solution": "Right-size or shutdown underutilized virtual machines" }

Please note that while invoking the Azure Advisor Recommendations - List API, if the response limit is reached you will get the nextLink property which you can leverage and enumerate through all the responses.

Alternatively, You could also leverage the Azure CLI command to list the recommendations for your subscription. Hope this answers.

**

Please do not forget to "Accept the answer” and “up-vote” wherever the information provided helps you, this can be beneficial to other community members.
Ivan Zeljkovic 60 Reputation points

2023-07-06T17:12:13.26+00:00

Thank you for looking into it!

Although, my issue is still that I would like access to all possible outputs for this text. I understand if Microsoft does not want to make this public, but I was just curious if it's possible since the documentation does not provide the data.

I appreciate your help.
navba-MSFT 19,655 Reputation points Microsoft Employee

2023-07-07T04:39:53.4033333+00:00

@Ivan Zeljkovic Thanks for getting back. May I know your use case ? There are more than 250+ Azure Services, Do you want the shortDescription for all 250+ Azure Services ? May I know what is the requirement to list all instead of listing it only for the Azure Resources within your subscription ? Awaiting your reply.
Ivan Zeljkovic 60 Reputation points

2023-07-07T13:16:31.7533333+00:00

@navba-MSFT Sure, the use case for this instance is that we would like to create more user-friendly verbiage for the problem description, and then keep the problem solution as is, since the API returns the same value for both of them.

We will be providing this for many different Azure subscriptions, and as a result it wouldn't be unusual for us to eventually encounter all possible shortDescription outputs.
navba-MSFT 19,655 Reputation points Microsoft Employee

2023-07-07T13:19:53.1866667+00:00

@Ivan Zeljkovic Thanks for getting back. I will check this internally with the Product Group team and update if the shortDescriptions for all the Azure services are publicly exposed or not. I will keep you posted.

Accepted answer

navba-MSFT 19,655 Reputation points Microsoft Employee

2023-07-08T03:39:29.46+00:00

@Ivan Zeljkovic Thanks for your patience. I am able to fetch all the problem (Solution) recommenadtions under the below Recommendation metadata REST API:

API: https://video2.skills-academy.com/en-us/rest/api/advisor/recommendation-metadata/list?tabs=HTTP

See below:

Hope this helps.

**

Please do not forget to "Accept the answer” and “up-vote” wherever the information provided helps you, this can be beneficial to other community members.
Please sign in to rate this answer.
navba-MSFT 19,655 Reputation points Microsoft Employee

2023-07-10T05:14:43.6+00:00

@Ivan Zeljkovic Just following up to check if the above answer helped. If that answers your query, do click "Accept the answer” for the same, which might be beneficial to other community members reading this thread. And, if you have any further query do let us know. I would be happy to help.
Sign in to comment

Share via

Azure Advisor Recommendations - List API: Question regarding properties.shortDescription

0 additional answers