Bagikan melalui

Azure API Center sebagai sumber Event Grid (Pratinjau)

  • Artikel

Artikel ini menyediakan properti dan skema untuk peristiwa Azure API Center. Untuk pengantar skema peristiwa, lihat Skema peristiwa Azure Event Grid.

Catatan

Fitur ini masih dalam mode pratinjau.

Tipe kejadian yang tersedia

Peristiwa ini dipicu saat klien menambahkan atau memperbarui definisi API.

Nama kejadian Deskripsi
Microsoft.ApiCenter.ApiDefinitionAdded Dipicu saat definisi API ditambahkan di pusat API.
Microsoft.ApiCenter.ApiDefinitionUpdated Dipicu saat definisi API diperbarui di pusat API.

Contoh peristiwa

Saat peristiwa dipicu, layanan API Center mengirimkan data tentang peristiwa tersebut ke titik akhir berlangganan. Bagian ini berisi contoh tampilan data tersebut untuk setiap peristiwa API Center.

Peristiwa Microsoft.ApiCenter.ApiDefinitionAdded

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

Peristiwa Microsoft.ApiCenter.ApiDefinitionUpdated

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

Properti kejadian

Sebuah peristiwa memiliki data tingkat atas berikut ini:

Properti Tipe Deskripsi
source string Jalur sumber daya lengkap ke sumber kejadian. Bidang ini tidak dapat ditulis. Event Grid memberikan nilai ini.
subject string Jalur yang ditentukan penerbit ke subjek kejadian.
type string Salah satu jenis kejadian terdaftar untuk sumber kejadian ini.
time string Waktu peristiwa dibuat berdasarkan waktu UTC penyedia.
id string Pengidentifikasi unik untuk peristiwa tersebut.
data object Data peristiwa Azure API Center.
specversion string Versi spesifikasi skema CloudEvents.

Objek data memiliki properti berikut:

Properti Tipe Deskripsi
title string Judul definisi API.
description string Deskripsi definisi API.
specification string Properti spesifikasi API, yang terdiri name dari (nama spesifikasi) dan version (versi spesifikasi)

Tutorial dan cara kerja

Judul Deskripsi
Mengaktifkan linting dan analisis untuk tata kelola API di pusat API Anda Gunakan peristiwa Event Grid untuk memicu linting untuk menganalisis definisi API di pusat API Anda.

Konten terkait