Delen via

Azure API Management als Event Grid-bron

Dit artikel bevat de eigenschappen en het schema voor Azure API Management-gebeurtenissen . Zie het Gebeurtenisschema van Azure Event Grid voor een inleiding tot gebeurtenisschema's. U krijgt ook koppelingen naar artikelen om API Management als gebeurtenisbron te gebruiken.

Beschikbare gebeurtenistypen

API Management verzendt de volgende gebeurtenistypen:

Gebeurtenistype Beschrijving
Microsoft.ApiManagement.GebruikerAangemaakt Opgetrokken wanneer een gebruiker wordt aangemaakt.
Microsoft.ApiManagement.UserUpdated Opgetreden wanneer een gebruiker wordt bijgewerkt.
Microsoft.ApiManagement.GebruikerVerwijderd Aangezwengeld wanneer een gebruiker wordt verwijderd.
Microsoft.ApiManagement.APICreated Wordt gegenereerd wanneer er een API wordt gemaakt.
Microsoft.ApiManagement.APIUpdated Uitgelokt wanneer een API wordt bijgewerkt.
Microsoft.ApiManagement.APIDeleted Geactiveerd wanneer een API wordt verwijderd.
Microsoft.ApiManagement.ProductCreated Wordt gegenereerd wanneer een product wordt gemaakt.
Microsoft.ApiManagement.ProductUpdated Verhoogd wanneer een product wordt bijgewerkt.
Microsoft.ApiManagement.ProductDeleted Verhoogd wanneer een product wordt verwijderd.
Microsoft.ApiManagement.APIReleaseGemaakt Ontstaat wanneer er een API-release wordt gemaakt.
Microsoft.ApiManagement.APIVrijgaveBijgewerkt Wordt gegenereerd wanneer een API-release wordt bijgewerkt.
Microsoft.ApiManagement.APIReleaseVerwijderd Wordt gegenereerd wanneer een API-release wordt verwijderd.
Microsoft.ApiManagement.SubscriptionCreated Wordt gegenereerd wanneer een abonnement wordt gemaakt.
Microsoft.ApiManagement.SubscriptionUpdated Wordt gegenereerd wanneer een abonnement wordt bijgewerkt.
Microsoft.ApiManagement.SubscriptionDeleted Wordt gegenereerd wanneer een abonnement wordt verwijderd.
Microsoft.ApiManagement.GatewayCreated Wordt gegenereerd wanneer een zelf-hostende gateway wordt gemaakt.
Microsoft.ApiManagement.Gateway Verwijderd Wordt gegenereerd wanneer een zelf-gehoste gateway wordt bijgewerkt.
Microsoft.ApiManagement.GatewayBijgewerkt Wordt veroorzaakt wanneer een zelfgehoste gateway wordt verwijderd.
Microsoft.ApiManagement.GatewayAPIAdded Wordt gegenereerd wanneer een API wordt toegevoegd aan een zelfgehoste gateway.
Microsoft.ApiManagement.GatewayAPIRemoved Wordt gegenereerd wanneer een API wordt verwijderd uit een zelf-hostende gateway.
Microsoft.ApiManagement.GatewayCertificateAuthorityCreated Wordt geactiveerd wanneer een certificeringsautoriteit wordt bijgewerkt voor een zelf-gehoste gateway.
Microsoft.ApiManagement.GatewayCertificateAuthorityDeleted Wordt gegenereerd als een certificeringsinstantie wordt verwijderd voor een zelfgehoste gateway.
Microsoft.ApiManagement.GatewayCertificateAuthorityUpdated Wordt geactiveerd wanneer een certificeringsautoriteit wordt bijgewerkt voor een zelf-gehoste gateway.
Microsoft.ApiManagement.GatewayHostnameConfigurationCreated Wordt gegenereerd wanneer een hostnaamconfiguratie wordt gemaakt voor een zelf-hostende gateway.
Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted Wordt gegenereerd wanneer een hostnaamconfiguratie wordt verwijderd voor een zelfgehoste gateway.
Microsoft.ApiBeheer.GatewayHostnaamConfiguratieBijgewerkt Wordt gegenereerd wanneer een hostnaamconfiguratie wordt bijgewerkt voor een zelfgehoste gateway.
Microsoft.ApiManagement.GatewayTokenBijnaVerlopen (preview) Wordt geactiveerd wanneer een toegangstoken van de zelf-gehoste gateway bijna verloopt.
Microsoft.ApiManagement.GatewayTokenVerlopen (preview) Wordt opgetreden wanneer een zelf-gehost gateway-toegangstoken is verlopen.
Microsoft.ApiManagement.CircuitBreaker.Opened (preview) Wordt gegenereerd wanneer een back-endcircuitonderbreker wordt geopend.
Microsoft.ApiManagement.CircuitBreaker.Closed (voorbeeld) Wordt opgetreden wanneer een circuitonderbreker van de back-end wordt gesloten.

Voorbeeld van een gebeurtenis

In het volgende voorbeeld ziet u het schema van een door een product gemaakte gebeurtenis. Het schema van andere gebeurtenissen die door API Management-resources zijn gemaakt, is vergelijkbaar.

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

In het volgende voorbeeld ziet u het schema van een verwijderde gebruiker. Het schema van andere verwijderde gebeurtenissen van API Management-resources is vergelijkbaar.

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

In het volgende voorbeeld ziet u het schema van een bijgewerkte API-gebeurtenis. Het schema van andere bijgewerkte gebeurtenissen voor API Management-resources is vergelijkbaar.

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

In het volgende voorbeeld ziet u het schema van een gebeurtenis waarbij de stroomonderbreker werd geopend.

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

In het volgende voorbeeld ziet u het schema van een verlopen gatewaytokengebeurtenis. Het schema van een gatewaytoken dat bijna verloopt is vergelijkbaar, maar vervangt een expiresAtUtc eigenschap door de expiredAtUtc eigenschap.

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

Gebeurteniseigenschappen

Een gebeurtenis bevat de volgende gegevens op het hoogste niveau:

Vastgoed Typologie Beschrijving
source touw Volledig hulpbronpad naar de gebeurtenisbron. Dit veld kan niet worden geschreven. Event Grid biedt deze waarde.
subject touw Het door de uitgever gedefinieerde pad naar het gebeurtenisonderwerp.
type touw Een van de geregistreerde gebeurtenistypen voor deze gebeurtenisbron.
time touw Het tijdstip waarop de gebeurtenis wordt gegenereerd op basis van de UTC-tijd van de provider.
id touw Unieke id voor de gebeurtenis.
data Voorwerp API Management-gebeurtenisgegevens.
specversion touw CloudEvents schemaspecificatieversie.

Eigenschappen van gegevensobjecten

Gebeurtenissen in het besturingsvlak

Het data object heeft de volgende eigenschappen voor besturingsvlakgebeurtenissen, zoals het maken, bijwerken en verwijderen van API Management-resources.

Vastgoed Typologie Beschrijving
resourceUri touw De volledig gekwalificeerde id van de resource waarvoor de nalevingsstatus wordt gewijzigd, inclusief de resourcenaam en het resourcetype. Maakt gebruik van de notatie, /subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>

Circuitonderbreker-gebeurtenissen

Het data object heeft de volgende eigenschappen voor circuitonderbrekergebeurtenissen.

Vastgoed Typologie Beschrijving
backendNme touw De naam (ID) van de back-endentiteit waarin de stroomonderbreker is ingesteld.
circuitBreaker Voorwerp De in de back-end geconfigureerde stroomonderbreker, bestaande uit een rules-object dat de regel bepaalt die de onderbreking heeft veroorzaakt. De regel heeft een tripDuration eigenschap in hh:mm:ss-indeling die de duur aangeeft waarvoor de circuitonderbreker wordt getript.

Zelfgehoste gateway verificatie token gebeurtenissen

Het data object heeft de volgende eigenschappen voor zelfgehoste authenticatietoken-events.

Vastgoed Typologie Beschrijving
gatewayInfo Voorwerp De zelf-hostende gatewaygegevens, bestaande uit de volgende tekenreekseigenschappen:

* gatewayId - De volledig gekwalificeerde ID van de gatewayresource
* instanceId - Unieke exemplaar-id van de geïmplementeerde gateway
tokenInfo Voorwerp De tokengegevens, bestaande uit een van de volgende eigenschappen in de UTC-tijd van de provider:

* expiresAtUtc - voor GatewayTokenNearExpiry gebeurtenis, of
* expiredAtUtc - voor GatewayTokenExpired gebeurtenis

Tutorials en how-to's

Titel Beschrijving
Gebeurtenissen verzenden van API Management naar Event Grid Abonneren op API Management-gebeurtenissen met behulp van Event Grid.

Volgende stappen

  • Last updated on