Referensi kebijakan API Management
Bagian ini menyediakan tautan ke artikel referensi untuk semua kebijakan API Management.
Informasi lebih lanjut mengenai kebijakan:
- Gambaran umum kebijakan
- Mengatur atau mengedit kebijakan
- Ekspresi kebijakan
- Kebijakan penulis menggunakan Microsoft Copilot untuk Azure
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.
Kebijakan pembatasan akses
- Periksa header HTTP - Terapkan keberadaan dan/atau nilai Header HTTP.
- Dapatkan konteks otorisasi - Mendapatkan konteks otorisasi koneksi tertentu ke penyedia kredensial yang dikonfigurasi dalam instans API Management.
- Batasi tarif panggilan dengan langganan - Mencegah lonjakan penggunaan API dengan membatasi tarif panggilan, per langganan.
- Batasi tarif panggilan berdasarkan kunci - Mencegah lonjakan penggunaan API dengan membatasi tarif panggilan, per kunci.
- Batasi IP penelepon - Memfilter (menerima/menolak) panggilan dari alamat IP dan/atau rentang alamat tertentu.
- Setel kuota penggunaan dengan langganan - Memungkinkan Anda untuk memberlakukan volume panggilan yang dapat diperbarui atau seumur hidup dan/atau kuota bandwidth, per langganan.
- Setel kuota penggunaan berdasarkan kunci - Memungkinkan Anda untuk menerapkan volume panggilan yang dapat diperbarui atau seumur hidup dan/atau kuota bandwidth, per kunci.
- Validasi token Microsoft Entra - Memberlakukan keberadaan dan validitas Microsoft Entra JWT yang diekstrak dari header HTTP, parameter kueri, atau nilai token tertentu.
- Validasi JWT - Memberlakukan keberadaan dan validitas JWT yang diekstrak dari Header HTTP, parameter kueri, atau nilai token tertentu.
- Memvalidasi sertifikat klien - Memberlakukan bahwa sertifikat yang disajikan oleh klien ke instans API Management cocok dengan aturan dan klaim validasi tertentu.
Kebijakan lanjutan
- Alur kontrol - Menerapkan pernyataan kebijakan secara bersyarat berdasarkan hasil evaluasi ekspresi Boolean.
- Memancarkan metrik - Mengirimkan metrik kustom ke Application Insights saat eksekusi.
- Teruskan permintaan - Meneruskan permintaan ke layanan backend.
- Sertakan fragmen - Menyisipkan fragmen kebijakan dalam sebuah definisi kebijakan.
- Batasi konkurensi - Mencegah kebijakan yang terlampir dijalankan oleh lebih dari jumlah permintaan yang ditentukan pada satu waktu.
- Masuk ke hub kejadian - Mengirim pesan dalam format yang ditentukan ke hub kejadian yang ditentukan oleh entitas Pencatat.
- Respons mock - Membatalkan eksekusi alur dan mengembalikan respons mock langsung ke pemanggil.
- Coba lagi - Mencoba kembali eksekusi pernyataan kebijakan yang terlampir, jika dan hingga kondisi terpenuhi. Eksekusi akan berulang pada interval waktu yang ditentukan dan hingga hitungan percobaan ulang yang ditentukan.
- Kembalikan respons - Membatalkan eksekusi alur dan mengembalikan respons yang ditentukan langsung ke pemanggil.
- Kirim permintaan satu arah - Mengirim permintaan ke URL yang ditentukan tanpa menunggu respons.
- Kirim permintaan - Mengirim permintaan ke URL yang ditentukan.
- Setel proksi HTTP - Memungkinkan Anda merutekan permintaan yang diteruskan melalui proksi HTTP.
- Setel metode permintaan - Memungkinkan Anda mengubah metode HTTP untuk sebuah permintaan.
- Setel kode status - Mengubah kode status HTTP ke nilai yang ditentukan.
- Tetapkan variabel - Mempertahankan nilai dalam variabel konteks bernama untuk akses nanti.
- Jejak - Menambahkan jejak kustom ke dalam output pelacakan permintaan di konsol pengujian, telemetri Application Insights, dan log sumber daya.
- Tunggu - Menunggu kebijakan Kirim permintaan, Dapatkan nilai dari cache, atau Alur kontrol terlampir untuk diselesaikan sebelum melanjutkan.
Kebijakan autentikasi
- Autentikasi dengan Dasar - Otentikasi dengan layanan backend menggunakan autentikasi Dasar.
- Autentikasi dengan sertifikat klien - Autentikasi dengan layanan backend menggunakan sertifikat klien.
- Autentikasi dengan identitas terkelola - Autentikasi dengan layanan backend menggunakan autentikasi terkelola.
Kebijakan cache
- Dapatkan dari cache - Melakukan pencarian cache dan menampilkan respons cache yang valid saat tersedia.
- Simpan ke cache - Respons cache sesuai dengan konfigurasi kontrol cache yang ditentukan.
- Dapatkan nilai dari cache - Ambil item cache berdasarkan kunci.
- Simpan nilai dalam cache - Menyimpan item di cache berdasarkan kunci.
- Hapus nilai dari cache - Hapus item di cache berdasarkan kunci.
Kebijakan lintas domain
- Izinkan panggilan lintas domain - Membuat API dapat diakses dari klien berbasis browser Adobe Flash dan Microsoft Silverlight.
- CORS - Menambahkan dukungan berbagi sumber daya lintas asal (CORS) ke operasi atau API untuk memungkinkan panggilan lintas domain dari klien berbasis browser.
- JSONP - Menambahkan dukungan JSON dengan padding (JSONP) ke operasi atau API untuk mengizinkan panggilan lintas domain dari klien berbasis browser JavaScript.
Kebijakan integrasi Dapr
- Kirim permintaan ke layanan: 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.
- Kirim pesan ke topik Terbitkan/Berlangganan - 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.
- Picu pengikatan output: Menggunakan runtime Dapr untuk memanggil sistem eksternal melalui pengikatan output. Untuk mempelajari selengkapnya tentang pengikatan di Dapr, lihat deskripsi dalam file README ini.
Kebijakan penyelesai GraphQL
- Sumber data Azure SQL untuk resolver - Mengonfigurasi permintaan Azure SQL dan respons opsional untuk menyelesaikan data untuk jenis objek dan bidang dalam skema GraphQL.
- Sumber data Cosmos DB untuk resolver - Mengonfigurasi permintaan Cosmos DB dan respons opsional untuk menyelesaikan data untuk jenis objek dan bidang dalam skema GraphQL.
- Sumber data HTTP untuk resolver - Mengonfigurasi permintaan HTTP dan secara opsional respons HTTP untuk menyelesaikan data untuk jenis objek dan bidang dalam skema GraphQL.
- Terbitkan 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.
Kebijakan transformasi
- Mengonversi JSON ke XML - Mengonversi bodi permintaan atau respons dari JSON ke XML.
- Mengonversi XML ke JSON - Mengonversi bodi permintaan atau respons dari XML ke JSON.
- Menemukan dan mengganti string dalam bodi - Menemukan substring permintaan atau respons dan menggantinya dengan substring yang berbeda.
- Mask URL dalam konten - Menulis ulang (mask) tautan di bodi respons sehingga mereka mengarah ke tautan yang setara melalui gateway.
- Atur layanan backend - 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.
- Atur isi - Mengatur isi pesan untuk permintaan atau respons.
- Mengatur header HTTP - Menetapkan nilai ke header respons dan/atau permintaan yang sudah ada atau menambahkan header respons dan/atau permintaan baru.
- Mengatur parameter string kueri - Menambahkan, mengganti nilai, atau menghapus parameter string kueri permintaan.
- Menulis ulang URL - Mengonversi URL permintaan dari bentuk publiknya ke bentuk yang diharapkan oleh layanan web.
- Mengubah XML menggunakan XSLT - Menerapkan transformasi XSL ke XML di bodi permintaan atau respons.
Kebijakan validasi
- Validasi konten - Memvalidasi ukuran atau konten dari badan permintaan atau tanggapan terhadap satu atau beberapa skema API. Format skema yang didukung adalah JSON dan XML.
- Validasi permintaan GraphQL - Memvalidasi dan mengotorisasi permintaan ke API GraphQL.
- Validasi permintaan OData - Memvalidasi permintaan ke API OData untuk memastikan kesuaian dengan spesifikasi OData.
- Validasi parameter - Memvalidasi parameter header permintaan, kueri, atau jalur terhadap skema API.
- Validasi header - Memvalidasi header respons terhadap skema API.
- Validasi kode status - Memvalidasi kode status HTTP sebagai respons terhadap skema API.
Konten terkait
Untuk informasi selengkapnya tentang bekerja dengan kebijakan, lihat:
- Tutorial: Mengubah dan melindungi API Anda
- Referensi Kebijakan untuk daftar lengkap pernyataan kebijakan dan pengaturannya
- Ekspresi kebijakan
- Mengatur atau mengedit kebijakan
- Menggunakan kembali konfigurasi kebijakan
- Repositori cuplikan kebijakan
- Kebijakan penulis menggunakan Microsoft Copilot untuk Azure