Megosztás a következőn keresztül:

Az Azure API Center mint Event Grid-forrás (előzetes verzió)

  • Cikk

Ez a cikk az Azure API Center-események tulajdonságait és sémáját ismerteti. Az eseménysémákról az Azure Event Grid eseményséma című témakörben olvashat.

Feljegyzés

Ez a szolgáltatás jelenleg előzetes kiadásban elérhető.

Elérhető eseménytípusok

Ezek az események akkor aktiválódnak, amikor egy ügyfél hozzáad vagy frissít egy API-definíciót.

Esemény neve Leírás
Microsoft.ApiCenter.ApiDefinitionAdded Akkor aktiválódik, ha api-definíciót ad hozzá egy API-központhoz.
Microsoft.ApiCenter.ApiDefinitionUpdated Akkor aktiválódik, ha egy API-definíció frissül egy API-központban.

Példaesemény

Amikor egy esemény aktiválódik, az API Center szolgáltatás adatokat küld az eseményről a feliratkozó végpontnak. Ez a szakasz egy példát tartalmaz arra, hogy milyenek lennének az adatok az egyes API Center-eseményekhez.

Microsoft.ApiCenter.ApiDefinitionAdded esemény

[{
  "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 esemény

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

Esemény tulajdonságai

Egy esemény a következő legfelső szintű adatokkal rendelkezik:

Tulajdonság Típus Leírás
source húr Az eseményforrás teljes erőforrás-elérési útja. Ez a mező nem írható. Az értéket az Event Grid adja meg.
subject húr Az esemény tárgyra mutató, a közzétevő által megadott elérési út.
type húr Az eseményforráshoz felvett eseménytípusok egyike.
time húr Az esemény létrehozásának időpontja a szolgáltató UTC-ideje alapján.
id húr Az esemény egyedi azonosítója.
data object Az Azure API Center eseményadatai.
specversion húr A CloudEvents sémaspecifikációs verziója.

Az adatobjektum a következő tulajdonságokkal rendelkezik:

Tulajdonság Típus Leírás
title húr Az API-definíció címe.
description húr Az API-definíció leírása.
specification húr Az API specifikációs tulajdonságai( name specifikáció neve) és version (specifikáció verziója)

Oktatóanyagok és útmutatók

Cím Leírás
A linting és az elemzés engedélyezése az API-szabályozáshoz az API-központban Az Event Grid-események használatával lintinget indíthat el az API-definíciók elemzéséhez az API-központban.

Kapcsolódó tartalom