Azure API Management als Event Grid-Quelle

  • Artikel

In diesem Artikel werden die Eigenschaften und das Schema für Azure API Management-Ereignisse beschrieben. Eine Einführung in Ereignisschemas finden Sie unter Azure Event Grid-Ereignisschema. Außerdem erhalten Sie Links zu Artikeln zur Verwendung von API Management als Ereignisquelle.

Verfügbare Ereignistypen

API Management 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.ReleaseCreated Wird ausgelöst, wenn ein API-Release erstellt wird.
Microsoft.APIManagement.ReleaseUpdated Wird ausgelöst, wenn ein API-Release aktualisiert wird.
Microsoft.APIManagement.ReleaseDeleted Wird ausgelöst, wenn ein API-Release gelöscht wird.
Microsoft.APIManagement.SubscriptionCreated Wird ausgelöst, wenn ein Abonnement erstellt wird.
Microsoft.APIManagement.SubscriptionUpdated Wird ausgelöst, wenn ein Abonnement aktualisiert wird.
Microsoft.APIManagement.SubscriptionDeleted Wird ausgelöst, wenn ein Abonnement gelöscht wird.
Microsoft.ApiManagement.GatewayCreated Wird beim Erstellen eines selbstgehosteten Gateways ausgelöst.
Microsoft.ApiManagement.GatewayDeleted Wird beim Aktualisieren eines selbstgehosteten Gateways ausgelöst.
Microsoft.ApiManagement.GatewayUpdated Wird beim Löschen eines selbstgehosteten Gateways ausgelöst.
Microsoft.ApiManagement.GatewayAPIAdded Wird ausgelöst, wenn eine API aus einem selbstgehosteten Gateway entfernt wurde.
Microsoft.ApiManagement.GatewayAPIRemoved Wird ausgelöst, wenn eine API aus einem selbstgehosteten Gateway entfernt wurde.
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 selbstgehostetes Gateway gelöscht wurde.
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 selbstgehostetes Gateway erstellt wurde.
Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted Wird ausgelöst, wenn eine Hostnamenkonfiguration für ein selbstgehostetes Gateway gelöscht wurde.
Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated Wird ausgelöst, wenn eine Hostnamenkonfiguration für ein selbstgehostetes Gateway aktualisiert wurde.

Beispielereignis

Das folgende Beispiel zeigt das Schema eines Produkterstellungsereignisses: Das Schema anderer Ereignisse zur Erstellung von API Management-Ressourcen 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 Benutzerlöschungsereignisses: Das Schema anderer Ereignisse zur Löschung von API Management-Ressourcen 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-Aktualisierungsereignisses: Das Schema anderer Ereignisse zur Aktualisierung von API Management-Ressourcen 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
}]

Ereigniseigenschaften

Ein Ereignis weist die folgenden Daten auf oberster Ebene aus:

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

Das Datenobjekt weist die folgenden Eigenschaften auf:

Eigenschaft Typ Beschreibung
resourceUri Zeichenfolge Die vollständig qualifizierte ID der Ressource, für die die Änderung des Konformitätsstatus gilt, einschließlich des Ressourcennamens und des Ressourcentyps. Verwendet das Format, /subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>

Tutorials und Vorgehensweisen

Titel BESCHREIBUNG
Senden von Ereignissen von API Management an Event Grid Abonnieren von API Management Ereignissen mithilfe von Event Grid

Nächste Schritte