Freigeben über

Azure API Center als Event Grid-Quelle (Vorschau)

  • Artikel

Dieser Artikel enthält die Eigenschaften und das Schema für Azure API Center-Ereignisse. Eine Einführung in Ereignisschemas finden Sie unter Azure Event Grid-Ereignisschema.

Hinweis

Diese Funktion befindet sich derzeit in der Vorschau.

Verfügbare Ereignistypen

Diese Ereignisse werden ausgelöst, wenn ein Client eine API-Definition hinzufügt oder aktualisiert.

Ereignisname Beschreibung
Microsoft.ApiCenter.ApiDefinitionAdded Wird ausgelöst, wenn eine API-Definition in einem API-Center hinzugefügt wird.
Microsoft.ApiCenter.ApiDefinitionUpdated Wird ausgelöst, wenn eine API-Definition in einem API-Center aktualisiert wird.

Beispielereignis

Wenn ein Ereignis ausgelöst wird, sendet der API Center-Dienst Daten über dieses Ereignis an den abonnierten Endpunkt. Dieser Abschnitt enthält ein Beispiel dafür, wie diese Daten für jedes API Center-Ereignis aussehen würden.

Microsoft.ApiCenter.ApiDefinitionAdded event

[{
  "source": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.ApiCenter/services",
  "subject": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.ApiCenter/services/{api_center_name}/workspaces/default/apis/{api_name}/versions/{version_name}/definitions/{definition_name}",
  "type": "Microsoft.ApiCenter.ApiDefinitionAdded",
  "time": "2024-03-01T00:00:00.0000000Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "data": {
    "title": "OpenAPI",
    "description": "Default spec",
    "specification": {
      "name": "openapi",
      "version": "3.0.1"
    }
  },
  "specversion": "1.0"
}]

Microsoft.ApiCenter.ApiDefinitionUpdated event

[{
  "source": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.ApiCenter/services",
  "subject": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.ApiCenter/services/{api_center_name}/workspaces/default/apis/{api_name}/versions/{version_name}/definitions/{definition_name}",
  "type": "Microsoft.ApiCenter.ApiDefinitionUpdated",
  "time": "2024-03-01T00:00:00.0000000Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "data": {
    "title": "OpenAPI",
    "description": "Default spec",
    "specification": {
      "name": "openapi",
      "version": "3.0.1"
    }
  },
  "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 Azure API Center-Ereignisdaten.
specversion Zeichenfolge Version der CloudEvents-Schemaspezifikation.

Das Datenobjekt weist die folgenden Eigenschaften auf:

Eigenschaft Typ Beschreibung
title string Der Titel der API-Definition.
description Zeichenfolge Beschreibung der API-Definition.
specification Zeichenfolge Die API-Spezifikationseigenschaften, bestehend aus name (Spezifikationsname) und version (Spezifikationsversion)

Tutorials und Anleitungen

Titel Beschreibung
Aktivieren von Linting und Analyse für API-Governance im API Center Verwenden Sie Ereignisrasterereignisse, um das Linting zum Analysieren von API-Definitionen in Ihrem API Center auszulösen.

Zugehöriger Inhalt