Utiliser des métadonnées pour la gouvernance des API

Cet article fournit des informations générales sur les métadonnées et la façon de les utiliser pour la gouvernance des API dans le centre des API Azure. Vous définissez et définissez des métadonnées pour organiser et filtrer les API et autres entités de votre centre API. Les métadonnées peuvent être intégrées ou personnalisées, et vous pouvez développer un schéma de métadonnées pour appliquer la cohérence entre vos API, environnements et déploiements.

Métadonnées intégrées

Lors de la création ou de la mise à jour d’API, d’environnements et de déploiements dans votre centre d’API, vous définissez certaines propriétés de métadonnées intégrées, telles que le type d’API (REST, WSDL, etc.).

Les tableaux suivants répertorient les métadonnées intégrées fournies pour les entités du Centre des API Azure. Pour plus d’informations, consultez la informations de référence sur l’API REST du Centre d’API. Les tables n’incluent pas de propriétés Azure standard telles que les identificateurs de ressource, les titres d’affichage ou les descriptions. Toutes les propriétés ne sont pas requises.

APIs

Métadonnées	Descriptif	Exemples de valeurs
kind	Type de l’API	REST, SOAP, GraphQL
phase de cycle de vie	Phase du cycle de vie du développement d’API	Conception, développement
license	Informations de licence pour l’API	Identificateur SPDX, lien vers le texte de la licence
documentation externe	Site pour la documentation externe de l’API	URL pointant vers la documentation
Informations de contact	Points de contact pour l’API	Adresse e-mail, nom, URL
conditions d’utilisation	Conditions d’utilisation de l’API	URL pointant vers les conditions d’utilisation

Environments

Métadonnées	Descriptif	Exemples de valeurs
kind	Type d’environnement	Production, préproduction, développement
server	Informations sur le serveur de l’environnement	Type et URL pointant vers le serveur d’environnement
type de serveur	Type de serveur d’environnement	Serveur Gestion des API, serveur Kubernetes, serveur Apigee
intégration	Informations d’intégration pour l’environnement	Instructions et URL pointant vers le portail des développeurs de l’environnement

Déploiements

Métadonnées	Descriptif	Exemples de valeurs
server	Informations sur le serveur du déploiement	URL pointant vers le serveur de déploiement
état	État du déploiement	Actif, inactif

Métadonnées personnalisées

Définissez des métadonnées personnalisées à l'aide du Portail Microsoft Azure, de l'API REST Azure API Center ou d'Azure CLI pour vous aider à organiser et filtrer les API, les environnements et les déploiements dans votre centre API. Azure API Center prend en charge les métadonnées personnalisées des types suivants.

Type	Descriptif	Exemple de nom
boolean	True ou false	IsInternal
nombre	Valeur numérique	YearOfCreation
ficelle	Valeur de texte	GitHubRepository
tableau	Liste des valeurs	Étiquettes
choix intégré	Liste intégrée des choix	Department
objet	Objet complexe composé de plusieurs types	Approbateur API

Important

N’incluez pas d’informations sensibles, confidentielles ou personnelles dans les titres (noms) des métadonnées que vous définissez. Ces titres sont visibles dans les journaux d’activité de supervision utilisés par Microsoft pour améliorer les fonctionnalités du service. Toutefois, les autres détails et valeurs de métadonnées sont vos données client protégées.

Affecter des métadonnées à des entités

Les propriétés de métadonnées personnalisées peuvent être affectées aux API, aux environnements ou aux déploiements dans votre centre d’API. Par exemple, vous pouvez définir et affecter des métadonnées d’un service aux API, de sorte que lorsqu’une API est inscrite ou qu’une nouvelle version d’API est ajoutée, le service responsable de l’API est spécifié.

Si elles sont affectées à une entité, les métadonnées sont facultatives ou obligatoires. Par exemple, vous pouvez exiger que les métadonnées Department soient définies uniquement pour les API, mais autorisez YearOfCreation être des métadonnées facultatives pour les environnements.

Note

Définissez des métadonnées personnalisées à tout moment et appliquez-les aux API et à d’autres entités de votre centre d’API.
Après avoir défini des métadonnées personnalisées, vous pouvez modifier son affectation en une entité, par exemple, de obligatoire à facultative pour les API.
Vous pouvez modifier les valeurs de métadonnées, mais vous ne pouvez pas supprimer ou modifier le type de métadonnées personnalisées actuellement définies dans les API, les environnements et les déploiements. Annulez tout d’abord l’affectation des métadonnées personnalisées des entités, puis vous pouvez les supprimer ou les modifier.