Beleidsconfiguraties opnieuw gebruiken in uw API Management beleidsdefinities

In dit artikel wordt beschreven hoe u beleidsfragmenten maakt en gebruikt in uw API Management beleidsdefinities. Beleidsfragmenten zijn centraal beheerde, herbruikbare XML-fragmenten die een of meer API Management beleidsconfiguraties bevatten.

Met beleidsfragmenten kunt u beleidsregels consistent configureren en beleidsdefinities onderhouden zonder XML-code te herhalen of opnieuw te hoeven invoeren.

Een beleidsfragment:

Beperkingen:

  • Een beleidsfragment kan geen beleidssectie-id (<inbound>, <outbound>, enzovoort) of het <base/> -element bevatten.
  • Op dit moment kan een beleidsfragment geen ander beleidsfragment nesten.

Vereisten

Als u nog geen API Management-exemplaar en back-end-API hebt, raadpleegt u:

Hoewel dit niet vereist is, wilt u mogelijk een of meer beleidsdefinities configureren . U kunt beleidselementen uit deze definities kopiƫren bij het maken van beleidsfragmenten.

Ga naar uw API Management-exemplaar

  1. Zoek in de Azure-portal naar API Management-services en selecteer dit.

    API Management-services selecteren

  2. Selecteer uw API Management-exemplaar op de pagina API Management-services.

    Uw API Management-exemplaar selecteren

Een beleidsfragment maken

  1. Selecteer in de linkernavigatiebalk van uw API Management-exemplaar onder API's de optie Beleidsfragmenten>+ Maken.

  2. Voer in het venster Een nieuw beleidsfragment maken een naam en een optionele beschrijving van het beleidsfragment in. De naam moet uniek zijn binnen uw API Management exemplaar.

    Voorbeeldnaam: ForwardContext

  3. Typ of plak in de xml-beleidsfragmenteditor een of meer XML-beleidselementen tussen de <fragment> tags en </fragment> .

    Schermopname van het formulier Een nieuw beleidsfragment maken.

    Het volgende fragment bevat bijvoorbeeld een set-header beleidsconfiguratie om contextinformatie door te sturen naar een back-endservice. Dit fragment wordt opgenomen in een sectie voor inkomend beleid. De beleidsexpressies in dit voorbeeld hebben toegang tot de ingebouwde context variabele.

    <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. Selecteer Maken. Het fragment wordt toegevoegd aan de lijst met beleidsfragmenten.

Een fragment opnemen in een beleidsdefinitie

Configureer het include-fragment beleid om een beleidsfragment in te voegen in een beleidsdefinitie. Zie Beleid instellen of bewerken voor meer informatie over beleidsdefinities.

  • U kunt een fragment opnemen in elk bereik en in een beleidssectie, zolang het onderliggende beleid of de onderliggende beleidsregels in het fragment dat gebruik ondersteunen.
  • U kunt meerdere beleidsfragmenten opnemen in een beleidsdefinitie.

Voeg bijvoorbeeld het beleidsfragment met de naam ForwardContext in de sectie voor binnenkomend beleid in:

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

Tip

Als u de inhoud van een opgenomen fragment wilt zien dat wordt weergegeven in de beleidsdefinitie, selecteert u Effectief beleid berekenen in de beleidseditor.

Beleidsfragmenten beheren

Nadat u een beleidsfragment hebt gemaakt, kunt u de eigenschappen van een beleidsfragment weergeven en bijwerken of het beleidsfragment op elk gewenst moment verwijderen.

Eigenschappen van een beleidsfragment weergeven:

  1. Selecteer in de linkernavigatiebalk van uw API Management-exemplaar onder API's de optie Beleidsfragmenten. Selecteer de naam van het fragment.
  2. Bekijk op de pagina Overzicht de beleidsdocumentverwijzingen om de beleidsdefinities te zien die het fragment bevatten.
  3. Controleer op de pagina Eigenschappen de naam en beschrijving van het beleidsfragment. De naam kan niet worden gewijzigd.

Een beleidsfragment bewerken:

  1. Selecteer in de linkernavigatiebalk van uw API Management-exemplaar onder API's de optie Beleidsfragmenten. Selecteer de naam van het fragment.
  2. Selecteer Beleidseditor.
  3. Werk de instructies in het fragment bij en selecteer vervolgens Toepassen.

Notitie

Update is van invloed op alle beleidsdefinities waarin het fragment is opgenomen.

Een beleidsfragment verwijderen:

  1. Selecteer in de linkernavigatiebalk van uw API Management-exemplaar onder API's de optie Beleidsfragmenten. Selecteer de naam van het fragment.
  2. Raadpleeg beleidsdocumentverwijzingen voor beleidsdefinities die het fragment bevatten. Voordat een fragment kan worden verwijderd, moet u de fragmentverwijzingen uit alle beleidsdefinities verwijderen.
  3. Nadat alle verwijzingen zijn verwijderd, selecteert u Verwijderen.

Volgende stappen

Zie voor meer informatie over het werken met beleid: