Dela via

Azure API Management som en Event Grid-källa

Den här artikeln innehåller egenskaper och schema för Azure API Management-händelser . En introduktion till händelsescheman finns i Händelseschema för Azure Event Grid. Det ger dig också länkar till artiklar för att använda API Management som händelsekälla.

Tillgängliga händelsetyper

API Management genererar följande händelsetyper:

Händelsetyp Beskrivning
Microsoft.ApiManagement.UserCreated Upphöjt när en användare skapas.
Microsoft.ApiManagement.AnvändarUppdaterad Utlöses när en användare uppdateras.
Microsoft.ApiManagement.AnvändareRaderad Utlöses när en användare tas bort.
Microsoft.ApiManagement.APISkapat Utlöses när ett API skapas.
Microsoft.ApiManagement.APIUppdaterad Utlöses när ett API uppdateras.
Microsoft.ApiManagement.API raderad Utlöses när ett API tas bort.
Microsoft.ApiManagement.ProductCreated Utlöses när en produkt skapas.
Microsoft.ApiManagement.ProduktUppdaterad Upphöjt när en produkt uppdateras.
Microsoft.ApiManagement.ProduktRaderad Utlöses när en produkt tas bort.
Microsoft.ApiManagement.APIReleaseCreated Utlöses när en API-version skapas.
Microsoft.ApiManagement.API-utgåva uppdaterad Utlöses när en API-version uppdateras.
Microsoft.ApiManagement.APIReleaseDeleted Utlöses när en API-version tas bort.
Microsoft.ApiManagement.SubscriptionCreated Utlöses när en prenumeration skapas.
Microsoft.ApiManagement.SubscriptionUpdated Utlöses när en prenumeration uppdateras.
Microsoft.ApiManagement.AbonnemangRaderat Utlöses när en prenumeration tas bort.
Microsoft.ApiManagement.GatewaySkapad Utlöses när en gateway med egen värd skapas.
Microsoft.ApiManagement.GatewayDeleted Utlöses när en lokalt installerad gateway uppdateras.
Microsoft.ApiManagement.GatewayUpdated Aktiveras när en självhostad gateway tas bort.
Microsoft.ApiManagement.GatewayAPITillagd Utlöses när ett API läggs till i en gateway med egen värd.
Microsoft.ApiManagement.GatewayAPIBorttagen Upphöjt när ett API tas bort från en gateway med egen värd.
Microsoft.ApiManagement.GatewayCertificateAuthorityCreated Utlöses när en certifikatsmyndighet uppdateras för en självhostad gateway.
Microsoft.ApiManagement.Gateway.CertificateAuthority.Borttagen Utlöses när en certifikatutfärdare tas bort för en gateway med egen värd.
Microsoft.ApiManagement.GatewayCertifikatAuthorityUpdated Utlöses när en certifikatsmyndighet uppdateras för en självhostad gateway.
Microsoft.ApiManagement.GatewayHostnameConfigurationCreated Upphöjt när en värdnamnskonfiguration skapas för en gateway med egen värd.
Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted Utlöses när en värdnamnskonfiguration tas bort för en gateway med egen värd.
Microsoft.ApiManagement.GatewayVärdnamnKonfigurationUppdaterad Utlöses när en värdnamnskonfiguration uppdateras för en gateway med egen värd.
Microsoft.ApiManagement.GatewayTokenNearExpiry (förhandsversion) Genereras när en gatewayåtkomsttoken med egen värd nästan har gått ut.
Microsoft.ApiManagement.GatewayTokenExpired (förhandsversion) Utlöses när en självhostad gatewayåtkomsttoken har upphört att gälla.
Microsoft.ApiManagement.CircuitBreaker.Opened (förhandsversion) Utlöses när en backend-kretsbrytare öppnas.
Microsoft.ApiManagement.CircuitBreaker.Closed (förhandsversion) Utlöst när en bakända strömbrytare stängs.

Exempelhändelse

I följande exempel visas schemat för en produkt skapad händelse. Schemat för andra API Management-resursskapade händelser är liknande.

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

I följande exempel visas schemat för en användarborttagningshändelse. Schemat för andra borttagna API Management-resurshändelser liknar varandra.

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

I följande exempel visas schemat för en UPPDATERAD API-händelse. Schemat över uppdaterade händelser för andra API Management-resurser är liknande.

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

I följande exempel visas schemat för en händelse där en kretsbrytare har öppnats.

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

I följande exempel visas schemat för en händelse för en gatewaytoken som har upphört att gälla. Schemat för en gatewaytoken nära förfallohändelse är liknande, men ersätter en expiresAtUtc egenskap för expiredAtUtc egenskapen.

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

Händelseegenskaper

En händelse har följande data på den översta nivån:

Fastighet Typ Beskrivning
source snöre Fullständig resurssökväg till händelsekällan. Det här fältet kan inte skrivas. Event Grid tillhandahåller det här värdet.
subject snöre Utgivardefinierad sökväg till händelseobjektet.
type snöre En av de registrerade händelsetyperna för den här händelsekällan.
time snöre Den tid då händelsen genereras baserat på leverantörens UTC-tid.
id snöre Unik identifierare för händelsen.
data objekt API Managements händelsedata
specversion snöre CloudEvents schemaspecifikationsversion.

Egenskaper för dataobjekt

Kontrollplanshändelser

Objektet data har följande egenskaper för kontrollplanshändelser som att skapa, uppdatera och ta bort API Management-resurser.

Fastighet Typ Beskrivning
resourceUri snöre Det fullständigt kvalificerade ID:t för resursen som ändringen av efterlevnadstillståndet gäller, inklusive resursnamnet och resurstypen. Använder formatet /subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>

Kretsbrytarehändelser

Objektet data har följande egenskaper för kretsbrytarehändelser.

Fastighet Typ Beskrivning
backendNme snöre Namnet (ID) för serverdelsentiteten där kretsbrytaren har konfigurerats.
circuitBreaker objekt Kretsbrytaren som konfigurerats i backend, bestående av ett rules objekt som anger regeln som utlöste backendfelet. Regeln har en tripDuration egenskap i formatet hh:mm:ss som anger hur länge kretsbrytaren ska utlösas.

Autentiseringstokenhändelser för lokalt installerad gateway

Objektet data har följande egenskaper för autentiseringstokenhändelser i en självhostad gateway.

Fastighet Typ Beskrivning
gatewayInfo objekt Den lokala gatewayinformationen som består av följande strängegenskaper:

* gatewayId – Gatewayresursens fullständigt kvalificerade ID
* instanceId – Unikt instans-ID för den distribuerade gatewayen
tokenInfo objekt Tokeninformationen, som består av någon av följande egenskaper under leverantörens UTC-tid:

* expiresAtUtc - för GatewayTokenNearExpiry händelse, eller
* expiredAtUtc - för GatewayTokenExpired händelse

Handledningar och instruktioner

Titel Beskrivning
Skicka händelser från API Management till Event Grid Prenumerera på API Management-händelser med Event Grid.

Nästa steg