Partager via

Centre d’API Azure en tant que source Event Grid (préversion)

  • Article

Cet article décrit les propriétés et le schéma des événements du centre d’API Azure. Pour une présentation des schémas d’événements, consultez Schéma d’événements Azure Event Grid.

Remarque

Actuellement, cette fonctionnalité est uniquement disponible en tant que version préliminaire.

Types d’événement disponibles

Ces événements sont déclenchés lorsqu’un client ajoute ou met à jour une définition d’API.

Nom de l’événement Description
Microsoft.ApiCenter.ApiDefinitionAdded Déclenché lorsqu’une définition d’API est ajoutée dans un centre d’API.
Microsoft.ApiCenter.ApiDefinitionUpdated Déclenché lorsqu’une définition d’API est mise à jour dans un centre d’API.

Exemple d’événement

Quand un événement est déclenché, le service du centre d’API envoie les données relatives à cet événement au point de terminaison d’abonnement. Cette section contient un exemple de ce à quoi ces données ressembleraient pour chaque événement de centre d’API.

Événement Microsoft.ApiCenter.ApiDefinitionAdded

[{
  "source": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.ApiCenter/services",
  "subject": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.ApiCenter/services/{api_center_name}/workspaces/default/apis/{api_name}/versions/{version_name}/definitions/{definition_name}",
  "type": "Microsoft.ApiCenter.ApiDefinitionAdded",
  "time": "2024-03-01T00:00:00.0000000Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "data": {
    "title": "OpenAPI",
    "description": "Default spec",
    "specification": {
      "name": "openapi",
      "version": "3.0.1"
    }
  },
  "specversion": "1.0"
}]

Événement Microsoft.ApiCenter.ApiDefinitionUpdated

[{
  "source": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.ApiCenter/services",
  "subject": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.ApiCenter/services/{api_center_name}/workspaces/default/apis/{api_name}/versions/{version_name}/definitions/{definition_name}",
  "type": "Microsoft.ApiCenter.ApiDefinitionUpdated",
  "time": "2024-03-01T00:00:00.0000000Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "data": {
    "title": "OpenAPI",
    "description": "Default spec",
    "specification": {
      "name": "openapi",
      "version": "3.0.1"
    }
  },
  "specversion": "1.0"
}]

Propriétés d’événement

Un événement contient les données générales suivantes :

Propriété Type Description
source string Chemin d’accès complet à la source de l’événement. Ce champ n’est pas modifiable. Event Grid fournit cette valeur.
subject string Chemin de l’objet de l’événement, défini par le serveur de publication.
type string Un des types d’événements inscrits pour cette source d’événement.
time string L’heure à quelle l’événement est généré selon l’heure UTC du fournisseur.
id string Identificateur unique de l’événement.
data object Données d’événements de centre d’API Azure.
specversion string Version de la spécification de schéma CloudEvents.

L’objet de données comporte les propriétés suivantes :

Propriété Type Description
title string Titre de la définition de l’API.
description string Description de la définition de l’API.
specification string Propriétés de spécification d’API, composées de name (nom de la spécification) et version (version de spécification)

Tutoriels et articles de procédures

Intitulé Description
Activer le linting et l’analyse pour la gouvernance des API dans votre centre d’API Utilisez les événements Event Grid pour déclencher le linting afin d’analyser les définitions d’API dans votre centre d’API.

Contenu connexe