Sdílet prostřednictvím

Centrum rozhraní Azure API jako zdroj služby Event Grid (Preview)

  • Článek

Tento článek obsahuje vlastnosti a schéma událostí azure API Center. Úvod do schémat událostí najdete ve schématu událostí služby Azure Event Grid.

Poznámka:

Tato funkce je aktuálně dostupná jako ukázková verze.

Dostupné typy událostí

Tyto události se aktivují, když klient přidá nebo aktualizuje definici rozhraní API.

Název události Popis
Microsoft.ApiCenter.ApiDefinitionAdded Aktivuje se při přidání definice rozhraní API do centra rozhraní API.
Microsoft.ApiCenter.ApiDefinitionUpdated Aktivuje se při aktualizaci definice rozhraní API v centru rozhraní API.

Příklad události

Když se aktivuje událost, služba API Center odešle data o této události do odběru koncového bodu. Tato část obsahuje příklad toho, jak by tato data vypadala pro každou událost centra API.

Událost 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"
}]

Událost 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"
}]

Vlastnosti události

Událost má následující data nejvyšší úrovně:

Vlastnost Type Description
source string Úplná cesta prostředku ke zdroji událostí. Toto pole není zapisovatelné. Tuto hodnotu poskytuje Event Grid.
subject string Cesta k předmětu události, kterou definuje vydavatel.
type string Jeden z registrovaných typů události pro tento zdroj události.
time string Čas vygenerování události na základě času UTC poskytovatele.
id string Jedinečný identifikátor události.
data objekt Data událostí azure API Center
specversion string Verze specifikace schématu CloudEvents

Datový objekt má následující vlastnosti:

Vlastnost Type Description
title string Název definice rozhraní API.
description string Popis definice rozhraní API.
specification string Vlastnosti specifikace rozhraní API, které se skládají z name (název specifikace) a version (verze specifikace)

Kurzy a postupy

Titulek Popis
Povolení lintování a analýzy zásad správného řízení rozhraní API v centru rozhraní API Pomocí událostí Event Gridu můžete aktivovat lintování za účelem analýzy definic rozhraní API ve vašem centru rozhraní API.

Související obsah

  • Úvod do Azure Event Gridu najdete v tématu Co je Event Grid?
  • Další informace o vytvoření odběru služby Azure Event Grid najdete ve schématu odběru služby Event Grid.