Share via

Az Azure API Management mint Event Grid-forrás

  • Cikk

Ez a cikk az Azure API Management-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. Emellett olyan cikkekre mutató hivatkozásokat is tartalmaz, amelyek az API Managementet eseményforrásként használják.

Elérhető eseménytípusok

Az API Management a következő eseménytípusokat bocsátja ki:

Eseménytípus Leírás
Microsoft.ApiManagement.UserCreated A felhasználó létrehozásakor aktiválódik.
Microsoft.ApiManagement.UserUpdated A felhasználó frissítésekor aktiválódik.
Microsoft.ApiManagement.UserDeleted A felhasználó törlésekor aktiválódik.
Microsoft.ApiManagement.APICreated API létrehozásakor aktiválódik.
Microsoft.ApiManagement.APIUpdated Az API frissítésekor aktiválódik.
Microsoft.ApiManagement.APIDeleted API törlésekor aktiválódik.
Microsoft.ApiManagement.ProductCreated A termék létrehozásakor jön létre.
Microsoft.ApiManagement.ProductUpdated A termék frissítésekor aktiválódik.
Microsoft.ApiManagement.ProductDeleted Termék törlésekor aktiválódik.
Microsoft.ApiManagement.ReleaseCreated API-kiadás létrehozásakor aktiválódik.
Microsoft.ApiManagement.ReleaseUpdated Az API-kiadás frissítésekor aktiválódik.
Microsoft.ApiManagement.ReleaseDeleted Api-kiadás törlésekor aktiválódik.
Microsoft.ApiManagement.SubscriptionCreated Előfizetés létrehozásakor jön létre.
Microsoft.ApiManagement.SubscriptionUpdated Az előfizetés frissítésekor merül fel.
Microsoft.ApiManagement.SubscriptionDeleted Előfizetés törlésekor merül fel.
Microsoft.ApiManagement.GatewayCreated A saját üzemeltetésű átjáró létrehozásakor történik.
Microsoft.ApiManagement.GatewayDeleted A saját üzemeltetésű átjáró frissítésekor aktiválódik.
Microsoft.ApiManagement.GatewayUpdated A saját üzemeltetésű átjáró törlésekor történik.
Microsoft.ApiManagement.GatewayAPIAdded Akkor merült fel, amikor egy API-t eltávolítottak egy saját üzemeltetésű átjáróból.
Microsoft.ApiManagement.GatewayAPIRemoved Akkor merült fel, amikor egy API-t eltávolítottak egy saját üzemeltetésű átjáróból.
Microsoft.ApiManagement.GatewayCertificateAuthorityCreated Akkor merült fel, amikor egy hitelesítésszolgáltatót frissítettek egy saját üzemeltetésű szolgáltatáshoz.
Microsoft.ApiManagement.GatewayCertificateAuthorityDeleted Akkor merült fel, amikor egy hitelesítésszolgáltatót töröltek egy saját üzemeltetésű szolgáltatáshoz.
Microsoft.ApiManagement.GatewayCertificateAuthorityUpdated Akkor merült fel, amikor egy hitelesítésszolgáltatót frissítettek egy saját üzemeltetésű szolgáltatáshoz.
Microsoft.ApiManagement.GatewayHostnameConfigurationCreated Akkor merült fel, amikor egy saját üzemeltetésű állomásnév-konfigurációt hoztak létre.
Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted Akkor merült fel, amikor egy gazdagépnév-konfigurációt töröltek egy saját üzemeltetésű példányhoz.
Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated A saját üzemeltetésű gazdagépnév-konfiguráció frissítésekor merült fel.

Példaesemény

Az alábbi példa egy termék által létrehozott esemény sémáját mutatja be. A többi API Management-erőforrás által létrehozott esemény sémája hasonló.

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

Az alábbi példa egy felhasználó által törölt esemény sémáját mutatja be. A többi API Management-erőforrás által törölt esemény sémája hasonló.

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

Az alábbi példa egy API-val frissített esemény sémáját mutatja be. A többi API Management-erőforrás által frissített esemény sémája hasonló.

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

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 API Management eseményadatok.
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
resourceUri húr Annak az erőforrásnak a teljes azonosítója, amelynél a megfelelőségi állapot változik, beleértve az erőforrás nevét és az erőforrás típusát. A formátumot használja, /subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>

Oktatóanyagok és útmutatók

Cím Leírás
Események küldése az API Managementből az Event Gridbe Api Management-eseményekre való feliratkozás az Event Grid használatával.

Következő lépések