Referensi kebijakan API Management

  • Artikel

BERLAKU UNTUK: Semua tingkatAN API Management

Bagian ini menyediakan deskripsi singkat dan tautan ke artikel referensi untuk semua kebijakan API Management. Gateway API Management yang mendukung setiap kebijakan ditunjukkan. Untuk pengaturan dan contoh kebijakan terperinci, lihat artikel referensi tertaut.

Informasi lebih lanjut mengenai kebijakan:

Penting

Batasi frekuensi panggilan berdasarkan langganan dan Atur kuota penggunaan berdasarkan langganan yang memiliki dependensi pada kunci langganan. Kunci langganan tidak diperlukan saat kebijakan lain diterapkan.

Pembatasan tarif dan kuota

Kebijakan Deskripsi Klasik V2 Consumption Dihosting sendiri
Batasi tarif panggilan menurut langganan Mencegah lonjakan penggunaan API dengan membatasi tarif panggilan, per langganan. Ya Ya Ya Ya
Batasi tarif panggilan menurut kunci Mencegah lonjakan penggunaan API dengan membatasi tarif panggilan, per basis kunci. Ya Ya No Ya
Mengatur kuota penggunaan menurut langganan Memungkinkan Anda menerapkan kuota volume panggilan dan/atau bandwidth terbarukan atau seumur hidup, per langganan. Ya Ya Ya Ya
Atur kuota penggunaan menurut kunci Memungkinkan Anda memberlakukan volume panggilan terbarukan atau seumur hidup dan/atau kuota bandwidth, per kunci. Ya No No Ya
Membatasi konkurensi Mencegah kebijakan tertutup dijalankan dengan lebih dari jumlah permintaan yang ditentukan pada satu waktu. Ya Ya Ya Ya

Autentikasi dan otorisasi

Kebijakan Deskripsi Klasik V2 Consumption Dihosting sendiri
Periksa header HTTP Memberlakukan keberadaan dan/atau nilai header HTTP. Ya Ya Ya Ya
Mendapatkan konteks otorisasi Mendapatkan konteks otorisasi koneksi tertentu ke penyedia kredensial yang dikonfigurasi dalam instans API Management. Ya Ya Ya Tidak
Batasi IP pemanggil Memfilter panggilan (memungkinkan/menolak) dari alamat IP dan/atau rentang alamat tertentu. Ya Ya Ya Ya
Memvalidasi token Microsoft Entra Memberlakukan keberadaan dan validitas Microsoft Entra (sebelumnya disebut Azure Active Directory) JWT yang diekstrak dari header HTTP, parameter kueri, atau nilai token tertentu. Ya Ya Ya Ya
Memvalidasi JWT Memberlakukan keberadaan dan validitas JWT yang diekstrak dari header HTTP, parameter kueri, atau nilai token tertentu. Ya Ya Ya Ya
Memvalidasi sertifikat klien Memberlakukan bahwa sertifikat yang disajikan oleh klien ke instans API Management cocok dengan aturan dan klaim validasi yang ditentukan. Ya Ya Ya Ya
Mengautentikasi dengan Dasar Mengautentikasi dengan layanan backend menggunakan autentikasi Dasar. Ya Ya Ya Ya
Mengautentikasi dengan sertifikat klien Mengautentikasi dengan layanan backend menggunakan sertifikat klien. Ya Ya Ya Ya
Mengautentikasi dengan identitas terkelola Mengautentikasi dengan layanan backend menggunakan identitas terkelola. Ya Ya Ya Ya

Validasi konten

Kebijakan Deskripsi Klasik V2 Consumption Dihosting sendiri
Memvalidasi konten Memvalidasi ukuran atau konten isi permintaan atau respons terhadap satu atau beberapa skema API. Format skema yang didukung adalah JSON dan XML. Ya Ya Ya Ya
Validasi permintaan GraphQL Memvalidasi dan memberikan otorisasi permintaan ke API GraphQL. Ya Ya Ya Ya
Memvalidasi permintaan OData Memvalidasi permintaan ke API OData untuk memastikan kesamaan dengan spesifikasi OData. Ya Ya Ya Ya
Memvalidasi parameter Memvalidasi parameter header permintaan, kueri, atau jalur terhadap skema API. Ya Ya Ya Ya
Memvalidasi header Memvalidasi header respons terhadap skema API. Ya Ya Ya Ya
Memvalidasi kode status Memvalidasi kode status HTTP sebagai respons terhadap skema API. Ya Ya Ya Ya

Perutean

Kebijakan Deskripsi Klasik V2 Consumption Dihosting sendiri
Meneruskan permintaan Meneruskan permintaan ke layanan backend. Ya Ya Ya Ya
Mengatur layanan ujung belakang Mengubah URL dasar layanan backend dari permintaan masuk ke URL atau backend. Mereferensikan sumber daya backend memungkinkan Anda mengelola URL dasar layanan backend dan pengaturan lainnya di satu tempat. Terapkan juga penyeimbangan beban lalu lintas di kumpulan layanan backend dan aturan pemutus arus untuk melindungi backend dari terlalu banyak permintaan. Ya Ya Ya Ya
Mengatur proksi HTTP Memungkinkan Anda merutekan permintaan yang diteruskan melalui proksi HTTP. Ya Ya Ya Ya

penembolokan

Kebijakan Deskripsi Klasik V2 Consumption Dihosting sendiri
Dapatkan dari cache Melakukan pencarian cache dan mengembalikan respons cache yang valid saat tersedia. Ya Ya Ya Ya
Simpan ke cache Respons cache sesuai dengan konfigurasi kontrol cache yang ditentukan. Ya Ya Ya Ya
Dapatkan nilai dari cache Mengambil item yang di-cache berdasarkan kunci. Ya Ya Ya Ya
Simpan nilai dalam cache Menyimpan item dalam cache menurut kunci. Ya Ya Ya Ya
Hapus nilai dari cache Menghapus item dalam cache menurut kunci. Ya Ya Ya Ya

Transformasi

Kebijakan Deskripsi Klasik V2 Consumption Dihosting sendiri
Atur metode permintaan Memungkinkan Anda mengubah metode HTTP untuk permintaan. Ya Ya Ya Ya
Atur kode status Mengubah kode status HTTP ke nilai yang ditentukan. Ya Ya Ya Ya
Menetapkan variabel Mempertahankan nilai dalam variabel konteks bernama untuk akses nanti. Ya Ya Ya Ya
Mengatur isi Mengatur isi pesan untuk permintaan atau respons. Ya Ya Ya Ya
Mengatur header HTTP Menetapkan nilai ke header respons dan/atau permintaan yang sudah ada atau menambahkan respons baru dan/atau header permintaan. Ya Ya Ya Ya
Mengatur parameter string kueri Menambahkan, mengganti nilai, atau menghapus parameter string kueri permintaan. Ya Ya Ya Ya
Menulis ulang URL Mengonversi URL permintaan dari bentuk publiknya ke bentuk yang diharapkan oleh layanan web. Ya Ya Ya Ya
Mengonversi JSON ke XML Mengonversi isi permintaan atau respons dari JSON ke XML. Ya Ya Ya Ya
Mengonversi XML ke JSON Mengonversi isi permintaan atau respons dari XML ke JSON. Ya Ya Ya Ya
Menemukan dan mengganti string dalam isi Menemukan substring permintaan atau respons dan menggantinya dengan substring yang berbeda. Ya Ya Ya Ya
Menyembunyikan URL dalam konten Menulis ulang tautan (masker) di isi respons sehingga menunjuk ke tautan yang setara melalui gateway. Ya Ya Ya Ya
Mengubah XML menggunakan XSLT Menerapkan transformasi XSL ke XML dalam isi permintaan atau respons. Ya Ya Ya Ya
Mengembalikan respons Membatalkan eksekusi alur dan mengembalikan respons yang ditentukan langsung ke pemanggil. Ya Ya Ya Ya
Respons tiruan Membatalkan eksekusi alur dan mengembalikan respons yang ditiru langsung ke pemanggil. Ya Ya Ya Ya

Lintas domain

Kebijakan Deskripsi Klasik V2 Consumption Dihosting sendiri
Perbolehkan panggilan lintas domain Membuat API dapat diakses dari klien berbasis browser Adobe Flash dan Microsoft Silverlight. Ya Ya Ya Ya
CORS Menambahkan dukungan berbagi sumber daya lintas asal (CORS) ke operasi atau API untuk memungkinkan panggilan lintas domain dari klien berbasis browser. Ya Ya Ya Ya
JSONP Menambahkan dukungan JSON dengan padding (JSONP) ke operasi atau API untuk memungkinkan panggilan lintas domain dari klien berbasis browser JavaScript. Ya Ya Ya Ya

Integrasi dan komunikasi eksternal

Kebijakan Deskripsi Klasik V2 Consumption Dihosting sendiri
Kirim permintaan Mengirim permintaan ke URL yang ditentukan. Ya Ya Ya Ya
Kirim permintaan satu arah Mengirim permintaan ke URL yang ditentukan tanpa menunggu respons. Ya Ya Ya Ya
Log ke hub peristiwa Mengirim pesan dalam format yang ditentukan ke hub peristiwa yang ditentukan oleh entitas Pencatat. Ya Ya Ya Ya
Mengirim permintaan ke layanan (Dapr) Menggunakan runtime Dapr untuk menemukan dan berkomunikasi dengan layanan mikro Dapr dengan andal. Untuk mempelajari selengkapnya tentang pemanggilan layanan di Dapr, lihat deskripsi dalam file README ini. Tidak No No Ya
Mengirim pesan ke topik Pub/Sub (Dapr) Menggunakan runtime Dapr untuk menerbitkan pesan ke topik Terbitkan/Berlangganan. Untuk mempelajari selengkapnya tentang pesan Terbitkan/Berlangganan di Dapr, lihat deskripsi dalam file README ini. Tidak No No Ya
Memicu pengikatan output (Dapr) Menggunakan runtime Dapr untuk memanggil sistem eksternal melalui pengikatan output. Untuk mempelajari selengkapnya tentang pengikatan di Dapr, lihat deskripsi dalam file README ini. Tidak No No Ya

Pencatatan

Kebijakan Deskripsi Klasik V2 Consumption Dihosting sendiri
Jejak Menambahkan jejak kustom ke dalam output pelacakan permintaan di konsol pengujian, telemetri Application Insights, dan log sumber daya. Ya Ya1 Ya Ya
Memancarkan metrik Mengirim metrik kustom ke Application Insights saat dieksekusi. Ya Ya Ya Ya

1 Di gateway V2, trace kebijakan saat ini tidak menambahkan output pelacakan di konsol pengujian.

Pemecah masalah GraphQL

Kebijakan Deskripsi Klasik V2 Consumption Dihosting sendiri
Sumber data Azure SQL untuk resolver Mengonfigurasi permintaan Azure SQL dan respons opsional untuk menyelesaikan data untuk jenis objek dan bidang dalam skema GraphQL. Ya Ya No Tidak
Sumber data Cosmos DB untuk resolver Mengonfigurasi permintaan Cosmos DB dan respons opsional untuk menyelesaikan data untuk jenis objek dan bidang dalam skema GraphQL. Ya Ya No Tidak
Sumber data HTTP untuk resolver Mengonfigurasi permintaan HTTP dan secara opsional respons HTTP untuk menyelesaikan data untuk jenis objek dan bidang dalam skema GraphQL. Ya Ya Ya Tidak
Menerbitkan peristiwa ke langganan GraphQL Menerbitkan peristiwa ke satu atau beberapa langganan yang ditentukan dalam skema API GraphQL. Konfigurasikan kebijakan dalam pemecah masalah GraphQL untuk bidang terkait dalam skema untuk jenis operasi lain seperti mutasi. Ya Ya Ya Tidak

Kontrol dan alur kebijakan

Kebijakan Deskripsi Klasik V2 Consumption Dihosting sendiri
Alur kontrol Menerapkan pernyataan kebijakan secara kondisional berdasarkan hasil evaluasi ekspresi Boolean. Ya Ya Ya Ya
Sertakan fragmen Menyisipkan fragmen kebijakan dalam definisi kebijakan. Ya Ya Ya Ya
Coba lagi Coba lagi eksekusi pernyataan kebijakan yang diapit, jika dan hingga kondisi terpenuhi. Eksekusi akan berulang pada interval waktu yang ditentukan dan hingga hitungan percobaan ulang yang ditentukan. Ya Ya Ya Ya
Tunggu Menunggu permintaan Kirim yang diapit, Dapatkan nilai dari cache, atau Kebijakan alur kontrol selesai sebelum melanjutkan. Ya Ya Ya Ya

Konten terkait

Untuk informasi selengkapnya tentang bekerja dengan kebijakan, lihat: