Eine Testverbindung implementieren

Eine Testverbindung ist ein einfacher Einstiegspunkt, der für einen Konnektor zur Verwendung mit Azure Logic Apps, Power Automate oder Power Apps definiert werden kann. Wenn Sie einen Vorgang für die Testverbindung verfügbar machen, ermöglicht der Connector die Überprüfung der Verbindungsparameter zur Entwurfszeit und Laufzeit.

Anforderungen

• Grundlegende Erfahrungen mit der Erstellung von Logik-Apps oder Flows und benutzerdefinierten Connectors.
• Grundverständnis der OpenAPI-Spezifikation (früher bekannt als Swagger).
• Ein GitHub-Konto.
• Die Beispiel-OpenAPI-Definition für dieses Tutorial.

Einen neuen Testverbindungsvorgang hinzufügen

Das Hinzufügen eines Vorgangs für TestConnection ist sehr einfach. Sie können zum Testen der Verbindung einen vorhandenen Vorgang verwenden oder einen bestimmten Vorgang hinzufügen, dessen einziger Zweck das Testen der Verbindungsparameter ist. Der Vorgang muss ein Get-Vorgang sein und einen Aufruf ohne Parameter oder mit hartcodierten Parametern unterstützen.

Das Hinzufügen eines neuen Vorgangs zu diesem Zweck wird in der OpenAPI-Spezifikation möglicherweise wie folgt angegeben:

    "/diagnostics/testconnection": {
      "get": {
        "tags": [ "Diagnostics" ],
        "operationId": "TestMyAPIConnection",
        "consumes": [],
        "produces": [],
        "responses": {
          "200": { "description": "OK" },
          "default": { "description": "Operation Failed." }
        },
        "x-ms-visibility": "internal"
      }
    }

Wichtig

Beachten Sie, dass dieser Vorgang als internal markiert ist. Wenn Sie zu diesem Zweck einen neuen Einstiegspunkt hinzufügen, wird dringend empfohlen, diesen Vorgang für den Benutzer auszublenden, indem Sie die Sichtbarkeit so markieren.

Der als Testverbindung zu verwendende Endpunkt muss identifiziert werden, indem der API auf oberster Ebene wie folgt eine Erweiterung hinzugefügt wird:

 "x-ms-capabilities": {
    "testConnection": {
      "operationId": "TestMyAPIConnection",
      "parameters": {}
    }
  }

Die in diesem Attribut angegebene operationId muss in derselben OpenAPI-Spezifikation vorhanden sein, damit sie gültig ist.

Einen vorhandenen Vorgang für eine Testverbindung wiederverwenden

Häufig ist es einfacher und besser zu handhaben, einen vorhandenen Vorgang zu identifizieren, mit dem die Verwendbarkeit der Verbindung überprüft werden kann, ohne hohe Kosten oder hohe Latenz zu verursachen. Dies kann ohne Hinzufügen eines neuen Vorgangs erreicht werden. Geben Sie einfach den zu verwendenden Vorgang und die zu übergebenden Parameter (sofern vorhanden) an.

Im folgenden Beispiel wird ein vorhandener „get“-Vorgang mit dem Namen GetTables verwendet, der erfolgreich ausgeführt werden muss, wenn die Verbindung gültig ist und die Parameter korrekt sind. Um sicherzustellen, dass der Testverbindungsvorgang so schnell wie möglich ausgeführt wird, fügt das Beispiel dem Aufruf außerdem einen Parameter hinzu, um anzugeben, dass nur die erste Zeile zurückgegeben werden soll.

 "x-ms-capabilities": {
    "testConnection": {
      "operationId": "GetTables",
      "parameters": {
        "$top": 1
      }
    }
  }

Eine Testverbindung implementieren

Wenn Sie die Testverbindung implementieren müssen und kein anderer vorhandener Vorgang zu diesem Zweck geeignet ist, können Sie dies mit einem einfachen Back-End-Aufruf tun. Der Vorgang muss keine Parameter akzeptieren und keinen Inhalt zurückgeben. Der URL-Pfad ist ebenfalls unwichtig und kann basierend auf Ihren Vorlieben ausgewählt werden. Das einzige Erfolgskriterium für den Aufruf einer Testverbindung ist eine erfolgreiche Antwort (z. B. 200) auf den HTTP-Aufruf. Der Vertrag im Testverbindungsvorgang stellt die Anforderung, dass der Connector den Authentifizierungskontext und die Verbindungsparameter überprüft.

Dies kann durch eine Abfrage eines einfachen Elements im Back-End erreicht werden, wobei die Authentifizierungsparameter und eine ggf. einbezogene Datenbank oder Bereichsdefinition verwendet werden. Das Abfragen der obersten Zeile einer einfachen Tabelle ist ein gutes Beispiel für ein Testverbindungsverfahren.

Feedback senden

Wir freuen uns sehr über Feedback zu Problemen mit unserer Connector-Plattform oder neuen Feature-Ideen. Wenn Sie Feedback geben möchten, gehen Sie zu Probleme melden oder Hilfe zu Connectors und wählen Sie einen Feedbacktyp aus.