Partager via

Gestion des API Azure en tant que source d'Event Grid

Cet article fournit les propriétés et le schéma des événements Gestion des API Azure . Pour une présentation des schémas d’événements, consultez Schéma d’événements Azure Event Grid. Il vous fournit également des liens vers des articles pour utiliser Gestion des API comme source d’événement.

Types d’événement disponibles

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

Type d'événement Descriptif
Microsoft.ApiManagement.UserCreated Déclenché lorsqu’un utilisateur est créé.
Microsoft.ApiManagement.UserUpdated Déclenché lorsqu’un utilisateur est mis à jour.
Microsoft.ApiManagement.UserDeleted Déclenché lorsqu’un utilisateur est supprimé.
Microsoft.ApiManagement.APICreated Déclenché lorsqu’une API est créée.
Microsoft.ApiManagement.APIUpdated Déclenché lorsqu’une API est mise à jour.
Microsoft.ApiManagement.APIDeleted Déclenché lorsqu’une API est supprimée.
Microsoft.ApiManagement.ProductCreated Déclenché quand un produit est créé.
Microsoft.ApiManagement.ProductUpdated Déclenché lorsqu’un produit est mis à jour.
Microsoft.ApiManagement.ProduitSupprimé Déclenché lorsqu’un produit est supprimé.
Microsoft.ApiManagement.APIReleaseCreated Déclenché lorsqu’une version d’API est créée.
Microsoft.ApiManagement.APIReleaseUpdated Déclenché lorsqu’une version d’API est mise à jour.
Microsoft.ApiManagement.APIReleaseDeleted Déclenché lorsqu’une version d’API est supprimée.
Microsoft.ApiManagement.SubscriptionCreated Déclenché lorsqu’un abonnement est créé.
Microsoft.ApiManagement.SubscriptionUpdated Déclenché lorsqu’un abonnement est mis à jour.
Microsoft.ApiManagement.AbonnementSupprimé Déclenché lorsqu’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 auto-hébergée est supprimée.
Microsoft.ApiManagement.GatewayAPIAdded Déclenché lorsqu’une API est ajoutée à une passerelle auto-hébergée.
Microsoft.ApiManagement.GatewayAPIRemoved Déclenché lorsqu’une API est supprimée d’une passerelle auto-hébergée.
Microsoft.ApiManagement.GatewayCertificateAuthorityCreated Déclenché lorsqu’une autorité de certificat est mise à jour pour une passerelle autohébergée.
Microsoft.ApiManagement.GatewayCertificateAuthorityDeleted Déclenché lorsqu’une autorité de certification est supprimée pour une passerelle auto-hébergée.
Microsoft.ApiManagement.GatewayCertificateAuthorityUpdated Déclenché lorsqu’une autorité de certificat est mise à jour pour une passerelle autohébergée.
Microsoft.ApiManagement.GatewayHostnameConfigurationCreated Déclenché lorsqu’une configuration de nom d’hôte est créée pour une passerelle auto-hébergée.
Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted Déclenché lorsqu’une configuration de nom d’hôte est supprimée pour une passerelle auto-hébergée.
Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated Déclenché lorsqu’une configuration de nom d’hôte est mise à jour pour une passerelle auto-hébergée.
Microsoft.ApiManagement.GatewayTokenNearExpiry (préversion) Déclenché lorsqu’un jeton d’accès de passerelle auto-hébergé est sur le point d'expirer.
Microsoft.ApiManagement.GatewayTokenExpired (préversion) Déclenché lorsqu’un jeton d’accès de passerelle autohébergée a expiré.
Microsoft.ApiManagement.CircuitBreaker.Opened (préversion) Déclenché lorsqu’un disjoncteur principal est ouvert.
Microsoft.ApiManagement.CircuitBreaker.Closed (préversion) Déclenché lorsqu’un disjoncteur principal est fermé.

Exemple d’événement

L’exemple suivant montre le schéma d’un événement créé par le produit. Le schéma d’autres événements créés par la 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 supprimé par l’utilisateur. Le schéma d’autres événements supprimés de la ressource 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 mis à jour d’API. Le schéma d’autres événements mis à jour de la ressource 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
}]

L’exemple suivant montre le schéma d’un événement d'ouverture de disjoncteur.

{
  "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}",
  "subject": "/backends/{backend-name}/circuit-breaker/rules/{rule-name}",
  "type": "Microsoft.ApiManagement.CircuitBreaker.Opened",
  "time": "2025-04-02T00:47:47.8536532Z",
  "id": "92c502f2-a966-42a7-a428-d3b319844544",
  "data": {
    "backendName": "{backend-name}",
    "circuitBreaker": {
      "rules": {
        "{rule-name}": {
          "tripDuration": "00:00:01"
        }
      }
    }
  },
  "specVersion": "1.0"
}

L’exemple suivant montre le schéma d’un événement de jeton de passerelle expiré. Le schéma d’un jeton de passerelle proche de l'expiration est similaire, mais remplace la propriété expiresAtUtc par la propriété expiredAtUtc.

{
  "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}",
  "subject": "/gateways/{gateway-name}/{instance-name}",
  "type": "Microsoft.ApiManagement.GatewayTokenExpired",
  "time": "2025-04-02T00:47:47.8536532Z",
  "id": "92c502f2-a966-42a7-a428-d3b319844544",
  "data": {
    "gatewayInfo": {
      "gatewayId": "{gateway-name}",
      "instanceId": "{instance-name}"
    },
    "tokenInfo": {
      "expiredAtUtc": "2025-02-25T08:56:00.0000000Z"
    }
  },
  "specVersion": "1.0"
}

Propriétés d’événement

Un événement a les données de niveau supérieur suivantes :

Propriété Catégorie Descriptif
source ficelle Chemin d’accès complet à la source de l’événement. Ce champ n’est pas modifiable. Event Grid fournit cette valeur.
subject ficelle Chemin de l’objet de l’événement, défini par le serveur de publication.
type ficelle L’un des types d’événements inscrits pour cette source d’événement.
time ficelle Heure à laquelle l’événement est généré en fonction de l’heure UTC du fournisseur.
id ficelle Identificateur unique de l’événement.
data objet Données d'événements de gestion des API.
specversion ficelle Version de la spécification de schéma CloudEvents.

Propriétés de l’objet de données

Événements du plan de contrôle

L’objet data a les propriétés suivantes pour les événements de plan de contrôle tels que la création, la mise à jour et la suppression de ressources Gestion des API.

Propriété Catégorie Descriptif
resourceUri ficelle ID complet de la ressource pour laquelle l’état de conformité change, y compris le nom de la ressource et le type de ressource. Utilise le format, /subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>

Événements de disjoncteurs

L’objet data a les propriétés suivantes pour les événements disjoncteur.

Propriété Catégorie Descriptif
backendNme ficelle Nom (ID) de l’entité back-end dans laquelle le disjoncteur est configuré.
circuitBreaker objet Le disjoncteur configuré dans le back-end, composé d’un objet rules spécifiant la règle qui a déclenché le back-end. La règle comporte une propriété tripDuration au format hh:mm:ss spécifiant la durée pendant laquelle le disjoncteur est déclenché.

Événements de jeton d’authentification de passerelle autohébergée

L’objet data a les propriétés suivantes pour les événements de jeton d’authentification de passerelle auto-hébergés.

Propriété Catégorie Descriptif
gatewayInfo objet Les informations de passerelle autohébergée, composées des propriétés de chaîne suivantes :

* gatewayId : ID complet de la ressource de passerelle
* instanceId - ID d’instance unique de la passerelle déployée
tokenInfo objet Les informations de jeton composées de l’une des propriétés suivantes à l’heure UTC du fournisseur :

* expiresAtUtc - pour l’événement GatewayTokenNearExpiry ou
* expiredAtUtc- pour l’événement GatewayTokenExpired

Tutoriels et guides pratiques

Titre Descriptif
Envoyer des événements de Gestion des API à Event Grid Comment s’abonner aux événements Gestion des API à l’aide d’Event Grid.

Étapes suivantes

  • Last updated on