Freigeben über

Azure API Management als Ereignisrasterquelle

Dieser Artikel enthält die Eigenschaften und das Schema für Azure API Management-Ereignisse . Eine Einführung in Ereignisschemas finden Sie unter Azure Event Grid-Ereignisschema. Außerdem erhalten Sie Links zu Artikeln zur Verwendung der API-Verwaltung als Ereignisquelle.

Verfügbare Ereignistypen

Die API-Verwaltung gibt die folgenden Ereignistypen aus:

Ereignistyp BESCHREIBUNG
Microsoft.ApiManagement.UserCreated Wird ausgelöst, wenn ein Benutzer erstellt wird.
Microsoft.ApiManagement.UserUpdated Wird ausgelöst, wenn ein Benutzer aktualisiert wird.
Microsoft.ApiManagement.UserDeleted Wird ausgelöst, wenn ein Benutzer gelöscht wird.
Microsoft.ApiManagement.APICreated Wird ausgelöst, wenn eine API erstellt wird.
Microsoft.ApiManagement.APIUpdated Wird ausgelöst, wenn eine API aktualisiert wird.
Microsoft.ApiManagement.APIDeleted Wird ausgelöst, wenn eine API gelöscht wird.
Microsoft.ApiManagement.ProductCreated Wird ausgelöst, wenn ein Produkt erstellt wird.
Microsoft.ApiManagement.ProductUpdated Wird ausgelöst, wenn ein Produkt aktualisiert wird.
Microsoft.ApiManagement.ProductDeleted Wird ausgelöst, wenn ein Produkt gelöscht wird.
Microsoft.ApiManagement.APIReleaseCreated Wird ausgelöst, wenn ein API-Release erstellt wird.
Microsoft.ApiManagement.APIReleaseUpdated Wird ausgelöst, wenn eine API-Version aktualisiert wird.
Microsoft.ApiManagement.APIReleaseDeleted Wird ausgelöst, wenn eine API-Version gelöscht wird.
Microsoft.ApiManagement.AbonnementErstellt Wird ausgelöst, wenn ein Abonnement erstellt wird.
Microsoft.ApiManagement.SubscriptionUpdated Wird ausgelöst, wenn ein Abonnement aktualisiert wird.
Microsoft.ApiManagement.AbonnementGelöscht Wird ausgelöst, wenn ein Abonnement gelöscht wird.
Microsoft.ApiManagement.GatewayCreated Wird ausgelöst, wenn ein selbst gehostetes Gateway erstellt wird.
Microsoft.ApiManagement.GatewayGelöscht Wird ausgelöst, wenn ein selbst gehostetes Gateway aktualisiert wird.
Microsoft.ApiManagement.GatewayUpdated Wird ausgelöst, wenn ein selbst gehostetes Gateway gelöscht wird.
Microsoft.ApiManagement.GatewayAPIAdded Wird ausgelöst, wenn einem selbst gehosteten Gateway eine API hinzugefügt wird.
Microsoft.ApiManagement.GatewayAPIRemoved Wird ausgelöst, wenn eine API von einem selbst gehosteten Gateway entfernt wird.
Microsoft.ApiManagement.GatewayCertificateAuthorityCreated Wird ausgelöst, wenn eine Zertifizierungsstelle für ein selbstgehostetes Gateway aktualisiert wurde.
Microsoft.ApiManagement.GatewayCertificateAuthorityDeleted Wird ausgelöst, wenn eine Zertifizierungsstelle für ein selbst gehostetes Gateway gelöscht wird.
Microsoft.ApiManagement.GatewayCertificateAuthorityUpdated Wird ausgelöst, wenn eine Zertifizierungsstelle für ein selbstgehostetes Gateway aktualisiert wurde.
Microsoft.ApiManagement.GatewayHostnameConfigurationCreated Wird ausgelöst, wenn eine Hostnamenkonfiguration für ein selbst gehostetes Gateway erstellt wird.
Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted Wird ausgelöst, wenn eine Hostnamenkonfiguration für ein selbst gehostetes Gateway gelöscht wird.
Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated Wird ausgelöst, wenn eine Hostnamenkonfiguration für ein selbst gehostetes Gateway aktualisiert wird.
Microsoft.ApiManagement.GatewayTokenNearExpiry (Vorschau) Wird ausgelöst, wenn ein selbst gehostetes Gatewayzugriffstoken bald abläuft.
Microsoft.ApiManagement.GatewayTokenExpired (Vorschau) Wird ausgelöst, wenn ein selbst gehostetes Gatewayzugriffstoken abgelaufen ist.
Microsoft.ApiManagement.CircuitBreaker.Opened (Vorschau) Wird ausgelöst, wenn ein Back-End-Schaltkreisschalter geöffnet wird.
Microsoft.ApiManagement.CircuitBreaker.Closed (Vorschau) Wird ausgelöst, wenn ein Back-End-Schaltkreisschalter geschlossen wird.

Beispielereignis

Das folgende Beispiel zeigt das Schema eines produkt erstellten Ereignisses. Das Schema anderer von der API-Verwaltung erstellter Ereignisse ist ähnlich.

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

Das folgende Beispiel zeigt das Schema eines Ereignisses, bei dem ein Benutzer gelöscht wird. Das Schema von Ereignissen, bei denen andere API-Management-Ressourcen gelöscht werden, ist ähnlich.

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

Das folgende Beispiel zeigt das Schema eines API-aktualisierten Ereignisses. Das Schema anderer API-Management-Ressource-Aktualisierungsereignisse ist ähnlich.

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

Das folgende Beispiel zeigt das Schema eines Ereignisses „Trennschalter geöffnet“.

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

Das folgende Beispiel zeigt das Schema eines Ereignisses, bei dem ein Gateway-Token abgelaufen ist. Das Schema eines Gatewaytokens in der Nähe des Ablaufereignisses ist ähnlich, ersetzt jedoch eine expiresAtUtc Eigenschaft für die expiredAtUtc Eigenschaft.

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

Ereigniseigenschaften

Ein Ereignis enthält die folgenden Daten auf oberster Ebene:

Eigentum Typ BESCHREIBUNG
source Schnur Vollständiger Ressourcenpfad zur Ereignisquelle. Dieses Feld ist nicht beschreibbar. Dieser Wert wird von Event Grid bereitgestellt.
subject Schnur Vom Herausgeber definierter Pfad zum Ereignisbetreff
type Schnur Einer der registrierten Ereignistypen für die Ereignisquelle.
time Schnur Die Zeit, in der das Ereignis generiert wird, basierend auf der UTC-Zeit des Anbieters.
id Schnur Eindeutiger Bezeichner für das Ereignis.
data Objekt API-Verwaltungsereignisdaten.
specversion Schnur Version der CloudEvents-Schemaspezifikation.

Datenobjekteigenschaften

Steuerungsebenenereignisse

Das data Objekt verfügt über die folgenden Eigenschaften für Steuerungsebenenereignisse wie das Erstellen, Aktualisieren und Löschen von API-Verwaltungsressourcen.

Eigentum Typ BESCHREIBUNG
resourceUri Schnur Die vollqualifizierte ID der Ressource, für die sich der Kompatibilitätsstatus ändert, einschließlich des Ressourcennamens und des Ressourcentyps. Verwendet das Format /subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>

Trennschalterereignisse

Das data Objekt verfügt über die folgenden Eigenschaften für Schaltkreisbrecherereignisse.

Eigentum Typ BESCHREIBUNG
backendNme Schnur Der Name (ID) der Back-End-Entität, in der der Schaltkreisschalter konfiguriert ist.
circuitBreaker Objekt Der im Back-End konfigurierte Trennschalter, der aus einem rules-Objekt besteht, das die Regel angibt, die das Back-End aktiviert hat. Die Regel weist eine tripDuration Eigenschaft im Format hh:mm:ss auf, die die Dauer angibt, für die der Schaltkreisbrecher getrippt wird.

Selbst gehostete Gatewayauthentifizierungstokenereignisse

Das data Objekt verfügt über die folgenden Eigenschaften für selbst gehostete Gatewayauthentifizierungstokenereignisse.

Eigentum Typ BESCHREIBUNG
gatewayInfo Objekt Die selbst gehosteten Gatewayinformationen, bestehend aus den folgenden Zeichenfolgeneigenschaften:

* gatewayId – Die vollqualifizierte ID der Gatewayressource
* instanceId - Eindeutige Instanz-ID des bereitgestellten Gateways
tokenInfo Objekt Die Tokeninformationen, bestehend aus einer der folgenden Eigenschaften in der UTC-Zeit des Anbieters:

* expiresAtUtc - für GatewayTokenNearExpiry Veranstaltung oder
* expiredAtUtc - für GatewayTokenExpired Veranstaltung

Tutorials und Anleitungen

Titel BESCHREIBUNG
Senden von Ereignissen aus der API-Verwaltung an das Ereignisraster Abonnieren von API-Verwaltungsereignissen mithilfe von Event Grid

Nächste Schritte