Opakované použití konfigurací zásad v definicích zásad API Management

V tomto článku se dozvíte, jak vytvářet a používat fragmenty zásad v definicích zásad API Management. Fragmenty zásad jsou centrálně spravované a opakovaně použitelné fragmenty XML obsahující jednu nebo více konfigurací zásad API Management.

Fragmenty zásad pomáhají konzistentně konfigurovat zásady a udržovat definice zásad, aniž byste museli opakovat nebo znovu zadávat kód XML.

Fragment zásad:

  • Musí být platný XML obsahující jednu nebo více konfigurací zásad.
  • Může obsahovat výrazy zásad, pokud je odkazovaná zásada podporuje.
  • Vloží se tak, jak je v definici zásad pomocí zásady zahrnutí fragmentu .

Omezení:

  • Fragment zásad nemůže obsahovat identifikátor oddílu zásad (<inbound>atd <outbound>.) ani <base/> prvek.
  • V současné době fragment zásad nemůže vnořit další fragment zásad.

Požadavky

Pokud ještě nemáte instanci API Management a back-endové rozhraní API, přečtěte si téma:

I když to není nutné, můžete chtít nakonfigurovat jednu nebo více definic zásad. Při vytváření fragmentů zásad můžete z těchto definic kopírovat prvky zásad.

Přejít k instanci služby API Management

  1. V Azure Portal vyhledejte a vyberte služby API Management.

    Select API Management services

  2. Na stránce API Management služeb vyberte vaši instanci API Management.

    Select your API Management instance

Vytvoření fragmentu zásad

  1. V levém navigačním panelu instance API Management v části Rozhraní API vyberte fragmenty> zásad+ Vytvořit.

  2. V okně Vytvořit nový fragment zásad zadejte název a volitelný popis fragmentu zásady. Název musí být jedinečný v rámci vaší instance API Management.

    Příklad názvu: ForwardContext

  3. V editoru fragmentů zásad XML zadejte nebo vložte jeden nebo více elementů XML zásad mezi značkami <fragment> a </fragment> značkami.

    Screenshot showing the create a new policy fragment form.

    Například následující fragment obsahuje set-header konfiguraci zásad pro předávání kontextových informací do back-endové služby. Tento fragment by byl součástí oddílu příchozích zásad. Výrazy zásad v tomto příkladu přistupují k předdefinované context proměnné.

    <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. Vyberte Vytvořit. Fragment se přidá do seznamu fragmentů zásad.

Zahrnutí fragmentu do definice zásady

include-fragment Nakonfigurujte zásadu tak, aby vložil fragment zásad do definice zásady. Další informace o definicích zásad najdete v tématu Nastavení nebo úprava zásad.

  • Můžete zahrnout fragment v libovolném rozsahu a v libovolné části zásad, pokud základní zásady nebo zásady v fragmentu podporují toto využití.
  • Do definice zásady můžete zahrnout více fragmentů zásad.

Například vložte fragment zásady s názvem ForwardContext do oddílu příchozích zásad:

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

Tip

Pokud chcete zobrazit obsah zahrnutého fragmentu zobrazeného v definici zásady, vyberte v editoru zásad vypočítat efektivní zásady .

Správa fragmentů zásad

Po vytvoření fragmentu zásad můžete kdykoli zobrazit a aktualizovat vlastnosti fragmentu zásady nebo odstranit fragment zásad.

Zobrazení vlastností fragmentu zásady:

  1. V levém navigačním panelu vaší instance API Management v části Rozhraní API vyberte fragmenty zásad. Vyberte název fragmentu.
  2. Na stránce Přehled si projděte odkazy na dokument Zásady a podívejte se na definice zásad, které obsahují fragment.
  3. Na stránce Vlastnosti zkontrolujte název a popis fragmentu zásady. Název nejde změnit.

Úprava fragmentu zásad:

  1. V levém navigačním panelu vaší instance API Management v části Rozhraní API vyberte fragmenty zásad. Vyberte název fragmentu.
  2. Vyberte Editor zásad.
  3. Aktualizujte příkazy v fragmentu a pak vyberte Použít.

Poznámka

Aktualizace ovlivňuje všechny definice zásad, ve kterých je fragment zahrnutý.

Odstranění fragmentu zásad:

  1. V levém navigačním panelu vaší instance API Management v části Rozhraní API vyberte fragmenty zásad. Vyberte název fragmentu.
  2. Projděte si referenční informace k dokumentům zásad pro definice zásad, které obsahují fragment. Před odstraněním fragmentu je nutné odebrat odkazy na fragmenty ze všech definic zásad.
  3. Po odebrání všechodkazůch

Další kroky

Další informace o práci se zásadami najdete v tématech: