Recommendation Metadata - List

Service:

Advisor

API Version:

2023-01-01

Gets the list of metadata entities.

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

URI Parameters

Name	In	Required	Type	Description
api-version	query	True	string	The version of the API to be used with the client request.

Responses

Name	Type	Description
200 OK	MetadataEntityListResult	OK. Successfully retrieved metadata entities
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

GetMetadata

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "nextLink": "string",
  "value": [
    {
      "id": "providers/Microsoft.Advisor/metadata/recommendationType",
      "name": "recommendationType",
      "type": "Microsoft.Advisor/metadata",
      "properties": {
        "displayName": "Recommendation Type",
        "dependsOn": [
          "category",
          "impact"
        ],
        "applicableScenarios": [
          "Alerts"
        ],
        "supportedValues": [
          {
            "id": "6a2b1e70-bd4c-4163-86de-5243d7ac05ee",
            "displayName": "Upgrade your SKU or add more instances to ensure fault tolerance"
          },
          {
            "id": "da6630fb-4286-4996-92a3-a43f5f26dd34",
            "displayName": "Delete ExpressRoute circuits in the provider status of Not Provisioned"
          }
        ]
      }
    },
    {
      "id": "providers/Microsoft.Advisor/metadata/recommendationCategory",
      "name": "recommendationCategory",
      "type": "Microsoft.Advisor/metadata",
      "properties": {
        "displayName": "Category",
        "dependsOn": null,
        "applicableScenarios": [
          "Alerts"
        ],
        "supportedValues": [
          {
            "id": "Cost",
            "displayName": "Cost"
          },
          {
            "id": "Performance",
            "displayName": "Performance"
          }
        ]
      }
    },
    {
      "id": "providers/Microsoft.Advisor/metadata/recommendationImpact",
      "name": "recommendationImpact",
      "type": "Microsoft.Advisor/metadata",
      "properties": {
        "displayName": "Impact",
        "dependsOn": null,
        "applicableScenarios": null,
        "supportedValues": [
          {
            "id": "High",
            "displayName": "High"
          },
          {
            "id": "Medium",
            "displayName": "Medium"
          },
          {
            "id": "Low",
            "displayName": "Low"
          }
        ]
      }
    }
  ]
}

Definitions

Name	Description
ArmErrorResponse
ARMErrorResponseBody	ARM error response body.
MetadataEntity	The metadata entity contract.
MetadataEntityListResult	The list of metadata entities
MetadataSupportedValueDetail	The metadata supported value detail.
Scenario	The list of scenarios applicable to this metadata entity.

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.

MetadataEntity

The metadata entity contract.

Name	Type	Description
id	string	The resource Id of the metadata entity.
name	string	The name of the metadata entity.
properties.applicableScenarios	Scenario[]	The list of scenarios applicable to this metadata entity.
properties.dependsOn	string[]	The list of keys on which this entity depends on.
properties.displayName	string	The display name.
properties.supportedValues	MetadataSupportedValueDetail[]	The list of supported values.
type	string	The type of the metadata entity.

MetadataEntityListResult

The list of metadata entities

Name	Type	Description
nextLink	string	The link used to get the next page of metadata.
value	MetadataEntity[]	The list of metadata entities.

MetadataSupportedValueDetail

The metadata supported value detail.

Name	Type	Description
displayName	string	The display name.
id	string	The id.

Scenario

The list of scenarios applicable to this metadata entity.

Name	Type	Description
Alerts	string