Udostępnij przez

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

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.UżytkownikUsunięty Zgłaszane po usunięciu użytkownika.
Microsoft.ApiManagement.APIUtworzono Wywoływane podczas tworzenia interfejsu API.
Microsoft.ApiManagement.APIUpdated Wywoływane w momencie aktualizacji interfejsu API.
Microsoft.ApiManagement.APIDeleted Podnoszone po usunięciu API.
Microsoft.ApiManagement.UtworzonoProdukt Zgłoszone podczas tworzenia produktu.
Microsoft.ApiManagement.ProductUpdated Zgłaszane po zaktualizowaniu produktu.
Microsoft.ApiManagement.ProduktUsunięty Generowane po usunięciu produktu.
Microsoft.ApiManagement.APIReleaseCreated Wywoływane po utworzeniu wydania interfejsu API.
Microsoft.ApiManagement.APIReleaseUpdated Zgłaszane po zaktualizowaniu wydania interfejsu API.
Microsoft.ApiManagement.APIReleaseUsunięto Wywoływane po usunięciu wydania interfejsu API.
Microsoft.ApiManagement.SubscriptionCreated Podnoszone podczas tworzenia subskrypcji.
Microsoft.ApiManagement.SubscriptionUpdated Zgłaszane po zaktualizowaniu subskrypcji.
Microsoft.ApiManagement.SubscriptionDeleted Zgłaszane, gdy subskrypcja zostaje usunięta.
Microsoft.ApiManagement.GatewayCreated Wywoływane podczas tworzenia samodzielnie hostowanej bramy.
Microsoft.ApiManagement.GatewayDeleted Zgłaszane, gdy zaktualizowana zostanie własna brama sieciowa.
Microsoft.ApiManagement.GatewayUpdated Występuje po usunięciu samodzielnie hostowanej bramy dostępu.
Microsoft.ApiManagement.GatewayAPIAdded Wywoływane jako zdarzenie po dodaniu interfejsu API do samodzielnie hostowanej bramy.
Microsoft.ApiManagement.GatewayAPIRemoved Podniesiony po usunięciu interfejsu API z samodzielnie hostowanej bramy.
Microsoft.ApiManagement.GatewayCertificateAuthorityCreated Wywołane, gdy urząd certyfikacji zostanie zaktualizowany dla bramy działającej samodzielnie.
Microsoft.ApiManagement.GatewayCertificateAuthorityDeleted Zgłaszane po usunięciu urzędu certyfikacji dla bramy samodzielnie hostowanej.
Microsoft.ApiManagement.BramaUrządCertyfikacjiZaktualizowana Wywołane, gdy urząd certyfikacji zostanie zaktualizowany dla bramy działającej samodzielnie.
Microsoft.ApiManagement.GatewayHostnameConfigurationCreated Zgłaszane podczas tworzenia konfiguracji nazwy hosta dla bramy hostowanej samodzielnie.
Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted Zgłaszane, gdy konfiguracja nazwy hosta zostanie usunięta dla bramy hostowanej samodzielnie.
Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated Zgłaszane, gdy zostanie zaktualizowana konfiguracja nazwy hosta dla bramy samodzielnie hostowanej.
Microsoft.ApiManagement.GatewayTokenNearExpiry (wersja zapoznawcza) Zgłaszane, gdy zbliża się do wygaśnięcia token dostępu do bramy hostowanej samodzielnie.
Microsoft.ApiManagement.GatewayTokenExpired (wersja zapoznawcza) Zgłaszane, gdy token dostępu bramy samodzielnego hostowania wygasł.
Microsoft.ApiManagement.CircuitBreaker.Opened (wersja zapoznawcza) Podniesione po otwarciu wyłącznika zaplecza.
Microsoft.ApiManagement.CircuitBreaker.Closed (wersja zapoznawcza) ** Sygnał podniesiony po zamknięciu wewnętrznego wyłącznika obwodu.

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ń związanych z aktualizacją zasobów w usłudze 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
}]

Poniższy przykład przedstawia schemat zdarzenia otwarcia wyłącznika.

{
  "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}",
  "subject": "/backends/{backend-name}/circuit-breaker/rules/{rule-name}",
  "type": "Microsoft.ApiManagement.CircuitBreaker.Opened",
  "time": "2025-04-02T00:47:47.8536532Z",
  "id": "92c502f2-a966-42a7-a428-d3b319844544",
  "data": {
    "backendName": "{backend-name}",
    "circuitBreaker": {
      "rules": {
        "{rule-name}": {
          "tripDuration": "00:00:01"
        }
      }
    }
  },
  "specVersion": "1.0"
}

Poniższy przykład pokazuje schemat zdarzenia wygaśnięcia tokenu gateway. Schemat tokenu bramy dla zdarzenia zbliżającego się wygaśnięcia jest podobny, ale zastępuje właściwość expiresAtUtc właściwością expiredAtUtc.

{
  "source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}",
  "subject": "/gateways/{gateway-name}/{instance-name}",
  "type": "Microsoft.ApiManagement.GatewayTokenExpired",
  "time": "2025-04-02T00:47:47.8536532Z",
  "id": "92c502f2-a966-42a7-a428-d3b319844544",
  "data": {
    "gatewayInfo": {
      "gatewayId": "{gateway-name}",
      "instanceId": "{instance-name}"
    },
    "tokenInfo": {
      "expiredAtUtc": "2025-02-25T08:56:00.0000000Z"
    }
  },
  "specVersion": "1.0"
}

Właściwości zdarzenia

Zdarzenie ma następujące dane najwyższego poziomu:

Majątek Typ Opis
source sznurek Pełna ścieżka zasobu prowadząca do źródła zdarzenia. To pole nie jest możliwe do zapisu. Usługa Event Grid udostępnia tę wartość.
subject sznurek Ścieżka do tematu wydarzenia zdefiniowana przez wydawcę.
type sznurek Jeden z zarejestrowanych typów zdarzeń dla tego źródła zdarzeń.
time sznurek Czas generowania zdarzenia na podstawie czasu UTC dostawcy.
id sznurek Unikalny identyfikator zdarzenia.
data przedmiot Dane zdarzeń usługi API Management.
specversion sznurek Wersja specyfikacji schematu CloudEvents.

Właściwości obiektu danych

Zdarzenia płaszczyzny sterowania

Obiekt data ma następujące właściwości dla zdarzeń płaszczyzny sterowania, takich jak tworzenie, aktualizowanie i usuwanie zasobów usługi API Management.

Majątek Typ Opis
resourceUri sznurek 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>

Zdarzenia wyłącznika

Obiekt data ma następujące właściwości dla zdarzeń wyłącznika.

Majątek Typ Opis
backendNme sznurek Nazwa (ID) jednostki zaplecza, w której skonfigurowano wyłącznik.
circuitBreaker przedmiot Wyłącznik skonfigurowany w backendzie, składający się z rules obiektu określającego regułę, która wyzwalała problem. Reguła ma tripDuration właściwość w formacie hh:mm:ss określającą czas trwania, przez jaki wyłącznik jest wyłączony.

Zdarzenia tokenu uwierzytelniania bramy samodzielnie hostowanej

Obiekt data ma następujące właściwości dotyczące zdarzeń związanych z tokenem uwierzytelniania dla samodzielnie hostowanej bramy.

Majątek Typ Opis
gatewayInfo przedmiot Informacje o własnej bramie składające się z następujących właściwości ciągu:

* gatewayId — W pełni kwalifikowany identyfikator zasobu bramy
* instanceId - Unikatowy identyfikator wystąpienia wdrożonej bramy
tokenInfo przedmiot Informacje o tokenie, które składają się z jednej z następujących właściwości, według czasu UTC określonego przez dostawcę:

* expiresAtUtc - dla GatewayTokenNearExpiry zdarzenia lub
* expiredAtUtc - dla GatewayTokenExpired zdarzenia

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.

Dalsze 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.
  • Last updated on