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

2025/09/10 • 1 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']
The filter can also be applied to property ['[TrackingIds]']

\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'. Filter can be applied on trackingIds as well.
- $filter=trackingIds/any(t: t eq 'some-guid')

\u26a0 **Note:** `trackingIDs` filter can be used for filtering one value at a time. The support to filter multiple values is not currently available. Also the support to add other filters along with `trackingIDs` is not available.",
        "old": "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'"
      }
    }
  ]
}

⚼ 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']
The filter can also be applied to property ['[TrackingIds]']

⚠ **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'. Filter can be applied on trackingIds as well.
- $filter=trackingIds/any(t: t eq 'some-guid')

⚠ **Note:** `trackingIDs` filter can be used for filtering one value at a time. The support to filter multiple values is not currently available. Also the support to add other filters along with `trackingIDs` is not available. ,
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 ,
}
,
}