Opakované použití konfigurací zásad v definicích zásad pro správu rozhraní API

PLATÍ PRO: Všechny úrovně služby API Management

Tento článek ukazuje, jak vytvářet a používat fragmenty zásad policy v definicích zásad Azure API Management. Fragmenty zásad jsou centrálně spravované a opakovaně použitelné fragmenty kódu XML, které obsahují jednu nebo více konfigurací zásad služby API Management.

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

Fragment zásad:

  • Musí být platný KÓD XML, který obsahuje jednu nebo více konfigurací zásad.
  • Výrazy zásad můžou zahrnovat, pokud je odkazovaná zásada podporuje.
  • as-is je vloženo do definice zásady prostřednictvím zásady zahrnutí fragmentu.

Omezení:

  • Fragment zásad nemůže obsahovat identifikátor oddílu zásad (<inbound><outbound>například) ani <base/> prvek.
  • V současné době fragment zásad nemůže vnořit do sebe další fragment zásad.
  • Maximální velikost fragmentu zásad je 512 kB.

Požadavky

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

I když to není nutné, možná budete 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. Na portálu Azure vyhledejte a vyberte Služby správyAPI:

    Snímek obrazovky zobrazící služby API Management ve výsledcích hledání

  2. Na stránce služby API Management vyberte instanci služby API Management:

    snímek obrazovky znázorňující instanci služby API Management na stránce služeb API Management

Vytvořte fragment zásad

  1. V levém podokně instance služby API Management v části Rozhraní API vyberte fragmenty zásad. V podokně Fragmenty zásad vyberte + 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 služby API Management.

    Příklad názvu: ForwardContext

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

    Okno pro vytvoření nového fragmentu zásad na snímku obrazovky.

    Následující fragment obsahuje set-header například konfiguraci zásad pro předávání kontextových informací back-endové službě. Tento fragment by byl zahrnut do oddílu zásad pro příchozí. 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á k seznamu fragmentů zásad.

Zahrňte fragment do definice zásady

Použijte zásadu include-fragment k vložení fragmentu zásady do definice zásady. Další informace o definicích zásad najdete v tématu Nastavení nebo úprava zásad.

  • Fragment můžete zahrnout v libovolném rozsahu a v libovolné části zásad, pokud základní zásady nebo zásady v fragmentu podporují 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>
[...]

Doporučení

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

Správa fragmentů zásad

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

Jak zobrazit vlastnosti fragmentu zásady:

  1. V levém podokně instance služby API Management v části Rozhraní API vyberte fragmenty zásad. Vyberte název fragmentu.
  2. Na stránce Přehled si prohlédněte odkazy na dokument Zásady a podívejte se na definice zásad, které obsahují fragment.
  3. Na stránce Vlastnosti v části Nastavení zkontrolujte název a popis fragmentu zásad. Název nelze změnit.

Úprava fragmentu zásad:

  1. V levém podokně instance služby API Management v části Rozhraní API vyberte fragmenty zásad. Vyberte název fragmentu.
  2. V části Nastavení vyberte Editor zásad.
  3. Aktualizujte příkazy v fragmentu a pak vyberte Použít.

Poznámka:

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

Odstranění fragmentu zásad:

  1. V levém podokně instance služby 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šech odkazů vyberte Odstranit.

Vytváření pokročilých kanálů s fragmenty zásad

Fragmenty lze použít k vytváření pokročilých scénářů pipeline s vlastním chováním, které se provádí během životního cyklu požadavku a odezvy. Mezi klíčová doporučení pro kanály založené na fragmentech patří:

  • Modularita – návrh každého fragmentu s jednou dobře definovanou odpovědností zaměřenou na jeden konkrétní problém.
  • Sdílení dat – Používejte kontextové proměnné a ukládání centrálních metadat do mezipaměti pro sdílení dat mezi fragmenty.
  • Chování při provádění fragmentů – Definujte chování provádění vložením fragmentů postupně do definic zásad produktů a rozhraní API na základě rozsahu.
  • Optimalizace výkonu – Postupujte podle pokynů k výkonu pro maximální efektivitu.

Pokročilé vedení pro potrubí

Úplné pokyny k vytváření pokročilých návrhů fragmentů zásad najdete v těchto článcích:

Související obsah

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

  • Last updated on