Sdílet prostřednictvím

Azure API Management jako zdroj Event Gridu

  • Článek

Tento článek obsahuje vlastnosti a schéma událostí služby Azure API Management . Úvod do schémat událostí najdete ve schématu událostí služby Azure Event Grid. Poskytuje také odkazy na články o použití služby API Management jako zdroje událostí.

Dostupné typy událostí

Api Management generuje následující typy událostí:

Typ události Popis
Microsoft.ApiManagement.UserCreated Vyvolá se při vytvoření uživatele.
Microsoft.ApiManagement.UserUpdated Vyvolá se při aktualizaci uživatele.
Microsoft.ApiManagement.UserDeleted Vyvolá se při odstranění uživatele.
Microsoft.ApiManagement.APICreated Vyvolá se při vytvoření rozhraní API.
Microsoft.ApiManagement.APIUpdated Vyvolá se při aktualizaci rozhraní API.
Microsoft.ApiManagement.APIDeleted Vyvolá se při odstranění rozhraní API.
Microsoft.ApiManagement.ProductCreated Vyvolá se při vytvoření produktu.
Microsoft.ApiManagement.ProductUpdated Vyvolá se při aktualizaci produktu.
Microsoft.ApiManagement.ProductDeleted Vyvolá se při odstranění produktu.
Microsoft.ApiManagement.ReleaseCreated Vyvolá se při vytvoření verze rozhraní API.
Microsoft.ApiManagement.ReleaseUpdated Vyvolá se při aktualizaci verze rozhraní API.
Microsoft.ApiManagement.ReleaseDeleted Vyvolá se při odstranění verze rozhraní API.
Microsoft.ApiManagement.SubscriptionCreated Vyvolá se při vytvoření předplatného.
Microsoft.ApiManagement.SubscriptionUpdated Vyvolá se při aktualizaci předplatného.
Microsoft.ApiManagement.SubscriptionDeleted Vyvolá se při odstranění předplatného.
Microsoft.ApiManagement.GatewayCreated Vyvolá se při vytvoření brány v místním prostředí.
Microsoft.ApiManagement.GatewayDeleted Vyvolá se při aktualizaci brány v místním prostředí.
Microsoft.ApiManagement.GatewayUpdated Vyvolá se při odstranění brány v místním prostředí.
Microsoft.ApiManagement.GatewayAPIAdded Vyvolá se při odebrání rozhraní API z brány v místním prostředí.
Microsoft.ApiManagement.GatewayAPIRemoved Vyvolá se při odebrání rozhraní API z brány v místním prostředí.
Microsoft.ApiManagement.GatewayCertificateAuthorityCreated Vyvolá se při aktualizaci certifikační autority v místním prostředí.
Microsoft.ApiManagement.GatewayCertificateAuthorityDeleted Vyvolá se při odstranění certifikační autority v místním prostředí.
Microsoft.ApiManagement.GatewayCertificateAuthorityUpdated Vyvolá se při aktualizaci certifikační autority v místním prostředí.
Microsoft.ApiManagement.GatewayHostnameConfigurationCreated Vyvolá se při vytvoření konfigurace názvu hostitele pro místní hostování.
Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted Vyvolá se při odstranění konfigurace názvu hostitele pro místní hostování.
Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated Vyvolá se při aktualizaci konfigurace názvu hostitele pro místní hostování.

Příklad události

Následující příklad ukazuje schéma události vytvořené produktem. Schéma jiných událostí vytvořených prostředků služby API Management je podobné.

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

Následující příklad ukazuje schéma události odstraněné uživatelem. Schéma jiných událostí odstraněných prostředků služby API Management je podobné.

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

Následující příklad ukazuje schéma aktualizované události rozhraní API. Schéma jiných aktualizovaných událostí prostředků služby API Management je podobné.

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

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í služby API Management
specversion string Verze specifikace schématu CloudEvents

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

Vlastnost Type Description
resourceUri string Plně kvalifikované ID prostředku, pro který se mění stav dodržování předpisů, včetně názvu prostředku a typu prostředku. Používá formát. /subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>

Kurzy a postupy

Titulek Popis
Odesílání událostí ze služby API Management do Event Gridu Jak se přihlásit k odběru událostí služby API Management pomocí Event Gridu

Další kroky

  • Ú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.