Bagikan melalui

Azure API Management sebagai sumber Event Grid

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

Tipe kejadian yang tersedia

API Management memancarkan jenis peristiwa berikut:

Jenis peristiwa Deskripsi
Microsoft.ApiManagement.UserCreated Dimunculkan saat pengguna dibuat.
Microsoft.ApiManagement.PenggunaDiperbarui Dimunculkan saat pengguna diperbarui.
Microsoft.ApiManagement.PenggunaDihapus Dimunculkan saat pengguna dihapus.
Microsoft.ApiManagement.APICreated Dimunculkan saat API dibuat.
Microsoft.ApiManagement.APIUpdated Dimunculkan saat API diperbarui.
Microsoft.ApiManagement.API Dihapus Dimunculkan saat API dihapus.
Microsoft.ApiManagement.ProductCreated Dimunculkan saat produk dibuat.
Microsoft.ApiManagement.ProdukDiperbarui Dimunculkan saat produk diperbarui.
Microsoft.ApiManagement.ProdukDihapus Dimunculkan saat produk dihapus.
Microsoft.ApiManagement.APIReleaseCreated Dimunculkan saat rilis API dibuat.
Microsoft.ApiManagement.RilisAPI Diperbarui Dimunculkan saat rilis API diperbarui.
Microsoft.ApiManagement.APIReleaseDihapus (Rilis API Dihapus) Dimunculkan saat rilis API dihapus.
Microsoft.ApiManagement.SubscriptionCreated Dimunculkan saat langganan dibuat.
Microsoft.ApiManagement.SubscriptionUpdated Dimunculkan saat langganan diperbarui.
Microsoft.ApiManagement.LanggananDihapus Dimunculkan saat langganan dihapus.
Microsoft.ApiManagement.Gateway telah Diciptakan Dimunculkan saat gateway yang dihost sendiri dibuat.
Microsoft.ApiManagement.GatewayDeleted Dimunculkan saat gateway yang dihosting sendiri diperbarui.
Microsoft.ApiManagement.GatewayUpdated Dimunculkan saat gateway yang dihost sendiri dihapus.
Microsoft.ApiManagement.GatewayAPIDitambahkan Dimunculkan saat API ditambahkan ke gateway yang dihost sendiri.
Microsoft.ApiManagement.GatewayAPIDihapus Dimunculkan saat API dihapus dari gateway yang dihost sendiri.
Microsoft.ApiManagement.GatewayCertificateAuthorityCreated Dimunculkan saat otoritas sertifikat diperbarui untuk gateway yang dihost sendiri.
Microsoft.ApiManagement.GatewayCertificateAuthorityDihapus Dimunculkan saat otoritas sertifikat dihapus untuk gateway yang dihost sendiri.
Microsoft.ApiManagement.OtoritasSertifikatGatewayDiperbarui Dimunculkan saat otoritas sertifikat diperbarui untuk gateway yang dihost sendiri.
KonfigurasiNamaHostGatewayDibuat.Microsoft.ApiManagement Dimunculkan saat konfigurasi nama host dibuat untuk gateway yang dihost sendiri.
Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted Dimunculkan saat konfigurasi nama host dihapus untuk gateway yang dihost sendiri.
Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated Dimunculkan saat konfigurasi nama host diperbarui untuk gateway yang dihost sendiri.
Microsoft.ApiManagement.GatewayTokenNearExpiry (pratinjau) Dimunculkan saat token akses gateway yang dihost sendiri mendekati kedaluwarsa.
Microsoft.ApiManagement.GatewayTokenExpired (pratinjau) Dimunculkan saat token akses gateway yang dihost sendiri kedaluwarsa.
Microsoft.ApiManagement.CircuitBreaker.Opened (pratinjau) Dimunculkan ketika pemutus sirkuit sistem belakang dibuka.
Microsoft.ApiManagement.CircuitBreaker.Tertutup (pratinjau) Dimunculkan ketika pemutus sirkuit backend tertutup.

Contoh peristiwa

Contoh berikut menunjukkan skema kejadian pembuatan 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 kejadian penghapusan 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 acara pembaruan API. Skema peristiwa pembaruan 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
}]

Contoh berikut menunjukkan skema peristiwa ketika pemutus sirkuit dibuka.

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

Contoh berikut menunjukkan skema peristiwa kedaluwarsa token gateway. Skema dari token gateway yang mendekati kedaluwarsa serupa, tetapi menggantikan properti expiresAtUtc dengan properti expiredAtUtc.

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

Properti acara

Sebuah peristiwa memiliki data tingkat atas berikut ini:

Harta benda Tipe Deskripsi
source benang Jalur sumber daya lengkap ke sumber kejadian. Bidang ini tidak dapat ditulis. Event Grid menyediakan nilai ini.
subject benang Jalur yang ditentukan penerbit menuju subjek peristiwa.
type benang Salah satu jenis peristiwa terdaftar untuk sumber kejadian ini.
time benang Waktu peristiwa dihasilkan berdasarkan waktu UTC penyedia.
id benang ID unik untuk acara tersebut.
data obyek Data peristiwa API Management.
specversion benang Versi spesifikasi skema CloudEvents.

Properti objek data

Peristiwa lapisan kontrol

Objek data memiliki properti berikut untuk peristiwa sarana kontrol seperti membuat, memperbarui, dan menghapus sumber daya API Management.

Harta benda Tipe Deskripsi
resourceUri benang 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>

Peristiwa pemutus sirkuit

Objek data memiliki properti berikut untuk peristiwa pemutus sirkuit.

Harta benda Tipe Deskripsi
backendNme benang Nama (ID) entitas backend tempat pemutus sirkuit dikonfigurasi.
circuitBreaker obyek Sakelar pemutus yang dikonfigurasi di bagian belakang sistem, terdiri dari objek yang rules menentukan aturan yang menyebabkan gangguan. Aturan memiliki tripDuration properti dalam format hh:mm:ss yang menentukan durasi pemutus sirkuit terputus.

Peristiwa token autentikasi gateway yang dihost sendiri

Objek data memiliki properti berikut untuk peristiwa token autentikasi gateway yang dihost sendiri.

Harta benda Tipe Deskripsi
gatewayInfo obyek Informasi gateway yang dihost sendiri, terdiri dari properti string berikut:

* gatewayId - ID sumber daya gateway yang sepenuhnya terkwalifikasi
* instanceId - ID instance unik gateway yang telah diterapkan
tokenInfo obyek Informasi token, yang terdiri dari salah satu properti berikut dalam format waktu UTC penyedia:

* expiresAtUtc - untuk acara GatewayTokenNearExpiry, atau
* expiredAtUtc - untuk acara GatewayTokenExpired

Tutorial dan cara kerja

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

Langkah selanjutnya