Recommendations - Get

Reference

Service:: Advisor

API Version:: 2023-01-01

Obtains details of a cached recommendation.

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

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	ResourceRecommendationBase	OK. Successfully got recommendation detail.
Other Status Codes	ArmErrorResponse	Error response describing why the operation failed.

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

HTTP

GET https://management.azure.com/resourceUri/providers/Microsoft.Advisor/recommendations/recommendationId?api-version=2023-01-01

Sample response

Status code:: 200

{
  "id": "/resourceUri/providers/Microsoft.Advisor/recommendations/recommendationId",
  "name": "recommendationId",
  "properties": {
    "category": "Security",
    "impact": "Medium",
    "impactedField": "Microsoft.Compute/virtualMachines",
    "impactedValue": "armavset",
    "lastUpdated": "2017-02-24T22:24:43.3216408Z",
    "risk": "Warning",
    "shortDescription": {
      "problem": "Monitoring agent should be installed on your machines",
      "solution": "Monitoring agent should be installed on your machines"
    },
    "remediation": {
      "additionalProperties": {
        "httpMethod": "POST",
        "uri": "uri",
        "details": "link to document"
      }
    },
    "resourceMetadata": {
      "resourceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Compute/virtualMachines/xyz",
      "source": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Compute/virtualMachines/xyz/providers/Microsoft.Security/assessments/assessmentGuid",
      "action": {
        "additionalProperties": {
          "actionType": "Document",
          "link": "https://link3",
          "caption": "Enable Soft Delete to protect blob data",
          "description": "Enable Soft Delete to protect blob data"
        },
        "metadata": {
          "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Compute/virtualMachines/xyz"
        }
      },
      "singular": "Virtual machine",
      "plural": "Virtual machines"
    },
    "actions": [
      {
        "additionalProperties": {
          "actionType": "Document",
          "link": "https://link1",
          "caption": "Enable Soft Delete to protect blob data",
          "description": "Enable Soft Delete to protect blob data"
        },
        "metadata": {
          "id": "/subscriptions/subscriptionId"
        }
      }
    ],
    "description": "After enabling Soft Delete, deleted data transitions to a soft deleted state instead of being permanently deleted. When data is overwritten, a soft deleted snapshot is generated to save the state of the overwritten data. You can configure the amount of time soft deleted data is recoverable before it permanently expires.",
    "label": "Enable Soft Delete",
    "learnMoreLink": "https://link2",
    "potentialBenefits": "Save and recover your data when blobs or blob snapshots are accidentally overwritten or deleted"
  },
  "type": "Microsoft.Advisor/recommendations"
}

Definitions

Name	Description
ArmErrorResponse
ARMErrorResponseBody	ARM error response body.
category	The category of the recommendation.
createdByType	The type of identity that created the resource.
impact	The business impact of the recommendation.
ResourceMetadata	Recommendation resource metadata
ResourceRecommendationBase	Advisor Recommendation.
risk	The potential risk of not implementing the recommendation.
ShortDescription	A summary of the recommendation.
systemData	Metadata pertaining to creation and last modification of the resource.

ArmErrorResponse

Name	Type	Description
error	ARMErrorResponseBody	ARM error response body.

ARMErrorResponseBody

ARM error response body.

Name	Type	Description
code	string	Gets or sets the string that can be used to programmatically identify the error.
message	string	Gets or sets the string that describes the error in detail and provides debugging information.

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

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

impact

The business impact of the recommendation.

Name	Type	Description
High	string
Low	string
Medium	string

ResourceMetadata

Recommendation resource metadata

Name	Type	Description
action	object	The action to view resource.
plural	string	The plural user friendly name of resource type. eg: virtual machines
resourceId	string	Azure resource Id of the assessed resource
singular	string	The singular user friendly name of resource type. eg: virtual machine
source	string	Source from which recommendation is generated

ResourceRecommendationBase

Advisor Recommendation.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties.actions	object[]	The list of recommended actions to implement recommendation.
properties.category	category	The category of the recommendation.
properties.description	string	The detailed description of recommendation.
properties.exposedMetadataProperties	object	The recommendation metadata properties exposed to customer to provide additional information.
properties.extendedProperties	object	Extended properties
properties.impact	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.label	string	The label of recommendation.
properties.lastUpdated	string	The most recent time that Advisor checked the validity of the recommendation.
properties.learnMoreLink	string	The link to learn more about recommendation and generation logic.
properties.metadata	object	The recommendation metadata.
properties.potentialBenefits	string	The potential benefit of implementing recommendation.
properties.recommendationTypeId	string	The recommendation-type GUID.
properties.remediation	object	The automated way to apply recommendation.
properties.resourceMetadata	ResourceMetadata	Metadata of resource that was assessed
properties.risk	risk	The potential risk of not implementing the recommendation.
properties.shortDescription	ShortDescription	A summary of the recommendation.
properties.suppressionIds	string[]	The list of snoozed and dismissed rules for the recommendation.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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 and proposed solution.
solution	string	The issue or opportunity identified by the recommendation and proposed solution.

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Share via