Fejléc beállítása

Cikk
03/18/2024

A KÖVETKEZŐRE VONATKOZIK: Minden API Management-szint

A set-header szabályzat egy értéket rendel egy meglévő HTTP-válaszhoz és/vagy kérelemfejléchez, vagy új válasz- és/vagy kérelemfejlécet ad hozzá.

A szabályzattal HTTP-fejlécek listáját szúrhatja be EGY HTTP-üzenetbe. Bejövő folyamatba helyezéskor ez a szabályzat beállítja a célszolgáltatásnak átadott kérés HTTP-fejléceit. Kimenő folyamatba helyezéskor ez a szabályzat beállítja az átjáró ügyfélének küldött válasz HTTP-fejléceit.

Feljegyzés

Állítsa be a szabályzat elemeit és gyermekelemeit a szabályzatutasításban megadott sorrendben. A szabályzat konfigurálásához a portál egy irányított, űrlapalapú szerkesztőt biztosít. További információ az API Management-szabályzatok beállításáról és szerkesztéséről.

Szabályzatutasítás

<set-header name="header name" exists-action="override | skip | append | delete">
    <value>value</value> <!--for multiple headers with the same name add additional value elements-->
</set-header>

Attribútumok

Név	Leírás	Kötelező	Alapértelmezett
exists-action	Megadja a fejléc megadásakor végrehajtandó műveletet. Ennek az attribútumnak az alábbi értékek egyikével kell rendelkeznie. - `override` - a meglévő fejléc értékét cseréli le. - `skip` - nem helyettesíti a meglévő fejlécértéket. - `append` - hozzáfűzi az értéket a meglévő fejlécértékhez. - `delete` - eltávolítja a fejlécet a kérelemből. `override`Ha több, azonos nevű bejegyzést vesz fel, a fejléc az összes bejegyzésnek megfelelően lesz beállítva (amely többször szerepel a listában); csak a felsorolt értékek lesznek beállítva az eredményben. A szabályzatkifejezések engedélyezettek.	Nem	`override`
név	Megadja a beállítani kívánt fejléc nevét. A szabályzatkifejezések engedélyezettek.	Igen	n/a

Elemek

Név	Leírás	Kötelező
Érték	Megadja a beállítandó fejléc értékét. A szabályzatkifejezések engedélyezettek. Több azonos nevű fejléc esetén adjon hozzá további `value` elemeket.	Nem

Használat

Szabályzatszakaszok: bejövő, kimenő, háttérrendszer, hiba
Szabályzathatókörök: globális, munkaterület, termék, API, művelet
Átjárók: klasszikus, v2, használat, saját üzemeltetésű

Használati megjegyzések

Egy fejléc több értéke összefűzve van egy CSV-sztringgel, például:

headerName: value1,value2,value3

A kivételek közé tartoznak azok a szabványos fejlécek, amelyek értékei:

tartalmazhat vesszőt (User-Agent, WWW-Authenticate, Proxy-Authenticate)
dátumot (Cookie, Set-Cookie, ), Warning
dátumot tartalmaz (Date, Expires, If-Modified-Since, If-Unmodified-Since, Last-Modified, ). Retry-After

Ilyen kivételek esetén több fejlécérték nem lesz összefűzve egy sztringbe, és külön fejlécként lesz átadva, például:

User-Agent: value1
User-Agent: value2
User-Agent: value3

A következő korlátozások érvényesek:

Az Server élőfej eltávolítása nem támogatott.
Fejlécek: Connection, ContentLength, KeepAliveTransferEncoding nem módosítható vagy törölhető.

Példák

Fejléc hozzáadása, meglévő felülbírálása

<set-header name="some header name" exists-action="override">
    <value>20</value>
</set-header>

Fejléc eltávolítása

 <set-header name="some header name" exists-action="delete" />

Környezeti információk továbbítása a háttérszolgáltatásnak

Ez a példa bemutatja, hogyan alkalmazhat házirendet API-szinten a háttérszolgáltatás környezeti információinak megadására.

<!-- Copy this snippet into the inbound element to forward some context information, user id and the region the gateway is hosted in, to the backend service for logging or evaluation -->
<set-header name="x-request-context-data" exists-action="override">
  <value>@(context.User.Id)</value>
  <value>@(context.Deployment.Region)</value>
</set-header>

További információ: Szabályzatkifejezések és környezeti változó.