Så anger eller redigerar du Azure API Management-principer

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 Portal. 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:

• Principöversikt
• Policyreferens för en fullständig lista över policyuttalanden och deras inställningar
• Lagringsplats för principfragment
• Policyverktyg för Azure API Management
• Skapa policyer med Microsoft Copilot i Azure

Förutsättningar

Om du inte redan har en API-hanteringsinstans och ett backend-API, se:

• Skapa en Azure API Management-instans
• Importera och publicera ett API

Gå till API Management-instansen

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

   

2. På sidan API Management Services väljer du 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.

Så här konfigurerar du en policy:

Konfigurera principer i olika omfång

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

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.

   

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.

   

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.

   

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å.

   

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 policies som har konfigurerats i det avsnittet på nästa bredare (föräldra-) nivå. Elementet base ingår som standard i varje principavsnitt.

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>
   

   Anteckning

   • 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. Det kan dock vara användbart i vissa situationer, till exempel när du vill tillämpa andra principer på en viss åtgärd än vad som har konfigurerats för API-omfånget (alla åtgärder).

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 Copilot

Du kan få AI-hjälp från Copilot för att skapa och redigera api Management-principdefinitioner. Du kan använda Copilot för att skapa och uppdatera principer som matchar dina specifika krav utan att behöva känna till XML-syntaxen. Du kan också få förklaringar av befintliga principer. Och Copilot kan hjälpa dig att översätta principer som du kan ha konfigurerat i andra API-hanteringslösningar.

• Microsoft Copilot i Azure tillhandahåller principredigeringshjälp med frågor om naturligt språk i Azure-portalen. Du kan skapa principer i API Management-principredigeraren och be Copilot att förklara principavsnitt.
• GitHub Copilot för Azure i Visual Studio Code ger stöd för principredigering i Visual Studio Code, och du kan använda Azure API Management-tillägget för Visual Studio Code för att påskynda principkonfigurationen. Du kan uppmana Copilot Chat eller Copilot Edits med naturligt språk att skapa och förfina principdefinitioner på plats.

Exempelfråga:

Generate a policy that adds an Authorization header to the request with a Bearer token.

Copilot drivs av AI, så överraskningar och misstag är möjliga. Mer information finns i vanliga frågor och svar om användning av Copilot.

Relaterat innehåll

Mer information om hur du arbetar med principer finns i:

• Självstudie: Transformera och skydda ditt API
• Policyreferens för en fullständig lista över policyuttalanden och deras inställningar
• Policyuttryck
• Ange eller redigera principer
• Återanvända policykonfigurationer
• Lagringsplats för principfragment
• Lagringsplats för principlekplats
• Policyverktyg för Azure API Management
• Få Hjälp med Copilot för att skapa, förklara och felsöka principer