Aracılığıyla paylaş

Event Grid kaynağı olarak Azure API Center (Önizleme)

  • Makale

Bu makale, Azure API Center olaylarının özelliklerini ve şemasını sağlar. Olay şemalarına giriş için bkz . Azure Event Grid olay şeması.

Not

Bu özellik şu anda önizlemededir.

Kullanılabilir olay türleri

Bu olaylar, bir istemci BIR API tanımı eklediğinde veya güncelleştirdiğinde tetiklenir.

Olay adı Açıklama
Microsoft.ApiCenter.ApiDefinitionAdded API merkezine bir API tanımı eklendiğinde tetikleniyor.
Microsoft.ApiCenter.ApiDefinitionUpdated API merkezinde bir API tanımı güncelleştirildiğinde tetiklendi.

Örnek olay

Bir olay tetiklendiğinde, API Center hizmeti bu olayla ilgili verileri abone olan uç noktaya gönderir. Bu bölüm, bu verilerin her API Center olayı için nasıl görüneceğine ilişkin bir örnek içerir.

Microsoft.ApiCenter.ApiDefinitionAdded olayı

[{
  "source": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.ApiCenter/services",
  "subject": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.ApiCenter/services/{api_center_name}/workspaces/default/apis/{api_name}/versions/{version_name}/definitions/{definition_name}",
  "type": "Microsoft.ApiCenter.ApiDefinitionAdded",
  "time": "2024-03-01T00:00:00.0000000Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "data": {
    "title": "OpenAPI",
    "description": "Default spec",
    "specification": {
      "name": "openapi",
      "version": "3.0.1"
    }
  },
  "specversion": "1.0"
}]

Microsoft.ApiCenter.ApiDefinitionUpdated olayı

[{
  "source": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.ApiCenter/services",
  "subject": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.ApiCenter/services/{api_center_name}/workspaces/default/apis/{api_name}/versions/{version_name}/definitions/{definition_name}",
  "type": "Microsoft.ApiCenter.ApiDefinitionUpdated",
  "time": "2024-03-01T00:00:00.0000000Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "data": {
    "title": "OpenAPI",
    "description": "Default spec",
    "specification": {
      "name": "openapi",
      "version": "3.0.1"
    }
  },
  "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 Azure API Center olay verileri.
specversion Dize CloudEvents şema belirtimi sürümü.

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

Özellik Türü Veri Akışı Açıklaması
title Dize API tanımının başlığı.
description Dize API tanımının açıklaması.
specification Dize (Belirtim adı) ve version (belirtim sürümü) içeren name API belirtimi özellikleri

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

Ünvan Açıklama
API merkezinizde API idaresi için lint ve analizi etkinleştirme API merkezinizdeki API tanımlarını analiz etmek için lint özelliğini tetikleyen Event Grid olaylarını kullanın.

İlgili içerik