Skip to main content

recommendations

Creates, updates, deletes, gets or lists a recommendations resource.

Overview

Namerecommendations
TypeResource
Idazure.advisor.recommendations

Fields

NameDatatypeDescription
idtextFully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
nametextThe name of the resource
descriptiontextfield from the properties object
actionstextfield from the properties object
categorytextfield from the properties object
exposed_metadata_propertiestextfield from the properties object
extended_propertiestextfield from the properties object
impacttextfield from the properties object
impacted_fieldtextfield from the properties object
impacted_valuetextfield from the properties object
labeltextfield from the properties object
last_updatedtextfield from the properties object
learn_more_linktextfield from the properties object
metadatatextfield from the properties object
potential_benefitstextfield from the properties object
recommendationIdtextfield from the properties object
recommendation_type_idtextfield from the properties object
remediationtextfield from the properties object
resourceUritextfield from the properties object
resource_metadatatextfield from the properties object
risktextfield from the properties object
short_descriptiontextfield from the properties object
subscriptionIdtextfield from the properties object
suppression_idstextfield from the properties object
system_datatextfield from the properties object
typetextThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

NameAccessible byRequired ParamsDescription
getSELECTrecommendationId, resourceUriObtains details of a cached recommendation.
listSELECTsubscriptionIdObtains cached recommendations for a subscription. The recommendations are generated or computed by invoking generateRecommendations.
exec_get_generate_statusEXECoperationId, subscriptionIdRetrieves the status of the recommendation computation or generation process. Invoke this API after calling the generation recommendation. The URI of this API is returned in the Location field of the response header.
generateEXECsubscriptionIdInitiates the recommendation generation or computation process for a subscription. This operation is asynchronous. The generated recommendations are stored in a cache in the Advisor service.
predictEXECsubscriptionId

SELECT examples

Obtains cached recommendations for a subscription. The recommendations are generated or computed by invoking generateRecommendations.

SELECT
id,
name,
description,
actions,
category,
exposed_metadata_properties,
extended_properties,
impact,
impacted_field,
impacted_value,
label,
last_updated,
learn_more_link,
metadata,
potential_benefits,
recommendationId,
recommendation_type_id,
remediation,
resourceUri,
resource_metadata,
risk,
short_description,
subscriptionId,
suppression_ids,
system_data,
type
FROM azure.advisor.vw_recommendations
WHERE subscriptionId = '{{ subscriptionId }}';