Så anger eller redigerar du Azure API Management-principer

  • Artikel

GÄLLER FÖR: Alla API Management-nivåer

Den här artikeln visar hur du konfigurerar principer i DIN API Management-instans genom att redigera principdefinitioner i Azure-portalen. Varje principdefinition är ett XML-dokument som beskriver en sekvens med inkommande och utgående instruktioner som körs sekventiellt på en API-begäran och ett SVAR.

Principredigeraren i portalen innehåller guidade formulär som API-utgivare kan lägga till och redigera principer i principdefinitioner. Du kan också redigera XML direkt i principkodredigeraren.

Mer information om principer:

Förutsättningar

Om du inte redan har en API Management-instans och ett serverdels-API kan du läsa:

Gå till API Management-instansen

  1. I Azure-portalen söker du efter och väljer API Management-tjänster.

    Välj API Management-tjänster

  2. På sidan API Management-tjänster väljer du din API Management-instans.

    Välj din API Management-instans

Konfigurera princip i portalen

I följande exempel visas hur du konfigurerar en princip med två alternativ i principredigeraren i portalen:

  • En guidad formulärbaserad redigerare för att förenkla konfigurationen av många principer
  • En kodredigerare där du kan lägga till eller redigera XML direkt

I det här exemplet filtrerar principen begäranden från vissa inkommande IP-adresser. Det är begränsat till ett valt API.

Kommentar

Du kan konfigurera principer i andra omfång, till exempel för alla API:er, en produkt eller en enda API-åtgärd. Se Konfigurera omfång senare i den här artikeln för andra exempel.

Så här konfigurerar du en princip:

  1. I det vänstra navigeringsfältet för din API Management-instans väljer du API:er.

  2. Välj ett API som du tidigare importerade.

  3. Välj fliken Design.

  4. Om du vill tillämpa principen på alla åtgärder väljer du Alla åtgärder.

  5. I avsnittet Inkommande bearbetning väljer du + Lägg till princip.

    Lägga till princip i API Management

  6. I Lägg till inkommande princip väljer du en princip att lägga till. Välj till exempel Filtrera IP-adresser.

    Filtrera IP-adressprincip

    Dricks

    • Principer som visas är begränsade till det principavsnitt som du konfigurerar – i det här fallet för inkommande bearbetning.
    • Om du inte ser en princip som du vill använda väljer du panelen Andra principer . Då öppnas XML-kodredigeraren och en fullständig lista över principer för det avsnittet och omfånget visas.

  7. Välj Tillåtna IP-adresser>+ Lägg till IP-filter och lägg till de första och sista IP-adresserna för ett intervall med inkommande adresser som tillåts göra API-begäranden. Lägg till andra IP-adressintervall om det behövs.

    Konfigurera tillåtna IP-adresser

  8. Välj Spara för att sprida ändringar till API Management-gatewayen omedelbart.

    Principen för ip-filter visas nu i avsnittet Inkommande bearbetning .

Konfigurera principer i olika omfång

API Management ger dig flexibilitet att konfigurera principdefinitioner i flera omfång i vart och ett av principavsnitten.

Viktigt!

Alla principer kan inte tillämpas i varje omfång eller principavsnitt. Om den princip som du vill lägga till inte är aktiverad kontrollerar du att du är i ett principavsnitt som stöds och omfånget för den principen. Om du vill granska principavsnitten och omfången för en princip läser du avsnittet Användning i referensavsnitten princip.

Kommentar

Avsnittet Serverdelsprincip kan bara innehålla ett principelement. Som standard konfigurerar forward-request API Management principen i avsnittet Serverdel i det globala omfånget och elementet base i andra omfång.

Globalt omfång

Globalt omfång har konfigurerats för Alla API:er i din API Management-instans.

  1. I det vänstra navigeringsfältet för din API Management-instans väljer du API:er>Alla API:er.

  2. Välj fliken Design.

    Konfigurera princip i produktomfång

  3. I ett principavsnitt väljer du + Lägg till princip för att använda en formulärbaserad principredigerare eller väljer <ikonen /> (kodredigeraren) för att lägga till och redigera XML direkt.

  4. Välj Spara för att sprida ändringar till API Management-gatewayen omedelbart.

Produktomfång

Produktomfånget har konfigurerats för en vald produkt.

  1. I den vänstra menyn väljer du Produkter och sedan en produkt som du vill tillämpa principer på.

  2. I produktfönstret väljer du Principer.

    Konfigurera princip i globalt omfång

  3. I ett principavsnitt väljer du + Lägg till princip för att använda en formulärbaserad principredigerare eller väljer <ikonen /> (kodredigeraren) för att lägga till och redigera XML direkt.

  4. Välj Spara för att sprida ändringar till API Management-gatewayen omedelbart.

API-omfång

API-omfånget har konfigurerats för Alla åtgärder i det valda API:et.

  1. I det vänstra navigeringsfältet för DIN API Management-instans väljer du API:er och sedan det API som du vill tillämpa principer på.

  2. Välj fliken Design.

  3. Välj Alla åtgärder.

    Konfigurera princip i API-omfång

  4. I ett principavsnitt väljer du + Lägg till princip för att använda en formulärbaserad principredigerare eller väljer <ikonen /> (kodredigeraren) för att lägga till och redigera XML direkt.

  5. Välj Spara för att sprida ändringar till API Management-gatewayen omedelbart.

Åtgärdsomfång

Åtgärdsomfånget har konfigurerats för en vald API-åtgärd.

  1. I det vänstra navigeringsfältet för din API Management-instans väljer du API:er.

  2. Välj fliken Design.

  3. Välj den åtgärd som du vill tillämpa principer på.

    Konfigurera princip vid åtgärdsomfång

  4. I ett principavsnitt väljer du + Lägg till princip för att använda en formulärbaserad principredigerare eller väljer <ikonen /> (kodredigeraren) för att lägga till och redigera XML direkt.

  5. Välj Spara för att sprida ändringar till API Management-gatewayen omedelbart.

Återanvända principkonfigurationer

Du kan skapa återanvändbara principfragment i DIN API Management-instans. Principfragment är XML-element som innehåller dina konfigurationer av en eller flera principer. Principfragment hjälper dig att konfigurera principer konsekvent och underhålla principdefinitioner utan att behöva upprepa eller skriva om XML-kod.

Använd principen include-fragment för att infoga ett principfragment i en principdefinition.

Använd base element för att ange principutvärderingsordning

Om du konfigurerar principdefinitioner i mer än ett omfång kan flera principer gälla för en API-begäran eller ett API-svar. Beroende på vilken ordning principerna från de olika omfången tillämpas kan omvandlingen av begäran eller svaret skilja sig åt.

I API Management bestämmer du principutvärderingsordningen genom att placera elementet base i varje avsnitt i principdefinitionen i varje omfång. Elementet base ärver de principer som konfigurerats i det avsnittet vid nästa bredare omfång (överordnat). Elementet base ingår som standard i varje principavsnitt.

Kommentar

Om du vill visa effektiva principer i det aktuella omfånget väljer du Beräkna effektiv princip i principredigeraren.

Så här ändrar du principutvärderingsordningen med hjälp av principredigeraren:

  1. Börja med definitionen med det mest begränsade omfång som du har konfigurerat, vilket API Management ska tillämpa först.

    När du till exempel använder principdefinitioner som konfigurerats i det globala omfånget och API-omfånget börjar du med konfigurationen i API-omfånget.

  2. Placera elementet base i ett avsnitt för att avgöra var du ska ärva alla principer från motsvarande avsnitt i det överordnade omfånget.

    I ett inbound avsnitt som har konfigurerats i API-omfånget placerar du till exempel ett base element för att styra var principer som konfigurerats i avsnittet ska ärvas i inbound det globala omfånget. I följande exempel tillämpas principer som ärvs från det globala omfånget ip-filter före principen.

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

    Kommentar

    • Du kan placera elementet base före eller efter ett principelement i ett avsnitt.
    • Om du vill förhindra ärvning av principer från det överordnade omfånget tar du bort elementet base . I de flesta fall rekommenderas det inte.

  3. Fortsätt att konfigurera elementet base i principdefinitioner vid successivt bredare omfång.

    En globalt begränsad princip har inget överordnat omfång och att använda elementet base i den har ingen effekt.

Få hjälp med att skapa principer med Hjälp av Microsoft Copilot för Azure (förhandsversion)

Microsoft Copilot för Azure (förhandsversion) tillhandahåller principredigeringsfunktioner för Azure API Management. Använd Copilot för Azure i kontexten för API Managements principredigerare för att skapa principer som matchar dina specifika krav utan att känna till syntaxen eller som redan har konfigurerat principer som förklaras för dig.

Du kan uppmana Copilot för Azure att generera principdefinitioner och sedan kopiera resultaten till principredigeraren och göra nödvändiga justeringar. Ställ frågor för att få insikter om olika alternativ, ändra den angivna principen eller klargöra vilken princip du redan har. Läs mer

Viktigt!

Microsoft Copilot för Azure (förhandsversion) kräver registrering och är för närvarande endast tillgängligt för godkända företagskunder och partner. Mer information finns i Begränsad åtkomst till Microsoft Copilot för Azure (förhandsversion).

Relaterat innehåll

Mer information om hur du arbetar med principer finns i: