Udostępnij za pośrednictwem

Centrum interfejsów API platformy Azure jako źródło usługi Event Grid (wersja zapoznawcza)

  • Artykuł

Ten artykuł zawiera właściwości i schemat zdarzeń centrum interfejsu API platformy Azure. Aby zapoznać się ze schematami zdarzeń, zobacz Schemat zdarzeń usługi Azure Event Grid.

Uwaga

Ta funkcja jest aktualnie dostępna jako funkcja podglądu.

Dostępne typy zdarzeń

Te zdarzenia są wyzwalane, gdy klient dodaje lub aktualizuje definicję interfejsu API.

Nazwa zdarzenia opis
Microsoft.ApiCenter.ApiDefinitionAdded Wyzwalane po dodaniu definicji interfejsu API w centrum interfejsu API.
Microsoft.ApiCenter.ApiDefinitionUpdated Wyzwalane po zaktualizowaniu definicji interfejsu API w centrum interfejsu API.

Przykładowe zdarzenie

Po wyzwoleniu zdarzenia usługa API Center wysyła dane dotyczące tego zdarzenia do subskrybowania punktu końcowego. Ta sekcja zawiera przykład tego, jak wyglądają te dane dla każdego zdarzenia centrum interfejsu API.

Zdarzenie Microsoft.ApiCenter.ApiDefinitionAdded

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

Zdarzenie Microsoft.ApiCenter.ApiDefinitionUpdated

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

Właściwości zdarzenia

Zdarzenie ma następujące dane najwyższego poziomu:

Właściwość Type opis
source string Pełna ścieżka zasobu do źródła zdarzeń. To pole nie jest możliwe do zapisu. Ta wartość jest podawana przez usługę Event Grid.
subject string Zdefiniowana przez wydawcę ścieżka do tematu zdarzenia.
type string Jeden z zarejestrowanych typów zdarzeń dla tego źródła zdarzeń.
time string Czas generowania zdarzenia na podstawie czasu UTC dostawcy.
id string Unikatowy identyfikator zdarzenia.
data obiekt Dane zdarzeń centrum interfejsu API Platformy Azure.
specversion string Wersja specyfikacji schematu CloudEvents.

Obiekt danych ma następujące właściwości:

Właściwość Type opis
title string Tytuł definicji interfejsu API.
description string Opis definicji interfejsu API.
specification string Właściwości specyfikacji interfejsu API składające się z name (nazwy specyfikacji) i version (wersja specyfikacji)

Samouczki i poradniki

Nazwa opis
Włączanie lintingu i analizy ładu interfejsu API w centrum interfejsu API Użyj zdarzeń usługi Event Grid, aby wyzwolić linting w celu analizowania definicji interfejsu API w centrum interfejsu API.

Powiązana zawartość

  • Aby zapoznać się z wprowadzeniem do usługi Azure Event Grid, zobacz Co to jest usługa Event Grid?
  • Aby uzyskać więcej informacji na temat tworzenia subskrypcji usługi Azure Event Grid, zobacz Schemat subskrypcji usługi Event Grid.