Usługa Azure API Management jako źródło usługi Event Grid

  • Artykuł

Ten artykuł zawiera właściwości i schemat zdarzeń usługi Azure API Management . Aby zapoznać się ze schematami zdarzeń, zobacz Schemat zdarzeń usługi Azure Event Grid. Udostępnia również linki do artykułów, które umożliwiają używanie usługi API Management jako źródła zdarzeń.

Dostępne typy zdarzeń

Usługa API Management emituje następujące typy zdarzeń:

Typ zdarzenia opis
Microsoft.ApiManagement.UserCreated Zgłaszany podczas tworzenia użytkownika.
Microsoft.ApiManagement.UserUpdated Zgłaszane po zaktualizowaniu użytkownika.
Microsoft.ApiManagement.UserDeleted Zgłaszane po usunięciu użytkownika.
Microsoft.ApiManagement.APICreated Wywoływane podczas tworzenia interfejsu API.
Microsoft.ApiManagement.APIUpdated Wywoływane po zaktualizowaniu interfejsu API.
Microsoft.ApiManagement.APIDeleted Zgłaszane po usunięciu interfejsu API.
Microsoft.ApiManagement.ProductCreated Zgłoszone podczas tworzenia produktu.
Microsoft.ApiManagement.ProductUpdated Zgłaszane po zaktualizowaniu produktu.
Microsoft.ApiManagement.ProductDeleted Zgłaszane po usunięciu produktu.
Microsoft.ApiManagement.ReleaseCreated Wywoływane po utworzeniu wydania interfejsu API.
Microsoft.ApiManagement.ReleaseUpdated Zgłaszane po zaktualizowaniu wydania interfejsu API.
Microsoft.ApiManagement.ReleaseDeleted Zgłaszane po usunięciu wydania interfejsu API.
Microsoft.ApiManagement.SubscriptionCreated Zgłaszane podczas tworzenia subskrypcji.
Microsoft.ApiManagement.SubscriptionUpdated Zgłaszane po zaktualizowaniu subskrypcji.
Microsoft.ApiManagement.SubscriptionDeleted Zgłaszane po usunięciu subskrypcji.
Microsoft.ApiManagement.GatewayCreated Wywoływane podczas tworzenia własnej bramy.
Microsoft.ApiManagement.GatewayDeleted Zgłaszane po zaktualizowaniu własnej bramy.
Microsoft.ApiManagement.GatewayUpdated Zgłaszane po usunięciu własnej bramy.
Microsoft.ApiManagement.GatewayAPIAdded Zgłaszane, gdy interfejs API został usunięty z własnej bramy.
Microsoft.ApiManagement.GatewayAPIRemoved Zgłaszane, gdy interfejs API został usunięty z własnej bramy.
Microsoft.ApiManagement.GatewayCertificateAuthorityCreated Zgłaszane, gdy urząd certyfikacji został zaktualizowany dla własnego serwera.
Microsoft.ApiManagement.GatewayCertificateAuthorityDeleted Zgłaszane, gdy urząd certyfikacji został usunięty dla własnego serwera.
Microsoft.ApiManagement.GatewayCertificateAuthorityUpdated Zgłaszane, gdy urząd certyfikacji został zaktualizowany dla własnego serwera.
Microsoft.ApiManagement.GatewayHostnameConfigurationCreated Zgłaszane, gdy konfiguracja nazwy hosta została utworzona dla własnego hosta.
Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted Zgłaszane, gdy konfiguracja nazwy hosta została usunięta dla własnego hostowania.
Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated Zgłaszane, gdy konfiguracja nazwy hosta została zaktualizowana dla własnego hosta.

Przykładowe zdarzenie

W poniższym przykładzie przedstawiono schemat zdarzenia utworzonego przez produkt. Schemat innych zdarzeń utworzonych zasób usługi API Management jest podobny.

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

W poniższym przykładzie przedstawiono schemat usuniętego zdarzenia użytkownika. Schemat innych zdarzeń usuniętych zasobów usługi API Management jest podobny.

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

W poniższym przykładzie przedstawiono schemat zaktualizowanego zdarzenia interfejsu API. Schemat innych zdarzeń zaktualizowanych zasobów usługi API Management jest podobny.

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

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ń usługi API Management.
specversion string Wersja specyfikacji schematu CloudEvents.

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

Właściwość Type opis
resourceUri string W pełni kwalifikowany identyfikator zasobu, dla którego jest zmieniany stan zgodności, łącznie z nazwą zasobu i typem zasobu. Używa formatu, /subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>

Samouczki i poradniki

Nazwa opis
Wysyłanie zdarzeń z usługi API Management do usługi Event Grid Jak subskrybować zdarzenia usługi API Management przy użyciu usługi Event Grid.

Następne kroki

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