Bagikan melalui


API Management Azure sebagai sumber Event Grid

Artikel ini menyediakan properti dan skema untuk peristiwa API Management Azure. Untuk pengantar skema peristiwa, lihat Skema peristiwa Azure Event Grid. Skema kejadian Azure Event Grid juga memberi Anda tautan ke artikel untuk menggunakan API Management sebagai sumber kejadian.

Tipe kejadian yang tersedia

API Management memancarkan jenis peristiwa berikut:

Jenis peristiwa Deskripsi
Microsoft.APIManagement.UserCreated Dimunculkan saat pengguna dibuat.
Microsoft.APIManagement.UserUpdated Dimunculkan saat pengguna diperbarui.
Microsoft.APIManagement.UserDeleted Dimunculkan saat pengguna dihapus.
Microsoft.APIManagement.APICreated Dimunculkan saat API dibuat.
Microsoft.APIManagement.APIUpdated Dimunculkan saat API diperbarui.
Microsoft.APIManagement.APIDeleted Dimunculkan saat API dihapus.
Microsoft.APIManagement.ProductCreated Dimunculkan saat produk dibuat.
Microsoft.APIManagement.ProductUpdated Dimunculkan saat produk diperbarui.
Microsoft.APIManagement.ProductDeleted Dimunculkan saat produk dihapus.
Microsoft.APIManagement.ReleaseCreated Dimunculkan saat rilis API dibuat.
Microsoft.APIManagement.ReleaseUpdated Dimunculkan saat rilis API diperbarui.
Microsoft.APIManagement.ReleaseDeleted Dimunculkan saat rilis API dihapus.
Microsoft.APIManagement.SubscriptionCreated Dimunculkan saat langganan dibuat.
Microsoft.APIManagement.SubscriptionUpdated Dimunculkan saat langganan diperbarui.
Microsoft.APIManagement.SubscriptionDeleted Dimunculkan saat langganan dihapus.
Microsoft.ApiManagement.GatewayCreated Dimunculkan saat gateway yang dihost sendiri dibuat.
Microsoft.ApiManagement.GatewayDeleted Dimunculkan saat gateway yang dihost sendiri diperbarui.
Microsoft.ApiManagement.GatewayUpdated Dimunculkan saat gateway yang dihost sendiri dihapus.
Microsoft.ApiManagement.GatewayAPITambahkan Dimunculkan saat API dihapus dari gateway yang dihost sendiri.
Microsoft.ApiManagement.GatewayAPIRemoved Dimunculkan saat API dihapus dari gateway yang dihost sendiri.
Microsoft.ApiManagement.GatewayCertificateAuthorityCreated Dimunculkan ketika otoritas sertifikat diperbarui untuk yang dihost sendiri.
Microsoft.ApiManagement.GatewayCertificateAuthorityDeleted Dimunculkan ketika otoritas sertifikat dihapus untuk yang dihost sendiri.
Microsoft.ApiManagement.GatewayCertificateAuthorityUpdated Dimunculkan ketika otoritas sertifikat diperbarui untuk yang dihost sendiri.
Microsoft.ApiManagement.GatewayHostnameConfigurationCreated Dimunculkan saat konfigurasi nama host dibuat untuk yang dihost sendiri.
Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted Dimunculkan saat konfigurasi nama host dihapus untuk yang dihost sendiri.
Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated Dimunculkan saat konfigurasi nama host diperbarui untuk yang dihost sendiri.

Contoh peristiwa

Contoh berikut menunjukkan skema peristiwa yang dibuat produk. Skema peristiwa yang dibuat sumber daya API Management lainnya serupa.

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

Contoh berikut menunjukkan skema peristiwa yang dihapus pengguna. Skema peristiwa yang dihapus sumber daya API Management lainnya serupa.

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

Contoh berikut menunjukkan skema peristiwa yang diperbarui API. Skema peristiwa yang diperbarui sumber daya API Management lainnya serupa.

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

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 API Management.
specversion string Versi spesifikasi skema CloudEvents.

Objek data memiliki properti berikut:

Properti Tipe Deskripsi
resourceUri string ID sumber daya yang sepenuhnya memenuhi syarat untuk perubahan status kepatuhan, termasuk nama sumber daya dan jenis sumber daya. Menggunakan format, /subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>

Tutorial dan cara kerja

Judul Deskripsi
Mengirim peristiwa dari API Management ke Event Grid Cara berlangganan peristiwa API Management menggunakan Event Grid.

Langkah berikutnya