Event Grid kaynağı olarak Azure API Management

Bu makalede Azure API Management olaylarının özellikleri ve şeması sağlanır. Olay şemalarına giriş için bkz. Azure Event Grid olay şeması. Ayrıca API Management'ı olay kaynağı olarak kullanmak için makalelere bağlantılar sağlar.

Kullanılabilir olay türleri

API Management aşağıdaki olay türlerini yayar:

Olay türü Açıklama
Microsoft.ApiManagement KullanıcıOluşturuldu Kullanıcı oluşturulduğunda tetiklenir.
Microsoft.ApiYönetimi.KullanıcıGüncellendi Bir kullanıcı güncellendiğinde tetiklenir.
Microsoft.ApiManagement.UserDeleted Kullanıcı silindiğinde oluşturulur.
Microsoft.ApiManagement.APICreated Bir API oluşturulduğunda tetiklenir.
Microsoft.ApiManagement.API Güncellendi BIR API güncelleştirildiğinde oluşturulur.
Microsoft.ApiManagement.APIDeleted Bir API silindiğinde oluşturulur.
Microsoft.ApiManagement.ProductCreated (Ürün Oluşturuldu) Bir ürün oluşturulduğunda meydana gelir.
Microsoft.ApiManagement.UrunGuncellendi Bir ürün güncelleştirildiğinde yükseltilir.
Microsoft.ApiManagement.ProductDeleted Bir ürün silindiğinde tetiklenir.
Microsoft.ApiManagement.APIReleaseCreated API sürümü oluşturulduğunda tetiklenir.
Microsoft.ApiManagement.APIYayınGüncellendi Bir API sürümü güncellendiğinde tetiklenir.
Microsoft.ApiYönetimi.APIYayınSilindi Bir API sürümü silindiğinde tetiklenir.
Microsoft.ApiManagement.SubscriptionCreated Abonelik oluşturulduğunda tetiklenir.
Microsoft.ApiYönetimi.AbonelikGüncellendi Abonelik güncelleştirildiğinde tetiklenir.
Microsoft.ApiYönetimi.AbonelikSilindi Abonelik silindiğinde oluşturulur.
Microsoft.ApiManagement.Ağ Geçidi Oluşturuldu Kendi kendini barındıran bir ağ geçidi oluşturulduğunda tetiklenir.
Microsoft.ApiManagement.GatewayDeleted (Geçit Silindi) Kendi kendine barındırılan bir ağ geçidinde güncelleme yapıldığında tetiklenir.
Microsoft.ApiManagement.Gateway güncellendi Kendi tarafından barındırılan bir ağ geçidi silindiğinde tetiklenir.
Microsoft.ApiManagement.GatewayAPIAdded Bir API, kendi barındırılan bir ağ geçidine eklendiğinde tetiklenir.
Microsoft.ApiManagement.GatewayAPIRemoved Bir API şirket içinde barındırılan ağ geçidinden kaldırıldığında oluşturulur.
Microsoft.ApiManagement.GeçitSertifikaOtoritesiOluşturuldu Kendi barındırdığı bir ağ geçidinde bir sertifika yetkilisi güncellendiğinde tetiklenir.
Microsoft.ApiManagement.GatewayCertificateAuthorityDeleted Kendi altyapınızda barındırılan bir ağ geçidi için bir sertifika yetkilisi silindiğinde yükseltilir.
Microsoft.ApiYönetimi.AğGeçidiSertifikaYetkilisiGüncellendi Kendi barındırdığı bir ağ geçidinde bir sertifika yetkilisi güncellendiğinde tetiklenir.
Microsoft.ApiManagement.Ağ Geçidi Ana Bilgisayar Adı Yapılandırması Oluşturuldu Bir self barındırılan ağ geçidi için bir ana makine adı yapılandırması oluşturulduğunda tetiklenir.
Microsoft.ApiManagement.GatewayHostnameYapılandırmasıSilindi Kendi kendine barındırılan bir ağ geçidi için bir host adı yapılandırması silindiğinde oluşturulur.
Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated Bir öz barındırılan ağ geçidi için bir konak adı yapılandırması güncellendiğinde oluşturulur.
Microsoft.ApiManagement.GatewayTokenNearExpiry (önizleme) Kendi kendine barındırılan bir ağ geçidi erişim belirtecinin süresi dolmak üzereyken oluşturulur.
Microsoft.ApiManagement.GatewayTokenExpired (önizleme) Kendi kendine barındırılan ağ geçidi erişim belirtecinin süresi dolduğunda tetiklenir.
Microsoft.ApiManagement.CircuitBreaker.Opened (önizleme) Arka uç devre kesici açıldığında tetiklenir.
Microsoft.ApiManagement.CircuitBreaker.Closed (önizleme) Arka uç devre kesici kapatıldığında yükseltilir.

Örnek olay

Aşağıdaki örnek, ürün tarafından oluşturulan olayın şemasını gösterir. Oluşturulan diğer API Management kaynağı olaylarının şeması benzerdir.

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

Aşağıdaki örnekte, kullanıcı tarafından silinen bir olayın şeması gösterilmektedir. Diğer API Management kaynaklarının silme olaylarının şeması benzerdir.

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

Aşağıdaki örnek, API güncelleştirilmiş olayının şemasını gösterir. Diğer API Management kaynaklarının güncellenen olaylarının şeması benzerdir.

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

Aşağıdaki örnekte, açılan bir devre kesici olayının şeması gösterilmektedir.

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

Aşağıdaki örnekte ağ geçidi belirtecinin süresi dolmuş olayının şeması gösterilmektedir. Süresi dolmakta olan bir ağ geçidi belirtecinin şeması benzerdir, ancak özellik expiresAtUtc yerine expiredAtUtc özelliği ile değiştirilir.

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

Olay özellikleri

Bir olay aşağıdaki üst düzey verilere sahiptir:

Mülkiyet Türü Açıklama
source String Etkinlik kaynağının kaynak yolunun tamamı. Bu alan yazılabilir değil. Event Grid bu değeri sağlar.
subject String Yayımcı tarafından tanımlanan olay konusuna giden yol.
type String Bu olay kaynağı için kayıtlı olay türlerinden biri.
time String Olayın oluşturulma saati, sağlayıcının UTC zamanına göre belirlenir.
id String Etkinliği benzersiz tanımlayan öğe.
data nesne API Management olay verileri.
specversion String CloudEvents şema belirtimi sürümü.

Veri nesnesi özellikleri

Kontrol düzlemi olayları

data nesnesi, API Management kaynaklarını oluşturma, güncelleştirme ve silme gibi denetim düzlemi olayları için aşağıdaki özelliklere sahiptir.

Mülkiyet Türü Açıklama
resourceUri String Kaynak adı ve kaynak türü de dahil olmak üzere uyumluluk durumu değişikliğinin olduğu kaynağın tam kimliği. /subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName> biçimini kullanır.

Devre kesici olayları

data nesnesi, devre kesici olayları için aşağıdaki özelliklere sahiptir.

Mülkiyet Türü Açıklama
backendNme String Devre kesicinin yapılandırıldığı arka uç varlığının adı (kimlik).
circuitBreaker nesne Arka uçta yapılandırılan devre kesici, arka uçta çalışan kuralı belirten bir rules nesnesinden oluşur. Kuralın hh:mm:ss biçiminde, devre kesicinin devreden çıktığı süreyi belirten bir tripDuration özelliği vardır.

Kendi kendine barındırılan ağ geçidi kimlik doğrulama belirteci olayları

data nesnesi, kendi kendine barındırılan ağ geçidi kimlik doğrulama belirteci olayları için aşağıdaki özelliklere sahiptir.

Mülkiyet Türü Açıklama
gatewayInfo nesne Kendi kendine barındırılan ağ geçidinin, aşağıdaki dize özelliklerinden oluşan bilgileri:

* gatewayId - Ağ geçidi kaynağının tam kimliği
* instanceId - Dağıtılan ağ geçidinin benzersiz örnek kimliği
tokenInfo nesne Sağlayıcının UTC saatinde aşağıdaki özelliklerden birini içeren belirteç bilgileri:

* expiresAtUtc - GatewayTokenNearExpiry etkinliği için veya
* expiredAtUtc - olay için GatewayTokenExpired

Öğreticiler ve nasıl yapılır

Başlık Açıklama
OLAYLARı API Management'tan Event Grid'e gönderme Event Grid kullanarak API Management olaylarına abone olma.

Sonraki Adımlar

  • Last updated on