Microsoft.Advisor (stable:2025-01-01)

2025/07/03 • 2 updated methods

RecommendationMetadata_List (updated)
Description :  Gets the list of metadata entities.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RecommendationMetadata_List",
  "$parameters": [
    {
      "#name": "$filter",
      "Description": {
        "new": "The filter to apply to the recommendation metadata.
Filter can be applied to properties ['[recommendationCategory](#category)', '[recommendationSubCategory](#recommendationSubCategory)', 'RetirementDate'] with operators ['eq', 'and', 'le', 'ge'].

\u26a0 **Note:** `recommendationControl` is a legacy filter property and will be deprecated in the future. Please use `recommendationSubCategory` for filtering recommendation subcategory.

Valid options for recommendationSubCategory: ['BusinessContinuity', 'DisasterRecovery', 'HighAvailability', 'MonitoringAndAlerting', 'Other', 'Personalized', 'PrioritizedRecommendations', 'Scalability', 'ServiceUpgradeAndRetirement', 'Validation']

Example:
- $filter=recommendationCategory eq 'HighAvailability' and recommendationSubCategory eq 'ServiceUpgradeAndRetirement' and retirementDate ge '2024-01-01' and retirementDate le '2028-01-01'",
        "old": "The filter to apply to the recommendation metadata.
Filter can be applied to properties ['[Category](#category)', '[Control](#control)', 'RetirementDate'] with operators ['eq', 'and', 'le', 'ge'].
Example:
- $filter=recommendationCategory eq 'HighAvailability' and recommendationControl eq 'ServiceUpgradeAndRetirement' and retirementDate ge '2024-01-01' and retirementDate le '2028-01-01'"
      }
    }
  ]
}

⚼ Request

GET:  /providers/Microsoft.Advisor/metadata
{
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply to the recommendation metadata.
Filter can be applied to properties ['[recommendationCategory](#category)', '[recommendationSubCategory](#recommendationSubCategory)', 'RetirementDate'] with operators ['eq', 'and', 'le', 'ge'].

⚠ **Note:** `recommendationControl` is a legacy filter property and will be deprecated in the future. Please use `recommendationSubCategory` for filtering recommendation subcategory.

Valid options for recommendationSubCategory: ['BusinessContinuity', 'DisasterRecovery', 'HighAvailability', 'MonitoringAndAlerting', 'Other', 'Personalized', 'PrioritizedRecommendations', 'Scalability', 'ServiceUpgradeAndRetirement', 'Validation']

Example:
- $filter=recommendationCategory eq 'HighAvailability' and recommendationSubCategory eq 'ServiceUpgradeAndRetirement' and retirementDate ge '2024-01-01' and retirementDate le '2028-01-01' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of metadata entities. ,
Required: False ,
}
[
{
id:
{
Description: The resource Id of the metadata entity. ,
Required: False ,
}
string ,
type:
{
Description: The type of the metadata entity. ,
Required: False ,
}
string ,
name:
{
Description: The name of the metadata entity. ,
Required: False ,
}
string ,
properties:
{
Description: The metadata entity properties. ,
Required: False ,
}
{
displayName:
{
Description: The display name. ,
Required: False ,
}
string ,
dependsOn:
{
Description: The list of keys on which this entity depends on. ,
Required: False ,
}
[
string ,
]
,
applicableScenarios:
{
Description: The list of scenarios applicable to this metadata entity. ,
Required: False ,
}
[
string ,
]
,
supportedValues:
{
Description: The list of supported values. ,
Required: False ,
}
[
{
id:
{
Description: The id. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of metadata. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}
Recommendations_List (updated)
Description :  Obtains cached recommendations for a subscription. The recommendations are generated or computed by invoking generateRecommendations.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Recommendations_List",
  "$parameters": [
    {
      "#name": "$filter",
      "Description": {
        "new": "The filter to apply to the recommendations.
Filter can be applied to properties ['ResourceId', 'ResourceGroup', 'RecommendationTypeGuid', '[Category](#category)', 'SubCategory', 'RetirementDate'] with operators ['eq', 'and', 'or', 'lt', 'gt', 'le', 'ge'].

\u26a0 **Note:** `Control` is a legacy filter property and will be deprecated in the future. Please use `SubCategory` for filtering recommendation subcategory.

Valid options for SubCategory:
['BusinessContinuity', 'DisasterRecovery', 'HighAvailability', 'MonitoringAndAlerting', 'Other', 'Personalized', 'PrioritizedRecommendations', 'Scalability', 'ServiceUpgradeAndRetirement', 'Validation']

Example:
- $filter=Category eq 'Cost' and ResourceGroup eq 'MyResourceGroup'
-$filter=SubCategory eq 'ServiceUpgradeAndRetirement' and RetirementDate le '2024-01-01' and RetirementDate ge '2028-01-01'",
        "old": "The filter to apply to the recommendations.
Filter can be applied to properties ['ResourceId', 'ResourceGroup', 'RecommendationTypeGuid', '[Category](#category)', '[Control](#control)', 'RetirementDate'] with operators ['eq', 'and', 'or', 'lt', 'gt', 'le', 'ge'].
Example:
- $filter=Category eq 'Cost' and ResourceGroup eq 'MyResourceGroup'
-$filter=Control eq 'ServiceUpgradeAndRetirement' and RetirementDate le '2024-01-01' and RetirementDate ge '2028-01-01'"
      }
    }
  ]
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/recommendations
{
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply to the recommendations.
Filter can be applied to properties ['ResourceId', 'ResourceGroup', 'RecommendationTypeGuid', '[Category](#category)', 'SubCategory', 'RetirementDate'] with operators ['eq', 'and', 'or', 'lt', 'gt', 'le', 'ge'].

⚠ **Note:** `Control` is a legacy filter property and will be deprecated in the future. Please use `SubCategory` for filtering recommendation subcategory.

Valid options for SubCategory:
['BusinessContinuity', 'DisasterRecovery', 'HighAvailability', 'MonitoringAndAlerting', 'Other', 'Personalized', 'PrioritizedRecommendations', 'Scalability', 'ServiceUpgradeAndRetirement', 'Validation']

Example:
- $filter=Category eq 'Cost' and ResourceGroup eq 'MyResourceGroup'
-$filter=SubCategory eq 'ServiceUpgradeAndRetirement' and RetirementDate le '2024-01-01' and RetirementDate ge '2028-01-01' ,
Required: False ,
}
string ,
$top:
{
Description: The number of recommendations per page if a paged version of this API is being used. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: The page-continuation token to use with a paged version of this API. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of recommendations. ,
Required: False ,
}
string ,
value:
{
Description: The list of recommendations. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the recommendation. ,
Required: False ,
}
{
category:
{
Description: The category of the recommendation. ,
Enum:
{
HighAvailability: No description available. ,
Security: No description available. ,
Performance: No description available. ,
Cost: No description available. ,
OperationalExcellence: No description available. ,
}
,
Required: False ,
}
enum ,
control:
{
Description: The sub-category of the recommendation. ,
Enum:
{
HighAvailability: No description available. ,
BusinessContinuity: No description available. ,
DisasterRecovery: No description available. ,
Scalability: No description available. ,
MonitoringAndAlerting: No description available. ,
ServiceUpgradeAndRetirement: No description available. ,
Other: No description available. ,
PrioritizedRecommendations: No description available. ,
Personalized: No description available. ,
}
,
Required: False ,
}
enum ,
impact:
{
Description: The business impact of the recommendation. ,
Enum:
{
High: No description available. ,
Medium: No description available. ,
Low: No description available. ,
}
,
Required: False ,
}
enum ,
impactedField:
{
Description: The resource type identified by Advisor. ,
Required: False ,
}
string ,
impactedValue:
{
Description: The resource identified by Advisor. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The most recent time that Advisor checked the validity of the recommendation. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The recommendation metadata. ,
Required: False ,
}
object ,
recommendationTypeId:
{
Description: The recommendation-type GUID. ,
Required: False ,
}
string ,
risk:
{
Description: The potential risk of not implementing the recommendation. ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
shortDescription:
{
Description: A summary of the recommendation. ,
Required: False ,
}
{
problem:
{
Description: The issue or opportunity identified by the recommendation and proposed solution. ,
Required: False ,
}
string ,
solution:
{
Description: The issue or opportunity identified by the recommendation and proposed solution. ,
Required: False ,
}
string ,
}
,
suppressionIds:
{
Description: The list of snoozed and dismissed rules for the recommendation. ,
Required: False ,
}
[
string ,
]
,
extendedProperties:
{
Description: Extended properties ,
Required: False ,
}
object ,
resourceMetadata:
{
Description: Metadata of resource that was assessed ,
Required: False ,
}
{
resourceId:
{
Description: Azure resource Id of the assessed resource ,
Required: False ,
}
string ,
source:
{
Description: Source from which recommendation is generated ,
Required: False ,
}
string ,
action:
{
Description: The action to view resource. ,
Required: False ,
}
object ,
singular:
{
Description: The singular user friendly name of resource type. eg: virtual machine ,
Required: False ,
}
string ,
plural:
{
Description: The plural user friendly name of resource type. eg: virtual machines ,
Required: False ,
}
string ,
}
,
description:
{
Description: The detailed description of recommendation. ,
Required: False ,
}
string ,
label:
{
Description: The label of recommendation. ,
Required: False ,
}
string ,
learnMoreLink:
{
Description: The link to learn more about recommendation and generation logic. ,
Required: False ,
}
string ,
potentialBenefits:
{
Description: The potential benefit of implementing recommendation. ,
Required: False ,
}
string ,
actions:
{
Description: The list of recommended actions to implement recommendation. ,
Required: False ,
}
[
object ,
]
,
remediation:
{
Description: The automated way to apply recommendation. ,
Required: False ,
}
object ,
exposedMetadataProperties:
{
Description: The recommendation metadata properties exposed to customer to provide additional information. ,
Required: False ,
}
object ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}