Ponowne używanie konfiguracji zasad w definicjach zasad usługi API Management

  • Artykuł

DOTYCZY: Wszystkie warstwy usługi API Management

W tym artykule pokazano, jak tworzyć fragmenty zasad i używać ich w definicjach zasad usługi API Management. Fragmenty zasad są centralnie zarządzane, fragmenty kodu XML wielokrotnego użytku zawierające co najmniej jedną konfigurację zasad usługi API Management.

Fragmenty zasad ułatwiają spójne konfigurowanie zasad i utrzymywanie definicji zasad bez konieczności powtarzania lub ponownego wpisywania kodu XML.

Fragment zasad:

  • Musi być prawidłowym plikiem XML zawierającym co najmniej jedną konfigurację zasad
  • Może zawierać wyrażenia zasad, jeśli zasady, do których odwołuje się odwołanie, obsługują je
  • Jest wstawiany zgodnie z definicją zasad przy użyciu zasad include-fragment

Ograniczenia:

  • Fragment zasad nie może zawierać identyfikatora sekcji zasad (<inbound>, <outbound>itp.) ani <base/> elementu.
  • Obecnie fragment zasad nie może zagnieżdżać innego fragmentu zasad.
  • Maksymalny rozmiar fragmentu zasad wynosi 32 KB.

Wymagania wstępne

Jeśli nie masz jeszcze wystąpienia usługi API Management i interfejsu API zaplecza, zobacz:

Chociaż nie jest to wymagane, możesz skonfigurować co najmniej jedną definicję zasad. Elementy zasad można kopiować z tych definicji podczas tworzenia fragmentów zasad.

Przechodzenie do wystąpienia usługi API Management

  1. W witrynie Azure Portal wyszukaj i wybierz pozycję Usługi API Management.

    Wybieranie usług API Management

  2. Na stronie Usługi API Management wybierz wystąpienie usługi API Management.

    Wybieranie wystąpienia usługi API Management

Tworzenie fragmentu zasad

  1. W lewym obszarze nawigacji wystąpienia usługi API Management w obszarze Interfejsy> API wybierz pozycję Fragmenty zasad+ Utwórz.

  2. W oknie Tworzenie nowego fragmentu zasad wprowadź nazwę i opcjonalny opis fragmentu zasad. Nazwa musi być unikatowa w wystąpieniu usługi API Management.

    Przykładowa nazwa: ForwardContext

  3. W edytorze fragmentów zasad XML wpisz lub wklej co najmniej jeden element XML zasad między tagami <fragment> i </fragment> .

    Zrzut ekranu przedstawiający formularz tworzenia nowego fragmentu zasad.

    Na przykład poniższy fragment zawiera konfigurację zasad do set-header przekazywania informacji kontekstowych do usługi zaplecza. Ten fragment zostanie uwzględniony w sekcji zasad dla ruchu przychodzącego. Wyrażenia zasad w tym przykładzie uzyskują dostęp do wbudowanej context zmiennej.

    <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. Wybierz pozycję Utwórz. Fragment jest dodawany do listy fragmentów zasad.

Dołączanie fragmentu do definicji zasad

Skonfiguruj zasady w include-fragment celu wstawienia fragmentu zasad w definicji zasad. Aby uzyskać więcej informacji na temat definicji zasad, zobacz Ustawianie lub edytowanie zasad.

  • Fragment można uwzględnić w dowolnym zakresie i w dowolnej sekcji zasad, o ile bazowe zasady lub zasady w fragmentach obsługują to użycie.
  • Możesz uwzględnić wiele fragmentów zasad w definicji zasad.

Na przykład wstaw fragment zasad o nazwie ForwardContext w sekcji zasad dla ruchu przychodzącego:

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

Napiwek

Aby wyświetlić zawartość dołączonego fragmentu wyświetlanego w definicji zasad, wybierz pozycję Oblicz obowiązujące zasady w edytorze zasad.

Zarządzanie fragmentami zasad

Po utworzeniu fragmentu zasad można wyświetlić i zaktualizować właściwości fragmentu zasad lub usunąć fragment zasad w dowolnym momencie.

Aby wyświetlić właściwości fragmentu zasad:

  1. W lewym obszarze nawigacji wystąpienia usługi API Management w obszarze Interfejsy API wybierz pozycję Fragmenty zasad. Wybierz nazwę fragmentu.
  2. Na stronie Przegląd przejrzyj odwołania do dokumentu Zasady, aby wyświetlić definicje zasad, które zawierają fragment.
  3. Na stronie Właściwości przejrzyj nazwę i opis fragmentu zasad. Nie można zmienić nazwy.

Aby edytować fragment zasad:

  1. W lewym obszarze nawigacji wystąpienia usługi API Management w obszarze Interfejsy API wybierz pozycję Fragmenty zasad. Wybierz nazwę fragmentu.
  2. Wybierz pozycję Edytor zasad.
  3. Zaktualizuj instrukcje w fragmentcie, a następnie wybierz pozycję Zastosuj.

Uwaga

Aktualizacja ma wpływ na wszystkie definicje zasad, w których znajduje się fragment.

Aby usunąć fragment zasad:

  1. W lewym obszarze nawigacji wystąpienia usługi API Management w obszarze Interfejsy API wybierz pozycję Fragmenty zasad. Wybierz nazwę fragmentu.
  2. Zapoznaj się z dokumentacją dokumentu zasad, aby zapoznać się z definicjami zasad, które zawierają fragment. Przed usunięciem fragmentu należy usunąć odwołania do fragmentów ze wszystkich definicji zasad.
  3. Po usunięciu wszystkich odwołań wybierz pozycję Usuń.

Powiązana zawartość

Aby uzyskać więcej informacji na temat pracy z zasadami, zobacz: