Einführung
Der Inhalt dieses Moduls erklärt die Verwendung von Richtlinien mit benutzerdefinierten Konnektoren und wie Sie sie mithilfe von Richtlinienvorlagen konfigurieren können.
In diesem Modul lernen Sie Folgendes:
Erfahren, wie Richtlinien das Verhalten benutzerdefinierter Konnektoren zur Laufzeit ändern können
Richtlinienvorlagen auf einen benutzerdefinierten Konnektor anwenden
Richtlinien ermöglichen Ihnen, das Verhalten eines benutzerdefinierter Konnektors zur Laufzeit zu ändern. Mithilfe von Richtlinien können Sie Datenkonvertierungen durchführen, Weiterleitungsanforderungen erstellen, Parameterwerte festlegen und vieles mehr. Sie können Richtlinien vor dem Import direkt in der Eigenschaftendatei der benutzerdefinierten Konnektor-API konfigurieren oder dies über das Herstellerportal im benutzerdefinierten Konnektor-Designer vornehmen, indem Sie Richtlinienvorlagen anwenden.
Häufige Anwendungsfälle für Richtlinien sind:
Host-URL festlegen – Standardmäßig ist die Host-URL in der Konnektorkonfiguration fest codiert. Eine Richtlinie in Kombination mit einem Verbindungsparameter ermöglicht die Angabe der Host-URL bei jedem Erstellen einer Verbindung mithilfe des Konnektors. In diesem Anwendungsfall kann beispielsweise eine Entwicklungs‑, Test‑ und Produktionsversion der System-API behandelt werden.
Kopfzeile setzen – Verwenden Sie diese Option, um Daten aus den Verbindungsparametern, der Abfrage oder dem Hauptteil der Anforderung in die Kopfzeile zu übertragen. In der Regel wird dieser Prozess durchgeführt, um APIs zu berücksichtigen, für die bestimmte Informationen in der Kopfzeile konfiguriert werden sollen. Dieser Anwendungsfall könnte beispielsweise eine Korrelations-ID sein, um den gesamten ausgeführten Geschäftsprozess zu verfolgen.
Abfrageparameter einstellen – Wird bei Bedarf zur Behandlung von Standardwerten verwendet, der Entwickler konfiguriert jedoch keinen. Wenn für eine API beispielsweise ein oberster Parameter für die Anzahl der Datensätze erforderlich ist, die mithilfe einer Richtlinie zurückgegeben werden sollen, können Sie einen Standardwert festlegen, der verwendet werden soll, wenn der Entwickler keinen konfiguriert.
Sie können Richtlinien verwenden, um bestimmte API-Anforderungen zu erfüllen und die Verwendung des Konnektors zu vereinfachen, indem Sie unnötige Komplexitäten ausblenden.
Eine Richtlinie anwenden
Durch Anwenden einer Richtlinienvorlage auf einen benutzerdefinierten Konnektor können Sie aus einer Liste von Vorlagen eine Richtlinie auswählen, die Sie verwenden möchten. Jede ausgewählte Vorlage fordert Sie auf, die erforderliche Konfiguration für diese Richtlinie auszufüllen. Wenn Sie das Formular ausfüllen, wird die Richtlinie aktiviert, nachdem Sie den Konnektor aktualisiert haben. Der folgende Screenshot zeigt ein Beispiel für das Erstellen einer neuen Richtlinie mithilfe einer der Vorlagen.
Wenn Sie eine Richtlinienvorlage anwenden, können Sie festlegen, dass sie auf alle Aktionen und Trigger oder nur auf bestimmte Aktionen angewendet werden soll.
Die Vorlage Host-URL festlegen wird normalerweise auf alle Aktionen und Trigger angewendet. Im Gegensatz dazu wird die Vorlage Ein Array in ein Objekt konvertieren (Vorschauversion) möglicherweise nur auf eine oder zwei Aktionen angewendet, die ähnliche Daten zurückgeben.
Wenn Sie eine Richtlinie so konfigurieren, dass sie für alle Aktionen und Trigger ausgeführt wird, müssen Sie sicherstellen, dass alle Datenpfade, die in den Richtlinienparametern verwendet werden, für alle Aktionen und Trigger gültig sind. Andernfalls treten Laufzeitfehler auf.
In der Liste der konfigurierten Richtlinien können Sie die Auslassungspunkte (...) neben jeder Richtlinie auswählen und sie in der Liste nach oben oder unten verschieben. Mit dieser Funktion können Sie die Reihenfolge konfigurieren, in der Richtlinien zur Laufzeit angewendet werden. Dies kann in Szenarien hilfreich sein, in denen Sie mehrere Richtlinienvorlagen verwenden, um Ihre Datenkonvertierung durchzuführen. Beispielsweise könnte eine Richtlinie eine durch Trennzeichen getrennte Zeichenfolge in ein Array analysieren und eine andere Richtlinie könnte das Array in ein Objekt konvertieren. In diesem Beispiel wäre die Reihenfolge der Implementierung wichtig.
Das Konfigurieren einer Richtlinienvorlage führt zu einer Änderung der API-Eigenschaften des Konnektors. API-Eigenschaften werden getrennt von der API-Definition für den Konnektor gespeichert. Sie können eine aktualisierte API-Definition über das Portal importieren, ohne die von Ihnen konfigurierten Richtlinien zu überschreiben.
Mithilfe von CLI anzeigen und ändern
Sie können Richtlinien nicht nur im Portal anzeigen, sondern auch als Teil der API-Eigenschaftendatei mit dem Download-Befehl „paconn“ von CLI exportieren.
Der Download enthält vier Dateien (apiDefintion.swagger.json, apiProperties.json, icon.png, settings.json).
Wenn Sie die Datei „apiProperties.json“ öffnen und den Abschnitt policyTemplateInstances finden, werden alle konfigurierten Richtlinien angezeigt.
Der folgende Screenshot ist ein Beispiel für den Abschnitt policyTemplateInstances.
Sie können die Datei „apiProperties.json“ auch direkt ändern, wenn Sie mit der Arbeit in JSON vertraut sind. Mit einigen Richtlinien, wie z. B. Host-URL festlegen, wenn Sie beim Erstellen einer Verbindung zur Eingabe der URL auffordern möchten, müssen Sie Änderungen an den connectionParameters in der Datei „apiPropertiess.json“ vornehmen, um die Richtlinienkonfiguration abzuschließen. Mit dem Aktualisierungsbefehl „paconn“ können die Änderungen importiert werden.
Es kann hilfreich sein zu überlegen, wie andere Konnektoren Richtlinien verwenden. Das GitHub-Repository Microsoft Power Platform-Konnektoren enthält viele großartige Beispiele für zertifizierte und nicht zertifizierte Konnektoren, die Sie sich ansehen können. Darüber hinaus können Sie die Datei „apiProperties.json“ der Konnektoren durchsuchen und anzeigen. Das Durchsuchen des Repositorys mithilfe eines Richtlinienvorlagennamens, z. B. setHeader kann schnell zeigen, welche Konnektoren diese Richtlinie verwenden.