Festlegen oder Bearbeiten von Azure API Management-RichtlinienHow to set or edit Azure API Management policies

Die Richtliniendefinition ist ein XML-Dokument, das eine Sequenz eingehender und ausgehender Anweisungen beschreibt.The policy definition is an XML document that describes a sequence of inbound and outbound statements. Das XML-Dokument kann direkt im Definitionsfenster bearbeitet werden.The XML can be edited directly in the definition window. Sie können auch eine vordefinierte Richtlinie aus der Liste auswählen, die rechts vom Richtlinienfenster angezeigt wird.You can also select a predefined policy from the list that is provided to the right of the policy window. Die für den aktuellen Bereich anwendbaren Anweisungen sind aktiviert und hervorgehoben.The statements applicable to the current scope are enabled and highlighted. Wenn Sie auf eine aktivierte Anweisung klicken, wird der entsprechende XML-Ausschnitt an der Cursorposition in der Definitionsansicht eingefügt.Clicking an enabled statement adds the appropriate XML at the location of the cursor in the definition view.

Ausführliche Informationen zu Richtlinien finden Sie unter Richtlinien in API Management.For detailed information about policies, see Policies in Azure API Management.

Festlegen oder Bearbeiten einer RichtlinieSet or edit a policy

Führen Sie zum Festlegen oder Bearbeiten einer Richtlinie die folgenden Schritte aus:To set or edit a policy, follow the following steps:

  1. Melden Sie sich unter https://portal.azure.com beim Azure-Portal an.Sign in to the Azure portal at https://portal.azure.com.

  2. Navigieren Sie zu Ihrer APIM-Instanz.Browse to your APIM instance.

  3. Klicken Sie auf die Registerkarte APIs.Click the APIs tab.

    Richtlinie bearbeiten

  4. Wählen Sie eine der APIs aus, die Sie zuvor importiert haben.Select one of the APIs that you previously imported.

  5. Klicken Sie auf die Registerkarte Entwurf.Select the Design tab.

  6. Wählen Sie einen Vorgang aus, auf den die Richtlinie angewendet werden soll.Select an operation to which you want to apply the policy. Wenn die Richtlinie auf alle Vorgänge angewendet werden soll, klicken Sie auf Alle Vorgänge.If you want to apply the policy to all operations, select All operations.

  7. Wählen Sie das Symbol </> (Codeeditor) im Abschnitt Eingehende Verarbeitung oder Ausgehende Verarbeitung.Select the </> (code editor) icon in the Inbound processing or Outbound processing section.

  8. Fügen Sie den gewünschten Richtliniencode in einen der entsprechenden Blöcke ein.Paste the desired policy code into one of the appropriate blocks.

    <policies>
        <inbound>
            <base />
        </inbound>
        <backend>
            <base />
        </backend>
        <outbound>
            <base />
        </outbound>
        <on-error>
            <base />
        </on-error>
    </policies>
    

Konfigurieren des SuchbereichsConfigure scope

Richtlinien können entweder global oder im Geltungsbereich eines Produkts, einer API oder eines Vorgangs konfiguriert werden.Policies can be configured globally or at the scope of a Product, API, or Operation. Um eine Richtlinie zu konfigurieren, müssen Sie zunächst ihren gewünschten Geltungsbereich auswählen.To begin configuring a policy, you must first select the scope at which the policy should apply.

Richtlinienbereiche werden in der folgenden Reihenfolge ausgewertet:Policy scopes are evaluated in the following order:

  1. Globaler BereichGlobal scope
  2. ProduktbereichProduct scope
  3. API-BereichAPI scope
  4. VorgangsbereichOperation scope

Die Anweisungen in diesen Richtlinien werden entsprechend der Platzierung des base-Elements ausgewertet, sofern es vorhanden ist.The statements within policies are evaluated according to the placement of the base element, if it is present. Eine globale Richtlinie besitzt keine übergeordnete Richtlinie, und die Verwendung des <base>-Elements in der Richtlinie hat keinerlei Auswirkung.Global policy has no parent policy and using the <base> element in it has no effect.

Um die Richtlinien im aktuellen Bereich im Richtlinien-Editor anzuzeigen, klicken Sie auf Recalculate effective policy for selected scope.To see the policies in the current scope in the policy editor, click Recalculate effective policy for selected scope.

Globaler BereichGlobal scope

Der globale Bereich ist für Alle APIs in Ihrer APIM-Instanz konfiguriert.Global scope is configured for All APIs in your APIM instance.

  1. Melden Sie sich beim Azure-Portal an, und navigieren Sie zu Ihrer APIM-Instanz.Sign in to the Azure portal and navigate to your APIM instance.

  2. Klicken Sie auf Alle APIs.Click All APIs.

    Globaler Bereich

  3. Klicken Sie auf das Dreieckssymbol.Click the triangle icon.

  4. Klicken Sie auf Code-Editor.Select Code editor.

  5. Sie können Richtlinien hinzufügen oder bearbeiten.Add or edit policies.

  6. Klicken Sie auf Speichern.Press Save.

    Die Änderungen werden sofort an das API Management-Gateway weitergegeben.The changes are propagated to the API Management gateway immediately.

ProduktbereichProduct scope

Der Produktbereich wird für das ausgewählte Produkt konfiguriert.Product scope is configured for the selected product.

  1. Klicken Sie auf Produkte.Click Products.

    Produktbereich

  2. Wählen Sie das Produkt aus, auf das Richtlinien angewendet werden sollen.Select the product to which you want to apply policies.

  3. Klicken Sie auf Richtlinien.Click Policies.

  4. Sie können Richtlinien hinzufügen oder bearbeiten.Add or edit policies.

  5. Klicken Sie auf Speichern.Press Save.

API-BereichAPI scope

Der API-Bereich wird für Alle Vorgänge der ausgewählten API konfiguriert.API scope is configured for All Operations of the selected API.

  1. Wählen Sie die API aus, auf die Richtlinien angewendet werden sollen.Select the API you want to apply policies to.

    API-Bereich

  2. Auswählen von Alle VorgängeSelect All operations

  3. Klicken Sie auf das Dreieckssymbol.Click the triangle icon.

  4. Klicken Sie auf Code-Editor.Select Code editor.

  5. Sie können Richtlinien hinzufügen oder bearbeiten.Add or edit policies.

  6. Klicken Sie auf Speichern.Press Save.

VorgangsbereichOperation scope

Der Vorgangsbereich wird für den ausgewählten Vorgang konfiguriert.Operation scope is configured for the selected operation.

  1. Wählen Sie eine API aus.Select an API.

  2. Wählen Sie den Vorgang aus, auf den Richtlinien angewendet werden sollen.Select the operation you want to apply policies to.

    Vorgangsbereich

  3. Klicken Sie auf das Dreieckssymbol.Click the triangle icon.

  4. Klicken Sie auf Code-Editor.Select Code editor.

  5. Sie können Richtlinien hinzufügen oder bearbeiten.Add or edit policies.

  6. Klicken Sie auf Speichern.Press Save.

Nächste SchritteNext steps

Informationen finden Sie in den folgenden verwandten Themen:See the following related topics: