Recommendation Metadata - Get

Référence

Service:: Advisor

API Version:: 2023-01-01

Obtient l’entité de métadonnées.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
name	path	True	string	Nom de l’entité de métadonnées.
api-version	query	True	string	Version de l’API à utiliser avec la demande cliente.

Réponses

Nom	Type	Description
200 OK	MetadataEntity	OK. Entités de métadonnées récupérées avec succès
404 Not Found	ARMErrorResponseBody	Nom des métadonnées inconnues envoyées par le client
Other Status Codes	ArmErrorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Exemples

GetMetadata

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

Status code:: 404

{
  "code": "NotFound",
  "message": "Unknown metadata name"
}

Définitions

Nom	Description
ArmErrorResponse
ARMErrorResponseBody	Corps de réponse d’erreur ARM.
MetadataEntity	Contrat d’entité de métadonnées.
MetadataSupportedValueDetail	Détail de la valeur prise en charge des métadonnées.
Scenario	Liste des scénarios applicables à cette entité de métadonnées.

ArmErrorResponse

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

ARMErrorResponseBody

Corps de 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

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	Le nom d’affichage.
properties.supportedValues	MetadataSupportedValueDetail[]	Liste des valeurs prises en charge.
type	string	Type de l’entité de métadonnées.

MetadataSupportedValueDetail

Détail de la valeur prise en charge des métadonnées.

Nom	Type	Description
displayName	string	Le nom d’affichage.
id	string	ID.

Scenario

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

Nom	Type	Description
Alerts	string