Recommendation Metadata - List

Service:

Advisor

Version d'API:

2025-01-01

Obtient la liste des entités de métadonnées.

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

Avec des paramètres facultatifs:

GET https://management.azure.com/providers/Microsoft.Advisor/metadata?api-version=2025-01-01&$filter={$filter}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
api-version	query	True	string	Version de l’API à utiliser avec la demande cliente.
$filter	query		string	Filtre à appliquer aux métadonnées de recommandation. Le filtre peut être appliqué aux propriétés ['recommendationCategory', 'recommendationSubCategory', 'RetirementDate'] avec les opérateurs ['eq', 'and', 'le', 'ge'] Le filtre peut également être appliqué à la propriété ['[TrackingIds]'] ⚠ Note:recommendationControl est une propriété de filtre héritée et sera obsolète à l’avenir. Veuillez utiliser recommendationSubCategory pour filtrer la sous-catégorie de recommandation. Options valides pour la recommandationSous-catégorie : ['BusinessContinuity', 'DisasterRecovery', 'HighAvailability', 'MonitoringAndAlerting', 'Other', 'Personalized', 'PrioritydRecommendations', 'Scalability', 'ServiceUpgradeAndRetirement', 'Validation'] Exemple: - $filter=recommendationCategory eq 'HighAvailability' et recommendationSubCategory eq 'ServiceUpgradeAndRetirement' et retirementDate ge '2024-01-01' et retirementDate le '2028-01-01'. Le filtre peut également être appliqué sur trackingIds. - $filter=trackingIds/any(t : t eq 'un-guid') ⚠ Note:trackingIDs filter peut être utilisé pour filtrer une valeur à la fois. La prise en charge du filtrage de plusieurs valeurs n’est pas disponible actuellement. De plus, la prise en charge de l’ajout d’autres filtres trackingIDs n’est pas disponible.

Réponses

Nom	Type	Description
200 OK	MetadataEntityListResult	D’ACCORD. Entités de métadonnées récupérées avec succès
Other Status Codes	ArmErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

GetMetadata

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:

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"
          }
        ]
      }
    }
  ]
}

Définitions

Nom	Description
ArmErrorResponse
ARMErrorResponseBody	Corps de la réponse d’erreur ARM.
MetadataEntity	Contrat d’entité de métadonnées.
MetadataEntityListResult	Liste des entités de métadonnées
MetadataSupportedValueDetail	Détails des valeurs prises en charge par les métadonnées.
Scenario	Liste des scénarios applicables à cette entité de métadonnées.

ArmErrorResponse

Object

Nom	Type	Description
error	ARMErrorResponseBody	Corps de la réponse d’erreur ARM.

ARMErrorResponseBody

Object

Corps de la réponse d’erreur ARM.

Nom	Type	Description
code	string	Obtient ou définit la chaîne qui peut être utilisée pour identifier l’erreur par programmation.
message	string	Obtient ou définit la chaîne qui décrit l’erreur en détail et fournit des informations de débogage.

MetadataEntity

Object

Contrat d’entité de métadonnées.

Nom	Type	Description
id	string	ID de ressource de l’entité de métadonnées.
name	string	Nom de l’entité de métadonnées.
properties.applicableScenarios	Scenario[]	Liste des scénarios applicables à cette entité de métadonnées.
properties.dependsOn	string[]	Liste des clés dont dépend cette entité.
properties.displayName	string	Nom complet.
properties.supportedValues	MetadataSupportedValueDetail[]	Liste des valeurs prises en charge.
type	string	Type de l’entité de métadonnées.

MetadataEntityListResult

Object

Liste des entités de métadonnées

Nom	Type	Description
nextLink	string	Lien utilisé pour obtenir la page suivante des métadonnées.
value	MetadataEntity[]	Liste des entités de métadonnées.

MetadataSupportedValueDetail

Object

Détails des valeurs prises en charge par les métadonnées.

Nom	Type	Description
displayName	string	Nom complet.
id	string	ID.

Scenario

Énumération

Liste des scénarios applicables à cette entité de métadonnées.

Valeur	Description
Alerts