Share via

Event Grid kaynağı olarak Azure API Management

  • Makale

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.UserCreated Kullanıcı oluşturulduğunda oluşturulur.
Microsoft.ApiManagement.UserUpdated Bir kullanıcı güncelleştirildiğinde oluşturulur.
Microsoft.ApiManagement.UserDeleted Kullanıcı silindiğinde oluşturulur.
Microsoft.ApiManagement.APICreated BIR API oluşturulduğunda oluşturulur.
Microsoft.ApiManagement.APIUpdated BIR API güncelleştirildiğinde oluşturulur.
Microsoft.ApiManagement.APIDeleted Bir API silindiğinde oluşturulur.
Microsoft.ApiManagement.ProductCreated Bir ürün oluşturulduğunda oluşturulur.
Microsoft.ApiManagement.ProductUpdated Bir ürün güncelleştirildiğinde yükseltilir.
Microsoft.ApiManagement.ProductDeleted Bir ürün silindiğinde oluşturulur.
Microsoft.ApiManagement.ReleaseCreated BIR API sürümü oluşturulduğunda oluşturulur.
Microsoft.ApiManagement.ReleaseUpdated BIR API sürümü güncelleştirildiğinde oluşturulur.
Microsoft.ApiManagement.ReleaseDeleted BIR API sürümü silindiğinde oluşturulur.
Microsoft.ApiManagement.SubscriptionCreated Abonelik oluşturulduğunda oluşturulur.
Microsoft.ApiManagement.SubscriptionUpdated Abonelik güncelleştirildiğinde oluşturulur.
Microsoft.ApiManagement.SubscriptionDeleted Abonelik silindiğinde oluşturulur.
Microsoft.ApiManagement.GatewayCreated Şirket içinde barındırılan bir ağ geçidi oluşturulduğunda oluşturulur.
Microsoft.ApiManagement.GatewayDeleted Şirket içinde barındırılan bir ağ geçidi güncelleştirildiğinde yükseltilir.
Microsoft.ApiManagement.GatewayUpdated Şirket içinde barındırılan bir ağ geçidi silindiğinde oluşturulur.
Microsoft.ApiManagement.GatewayAPIAdded Bir API şirket içinde barındırılan ağ geçidinden kaldırıldığında tetiklendi.
Microsoft.ApiManagement.GatewayAPIRemoved Bir API şirket içinde barındırılan ağ geçidinden kaldırıldığında tetiklendi.
Microsoft.ApiManagement.GatewayCertificateAuthorityCreated Şirket içinde barındırılan bir sertifika yetkilisi güncelleştirildiğinde oluşturulur.
Microsoft.ApiManagement.GatewayCertificateAuthorityDeleted Şirket içinde barındırılan bir sertifika yetkilisi silindiğinde oluşturulur.
Microsoft.ApiManagement.GatewayCertificateAuthorityUpdated Şirket içinde barındırılan bir sertifika yetkilisi güncelleştirildiğinde oluşturulur.
Microsoft.ApiManagement.GatewayHostnameConfigurationCreated Şirket içinde barındırılan bir için konak adı yapılandırması oluşturulduğunda oluşturulur.
Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted Şirket içinde barındırılan bir konak adı yapılandırması silindiğinde oluşturulur.
Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated Şirket içinde barındırılan bir konak adı yapılandırması güncelleştirildiğinde tetiklendi.

Ö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 kaynağı silinen 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 kaynağı güncelleştirilmiş 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
}]

Olay özellikleri

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

Özellik Türü Veri Akışı Açıklaması
source Dize Olay kaynağının tam kaynak yolu. Bu alan yazılabilir değil. Event Grid bu değeri sağlar.
subject Dize Olay konusunun yayımcı tarafından tanımlanan yolu.
type Dize Bu olay kaynağı için kayıtlı olay türlerinden biri.
time Dize Sağlayıcının UTC saati temelinde olayın oluşturulduğu saat.
id Dize Olayın benzersiz tanımlayıcısı.
data nesne API Management olay verileri.
specversion Dize CloudEvents şema belirtimi sürümü.

Veri nesnesi aşağıdaki özelliklere sahiptir:

Özellik Türü Veri Akışı Açıklaması
resourceUri Dize Kaynak adı ve kaynak türü de dahil olmak üzere uyumluluk durumu değişikliğinin olduğu kaynağın tam kimliği. Biçimini kullanır, /subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>

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

Ünvan Açıklama
OLAYLARı API Management'tan Event Grid'e gönderme Event Grid kullanarak API Management olaylarına abone olma.

Sonraki adımlar