Jak ustawić i edytować zasady usługi Azure API Management

  • Artykuł

DOTYCZY: Wszystkie warstwy usługi API Management

W tym artykule pokazano, jak skonfigurować zasady w wystąpieniu usługi API Management, edytując definicje zasad w witrynie Azure Portal. Każda definicja zasad to dokument XML opisujący sekwencję instrukcji przychodzących i wychodzących uruchamianych sekwencyjnie na żądaniu i odpowiedzi interfejsu API.

Edytor zasad w portalu udostępnia formularze z przewodnikiem dla wydawców interfejsu API w celu dodawania i edytowania zasad w definicjach zasad. Możesz również edytować kod XML bezpośrednio w edytorze kodu zasad.

Więcej informacji o zasadach:

Wymagania wstępne

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

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

Konfigurowanie zasad w portalu

W poniższym przykładzie pokazano, jak skonfigurować zasady przy użyciu dwóch opcji w edytorze zasad w portalu:

  • Edytor oparty na formularzach z przewodnikiem upraszczający konfigurowanie wielu zasad
  • Edytor kodu, w którym można bezpośrednio dodawać lub edytować kod XML

W tym przykładzie zasady filtruje żądania z określonych przychodzących adresów IP. Zakres jest określany dla wybranego interfejsu API.

Uwaga

Zasady można skonfigurować w innych zakresach, takich jak wszystkie interfejsy API, produkt lub pojedyncza operacja interfejsu API. Zobacz Konfigurowanie zakresu w dalszej części tego artykułu, aby zapoznać się z innymi przykładami.

Aby skonfigurować zasady:

  1. W lewym obszarze nawigacji wystąpienia usługi API Management wybierz pozycję Interfejsy API.

  2. Wybierz wcześniej zaimportowany interfejs API.

  3. Wybierz kartę Projekt.

  4. Aby zastosować zasady do wszystkich operacji, wybierz pozycję Wszystkie operacje.

  5. W sekcji Przetwarzanie przychodzące wybierz pozycję + Dodaj zasady.

    Dodawanie zasad w usłudze API Management

  6. W obszarze Dodawanie zasad dla ruchu przychodzącego wybierz zasady do dodania. Na przykład wybierz pozycję Filtruj adresy IP.

    Filtruj zasady adresów IP

    Napiwek

    • Wyświetlane zasady są ograniczone do sekcji zasad, którą konfigurujesz — w tym przypadku w przypadku przetwarzania przychodzącego.
    • Jeśli nie widzisz żądanych zasad, wybierz kafelek Inne zasady . Spowoduje to otwarcie edytora kodu XML i wyświetlenie pełnej listy zasad dla tej sekcji i zakresu.

  7. Wybierz pozycję Dozwolone adresy IP>+ Dodaj filtr IP i dodaj pierwsze i ostatnie adresy IP zakresu adresów przychodzących, które mogą wysyłać żądania interfejsu API. W razie potrzeby dodaj inne zakresy adresów IP.

    Konfigurowanie dozwolonych adresów IP

  8. Wybierz pozycję Zapisz , aby natychmiast propagować zmiany do bramy usługi API Management.

    Zasady filtru ip są teraz wyświetlane w sekcji Przetwarzanie przychodzące.

Konfigurowanie zasad w różnych zakresach

Usługa API Management zapewnia elastyczność konfigurowania definicji zasad w wielu zakresach w poszczególnych sekcjach zasad.

Ważne

Nie wszystkie zasady można stosować w każdej sekcji zakresu lub zasad. Jeśli zasady, które chcesz dodać, nie są włączone, upewnij się, że jesteś w obsługiwanej sekcji zasad i zakres dla tych zasad. Aby przejrzeć sekcje zasad i zakresy zasad dla zasad, zapoznaj się z sekcją Użycie w tematach dokumentacji zasad.

Uwaga

Sekcja zasad zaplecza może zawierać tylko jeden element zasad. Domyślnie usługa API Management konfiguruje forward-request zasady w sekcji Zaplecze w zakresie globalnym i base element w innych zakresach.

Zakres globalny

Zakres globalny jest skonfigurowany dla wszystkich interfejsów API w wystąpieniu usługi API Management.

  1. W lewym obszarze nawigacji wystąpienia usługi API Management wybierz pozycję Interfejsy API Wszystkie interfejsy> API.

  2. Wybierz kartę Projekt.

    Konfigurowanie zasad w zakresie produktu

  3. W sekcji zasad wybierz pozycję + Dodaj zasady , aby użyć edytora zasad opartych na formularzach lub wybierz <ikonę /> (edytor kodu), aby dodać i edytować kod XML bezpośrednio.

  4. Wybierz pozycję Zapisz , aby natychmiast propagować zmiany do bramy usługi API Management.

Zakres produktu

Zakres produktu jest skonfigurowany dla wybranego produktu.

  1. W menu po lewej stronie wybierz pozycję Produkty, a następnie wybierz produkt, do którego chcesz zastosować zasady.

  2. W oknie produktu wybierz pozycję Zasady.

    Konfigurowanie zasad w zakresie globalnym

  3. W sekcji zasad wybierz pozycję + Dodaj zasady , aby użyć edytora zasad opartych na formularzach lub wybierz <ikonę /> (edytor kodu), aby dodać i edytować kod XML bezpośrednio.

  4. Wybierz pozycję Zapisz , aby natychmiast propagować zmiany do bramy usługi API Management.

Zakres interfejsu API

Zakres interfejsu API jest skonfigurowany dla wszystkich operacji wybranego interfejsu API.

  1. W lewym obszarze nawigacji wystąpienia usługi API Management wybierz pozycję Interfejsy API, a następnie wybierz interfejs API, do którego chcesz zastosować zasady.

  2. Wybierz kartę Projekt.

  3. Wybierz opcję Wszystkie operacje.

    Konfigurowanie zasad w zakresie interfejsu API

  4. W sekcji zasad wybierz pozycję + Dodaj zasady , aby użyć edytora zasad opartych na formularzach lub wybierz <ikonę /> (edytor kodu), aby dodać i edytować kod XML bezpośrednio.

  5. Wybierz pozycję Zapisz , aby natychmiast propagować zmiany do bramy usługi API Management.

Zakres operacji

Zakres operacji jest skonfigurowany dla wybranej operacji interfejsu API.

  1. W lewym obszarze nawigacji wystąpienia usługi API Management wybierz pozycję Interfejsy API.

  2. Wybierz kartę Projekt.

  3. Wybierz operację, do której chcesz zastosować zasady.

    Konfigurowanie zasad w zakresie operacji

  4. W sekcji zasad wybierz pozycję + Dodaj zasady , aby użyć edytora zasad opartych na formularzach lub wybierz <ikonę /> (edytor kodu), aby dodać i edytować kod XML bezpośrednio.

  5. Wybierz pozycję Zapisz , aby natychmiast propagować zmiany do bramy usługi API Management.

Ponowne używanie konfiguracji zasad

Fragmenty zasad wielokrotnego użytku można tworzyć w wystąpieniu usługi API Management. Fragmenty zasad to elementy XML zawierające konfiguracje co najmniej jednej zasady. Fragmenty zasad ułatwiają spójne konfigurowanie zasad i utrzymywanie definicji zasad bez konieczności powtarzania lub ponownego wpisywania kodu XML.

include-fragment Użyj zasad, aby wstawić fragment zasad w definicji zasad.

Ustawianie kolejności oceny zasad przy użyciu base elementu

Jeśli skonfigurujesz definicje zasad w więcej niż jednym zakresie, wiele zasad może dotyczyć żądania lub odpowiedzi interfejsu API. W zależności od kolejności stosowania zasad z różnych zakresów przekształcenie żądania lub odpowiedzi może się różnić.

W usłudze API Management określ kolejność oceny zasad, umieszczając base element w każdej sekcji w definicji zasad w każdym zakresie. Element base dziedziczy zasady skonfigurowane w tej sekcji w następnym szerszym zakresie (nadrzędnym). Element base jest domyślnie dołączany do każdej sekcji zasad.

Uwaga

Aby wyświetlić obowiązujące zasady w bieżącym zakresie, wybierz pozycję Oblicz obowiązujące zasady w edytorze zasad.

Aby zmodyfikować kolejność oceny zasad przy użyciu edytora zasad:

  1. Zacznij od definicji w najbardziej wąskim zakresie skonfigurowanym, który będzie stosowany najpierw przez usługę API Management.

    Na przykład w przypadku używania definicji zasad skonfigurowanych w zakresie globalnym i zakresie interfejsu API należy rozpocząć od konfiguracji w zakresie interfejsu API.

  2. base Umieść element w sekcji, aby określić, gdzie dziedziczyć wszystkie zasady z odpowiedniej sekcji w zakresie nadrzędnym.

    Na przykład w sekcji skonfigurowanej inbound w zakresie interfejsu API umieść base element do kontrolowania, gdzie dziedziczyć zasady skonfigurowane w inbound sekcji w zakresie globalnym. W poniższym przykładzie zasady dziedziczone z zakresu globalnego są stosowane przed zasadami ip-filter .

    <policies>
  <inbound>
      <base />
        <ip-filter action="allow">
            <address>10.100.7.1</address>
        </ip-filter>
  </inbound>
  [...]
</policies>

    Uwaga

    • Element można umieścić base przed elementem zasad lub po nim w sekcji.
    • Jeśli chcesz zapobiec dziedziczeniu zasad z zakresu nadrzędnego, usuń base element. W większości przypadków nie jest to zalecane.

  3. Kontynuuj konfigurowanie base elementu w definicjach zasad w kolejnych szerszych zakresach.

    Zasady o zakresie globalnym nie mają zakresu nadrzędnego i użycie base w nim elementu nie ma żadnego efektu.

Uzyskiwanie pomocy przy tworzeniu zasad przy użyciu rozwiązania Microsoft Copilot dla platformy Azure (wersja zapoznawcza)

Rozwiązanie Microsoft Copilot dla platformy Azure (wersja zapoznawcza) udostępnia funkcje tworzenia zasad dla usługi Azure API Management. Użyj narzędzia Copilot dla platformy Azure w kontekście edytora zasad usługi API Management, aby utworzyć zasady zgodne z określonymi wymaganiami bez znajomości składni lub zostały już skonfigurowane zasady wyjaśnione dla Ciebie.

Możesz wyświetlić monit Copilot dla platformy Azure o wygenerowanie definicji zasad, a następnie skopiować wyniki do edytora zasad i wprowadzić wszelkie niezbędne korekty. Zadawaj pytania, aby uzyskać wgląd w różne opcje, zmodyfikować podane zasady lub wyjaśnić już posiadane zasady. Dowiedz się więcej

Ważne

Rozwiązanie Microsoft Copilot dla platformy Azure (wersja zapoznawcza) wymaga rejestracji i jest obecnie dostępne tylko dla zatwierdzonych klientów korporacyjnych i partnerów. Aby uzyskać więcej informacji, zobacz Ograniczony dostęp do rozwiązania Microsoft Copilot dla platformy Azure (wersja zapoznawcza).

Powiązana zawartość

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