Cara mengatur atau mengedit kebijakan Azure API Management

BERLAKU UNTUK: Semua tingkatan manajemen API

Artikel ini memperlihatkan kepada Anda cara mengonfigurasi kebijakan di instans API Management Anda dengan mengedit definisi kebijakan di portal Microsoft Azure. Setiap definisi kebijakan adalah dokumen XML yang menjelaskan urutan pernyataan masuk dan keluar yang berjalan secara berurutan pada permintaan dan respons API.

Editor kebijakan di portal menyediakan formulir terpandu bagi penerbit API untuk menambahkan dan mengedit kebijakan dalam definisi kebijakan. Anda juga dapat mengedit XML langsung di editor kode kebijakan.

Untuk informasi selengkapnya tentang kebijakan, lihat artikel berikut ini:

• Gambaran umum kebijakan
• Referensi Kebijakan untuk daftar lengkap pernyataan kebijakan dan pengaturannya
• Repositori cuplikan kebijakan
• Toolkit kebijakan untuk Azure API Management
• Menulis kebijakan menggunakan Azure Copilot

Prasyarat

Jika Anda belum memiliki instans API Management dan API backend, lihat:

• Buat instans Azure API Management.
• Mengimpor dan menerbitkan API.

Buka instans Manajemen API Anda

1. Di portal Microsoft Azure, cari dan pilih layanan API Management:

   

2. Pada halaman layanan API Management , pilih instans API Management Anda:

   

Mengonfigurasi kebijakan di portal

Contoh berikut menunjukkan cara mengonfigurasi kebijakan menggunakan dua opsi di editor kebijakan di portal:

• Editor berbasis formulir terpandu untuk menyederhanakan konfigurasi banyak kebijakan
• Editor kode tempat Anda dapat menambahkan atau mengedit XML secara langsung

Dalam contoh ini, kebijakan memfilter permintaan dari alamat IP masuk tertentu. Ini terbatas pada API yang dipilih.

Nota

Anda dapat mengonfigurasi kebijakan di cakupan lain, seperti untuk semua API, produk, atau satu operasi API. Untuk contoh lain, lihat Mengonfigurasi kebijakan pada cakupan yang berbeda nanti di artikel ini.

Untuk mengonfigurasi kebijakan:

Formulir

1. Di menu bar samping instans API Management Anda, di bawah API, pilih API.

2. Pilih API yang sebelumnya Anda impor.

3. Pilih tab Desain.

4. Untuk menerapkan kebijakan ke semua operasi, pilih Semua operasi.

5. Di bagian Pemrosesan masuk, pilih + Tambahkan kebijakan.

   

6. Di Tambahkan kebijakan masuk, pilih kebijakan yang akan ditambahkan. Misalnya, pilih Filter alamat IP.

   

   Petunjuk / Saran

   • Kebijakan yang ditampilkan difilter untuk bagian kebijakan yang Anda konfigurasi, dalam hal ini, untuk pemrosesan masuk.
   • Jika Anda tidak melihat kebijakan yang Anda inginkan, pilih petak Kebijakan lainnya . Ini membuka editor kode XML dan menampilkan daftar lengkap kebijakan untuk bagian dan cakupan tersebut.

7. Pilih IP yang diizinkan>+ Tambahkan filter IP dan tambahkan alamat IP pertama dan terakhir dari berbagai alamat masuk yang diizinkan untuk membuat permintaan API. Tambahkan rentang alamat IP lainnya, jika diperlukan.

   

8. Pilih Simpan untuk menyebarkan perubahan ke gateway API Management segera.

   Kebijakan ip-filter sekarang muncul di bagian Pemrosesan masuk .

Kode

1. Di menu bilah samping instans API Management Anda, pilih API.

2. Pilih API yang sebelumnya Anda impor.

3. Pilih tab Desain.

4. Untuk menerapkan kebijakan ke semua operasi, pilih Semua operasi.

5. Di bagian Pemrosesan masuk , pilih <ikon /> (editor kode).

   

6. Untuk melihat cuplikan kode XML kebijakan yang tersedia, pilih Perlihatkan cuplikan. Misalnya, pilih Batasi IP pemanggil.

   

7. Tempelkan atau masukkan cuplikan kode kebijakan yang diinginkan ke salah satu blok yang sesuai, dan selesaikan konfigurasi kebijakan.

   <policies>
       <inbound>
           <base />
           <ip-filter action="allow">
               <address-range from="10.100.7.0" to="10.100.127.0" />
           </ip-filter>
       </inbound>
       <backend>
           <base />
       </backend>
       <outbound>
           <base />
       </outbound>
       <on-error>
           <base />
       </on-error>
   </policies>
   

   Nota

   Tetapkan elemen kebijakan dan elemen turunan dalam urutan yang disediakan dalam pernyataan kebijakan.

8. Pilih Simpan untuk menyebarkan perubahan ke gateway API Management segera.

   Kebijakan ip-filter sekarang muncul di bagian Pemrosesan masuk .

Mengonfigurasi kebijakan pada cakupan yang berbeda

API Management memberi Anda fleksibilitas untuk mengonfigurasi definisi kebijakan di beberapa cakupan, di setiap bagian kebijakan.

Penting

Tidak semua kebijakan dapat diterapkan di setiap cakupan atau bagian kebijakan. Jika kebijakan yang ingin Anda tambahkan tidak diaktifkan, pastikan Anda berada di bagian kebijakan yang didukung dan cakupan untuk kebijakan tersebut. Untuk meninjau bagian dan cakupan kebijakan, periksa bagian Penggunaan di referensi Kebijakan.

Nota

Bagian Kebijakan backend hanya dapat berisi satu elemen kebijakan. Secara default, API Management mengonfigurasi forward-request kebijakan di bagian Backend pada cakupan global, dan base elemen pada cakupan lain.

Cakupan global

Cakupan global dikonfigurasi untuk Semua API dalam instans API Management Anda.

1. Di menu bilah samping instans API Management Anda, pilih API>Semua API.

2. Pilih tab Desain.

3. Di bagian kebijakan, pilih + Tambahkan kebijakan untuk menggunakan editor kebijakan berbasis formulir, atau pilih <ikon /> (editor kode) untuk menambahkan dan mengedit XML secara langsung.

   

4. Pilih Simpan untuk menyebarkan perubahan ke gateway API Management segera.

Cakupan produk

Cakupan produk dikonfigurasi untuk produk yang dipilih, jika sudah dikonfigurasi.

1. Di menu bilah samping, pilih Produk, lalu pilih produk yang ingin Anda terapkan kebijakannya.

2. Di jendela produk, pilih Kebijakan.

   

3. Di bagian kebijakan, pilih + Tambahkan kebijakan untuk menggunakan editor kebijakan berbasis formulir, atau pilih <ikon /> (editor kode) untuk menambahkan dan mengedit XML secara langsung.

4. Pilih Simpan untuk menyebarkan perubahan ke gateway API Management segera.

Cakupan API

Cakupan API dikonfigurasi untuk Semua operasi API yang dipilih.

1. Di menu bar samping instans API Management Anda, pilih API, lalu pilih API yang ingin Anda terapkan kebijakannya.

2. Pilih tab Desain.

3. Pilih Semua operasi.

   

4. Di bagian kebijakan, pilih + Tambahkan kebijakan untuk menggunakan editor kebijakan berbasis formulir, atau pilih <ikon /> (editor kode) untuk menambahkan dan mengedit XML secara langsung.

5. Pilih Simpan untuk menyebarkan perubahan ke gateway API Management segera.

Cakupan operasi

Cakupan operasi dikonfigurasi untuk operasi API yang dipilih.

1. Di menu bilah samping instans API Management Anda, pilih API.

2. Pilih tab Desain.

3. Pilih operasi yang ingin Anda terapkan kebijakannya.

   

4. Di bagian kebijakan, pilih + Tambahkan kebijakan untuk menggunakan editor kebijakan berbasis formulir, atau pilih <ikon /> (editor kode) untuk menambahkan dan mengedit XML secara langsung.

5. Pilih Simpan untuk menyebarkan perubahan ke gateway API Management segera.

Penggunaan ulang konfigurasi kebijakan

Anda dapat membuat fragmen kebijakan yang dapat digunakan kembali di instans API Management Anda. Fragmen kebijakan adalah elemen XML yang berisi konfigurasi Anda dari satu atau beberapa kebijakan. Fragmen kebijakan membantu Anda mengonfigurasi kebijakan secara konsisten dan mempertahankan definisi kebijakan tanpa perlu mengulangi atau mengetik ulang kode XML.

Gunakan kebijakan include-fragment untuk menyisipkan fragmen kebijakan dalam definisi kebijakan.

Menggunakan base elemen untuk mengatur urutan evaluasi kebijakan

Jika Anda mengonfigurasi definisi kebijakan pada lebih dari satu cakupan, beberapa kebijakan dapat berlaku untuk permintaan atau respons API. Bergantung pada urutan bahwa kebijakan dari berbagai cakupan diterapkan, transformasi permintaan atau respons dapat berbeda.

Di API Management, tentukan urutan evaluasi kebijakan berdasarkan penempatan base elemen di setiap bagian dalam definisi kebijakan di setiap cakupan. Elemen base mewarisi kebijakan yang dikonfigurasi di bagian tersebut pada cakupan (induk) yang lebih luas berikutnya. Elemen base disertakan secara default di setiap bagian kebijakan.

Nota

Untuk melihat kebijakan efektif pada cakupan saat ini, pilih Hitung kebijakan efektif di editor kebijakan.

Untuk mengubah urutan evaluasi kebijakan menggunakan editor kebijakan:

1. Mulailah dengan definisi pada cakupan paling sempit yang Anda konfigurasi, yang diterapkan API Management terlebih dahulu.

   Misalnya, saat menggunakan definisi kebijakan yang dikonfigurasi pada cakupan global dan cakupan API, mulailah dengan konfigurasi di cakupan API.

2. Letakkan elemen base di dalam bagian untuk menentukan di mana mewarisi semua kebijakan dari bagian yang sesuai di cakupan induk.

   Misalnya, di inbound bagian yang dikonfigurasi pada cakupan API, tempatkan elemen base untuk mengontrol tempat mewarisi kebijakan yang dikonfigurasi di inbound bagian pada cakupan global. Dalam contoh berikut, kebijakan yang diwariskan dari cakupan global diterapkan sebelum kebijakan ip-filter.

   <policies>
     <inbound>
         <base />
           <ip-filter action="allow">
               <address>10.100.7.1</address>
           </ip-filter>
     </inbound>
     [...]
   </policies>
   

   Nota

   • Anda dapat menempatkan base elemen sebelum atau sesudah elemen kebijakan apa pun di bagian .
   • Jika Anda ingin mencegah mewarisi kebijakan dari cakupan induk, hapus elemen base. Dalam kebanyakan kasus, ini tidak disarankan. Namun, mungkin berguna dalam situasi tertentu, seperti ketika Anda ingin menerapkan kebijakan yang berbeda ke operasi tertentu daripada yang dikonfigurasi untuk cakupan API (semua operasi).

3. Lanjutkan mengonfigurasi base elemen dalam definisi kebijakan pada cakupan yang berturut-turut lebih luas.

   Kebijakan yang dilingkup secara global tidak memiliki cakupan induk, dan menggunakan base elemen di dalamnya tidak berpengaruh.

Dapatkan bantuan Copilot

Anda bisa mendapatkan bantuan AI dari Copilot untuk membuat dan mengedit definisi kebijakan API Management Anda. Anda dapat menggunakan Copilot untuk membuat dan memperbarui kebijakan yang sesuai dengan persyaratan spesifik Anda tanpa perlu mengetahui sintaks XML. Anda juga bisa mendapatkan penjelasan tentang kebijakan yang ada. Dan Copilot dapat membantu Anda menerjemahkan kebijakan yang mungkin telah Anda konfigurasikan di solusi manajemen API lainnya.

• Azure Copilot menyediakan bantuan penulisan kebijakan dengan perintah bahasa alami di portal Microsoft Azure. Anda dapat menulis kebijakan di editor kebijakan API Management dan meminta Copilot untuk menjelaskan bagian kebijakan.
• GitHub Copilot untuk Azure di Visual Studio Code menyediakan bantuan penulisan kebijakan di Visual Studio Code, dan Anda dapat menggunakan Ekstensi Azure API Management untuk Visual Studio Code untuk mempercepat konfigurasi kebijakan. Anda dapat meminta Copilot Chat atau Copilot Edits dengan bahasa alami untuk membuat dan menyempurnakan definisi kebijakan di tempat.

Contoh perintah:

Generate a policy that adds an Authorization header to the request with a Bearer token.

Copilot didukung oleh AI, sehingga kejutan dan kesalahan dimungkinkan. Untuk informasi selengkapnya, lihat FAQ umum untuk Copilot.

Konten terkait

Untuk informasi selengkapnya tentang mengelola kebijakan, lihat:

• Tutorial: Mengubah dan melindungi API Anda
• Referensi Kebijakan untuk daftar lengkap pernyataan kebijakan dan pengaturannya
• Pernyataan kebijakan
• Mengatur atau mengedit kebijakan
• Gunakan ulang konfigurasi kebijakan
• Repositori cuplikan kebijakan
• Repo sampel kebijakan
• Toolkit kebijakan untuk Azure API Management
• Mendapatkan bantuan Copilot untuk membuat, menjelaskan, dan memecahkan masalah kebijakan