Ange rubrik
GÄLLER FÖR: Alla API Management-nivåer
Principen set-header
tilldelar ett värde till ett befintligt HTTP-svar och/eller begärandehuvud eller lägger till ett nytt svar och/eller begärandehuvud.
Använd principen för att infoga en lista över HTTP-huvuden i ett HTTP-meddelande. När den placeras i en inkommande pipeline anger den här principen HTTP-huvudena för begäran som skickas till måltjänsten. När den placeras i en utgående pipeline anger den här principen HTTP-huvudena för svaret som skickas till gatewayens klient.
Kommentar
Ange principens element och underordnade element i den ordning som anges i principbeskrivningen. För att hjälpa dig att konfigurera den här principen tillhandahåller portalen en guidad, formulärbaserad redigerare. Läs mer om hur du anger eller redigerar API Management-principer.
Principuttryck
<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>
Attribut
Namn | beskrivning | Obligatoriskt | Standardvärde |
---|---|---|---|
exists-action | Anger vilken åtgärd som ska vidtas när huvudet redan har angetts. Det här attributet måste ha något av följande värden. - override – ersätter värdet för det befintliga huvudet.- skip – ersätter inte det befintliga huvudvärdet.- append – lägger till värdet i det befintliga huvudvärdet.- delete – tar bort huvudet från begäran.När värdet är override anger du flera poster med samma namn, vilket resulterar i att rubriken anges enligt alla poster (som visas flera gånger). Endast angivna värden anges i resultatet. Principuttryck tillåts. |
Nej | override |
name | Anger namnet på rubriken som ska anges. Principuttryck tillåts. | Ja | Ej tillämpligt |
Element
Name | beskrivning | Obligatoriskt |
---|---|---|
värde | Anger namnet på det värde som ska anges. Principuttryck tillåts. Lägg till ytterligare value element för flera rubriker med samma namn. |
Nej |
Användning
- Principavsnitt: inkommande, utgående, serverdel, on-error
- Principomfattningar: global, arbetsyta, produkt, API, åtgärd
- Gatewayer: klassisk, v2, förbrukning, lokalt installerad, arbetsyta
Användningsanteckningar
Flera värden för en rubrik sammanfogas till en CSV-sträng, till exempel:
headerName: value1,value2,value3
Undantag inkluderar standardiserade rubriker vars värden:
- kan innehålla kommatecken (
User-Agent
,WWW-Authenticate
,Proxy-Authenticate
) - kan innehålla datum (
Cookie
,Set-Cookie
,Warning
), - innehåller datum (
Date
,Expires
,If-Modified-Since
,If-Unmodified-Since
,Last-Modified
,Retry-After
).
Vid dessa undantag sammanfogas inte flera rubrikvärden till en sträng och skickas som separata rubriker, till exempel:
User-Agent: value1
User-Agent: value2
User-Agent: value3
Följande begränsningar gäller:
Server
Det går inte att ta bort huvudet.- Rubriker:
Connection
,ContentLength
,KeepAlive
,TransferEncoding
kan inte ändras eller tas bort.
Exempel
Lägg till rubrik, åsidosätt befintlig
<set-header name="some header name" exists-action="override">
<value>20</value>
</set-header>
Ta bort sidhuvud
<set-header name="some header name" exists-action="delete" />
Vidarebefordra kontextinformation till serverdelstjänsten
Det här exemplet visar hur du tillämpar principer på API-nivå för att tillhandahålla kontextinformation till serverdelstjänsten.
<!-- 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>
Mer information finns i Principuttryck och Kontextvariabel.
Relaterade principer
Relaterat innehåll
Mer information om hur du arbetar med principer finns i:
- Självstudie: Transformera och skydda ditt API
- Principreferens för en fullständig lista över principinstruktioner och deras inställningar
- Principuttryck
- Ange eller redigera principer
- Återanvända principkonfigurationer
- Lagringsplats för principfragment
- Skapa principer med Microsoft Copilot i Azure