Dela via

Återanvända principkonfigurationer i api Management-principdefinitioner

GÄLLER FÖR: Alla API Management-nivåer

Den här artikeln visar hur du skapar och använder principfragment i azure API Management-principdefinitioner. Principfragment är centralt hanterade, återanvändbara XML-kodfragment som innehåller en eller flera API Management-principkonfigurationer .

Principfragment hjälper dig att konfigurera principer konsekvent och underhålla principdefinitioner utan att behöva upprepa eller skriva om XML-kod.

Ett principfragment:

  • Måste vara giltig XML som innehåller en eller flera principkonfigurationer.
  • Kan innehålla principuttryck om en refererad princip stöder dem.
  • Införs as-is i en policydefinition via policyn include-fragment.

Begränsningar:

  • Ett principfragment kan inte innehålla en principavsnittsidentifierare (<inbound>till <outbound>exempel) eller elementet <base/> .
  • För närvarande kan ett principfragment inte kapsla ett annat principfragment.
  • Den maximala storleken på ett principfragment är 32 KB.

Förutsättningar

Om du inte redan har en API Management-instans och ett serverdels-API kan du läsa:

Även om det inte krävs kanske du vill konfigurera en eller flera principdefinitioner. Du kan kopiera principelement från dessa definitioner när du skapar principfragment.

Gå till API Management-instansen

  1. I Azure -portalensöker du efter och väljer API Management-tjänster:

    Skärmbild som visar API Management-tjänster i sökresultaten.

  2. På sidan API Management Services väljer du din API Management-instans:

    Skärmbild som visar en API Management-instans på sidan API Management-tjänster.

Skapa ett principfragment

  1. I den vänstra rutan i API Management-instansen går du till API:er och väljer Principfragment. I rutan Policyfragment väljer du + Skapa.

  2. I fönstret Skapa ett nytt principfragment anger du ett Namn och, om du vill, en beskrivning av principfragmentet. Namnet måste vara unikt i DIN API Management-instans.

    Exempelnamn: ForwardContext

  3. I redigeraren för XML-principfragment skriver eller klistrar du in ett eller flera princip-XML-element mellan taggarna <fragment> och </fragment> :

    Skärmbild som visar fönstret Skapa ett nytt principfragment.

    Följande fragment innehåller till exempel en set-header principkonfiguration för att vidarebefordra kontextinformation till en serverdelstjänst. Det här fragmentet skulle ingå i ett avsnitt om inkommande principer. Principuttrycken i det här exemplet har åtkomst till den inbyggda context variabeln.

    <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. Välj Skapa. Fragmentet läggs till i listan över principfragment.

Inkludera ett fragment i en principdefinition

Använd principen include-fragment för att infoga ett principfragment i en principdefinition. Mer information om principdefinitioner finns i Ange eller redigera principer.

  • Du kan inkludera ett fragment i valfritt omfång och i valfritt principavsnitt, så länge den underliggande principen eller principerna i fragmentet stöder användningen.
  • Du kan inkludera flera principfragment i en principdefinition.

Infoga till exempel principfragmentet med namnet ForwardContext i avsnittet inkommande princip:

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

Dricks

Om du vill se innehållet i ett inkluderat fragment som visas i principdefinitionen väljer du Beräkna effektiv princip i principredigeraren.

Hantera principfragment

När du har skapat ett principfragment kan du visa och uppdatera dess egenskaper eller ta bort det när som helst.

Så här visar du egenskaperna för ett principfragment:

  1. I den vänstra rutan i API Management-instansen går du till API:er och väljer Principfragment. Välj namnet på fragmentet.
  2. På sidan Översikt granskar du referenserna för principdokumentet för att se de principdefinitioner som innehåller fragmentet.
  3. På sidan Egenskaper går du igenom namnet och beskrivningen av principfragmentet under Inställningar. Det går inte att ändra namnet.

Så här redigerar du ett principfragment:

  1. I den vänstra rutan i API Management-instansen går du till API:er och väljer Principfragment. Välj namnet på fragmentet.
  2. Under Inställningar väljer du Principredigerare.
  3. Uppdatera uttrycken i fragmentet och välj sedan Använd.

Kommentar

Uppdateringar påverkar alla principdefinitioner där fragmentet ingår.

Så här tar du bort ett principfragment:

  1. I den vänstra rutan i API Management-instansen går du till API:er och väljer Principfragment. Välj namnet på fragmentet.
  2. Granska referenserna till principdokumentet för principdefinitioner som innehåller fragmentet. Innan du tar bort ett fragment måste du ta bort fragmentreferenserna från alla principdefinitioner.
  3. När alla referenser har tagits bort väljer du Ta bort.

Relaterat innehåll

Mer information om hur du arbetar med principer finns i: