Recommendations - Get

Obtains details of a cached recommendation.

GET https://management.azure.com/{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}?api-version=2017-04-19

URI Parameters

Name In Required Type Description
recommendationId
path True
  • string

The recommendation ID.

resourceUri
path True
  • string

The fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies.

api-version
query True
  • string

The version of the API to be used with the client request.

Responses

Name Type Description
200 OK

OK. Successfully got recommendation detail.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

GetRecommendationDetail

Sample Request

GET https://management.azure.com/resourceUri/providers/Microsoft.Advisor/recommendations/recommendationId?api-version=2017-04-19

Sample Response

{
  "id": "/resourceUri/providers/Microsoft.Advisor/recommendations/recommendationId",
  "name": "recommendationId",
  "properties": {
    "category": "HighAvailability",
    "impact": "Medium",
    "impactedField": "Microsoft.Compute/availabilitySets",
    "impactedValue": "armavset",
    "lastUpdated": "2017-02-24T22:24:43.3216408Z",
    "risk": "Warning",
    "shortDescription": {
      "problem": "This availability set is not configured for fault tolerance",
      "solution": "To ensure high availability add one or more virtual machines to this availability set"
    }
  },
  "type": "Microsoft.Advisor/recommendations"
}

Definitions

category

The category of the recommendation.

impact

The business impact of the recommendation.

ResourceRecommendationBase

Advisor Recommendation.

risk

The potential risk of not implementing the recommendation.

ShortDescription

A summary of the recommendation.

category

The category of the recommendation.

Name Type Description
Cost
  • string
HighAvailability
  • string
OperationalExcellence
  • string
Performance
  • string
Security
  • string

impact

The business impact of the recommendation.

Name Type Description
High
  • string
Low
  • string
Medium
  • string

ResourceRecommendationBase

Advisor Recommendation.

Name Type Description
id
  • string

The resource ID.

name
  • string

The name of the resource.

properties.category

The category of the recommendation.

properties.extendedProperties
  • object

Extended properties

properties.impact

The business impact of the recommendation.

properties.impactedField
  • string

The resource type identified by Advisor.

properties.impactedValue
  • string

The resource identified by Advisor.

properties.lastUpdated
  • string

The most recent time that Advisor checked the validity of the recommendation.

properties.metadata
  • object

The recommendation metadata.

properties.recommendationTypeId
  • string

The recommendation-type GUID.

properties.risk

The potential risk of not implementing the recommendation.

properties.shortDescription

A summary of the recommendation.

properties.suppressionIds
  • string[]

The list of snoozed and dismissed rules for the recommendation.

type
  • string

The type of the resource.

risk

The potential risk of not implementing the recommendation.

Name Type Description
Error
  • string
None
  • string
Warning
  • string

ShortDescription

A summary of the recommendation.

Name Type Description
problem
  • string

The issue or opportunity identified by the recommendation.

solution
  • string

The remediation action suggested by the recommendation.