Werte hinzufügen oder aktualisieren
In dieser Lerneinheit werden die Richtlinienvorlagen erläutert, die Sie anwenden können, um Datenwerte in der Anforderung an und in der Antwort von der API festzulegen. Das häufigste Szenario besteht darin, Werte festzulegen, die von der API im Text, im Header oder in der Abfrage der Anforderung benötigt werden, damit der Entwickler sie nicht bereitstellen muss. Die Richtlinien sind flexibel, um verschiedene Aufgaben zu erledigen, die sich auf das Festlegen von Daten auf Anforderung und Antwort beziehen. Die folgenden Richtlinienvorlagen sind verfügbar und konzentrieren sich auf das Festlegen von Datenwerten:
Eigenschaft festlegen – Eigenschaft für ein Objekt oder eine Sammlung hinzufügen oder aktualisieren
Abfrageparameter festlegen – Parameter für die Abfragezeichenfolge hinzufügen oder aktualisieren
HTTP-Header festlegen – Für Anforderungs- bzw. Antwort-Header einen Wert hinzufügen oder aktualisieren
Die Richtlinienvorlage „Eigenschaft festlegen“
Die Richtlinienvorlage Eigenschaft festlegen kann verwendet werden, um Werte im Text der Anforderungs- oder der Antwortobjekte festzulegen oder zu aktualisieren. Sie können einen konstanten Wert festlegen, indem Sie einen Zeichenfolgenwert oder einen Ausdruck durch Verwendung von @body() verwenden, um einen weiteren vorhandenen Wert aus dem Textobjekt zu erhalten. Das folgende Beispiel zeigt, wie Sie einen konstanten Wert für den Antworttext festlegen.
Wenn Sie sich die Antwort nach der Implementierung der Richtlinienvorlage ansehen, wird das folgende Bild angezeigt.
Das vorherige Beispiel zeigt, dass der Vorgang ListInvoice ein Objekt mit einer Eigenschaftsrechnung zurückgibt, die ein Array von Rechnungsobjekten ist. Wenn Sie die Präfix-Eigenschaft für jede Rechnung im Rechnungsarray festlegen möchten, ändern Sie Ihr übergeordnetes Objekt oder Ihren Sammlungspfad so, dass er dem folgenden Bild ähnelt.
Die Ausgabe, die Sie nach dieser Änderung erhalten würden, ähnelt dem folgenden Bild.
Sie können auch auf andere Werte im Text verweisen, die bereits festgelegt wurden. Das folgende Bild zeigt beispielsweise, dass die Eigenschaft FullValue die Eigenschaft Prefix umfasst.
Beachten Sie, dass das Feld Hinzuzufügender Wert den Ausdruck {@body().Prefix} enthält, um den Präfixwert aus dem Text abzurufen. Sie müssen für den Ausdruck geschweifte Klammern verwenden ({expression}), damit es funktioniert.
Nur der Verweis auf den Ausdruck @body funktioniert in diesem Feld. Die Verwendung anderer Ausdrücke wie @connectionProperties, @headers oder @queryParameters wird nicht unterstützt.
Die Richtlinienvorlage „Abfrageparameter festlegen“ verwenden
Die Vorlagenrichtlinie Abfrageparameter festlegen kann verwendet werden, um Abfrageparameter für die Anforderung hinzuzufügen oder zu aktualisieren. Da die Abfragezeichenfolge nur für die Anforderung von Bedeutung ist, müssen Sie den Wert Richtlinie ausführen aus nicht festlegen. Im Gegensatz zur Richtlinie Eigenschaft festlegen, die immer den Wert festlegt, auch wenn er vorhanden ist, kann diese Richtlinie konfiguriert werden. Sie können die Aktion, falls der Parameter vorhanden ist, auf eine der folgenden Optionen einstellen:
Überschreiben – Ersetzt den vorhandenen Wert
Überspringen – Der vorhandene Wert wird nicht ersetzt.
Anfügen – Der Wert der Richtlinienvorlage wird an den vorhandenen Wert angefügt.
Mit dieser Funktion können Sie steuern, wann der Wert verwendet wird. Dies ist ein guter Ansatz für die Bereitstellung von Standardwerten. Ein Beispiel für diesen Ansatz ist der Microsoft Outlook-Konnektor mit der Richtlinie Abfrageparameter festlegen, um einen Standardwert von 50 für seinen Parameter $top festzulegen. Das folgende Beispiel zeigt, wie die Richtlinienvorlage aussehen würde.
Beachten Sie, dass die Option Überspringen für den Wert Aktion, wenn Abfrageparameter vorhanden sind verwendet wurde, um sicherzustellen, dass diese Richtlinie nur als Standard verwendet wird.
Die Richtlinienvorlage „HTTP-Header festlegen“ verwenden
Sie können die Richtlinienvorlage HTTP-Header festlegen verwenden, um Werte im Header für Anfrage, Antwort oder Fehler hinzuzufügen oder zu aktualisieren. Ähnlich wie bei der Richtlinienvorlage Abfrageparameter festlegen können Sie die Aktion auswählen, wenn der Wert bereits vorhanden ist. Die Richtlinienvorlage wird am häufigsten verwendet, um Header-Werte festzulegen, die von der API erwartet werden, z. B. Absenderidentifikation, ETag für die Änderungsverfolgung oder spezielle API-Schlüsselheader, die nicht von den normalen Konnektoreinstellungen verarbeitet werden. Der Azure Cognitive Services-Konnektor verwendet beispielsweise die Richtlinienvorlage Kopfzeile setzen zum Festlegen des Kopfzeilenwerts X-Ms-Sender auf Microsoft Azure Logic Apps. Das folgende Beispiel zeigt, wie die Richtlinienvorlage aussehen würde.
Mit diesen Richtlinienvorlagen können Sie Werte festlegen, die von der API erwartet werden. Sie können sie auch verwenden, um Werte in der Antwort festzulegen, die die Aufgabe des Entwicklers, die Daten zu nutzen, vereinfachen könnten. Diese Richtlinien können auch verwendet werden, um Standardwerte festzulegen, wenn noch keine bereitgestellt wurden. Sie können mehrere Richtlinien in einer bestimmten Reihenfolge verwenden, um komplexere Werte zu erstellen.