Menggunakan kembali konfigurasi kebijakan dalam definisi kebijakan API Management Anda

  • Artikel

BERLAKU UNTUK: Semua tingkatAN API Management

Artikel ini memperlihatkan kepada Anda cara membuat dan menggunakan fragmen kebijakan dalam definisi kebijakan API Management Anda. Fragmen kebijakan dikelola secara terpusat, cuplikan XML yang dapat digunakan kembali yang berisi satu atau beberapa konfigurasi kebijakan API Management.

Fragmen kebijakan membantu Anda mengonfigurasi kebijakan secara konsisten dan mempertahankan definisi kebijakan tanpa perlu mengulangi atau mengetik ulang kode XML.

Fragmen kebijakan:

  • Harus xml valid yang berisi satu atau beberapa konfigurasi kebijakan
  • Dapat menyertakan ekspresi kebijakan, jika kebijakan yang direferensikan mendukungnya
  • Dimasukkan apa adanya dalam definisi kebijakan dengan menggunakan kebijakan include-fragment

Batasan:

  • Fragmen kebijakan tidak dapat menyertakan pengidentifikasi bagian kebijakan (<inbound>, <outbound>, dll.) atau elemen <base/>.
  • Saat ini, fragmen kebijakan tidak dapat menumpuk fragmen kebijakan lain.
  • Ukuran maksimum fragmen kebijakan adalah 32 KB.

Prasyarat

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

Meskipun tidak diperlukan, Anda mungkin ingin mengonfigurasi satu atau beberapa definisi kebijakan. Anda dapat menyalin elemen kebijakan dari definisi ini saat membuat fragmen kebijakan.

Membuka instans API Management Anda

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

    Pilih layanan API Management

  2. Di halaman layanan API Management, pilih instans API Management Anda.

    Pilih instans API Management Anda

Membuat fragmen kebijakan

  1. Di navigasi kiri instans API Management Anda, di bawah API, pilih Fragmen kebijakan>+ Buat.

  2. Di jendela Buat fragmen kebijakan baru, masukkan Nama dan Deskripsi opsional fragmen kebijakan. Nama harus unik dalam instans API Management Anda.

    Contoh nama: ForwardContext

  3. Di editor fragmen kebijakan XML, ketik atau tempel satu atau beberapa elemen XML kebijakan antara tag <fragment> dan </fragment>.

    Cuplikan layar memperlihatkan formulir buat fragmen kebijakan baru.

    Misalnya, fragmen berikut berisi konfigurasi kebijakan set-header untuk meneruskan informasi konteks ke layanan backend. Fragmen ini akan disertakan dalam bagian kebijakan masuk. Ekspresi kebijakan dalam contoh ini mengakses variabel contextbawaan.

    <fragment>
    <set-header name="x-request-context-data" exists-action="override">
      <value>@(context.User.Id)</value>
      <value>@(context.Deployment.Region)</value>
    </set-header>
</fragment>

  4. Pilih Buat. Fragmen ditambahkan ke daftar fragmen kebijakan.

Menyertakan fragmen dalam definisi kebijakan

Konfigurasikan kebijakan include-fragment untuk menyisipkan fragmen kebijakan dalam definisi kebijakan. Untuk informasi selengkapnya tentang mengonfigurasi kebijakan, lihat Kebijakan dalam API Management.

  • Anda dapat menyertakan fragmen pada cakupan apa pun dan di bagian kebijakan apa pun, selama kebijakan atau kebijakan yang mendasar dalam fragmen mendukung penggunaan tersebut.
  • Anda dapat menyertakan beberapa fragmen kebijakan dalam definisi kebijakan.

Misalnya, sisipkan fragmen kebijakan bernama ForwardContext di bagian kebijakan masuk:

<policies>
    <inbound>
        <include-fragment fragment-id="ForwardContext" />
        <base />
    </inbound>
[...]

Tip

Untuk melihat konten fragmen yang disertakan yang ditampilkan dalam definisi kebijakan, pilih Hitung kebijakan yang efektif di editor kebijakan.

Mengelola fragmen kebijakan

Setelah membuat fragmen kebijakan, Anda dapat melihat dan memperbarui properti kebijakan, atau menghapus kebijakan kapan saja.

Untuk melihat properti fragmen kebijakan:

  1. Di navigasi kiri instans API Management Anda, di bawah API, pilih Fragmen kebijakan. Pilih nama registri Anda.
  2. Pada halaman Gambaran Umum, tinjau referensi dokumen Azure Policy untuk melihat definisi kebijakan yang menyertakan fragmen.
  3. Pada halaman Properti, tinjau nama dan deskripsi fragmen kebijakan. Nama tidak dapat diubah nanti.

Untuk mengedit fragmen kebijakan:

  1. Di navigasi kiri instans API Management Anda, di bawah API, pilih Fragmen kebijakan. Pilih nama registri Anda.
  2. Pilih Editor kebijakan.
  3. Perbarui pernyataan dalam fragmen lalu pilih Terapkan.

Catatan

Pembaruan memengaruhi semua definisi kebijakan tempat fragmen disertakan.

Untuk menghapus fragmen kebijakan:

  1. Di navigasi kiri instans API Management Anda, di bawah API, pilih Fragmen kebijakan. Pilih nama registri Anda.
  2. Tinjau Referensi dokumen Kebijakan untuk definisi kebijakan yang menyertakan fragmen. Sebelum fragmen dapat dihapus, Anda harus menghapus referensi fragmen dari semua definisi kebijakan.
  3. Setelah semua referensi dihapus, pilih Hapus.

Konten terkait

Untuk informasi selengkapnya tentang bekerja dengan kebijakan, lihat: