Partager via

Gestion des API Azure comme source Event Grid

  • Article

Cet article fournit les propriétés et le schéma des événements de Gestion des API Azure. Pour une présentation des schémas d’événements, consultez Schéma d’événements Azure Event Grid. Vous y trouverez également des liens vers des articles expliquant comment utiliser la Gestion des API comme source d’événement.

Types d’événement disponibles

La Gestion des API émet les types d’événements suivants :

Type d’événement Description
Microsoft.APIManagement.UserCreated Déclenché quand un utilisateur est créé.
Microsoft.APIManagement.UserUpdated Déclenché quand un utilisateur est mis à jour.
Microsoft.APIManagement.UserDeleted Déclenché quand un utilisateur est supprimé.
Microsoft.APIManagement.APICreated Déclenché quand une API est créée.
Microsoft.APIManagement.APIUpdated Déclenché quand une API est mise à jour.
Microsoft.APIManagement.APIDeleted Déclenché quand une API est supprimée.
Microsoft.APIManagement.ProductCreated Déclenché quand un produit est créé.
Microsoft.APIManagement.ProductUpdated Déclenché quand un produit est mis à jour.
Microsoft.APIManagement.ProductDeleted Déclenché quand un produit est supprimé.
Microsoft.APIManagement.ReleaseCreated Déclenché quand une version d’API est créée.
Microsoft.APIManagement.ReleaseUpdated Déclenché quand une version d’API est mise à jour.
Microsoft.APIManagement.ReleaseDeleted Déclenché quand une version d’API est supprimée.
Microsoft.APIManagement.SubscriptionCreated Déclenché quand un abonnement est créé.
Microsoft.APIManagement.SubscriptionUpdated Déclenché quand un abonnement est mis à jour.
Microsoft.APIManagement.SubscriptionDeleted Déclenché quand un abonnement est supprimé.
Microsoft.ApiManagement.GatewayCreated Déclenché lorsqu’une passerelle autohébergée est créée.
Microsoft.ApiManagement.GatewayDeleted Déclenché lorsqu’une passerelle autohébergée est mise à jour.
Microsoft.ApiManagement.GatewayUpdated Déclenché lorsqu’une passerelle autohébergée est supprimée.
Microsoft.ApiManagement.GatewayAPIAdded Déclenché lorsqu’une API a été supprimée d’une passerelle autohébergée.
Microsoft.ApiManagement.GatewayAPIRemoved Déclenché lorsqu’une API a été supprimée d’une passerelle autohébergée.
Microsoft.ApiManagement.GatewayCertificateAuthorityCreated Déclenché lorsqu’une autorité de certification a été mise à jour pour une passerelle autohébergée.
Microsoft.ApiManagement.GatewayCertificateAuthorityDeleted Déclenché lorsqu’une autorité de certification a été supprimée pour une passerelle autohébergée.
Microsoft.ApiManagement.GatewayCertificateAuthorityUpdated Déclenché lorsqu’une autorité de certification a été mise à jour pour une passerelle autohébergée.
Microsoft.ApiManagement.GatewayHostnameConfigurationCreated Déclenché lorsqu’une configuration de nom d’hôte a été créée pour une passerelle autohébergée.
Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted Déclenché lorsqu’une configuration de nom d’hôte a été supprimée pour une passerelle autohébergée.
Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated Déclenché lorsqu’une configuration de nom d’hôte a été mise à jour pour une passerelle autohébergée.

Exemple d’événement

L’exemple suivant montre le schéma d’un événement de création d’un produit. Le schéma des autres événements de création d’une ressource de Gestion des API est similaire.

[{
  "id": "81dac958-49cf-487e-8805-d0baf0ee485a",
  "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}",
  "subject": "/products/myproduct",
  "data": {
    "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/products/myproduct"
  },
  "Type": "Microsoft.ApiManagement.ProductCreated",
  "Time": "2021-07-02T00:38:44.3978295Z",
  "specversion":"1.0"
}]

L’exemple suivant montre le schéma d’un événement de suppression d’un utilisateur. Le schéma des autres événements de suppression d’une ressource de Gestion des API est similaire.

[{
  "id": "81dac958-49cf-487e-8805-d0baf0ee485a",
  "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}",
  "subject": "/users/apimuser-contoso-com",
  "data": {
    "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/users/apimuser-contoso-com"
  },
  "Type": "Microsoft.ApiManagement.UserDeleted",
  "Time": "2021-07-02T00:38:44.3978295Z",
  "specversion":"1.0"
}]

L’exemple suivant montre le schéma d’un événement de mise à jour d’une API. Le schéma des autres événements de mise à jour d’une ressource de Gestion des API est similaire.

[{
  "id": "95015754-aa51-4eb6-98d9-9ee322b82ad7",
  "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}",
  "subject": "/apis/myapi;Rev=1",
  "data": {
    "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/apis/myapi;Rev=1"
  },
  "Type": "Microsoft.ApiManagement.APIUpdated",
  "Time": "2021-07-12T23:13:44.9048323Z",
  "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énement de Gestion des API.
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
resourceUri string Identifiant complet de la ressource concernée par le changement de l’état de conformité, y compris le nom et le type de la ressource. Utilise le format, /subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>

Tutoriels et articles de procédures

Intitulé Description
Envoyer les événements de la Gestion des API à Event Grid Comment s’abonner à des événements de Gestion des API à l’aide d’Event Grid.

Étapes suivantes