Mengatur parameter string kueri
BERLAKU UNTUK: Semua tingkatAN API Management
Kebijakan set-query-parameter menambahkan, mengganti nilai, atau menghapus permintaan parameter string kueri. Dapat digunakan untuk meneruskan parameter kueri yang diharapkan oleh layanan backend yang opsional atau tidak pernah ada dalam permintaan.
Catatan
Tetapkan elemen kebijakan dan elemen turunan dalam urutan yang disediakan dalam pernyataan kebijakan. Untuk membantu Anda mengonfigurasi kebijakan ini, portal menyediakan editor berbasis formulir berikut panduannya. Pelajari lebih lanjut cara mengatur atau mengedit kebijakan API Management.
Pernyataan kebijakan
<set-query-parameter name="param name" exists-action="override | skip | append | delete">
<value>value</value> <!--for multiple parameters with the same name add additional value elements-->
</set-query-parameter>
Atribut
| Nama | Deskripsi | Wajib diisi | Default |
|---|---|---|---|
| exists-action | Menentukan tindakan apa yang harus diambil ketika parameter kueri sudah ditentukan. Atribut ini harus memiliki salah satu nilai berikut. - override - menggantikan nilai parameter yang ada.- skip - tidak menggantikan nilai parameter kueri yang ada.- append - menambahkan nilai ke nilai parameter kueri yang ada.- delete - menghapus parameter kueri dari permintaan.Ketika disetel ke override, mendaftarkan beberapa entri dengan nama yang sama menghasilkan parameter kueri yang disetel sesuai dengan semua entri (yang akan dicantumkan beberapa kali); hanya nilai yang terdaftar yang akan ditetapkan dalam hasil.Ekspresi kebijakan diizinkan. |
No | override |
| nama | Menentukan nama parameter kueri yang akan ditetapkan. Ekspresi kebijakan diizinkan. | Ya | T/A |
Elemen
| Nama | Deskripsi | Wajib diisi |
|---|---|---|
| value | Menentukan nilai parameter kueri yang akan ditetapkan. Untuk beberapa parameter kueri dengan nama yang sama, tambahkan elemen tambahan value . Ekspresi kebijakan diizinkan. |
Ya |
Penggunaan
- Bagian kebijakan: masuk, backend
- Cakupan kebijakan: global, ruang kerja, produk, API, operasi
- Gateway: klasik, v2, konsumsi, dihost sendiri, ruang kerja
Contoh
Atur nilai parameter kueri
<set-query-parameter name="api-key" exists-action="skip">
<value>12345678901</value>
</set-query-parameter>
Mengatur parameter kueri untuk meneruskan konteks ke backend
Contoh ini menunjukkan cara menerapkan kebijakan di tingkat API untuk memasok informasi konteks ke layanan backend.
<!-- Copy this snippet into the inbound element to forward a piece of context, product name in this example, to the backend service for logging or evaluation -->
<set-query-parameter name="x-product-name" exists-action="override">
<value>@(context.Product.Name)</value>
</set-query-parameter>
Untuk informasi selengkapnya, lihat Ekspresi kebijakan dan Variabel konteks.
Kebijakan terkait
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
- Toolkit kebijakan Azure API Management
- Kebijakan penulis menggunakan Microsoft Copilot di Azure