Erstellen eines benutzerdefinierten Konnektors für eine Web-API

In diesem Lernprogramm erfahren Sie, wie Sie mit dem Aufbau einer ASP.NET Web API beginnen, sie auf dem Azure Web Apps Feature des Azure App Service hosten, die Microsoft Entra ID-Authentifizierung aktivieren und dann die ASP.NET Web API in Power Automate registrieren. Nachdem Sie die API registriert haben, können Sie eine Verbindung damit herstellen und sie über den Flow aufrufen. Darüber hinaus haben Sie vielleicht auch folgende Möglichkeit:

• Registrieren und Aufrufen der API über Power Apps oder Azure Logic Apps.
• Integrate with Microsoft Copilot Studio.

Anforderungen

• Visual Studio 2013 oder höher. In diesem Lernprogramm wird Visual Studio 2015 verwendet.

• Code für Ihre Web-API. Wenn Sie noch keines haben, probieren Sie dieses Lernprogramm aus: Getting Started with ASP.NET Web API 2 (C#).

• Ein Azure-Abonnement. Wenn Sie kein Abonnement haben, können Sie mit einem free Azure Konto beginnen. Andernfalls können Sie sich für ein Pay-As-You-Go-Abonnement registrieren.

Erstellen und Bereitstellen einer ASP.NET Web-App für Azure

Erstellen Sie für dieses Lernprogramm eine Visual C#-ASP.NET Web-App.

1. Öffnen Sie Visual Studio, und wählen Sie dann File>Neues Projekt aus.

   1. Erweitern Sie Installed, wechseln Sie zu Templates>Visual C#>Web, und wählen Sie dann ASP.NET Webanwendung aus.

   2. Geben Sie einen Projektnamen, einen Speicherort und einen Lösungsnamen für Ihre App an, und wählen Sie dann OK.

   

2. Im Feld Neue ASP.NET Webanwendung Wählen Sie die Vorlage Web-API aus, stellen Sie sicher, dass das Kontrollkästchen Host in der Cloud aktiviert ist, und wählen Sie dann Authentifizierung ändern aus.

   

3. Wählen Sie Keine Authentifizierung und dann OK aus. Sie können die Authentifizierung später einrichten.

   

4. Wenn das Feld Neue ASP.NET Webanwendung wieder angezeigt wird, wählen Sie OK aus.

5. Überprüfen Sie im Feld App Service erstellen die in der folgenden Tabelle beschriebenen Hosting-Einstellungen, nehmen Sie die gewünschten Änderungen vor, und wählen Sie dann Erstellen aus.

   Ein App Service-Plan stellt eine Sammlung physischer Ressourcen dar, die zum Hosten von Apps in Ihrem Azure-Abonnement verwendet werden. Erfahren Sie mehr über App Service.

   

   Einstellungen	Vorgeschlagener Wert	Beschreibung
   Ihr Azure Geschäfts-, Schul- oder Unikonto oder Ihr persönliches Microsoft-Konto	Ihr-Benutzerkonto	Wählen Sie Ihr Benutzerkonto.
   Name der Webanwendung	custom-web-api-app-name oder der Standardname	Geben Sie den Namen für Ihre Web-API-Anwendung ein, der z.B. in der URL Ihrer Anwendung verwendet wird: http://Web-api-Anwendungsname.
   Subscription	Azure-subscription-name	Wählen Sie das Azure Abonnement aus, das Sie verwenden möchten.
   Ressourcengruppe	Azure-resource-group-name	Wählen Sie eine vorhandene Azure Ressourcengruppe aus, oder erstellen Sie – falls noch nicht geschehen – eine Ressourcengruppe. Note: Eine Azure Ressourcengruppe organisiert Azure Ressourcen in Ihrem Azure-Abonnement.
   App Service-Plan	App-Service-plan-name	Wählen Sie einen vorhandenen App Service-Plan, oder, falls noch nicht geschehen, erstellen Sie einen Plan.

   Wenn Sie einen App Service-Plan erstellen, geben Sie Folgendes an.

   Einstellungen	Vorgeschlagener Wert	Beschreibung
   Ort	deployment-region	Wählen Sie die Region für die Bereitstellung Ihrer Anwendung.
   Größe	App-Dienstplan-Größe	Wählen Sie Ihre Plangröße, die die Kosten und die Rechenressourcenkapazität für Ihren Serviceplan bestimmt.

   Wählen Sie Explorer zusätzliche Azure-Dienste aus, um andere Ressourcen einzurichten, die von Ihrer App benötigt werden.

   Einstellungen	Vorgeschlagener Wert	Beschreibung
   Ressourcentyp	Azure-resource-type	Wählen Sie alle zusätzlichen Ressourcen, die für Ihre App erforderlich sind, und richten Sie sie ein.

6. Nachdem Visual Studio Ihr Projekt bereitgestellt haben, erstellen Sie den Code für Ihre App.

Eine OpenAPI (Swagger)-Datei erstellen, die Ihre Web-API beschreibt

Um Ihre Web-API-App mit Power Automate, Power Apps oder Logic Apps zu verbinden, benötigen Sie eine OpenAPI-Datei (ehemals Swagger), die die Vorgänge Ihrer API beschreibt. Sie können Ihre eigene OpenAPI-Definition für Ihre API mit dem Swagger-Online-Editor schreiben, aber dieses Tutorial verwendet ein Open Source-Tool namens Swashbuckle.

1. Falls noch nicht geschehen, installieren Sie das Swashbuckle Nuget-Paket in Ihrem Visual Studio Projekt:

   1. Wählen Sie in Visual Studio Tools>NuGet Package Manager>Package Manager Console aus.

   2. Wechseln Sie in der Package Manager Console zum Projektverzeichnis Ihrer App, falls Sie sich noch nicht dort befinden (führen Sie Set-Location "project-path" aus), und führen Sie dieses PowerShell-Cmdlet aus.

      Install-Package Swashbuckle

      

   Tipp

   Wenn Sie Ihre App nach der Installation von Swashbuckle ausführen, generiert Swashbuckle eine OpenAPI-Datei unter dieser URL:

     http://{your-web-api-app-root-URL}/swagger/docs/v1

   Swashbuckle generiert unter dieser URL auch eine Benutzeroberfläche:
   

     http://{your-web-api-app-root-URL}/swagger

2. Wenn Sie fertig sind, veröffentlichen Sie Ihre Web-API-App für Azure. Wenn Sie aus Visual Studio veröffentlichen möchten, klicken Sie mit der rechten Maustaste in Solution Explorer auf Ihr Webprojekt, wählen Sie Publish aus, und folgen Sie den Anweisungen.

   Wichtig

   Wenn ein OpenAPI-Dokument doppelte Vorgangs-IDs enthält, wird es ungültig. Die C#-Beispielvorlage wiederholt die Vorgangs-ID, Values_Get.

   Wenn Sie die C#-Beispielvorlage verwendet haben, können Sie dieses Problem beheben, indem Sie eine Vorgangs-ID-Instanz in Value_Get ändern und erneut veröffentlichen.

3. Rufen Sie das OpenAPI-Dokument ab, indem Sie zu diesem Speicherort navigieren:

   http://{your-web-api-app-root-URL}/swagger/docs/v1

   Sie können auch ein OpenAPI-Beispieldokument aus diesem Tutorial herunterladen. Stellen Sie sicher, dass Sie die Kommentare, die mit // beginnen, entfernen, bevor Sie das Dokument verwenden.

4. Speichern Sie den Inhalt als JSON-Datei. Abhängig von Ihrem Browser müssen Sie den Text möglicherweise kopieren und in eine leere Textdatei einfügen.

Einrichtung der Microsoft Entra ID-Authentifizierung

Sie erstellen nun zwei Microsoft Entra ID Anwendungen in Azure. Weitere Informationen finden Sie unter Integrating applications with Microsoft Entra ID.

Erste Microsoft Entra ID Anwendung: Sichern der Web-API

Die erste Microsoft Entra ID Anwendung wird verwendet, um die Web-API zu sichern. Geben Sie als Namen webAPI ein. Sie können die Microsoft Entra ID-Authentifizierung in Ihrer Web-API aktivieren, indem Sie diese Schritte mit den folgenden Werten befolgen:

• Anmelde-URL: https://login.windows.net
• Antwort-URL: https://<your-root-url>/.auth/login/aad/callback
• Sie brauchen keinen Clientschlüssel.
• Sie müssen keine Berechtigungen delegieren.
• Kopieren Sie die Anwendungs-ID, da Sie sie später benötigen.

Zweite Microsoft Entra ID Anwendung: Sichern des benutzerdefinierten Connectors und delegierten Zugriffs

Die zweite Microsoft Entra ID Anwendung wird verwendet, um die benutzerdefinierte Connectorregistrierung zu sichern und delegierten Zugriff auf die Web-API zu erwerben, die durch die erste Anwendung geschützt ist. Geben Sie als Namen hierfür webAPI-customAPI an.

• Anmelde-URL: https://login.windows.net
• Antwort-URL: https://msmanaged-na.consent.azure-apim.net/redirect
• Fügen Sie Berechtigungen für den delegierten Zugriff auf die Web-API hinzu.
• Kopieren Sie die Anwendungs-ID, da Sie sie später benötigen.
• Erzeugen Sie einen Mandantenschlüssel und kopieren Sie ihn, da Sie ihn später benötigen.

Hinzufügen der Authentifizierung zu Ihrer Azure Web-App

1. Melden Sie sich beim portal Azure an, und suchen Sie dann die Web-App, die Sie im ersten Abschnitt bereitgestellt haben.

2. Wählen Sie Einstellungen, und wählen Sie dann Authentifizierung / Autorisierung.

3. Aktivieren Sie App Service Authentication und wählen Sie dann Azure Active Directory aus. Wählen Sie auf dem nächsten Blatt Express aus.

4. Wählen Sie Bestehende AD-App auswählen und anschließend die webAPI Microsoft Entra ID-Anwendung, die Sie zuvor erstellt haben.

Sie sollten jetzt Microsoft Entra ID verwenden können, um Ihre Web-App zu authentifizieren.

Hinzufügen des benutzerdefinierten Connectors zu Power Automate

1. Ändern Sie Ihre OpenAPI, um das securityDefintions-Objekt hinzuzufügen und die Microsoft Entra ID-Authentifizierung für die Web-App zu verwenden. Der Teil Ihrer OpenAPI mit der host-Eigenschaft sollte wie folgt aussehen:

// File header should be above here...

"host": "<your-root-url>",
"schemes": [
    "https"         //Make sure this is https!
],
"securityDefinitions": {
    "Microsoft Entra ID": {
        "type": "oauth2",
        "flow": "accessCode",
        "authorizationUrl": "https://login.windows.net/common/oauth2/authorize",
        "tokenUrl" : "https://login.windows.net/common/oauth2/token",
        "scopes": {}
    }
},

// The rest of the OpenAPI follows...

2. Navigieren Sie zu Power Automate, und fügen Sie einen benutzerdefinierten Connector hinzu, wie in Use custom connectors in Power Automate beschrieben.

3. Nachdem Sie Ihre OpenAPI hochgeladen haben, erkennt der Assistent automatisch, dass Sie Microsoft Entra ID Authentifizierung für Ihre Web-API verwenden.

4. Konfigurieren Sie die Microsoft Entra ID Authentifizierung für den benutzerdefinierten Connector.

• Client-ID: Client-ID von „webAPI-CustomAPI“
• Geheimer Clientschlüssel: Clientschlüssel von webAPI-CustomAPI
• Anmelde-URL: https://login.windows.net
• ResourceUri: Client-ID von „webAPI“

5. Wählen Sie Erstellen aus, um eine Verbindung mit dem benutzerdefinierten Connector zu erstellen.

Verwandte Informationen

Erfahren Sie mehr über Microsoft Entra ID Authentifizierung

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 mit Connectors melden oder Hilfe anfordern und wählen Sie einen Feedbacktyp aus.