Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
In diesem Artikel erfahren Sie mehr über den Aufbau von Teams-App-Funktionen. Hier ist eine Liste der verfügbaren Schritt-für-Schritt-Anleitungen für die Funktionen der Teams-Plattform.
| # | Funktion | Schritt-für-Schritt-Anleitung |
|---|---|---|
| 1. | Bot |
-
Debuggen Ihres KI-Chatbots mit Microsoft 365 Agents Playground - Proaktive Nachrichten senden |
| 2. | Nachrichtenerweiterung |
-
API-basierte Nachrichtenerweiterung erstellen - Erstellen einer aktionsbasierten Nachrichtenerweiterung - Erstellen Ihrer ersten Nachrichtenerweiterungs-App mit JavaScript |
| 3. | Tab | Erstellen Ihrer ersten Registerkarten-App mit C-sharp |
| 4. | SSO |
-
Erstellen eines Bots mit SSO-Authentifizierung - Hinzufügen von SSO zur Registerkarten- und Nachrichtenerweiterungs-App |
Erstellen Sie Ihre erste Bot-App
Beginnen Sie die Entwicklung von Microsoft Teams-Apps mit Ihrer ersten Teams-App. Sie können eine Bot-App mit Teams mithilfe von Javascript erstellen.
Erstellen Sie Ihren ersten Bot.
Ihre App verfügt über eine Funktion mit eigener Benutzeroberfläche und UX:
In diesem Tutorial lernst du Folgendes:
- Einrichten eines neuen Projekts mit dem Microsoft 365 Agents Toolkit (früher bekannt als Teams Toolkit).
- Erstellen einer Bot-App.
- Bereitstellen Ihrer App.
Voraussetzungen
Stellen Sie sicher, dass Sie die folgenden Tools zum Erstellen und Bereitstellen Ihrer Apps installieren.
| Installieren | Zur Verwendung... | |
|---|---|---|
| Erforderlich | ||
| Microsoft 365 Agents Toolkit | Eine Microsoft Visual Studio Code-Erweiterung, die ein Projektgerüst für Ihre App erstellt. Verwenden Sie die neueste Version. | |
| Microsoft Teams | Microsoft Teams für die Zusammenarbeit mit allen Personen, mit denen Sie zusammenarbeiten, über Apps für Chats, Besprechungen und Anrufe – alles an einem Ort. | |
| Node.js | JavaScript-Laufzeitumgebung für das Back-End. Weitere Informationen finden Sie in Node.js Versionskompatibilitätstabelle für den Projekttyp. | |
| Microsoft Edge (empfohlen) oder Google Chrome | Ein Browser mit Entwicklertools. | |
| Visual Studio Code | JavaScript, TypeScript oder SharePoint-Framework (SPFx)-Buildumgebungen. Verwenden Sie die neueste Version. | |
| Optional | ||
| Azure-Tools für Visual Studio Code und Azure CLI | Azure-Tools für den Zugriff auf gespeicherte Daten oder für die Bereitstellung eines cloudbasierten Back-Ends für Ihre Teams-App in Azure. | |
| React Developer Tools für Chrome ODER React Developer Tools für Microsoft Edge | Eine Browser-DevTools-Erweiterung für die Open-Source-JavaScript-Bibliothek React. | |
| Microsoft Graph Explorer | Microsoft Graph Explorer, ein browserbasiertes Tool, mit dem Sie eine Abfrage aus Microsoft Graph-Daten ausführen können. | |
| Entwicklerportal für Teams | Webbasiertes Portal zum Konfigurieren, Verwalten und Veröffentlichen Ihrer Teams-App, einschließlich für Ihre organization oder den Microsoft Teams Store. |
Tipp
Wenn Sie mit Microsoft Graph-Daten arbeiten, sollten Sie den Microsoft Graph-Explorer kennenlernen und mit einem Lesezeichen versehen. Mit diesem browserbasierten Tool können Sie Microsoft Graph außerhalb einer App abfragen.
Erforderliche Komponenten einrichten
Nachdem Sie die erforderlichen Tools installiert haben, richten Sie die Entwicklungsumgebung ein.
Microsoft 365 Agents Toolkit installieren
Microsoft 365 Agents Toolkit (früher als Teams Toolkit bezeichnet) hilft dabei, den Entwicklungsprozess mit Tools zum Bereitstellen und Bereitstellen von Cloudressourcen für Ihre App und zur Veröffentlichung im Teams Store zu vereinfachen.
Sie können Agents Toolkit mit Visual Studio Code oder eine Befehlszeilenschnittstelle namens Microsoft 365 Agents Toolkit CLI (früher als TeamsFx CLI bezeichnet) verwenden.
Öffne Visual Studio Code und wähle Erweiterungen aus (STRG+UMSCHALT+X oderErweiterungenanzeigen>).
Geben Sie im Suchfeld "Microsoft 365 Agents Toolkit" ein.
Wählen Sie Installieren aus.
Das Symbol Microsoft 365 Agents Toolkit
wird in der Aktivitätsleiste von Visual Studio Code angezeigt.
Sie können Agents Toolkit auch aus dem Visual Studio Code Marketplace installieren.
Einrichten Ihres Teams-Entwicklungsmandanten
Ein Mandant ist ein Raum oder Container für Ihre organization in Teams, in dem Sie chatten, Dateien freigeben und Besprechungen abhalten. In diesen Bereich laden Sie auch Ihre App hoch und testen sie. Lassen Sie uns überprüfen, ob Sie bereit sind, mit dem Mandanten zu entwickeln.
Option zum Hochladen einer App überprüfen
Nachdem Sie Ihre benutzerdefinierte App erstellt haben, müssen Sie Ihre App mit der Option "Benutzerdefinierte App hochladen " in Teams hochladen. Melden Sie sich bei Ihrem Microsoft 365-Konto an, um zu überprüfen, ob diese Option aktiviert ist.
Mithilfe der folgenden Schritte können Sie überprüfen, ob Sie Apps in Teams hochladen können:
Wählen Sie im Teams-Client das Symbol "Apps " aus.
Wählen Sie Apps verwalten aus.
Wählen Sie App hochladen aus.
Suchen Sie nach der Option zum Hochladen einer benutzerdefinierten App. Wenn die Option angezeigt wird, können Sie benutzerdefinierte Apps hochladen.
Hinweis
Wenn Sie die Option zum Hochladen einer benutzerdefinierten App nicht finden, wenden Sie sich an Ihren Teams-Administrator.
Erstellen eines kostenlosen Microsoft Teams-Entwicklermandanten
Wenn Sie kein Teams-Entwicklerkonto haben, treten Sie dem Microsoft 365-Entwicklerprogramm bei. Dies ist ein optionaler Schritt.
Wechseln Sie zum Microsoft 365-Entwicklerprogramm.
Wählen Sie "Jetzt teilnehmen" aus, und folgen Sie den Anweisungen auf dem Bildschirm.
Wählen Sie auf dem Willkommensbildschirm E5-Abonnement einrichten aus.
Richten Sie Ihr Administratorkonto ein. Nach Abschluss des Vorgangs wird der folgende Bildschirm angezeigt:
Melden Sie sich mit dem soeben eingerichteten Administratorkonto bei Teams an. Stellen Sie sicher, dass die Option "Benutzerdefinierte App hochladen " in Teams vorhanden ist.
Kostenloses Azure-Konto erhalten
Wenn Sie Ihre App hosten oder auf Ressourcen in Azure zugreifen möchten, benötigen Sie ein Azure-Abonnement. Erstellen Sie ein kostenloses Konto , bevor Sie beginnen.
Jetzt verfügen Sie über alle Tools, um Ihr Konto einzurichten. Als Nächstes richten wir deine Entwicklungsumgebung ein und beginnen mit dem Erstellen! Wählen Sie zuerst die App aus, die Sie erstellen möchten.
Projektarbeitsbereich für Ihre Bot-App erstellen
Lassen Sie uns Ihre erste Bot-App erstellen.
Die Botfunktion einer Teams-App erstellt einen Chatbot oder Unterhaltungsbot. Sie verwenden es, um einfache und automatisierte Aufgaben auszuführen, wie z. B. die Bereitstellung von Kundenservice. Ein Bot kommuniziert mit einem Webdienst und hilft Ihnen bei der Nutzung seiner Angebote. Sie können Wettervorhersagen abrufen, Reservierungen vornehmen oder jeden anderen angebotenen Dienst über einen Konversationsbot erhalten.
Da Sie die Erstellung dieser Apps bereits vorbereitet haben, können Sie ein neues Teams-Projekt zum Erstellen der Bot-App einrichten.
In diesem Tutorial lernst du Folgendes:
- So richten Sie ein neues Bot-Projekt mit Agents Toolkit ein.
- Über die Verzeichnisstruktur Ihres App-Projekts.
Wichtig
Bots sind in Government Community Cloud (GCC), GCC High, Department of Defense (DoD) und Teams, die von 21Vianet-Umgebungen betrieben werden, verfügbar.
Erstellen Sie Ihren Botprojektarbeitsbereich
Wenn die Voraussetzungen gegeben sind, kann es losgehen!
Hinweis
Die gezeigte Visual Studio Code-Benutzeroberfläche stammt vom Mac. Dies kann je nach Betriebssystem, Agents Toolkit-Version und Umgebung variieren.
Öffne Visual Studio Code.
Wählen Sie das Symbol Microsoft 365 Agents Toolkit
in der Aktivitätsleiste von Visual Studio Code aus.Wählen Sie "Neue Agent-/App-Teams-App> erstellen" aus.
Wählen Sie Bot , um ein neues Bot-Projekt zu erstellen.
Stellen Sie sicher, dass Basic Bot als App-Feature ausgewählt ist, das Sie in Ihrer App erstellen möchten.
Wählen Sie JavaScript als Programmiersprache aus.
Wähle Standardordner aus, um den Projektstammordner am Standardspeicherort zu speichern.
Sie können den Standardspeicherort auch wie folgt ändern:
Wählen Sie Durchsuchen aus.
Wählen Sie den Speicherort für den Projektarbeitsbereich aus.
Wählen Sie den ausgewählten Ordner aus.
Geben Sie einen geeigneten Namen für Ihre App ein, und wählen Sie dann die EINGABETASTE aus.
Ein Dialogfeld wird angezeigt, in dem Sie Ja oder Nein auswählen müssen, um den Autoren der Dateien in diesem Ordner zu vertrauen.
Ihre Teams-App mit einer Botfunktion ist in wenigen Sekunden erstellt.
Nachdem Ihre App erstellt wurde, zeigt Agents Toolkit die folgende Meldung an:
Wähle Lokales Debuggen aus, um eine Vorschau deines Projekts anzuzeigen.
Eine kurze Zusammenfassung der Erstellung einer Teams-App.
Sehen Sie sich diese kurze Zusammenfassung zum Erstellen einer Teams-App an.
Unternehmen Sie eine Tour durch den Quellcode der Bot-App
Zeigen Sie nach Abschluss des Gerüstbaus die Projektverzeichnisse und Dateien im Explorer in Visual Studio Code an.
| Ordner / Datei | Inhalt |
|---|---|
m365agents.yml |
Hauptprojektdatei |
m365agents.local.yml |
Dies setzt Aktionen außer Kraft m365agents.yml , die lokale Ausführung und Debugging ermöglichen. |
.vscode/ |
VSCode-Dateien für lokales Debuggen. |
appPackage/ |
Vorlagen für das Teams-Anwendungsmanifest. |
adaptiveCards/ |
Adaptive Karten, die vom Bot zurückgeschickt werden. |
infra/ |
Vorlagen für die Bereitstellung von Azure-Ressourcen. |
index.js |
Anwendungseinstiegspunkt und express -handler. |
teamsBot.js |
Teams-Aktivitätshandler. |
Tipp
Machen Sie sich mit Bots außerhalb von Teams vertraut, bevor Sie Ihren ersten Bot in Teams integrieren.
Erstellen und Ausführen Ihrer ersten Bot-App
Nachdem Sie Ihren Projektarbeitsbereich mit Agents Toolkit eingerichtet haben, erstellen Sie Ihr Botprojekt. Sie müssen sich bei Ihrem Microsoft 365-Konto anmelden.
Anmelden bei Ihrem Microsoft 365-Konto
Verwenden Sie dieses Konto, um sich bei Teams anzumelden. Wenn Sie einen Microsoft 365-Entwicklerprogrammmandanten verwenden, ist das Administratorkonto, das Sie bei der Registrierung einrichten, Ihr Microsoft 365-Konto.
Öffne Visual Studio Code.
Wählen Sie auf der Randleiste das Symbol Microsoft 365 Agents Toolkit
aus.Wählen Sie "Bei M365 anmelden" mit Ihren Anmeldeinformationen aus.
Ihr Standardwebbrowser wird geöffnet, damit Sie sich beim Konto anmelden können.
Schließen Sie den Browser, wenn Sie dazu aufgefordert werden, und kehren Sie zu Visual Studio Code zurück.
Zurück zum Agents-Toolkit in Visual Studio Code.
Verwenden Sie dieses Konto, um sich bei Teams anzumelden. Wenn Sie einen Microsoft 365-Entwicklerprogrammmandanten verwenden, ist das Administratorkonto, das Sie bei der Registrierung einrichten, Ihr Microsoft 365-Konto.
Jetzt können Sie die App erstellen und lokal ausführen!
Erstellen und Ausführen Ihrer ersten Bot-App lokal
So erstellen und führen Sie Ihre App in der lokalen Umgebung aus:
Wähle in Visual Studio Code F5 aus, um deine App im Debugmodus auszuführen.
Hinweis
Wenn Agents Toolkit eine bestimmte Voraussetzung nicht überprüfen kann, werden Sie aufgefordert, dies zu überprüfen.
Erfahren Sie, was geschieht, wenn Sie Ihre App lokal im Debugger ausführen.
Falls Sie sich fragen, wenn Sie die Taste F5 drücken, Agents Toolkit:
- Überprüft alle folgenden Voraussetzungen:
- Sie sind mit einem Microsoft 365-Konto angemeldet.
- Der benutzerdefinierte App-Upload ist für Ihr Microsoft 365-Konto aktiviert.
- Unterstützte Node.js-Version ist installiert.
- Von Bot-App erforderlicher Port ist verfügbar.
- Installieren Sie npm-Pakete.
- Startet den Dev-Tunnel, um einen HTTP-Tunnel zu erstellen.
- Registriert die App in Microsoft Entra ID und konfiguriert die App.
- Registriert die Bot-App im Bot Framework und konfiguriert die Bot-App.
- Registriert die App im Teams-Entwicklerportal und konfiguriert die App.
- Startet die Bot-App.
- Startet Teams in einem Webbrowser und lädt die benutzerdefinierte Bot-App hoch.
Hinweis
Wenn Sie die App zum ersten Mal ausführen, werden alle Abhängigkeiten heruntergeladen, und die App wird erstellt. Nach Abschluss des Builds wird automatisch ein Browserfenster geöffnet. Dieser Vorgang kann drei bis fünf Minuten in Anspruch nehmen.
Teams führt Ihre App in einem Webbrowser aus.
Melden Sie sich mit Ihrem Microsoft 365-Konto an, wenn Sie dazu aufgefordert werden.
Wählen Sie "Hinzufügen" aus, um die benutzerdefinierte Bot-App in Teams hochzuladen.
Wählen Sie "Öffnen " aus, um die App im persönlichen Bereich zu öffnen.
Alternativ können Sie entweder den gewünschten Bereich durchsuchen und auswählen oder einen Kanal, Chat oder eine Besprechung aus der Liste auswählen und durch das Dialogfeld navigieren, um Los auszuwählen.
Jetzt wird der Bot erfolgreich in Teams ausgeführt! Nachdem die App geladen wurde, wird eine Chatsitzung mit dem Bot geöffnet.
Sie können eingeben
welcome, um eine Einführung Karte anzuzeigen, und eingebenlearn, um zur Dokumentation zu adaptiven Karten und Botbefehlen zu gelangen.
Sie können wie bei jeder anderen Webanwendung auch normale Debugaktivitäten ausführen, z. B. das Festlegen von Haltepunkten. Öffnen Sie die Datei,
bot/teamsBot.jsund suchen Sie dieonMessage()Methode. Legen Sie für jeden Fall einen Haltepunkt fest. Geben Sie dann Text ein.Erfahren Sie, wie Sie Probleme beheben können, wenn Ihre App nicht lokal ausgeführt wird.
Um Ihre App erfolgreich in Teams auszuführen, stellen Sie sicher, dass Sie den benutzerdefinierten App-Upload in Ihrem Teams-Konto aktiviert haben. Weitere Informationen zum Hochladen benutzerdefinierter Apps finden Sie im Abschnitt "Voraussetzungen".
Wichtig
Der benutzerdefinierte App-Upload ist in Government Community Cloud (GCC) verfügbar und wird in GCC High, DoD und Teams, die von 21Vianet betrieben werden, nicht unterstützt.
Tipp
Suchen Sie mit dem App-Validierungstool nach Problemen, bevor Sie eine benutzerdefinierte App hochladen. Dieses Tool ist im Toolkit enthalten. Beheben Sie die Fehler zum Hochladen der App.
Bereitstellen Ihrer ersten Teams-App
Sie haben gelernt, eine Teams-App mit Botfunktion zu erstellen, zu erstellen und auszuführen. Der letzte Schritt besteht darin, Ihre App in Azure bereitzustellen.
Stellen wir die erste App mit Bot-Funktion in Azure mithilfe des Agents Toolkit bereit.
Anmelden bei Ihrem Azure-Konto
Verwenden Sie dieses Konto für den Zugriff auf das Microsoft Azure-Portal und zum Bereitstellen neuer Cloudressourcen zur Unterstützung Ihrer App.
Öffne Visual Studio Code.
Öffnen Sie den Projektordner, in dem Sie die Bot-App erstellt haben.
Wählen Sie auf der Randleiste das Symbol Microsoft 365 Agents Toolkit
aus.Wählen Sie Bei Azure anmelden mit Ihren Anmeldeinformationen aus.
Tipp
Wenn Sie die AZURE ACCOUNT-Erweiterung installiert haben und dasselbe Konto verwenden, können Sie diesen Schritt überspringen. Verwenden Sie dasselbe Konto wie in anderen Erweiterungen.
Ihr Standardwebbrowser wird geöffnet, damit Sie sich beim Konto anmelden können.
Schließen Sie den Browser, wenn Sie dazu aufgefordert werden, und kehren Sie zu Visual Studio Code zurück.
Im Abschnitt "KONTEN " der Randleiste werden die beiden Konten separat angezeigt. Außerdem wird die Anzahl der nutzbaren Azure-Abonnements aufgeführt, die Ihnen zur Verfügung stehen. Stellen Sie sicher, dass Sie über mindestens ein nutzbares Azure-Abonnement verfügen. Wenn nicht, melden Sie sich ab und verwenden Sie ein anderes Konto.
Herzlichen Glückwunsch, Sie haben eine Teams-App erstellt! Nun erfahren Sie, wie Sie eine der Apps mithilfe des Agents-Toolkits in Azure bereitstellen.
Bereitstellen und Bereitstellen Ihrer App in Azure
Die Bereitstellung besteht aus zwei Schritten. Zunächst erstellt Azure die erforderlichen Cloudressourcen (auch als Bereitstellung bezeichnet). Anschließend kopiert Azure den Code Ihrer App in die erstellten Cloudressourcen. Für dieses Tutorial stellen Sie die Bot-App bereit.
Was ist der Unterschied zwischen Bereitstellen und Bereitstellen?
Der Bereitstellungsschritt erstellt Ressourcen in Azure und Microsoft 365 für Ihre App, kopiert jedoch keinen Code (HTML, CSS oder JavaScript) in die Ressourcen. Im Bereitstellungsschritt wird der Code für Ihre App in die Ressourcen kopiert, die Sie während des Bereitstellungsschritts erstellt haben. Es kommt häufig vor, dass mehrere Stellen bereitgestellt werden, ohne dass neue Ressourcen bereitgestellt werden. Da der Bereitstellungsschritt einige Zeit in Anspruch nehmen kann, ist er vom Bereitstellungsschritt getrennt.
Wählen Sie das Symbol Microsoft 365 Agents Toolkit
in der Visual Studio Code-Randleiste aus.
Wählen Sie "Bereitstellen" aus.
Wählen Sie ein Abonnement für die Azure-Ressourcen aus.
Ihre App wird mithilfe von Azure-Ressourcen gehostet.
Ein Dialogfeld warnt Sie, dass beim Ausführen von Ressourcen in Azure Kosten anfallen können.
Wählen Sie "Bereitstellen" aus.
Beim Bereitstellungsprozess werden Ressourcen in der Azure-Cloud erstellt. Dies kann einige Zeit dauern. Sie können den Fortschritt überwachen, indem Sie die Dialogfelder in der unteren rechten Ecke beobachten. Nach ein paar Minuten sehen Sie den folgenden Hinweis:
Sie können sich die bereitgestellten Ressourcen anzeigen lassen. Für dieses Tutorial müssen Sie keine Ressourcen anzeigen.
Die bereitgestellte Ressource wird im Abschnitt ENVIRONMENT angezeigt.
Wählen Sie nach Abschluss der Bereitstellung im Bereich "LEBENSZYKLUS" die Option "Bereitstellen" aus.
Wie bei der Bereitstellung nimmt die Bereitstellung einige Zeit in Anspruch. Sie können den Prozess überwachen, indem Sie die Dialogfelder in der unteren rechten Ecke beobachten. Nach ein paar Minuten wird ein Hinweis zum Abschluss angezeigt.
Jetzt können Sie denselben Prozess verwenden, um Ihre Bot- und Nachrichtenerweiterungs-Apps in Azure bereitzustellen.
Ausführen der bereitgestellten App
Gehen Sie nach Abschluss der Bereitstellungs- und Bereitstellungsschritte folgendermaßen vor:
Öffnen Sie den Debugbereich (STRG+UMSCHALT+D / ⌘⇧-D oder Ausführung anzeigen>) in Visual Studio Code.
Wählen Sie "Remote starten (Edge)" aus der Dropdownliste der Startkonfiguration aus.
Klicken Sie auf Debuggen starten (F5). Sie werden aufgefordert, die benutzerdefinierte Bot-App in Teams hochzuladen.
Wählen Sie Hinzufügen aus.
Wählen Sie "Öffnen " aus, um die App im persönlichen Bereich zu öffnen.
Alternativ können Sie entweder den gewünschten Bereich durchsuchen und auswählen oder einen Kanal, Chat oder eine Besprechung aus der Liste auswählen und durch das Dialogfeld navigieren, um Los auszuwählen.
Sie haben Ihre Bot-App erfolgreich zum Teams-Client hinzugefügt.
Erfahren Sie, was geschieht, wenn Sie Ihre App in Azure bereitstellen.
Vor der Bereitstellung wurde die Anwendung lokal ausgeführt:
- Das Back-End wird mithilfe der Azure Functions Core Tools ausgeführt.
- Der HTTP-Endpunkt der Anwendung, auf den Microsoft Teams die Anwendung lädt, wird lokal ausgeführt.
Die Bereitstellung erfolgt in zwei Schritten. Sie stellen die Ressourcen in einem aktiven Azure-Abonnement bereit und stellen dann den Back-End- und Front-End-Code für die Anwendung in Azure bereit oder laden ihn hoch.
- Wenn das Back-End konfiguriert ist, verwendet es verschiedene Azure-Dienste, einschließlich Azure App Service und Azure Storage.
- Die Front-End-Anwendung wird in einem Azure Storage-Konto bereitgestellt, das für statisches Webhosting konfiguriert ist.
Herzlichen Glückwunsch.
Du hast es geschafft!
Sie haben eine Bot-App erstellt.
Nachdem Sie nun wissen, wie Sie eine einfache App erstellen, können Sie mit dem Erstellen komplexerer Apps fortfahren. Sie haben das Tutorial zum Erstellen eines Bots mit JavaScript abgeschlossen.
Debuggen Ihres KI-Chatbots mit Microsoft 365 Agents Playground
Starten Sie die Microsoft Teams-App-Entwicklung mit Ihrer Teams KI-Chatbot-App, und debuggen Sie mit Microsoft 365 Agents Playground (früher als Teams App Test Tool bezeichnet). Agents Playground macht das Debuggen von Bot-basierten Apps mühelos. Sie benötigen kein Microsoft 365-Entwicklerkonto, keinen Tunnel oder keine Teams-App und Bot-Registrierung, um Agents Playground zu verwenden.
Tutorial: Debuggen Ihres KI-Chatbots
Voraussetzungen
Sie können mit Ihrem Bot chatten und die Nachrichten und adaptiven Karten anzeigen, während sie in Teams angezeigt werden. Sie können eine Aktivität in Agents Playground auch mithilfe von Aktivitätstriggern simulieren.
Hinweis
- Agents Playground ist nur in Version 5.4.0 von Microsoft 365 Agents Toolkit (früher als Teams Toolkit bezeichnet) verfügbar.
- Agents Playground wird nur für Desktop- und Webclients unterstützt.
Diese Schritt-für-Schritt-Anleitung hilft Ihnen, einen KI-Chatbot mit dem Agents Toolkit zu erstellen und mit dem Testtool zu debuggen. Nach Abschluss dieses Leitfadens wird die folgende Ausgabe angezeigt, in der der Benutzer auf den KI-Chatbot zugreifen und ihn verwenden kann:
| Installieren | Zur Verwendung... |
|---|---|
| Visual Studio Code oder Visual Studio | JavaScript-, TypeScript- oder C#-Buildumgebungen. Verwenden Sie die neueste Version. |
| Microsoft 365 Agents Toolkit | Microsoft Visual Studio Code-Erweiterung, die ein Projektgerüst für Ihre App erstellt. Verwenden Sie Agents Toolkit v5.4.0. Weitere Informationen finden Sie unter Installieren des Agents Toolkit. |
| Node.js | JavaScript-Laufzeitumgebung für das Back-End. Weitere Informationen finden Sie in Node.js Versionskompatibilitätstabelle für den Projekttyp. |
| OpenAI oder Azure OpenAI | Erstellen Sie zunächst Ihren OpenAI-API-Schlüssel, um die GPT von OpenAI zu verwenden. Wenn Sie Ihre App hosten oder auf Ressourcen in Azure zugreifen möchten, müssen Sie einen Azure OpenAI-Dienst erstellen. |
| Microsoft Edge (empfohlen) oder Google Chrome | Ein Browser mit Entwicklertools. |
Projektarbeitsbereich für Ihre KI-Chatbot-App erstellen
Die Botfunktion einer Teams-App erstellt einen Chatbot oder Unterhaltungsbot. Es kommuniziert mit einem Webdienst und erleichtert so die Nutzung seiner Dienste. Der Bot kann einfache, automatisierte Aufgaben wie die Bereitstellung von Kundenservice ausführen. Sie können Wettervorhersagen abrufen, Reservierungen vornehmen oder jeden anderen angebotenen Dienst über einen Konversationsbot erhalten.
Da Sie die Erstellung dieser Apps bereits vorbereitet haben, können Sie ein neues Teams-Projekt zum Erstellen der KI-Chatbot-App einrichten.
Erstellen Sie Ihren Botprojektarbeitsbereich
Wenn die Voraussetzungen gegeben sind, kann es losgehen!
Öffne Visual Studio Code.
Wählen Sie das Symbol Microsoft 365 Agents Toolkit
in der Aktivitätsleiste von Visual Studio Code aus.Wählen Sie "Neue Agentin/App erstellen" aus.
Wählen Sie Agents für Teams> aus Azure OpenAI> Geben Sie jetzt eine Eingabe in Geben Sie Azure API-Dienstschlüssel ein
Wählen Sie Basic-Agents für Teams aus. Wenn Sie eine andere Funktionalität für Ihren Bot benötigen, wählen Sie die gewünschte Option aus.
Wählen Sie die Programmiersprache als JavaScript aus.
Wählen Sie Standardordner aus.
Gehen Sie wie folgt vor, um den Standardspeicherort zu ändern:
Wählen Sie Durchsuchen aus.
Wählen Sie den Speicherort für den Projektarbeitsbereich aus.
Wählen Sie "Ordner auswählen" aus.
Geben Sie einen geeigneten Namen für Ihre App ein, und wählen Sie dann die Eingabetaste aus .
Ein Dialogfeld wird angezeigt, in dem Sie Ja oder Nein auswählen müssen, um den Autoren der Dateien in diesem Ordner zu vertrauen.
Jetzt haben Sie erfolgreich Ihren KI-Chatbot-Projektarbeitsbereich erstellt.
Unternehmen Sie eine Tour durch den Quellcode der Bot-App
Nachdem du das Gerüst fertiggestellt hast, erkunde die Projektverzeichnisse und Dateien im EXPLORER-Abschnitt von Visual Studio Code.
| Ordner- oder Dateiname | Inhalt |
|---|---|
env/.env.playground |
Die Konfigurationsdatei mit Umgebungsvariablen, die an Git übergeben werden können. |
env/.env.playground.user |
Die Konfigurationsdatei mit Umgebungsvariablen, einschließlich Anmeldeinformationen, die standardmäßig nicht an Git übergeben werden. |
appPackage |
Vorlagendateien für App-Manifeste und App-Symbole (color.png und outline.png). |
appPackage/manifest.json |
App-Manifest zum Ausführen der App in lokalen und Remoteumgebungen. |
src/app.js |
Verarbeitet die Geschäftslogik für den KI-Chatbot. |
m365agents.yml |
Dies ist die Hauptprojektdatei des Agents-Toolkits. Die Projektdatei definiert zwei grundlegende Dinge: Eigenschaften und Konfiguration sowie Phasendefinitionen. |
m365agents.local.yml |
Dies setzt Aktionen außer Kraft m365agents.yml , die lokale Ausführung und Debugging ermöglichen. |
m365agents.playground.yml |
Dies setzt Aktionen außer m365agents.yml Kraft, die die lokale Ausführung und das Debuggen im Testtool ermöglichen. |
Erstellen und Ausführen Ihrer KI-Chatbot-App
OpenAI-Schlüssel und Endpunkt für Ihren KI-Chatbot erstellen
Wechseln Sie zum Azure-Portal.
Wählen Sie Ressource erstellen aus, und suchen Sie nach Azure OpenAI.
Wählen Sie Azure OpenAI und dann Erstellen aus.
Geben Sie die erforderlichen Details ein, und klicken Sie auf Weiter.
Wählen Sie Alle Netzwerke aus, einschließlich des Internets, können auf diese Ressource zugreifen, und wählen Sie dann Weiter aus.
Geben Sie die erforderlichen Details ein, und klicken Sie auf Weiter.
Wählen Sie Erstellen aus.
Sie haben erfolgreich Schlüssel und Endpunkt für Ihren KI-Chatbot erstellt.
Hinweis
Sie können auch einen OpenAI-API-Schlüssel abrufen, um Ihren KI-Chatbot zu debuggen.
Abrufen von Azure OpenAI-Schlüsseln und -Endpunkt
Wählen Sie Zu Ressourcen wechseln aus.
Wählen Sie im linken Bereich Schlüssel und Endpunkt aus, und kopieren Sie den Schlüssel und Endpunkt. Sie können entweder SCHLÜSSEL 1 oder SCHLÜSSEL 2 kopieren.
Speichern Sie den SCHLÜSSEL und den Endpunkt zur weiteren Verwendung.
Wählen Sie im linken Bereich Modellbereitstellungen und dann Bereitstellungen verwalten aus.
Das Fenster Azure OpenAI Studio wird angezeigt.
Wählen Sie im linken Bereich Bereitstellungen und dann + Neue Bereitstellung erstellen aus.
Wählen Sie die folgenden Details aus:
Wählen Sie gpt-35-turbo aus der Dropdownliste Modell auswählen aus.
Hinweis
Für den KI-Chatbot wird nur das Modell gpt-35-turbo unterstützt.
Wählen Sie 0301 (Standard) aus der Dropdownliste Modellversion aus.
Geben Sie den Bereitstellungsnamen ein, und wählen Sie Erstellen aus.
Kopieren und speichern Sie den Bereitstellungsnamen zur weiteren Verwendung.
Aktualisieren des Azure OpenAI-Schlüssels und der Endpunkte
Öffne dein Projekt in Visual Studio Code.
Wechseln Sie unter EXPLORER zur Datei env.env.playground.user>.
Geben Sie Ihre SECRET_AZURE_OPENAI_API_KEY und SECRET_AZURE_OPENAI_ENDPOINT ein.
... SECRET_AZURE_OPENAI_API_KEY=<azure-openai-api-key> SECRET_AZURE_OPENAI_ENDPOINT=<azure-openai-endpoint>Wechseln Sie zu src>app.js Datei.
Kommentieren Sie den
OpenAICode aus, und kommentieren Sie die Auskommentierung desAzure OpenAICodes auf.Geben Sie den Namen für Ihre Azure OpenAI-Bereitstellung in
azureDefaultDeploymentein.// Use OpenAI // apiKey: config.openAIKey, // defaultModel: "gpt-3.5-turbo", azureApiKey: config.azureOpenAIKey, azureDefaultDeployment: "gpt-35-turbo", azureEndpoint: config.azureOpenAIEndpoint,
Debuggen und Ausführen Ihrer KI-Chatbot-App
Wählen Sie im linken Bereich AUSFÜHREN und DEBUGGEN (STRG+UMSCHALT+D) und dann in der Dropdownliste Debuggen in Agents Playground aus.
Agents Playground öffnet Ihren KI-Chatbot auf einer Webseite.
Aktivitätsauslöser
Es gibt zwei Arten von Aktivitätsauslösern:
Vordefinierte Aktivitätsauslöser
Agents Playground stellt vordefinierte Aktivitätstrigger bereit, um die Funktionen Ihres Bots zu testen.
| Kategorie | Aktivität | Handler |
|---|---|---|
| Installationsupdateaktivität auslösen | Bot installieren Bot zum Deinstallieren |
onInstallationUpdate onInstallationUpdateAdded onInstallationUpdate onInstallationUpdateRemove |
| Konversationsupdateaktivität auslösen | Benutzer hinzufügen Bot hinzufügen Kanal hinzufügen |
onMembersAdded onTeamsMembersAddedEvent onMembersAdded onTeamsMembersAddedEvent onTeamsChannelCreatedEvent |
| Remote-Benutzer Bot entfernen Kanal entfernen Team entfernen |
onMembersRemoved onTeamsMembersRemovedEvent onMembersRemoved onTeamsMembersRemovedEvent onTeamsChannelDeletedEvent onTeamsTeamDeletedEvent |
|
| Kanal umbenennen Team umbenennen |
onTeamsChannelRenamedEvent onTeamsTeamRenamedEvent |
Hinweis
Nicht alle Arten von Aktivitäten sind in allen Bereichen verfügbar. Sie können beispielsweise keinen Kanal in einem persönlichen Chat oder Gruppenchat hinzufügen oder entfernen.
Vordefinierte Aktivitätsauslöser sind im Menü "Aktivität simulieren " im Agenten-Playground verfügbar.
Führen Sie die folgenden Schritte aus, um eine Benutzeraktivität zu simulieren:
Wechseln Sie in Agents Playground zu Mock an activity add>user.
Ein Dialogfeld wird angezeigt, um eine Vorschau des Aktivitätshandlers anzuzeigen.
Wählen Sie Aktivität senden aus.
Bot sendet die folgende Antwort:
Benutzerdefinierte Aktivitätstrigger
Sie können benutzerdefinierte Aktivitäten verwenden, um Aktivitätsauslöser anzupassen, reactionsAdded z. B. um die Anforderungen Ihrer Bot-App zu erfüllen. Agents Playground füllt automatisch die erforderlichen Eigenschaften der Aktivität aus. Sie können auch den Aktivitätstyp ändern und weitere Eigenschaften hinzufügen.
Wählen Sie "Aktivität simulieren>" und"Benutzerdefinierte Aktivität" aus.
Fügen Sie hinzu
messageReaction, um die Aktivität unter dertypeEigenschaft anzupassen:{ "type": "messageReaction", "reactionsAdded": [ { "type": "like" } ], "replyToId": "d60fd1cb-3e8f-44ef-849c-404806ba1b47" }Wählen Sie Aktivität senden aus.
Bot sendet einen
onReactionsAddedHandler als Antwort.
Herausforderung abschließen
Hast du dir eine Ausgabe wie diese ausgedacht?
Herzlichen Glückwunsch. Sie haben erfolgreich eine KI-Chatbot-App erstellt. Jetzt haben Sie gelernt, Ihre KI-Chatbot-App im Agents Playground zu debuggen.
Proaktive Nachrichten senden
Eine proaktive Nachricht ist eine Nachricht, die von einem Bot als Reaktion auf einfache Befehle gesendet wird, die von einem Benutzer im Chat gesendet werden.
Tutorial: Senden proaktiver Nachrichten
Die Antwort auf die Nachricht kann in einem der folgenden Formate vorliegen:
- Begrüßungsnachrichten
- Geplante Nachrichten
- Benachrichtigungen
Diese schrittweise Anleitung hilft Ihnen, eine proaktive Nachricht von einem Bot zu senden. Die folgende Ausgabe wird angezeigt:
Voraussetzungen
Stellen Sie sicher, dass Sie die folgenden Tools zum Erstellen und Bereitstellen Ihrer Apps installieren.
| Installieren | Zur Verwendung | |
|---|---|---|
| Microsoft Visual Studio Code | JavaScript oder TypeScript, Buildumgebungen. Verwenden Sie die neueste Version. | |
| Microsoft 365 Agents Toolkit (früher als Teams Toolkit bezeichnet) | Visual Studio Code-Erweiterung, die ein Projektgerüst für Ihre App erstellt. Verwenden Sie die neueste Version. | |
| Node.js | JavaScript-Laufzeitumgebung für das Back-End. Weitere Informationen finden Sie in Node.js Versionskompatibilitätstabelle für den Projekttyp. | |
| Microsoft Teams | Teams, um mit allen Personen, mit denen Sie arbeiten, über Apps für Chat, Besprechungen, Anrufe und alles an einem Ort zusammenzuarbeiten. | |
| Microsoft Edge (empfohlen) oder Google Chrome | Ein Browser mit Entwicklertools. | |
| Microsoft 365-Entwicklerkonto | Zugriff auf ein Teams-Konto mit den entsprechenden Berechtigungen zum Installieren einer App. |
Vorbereiten der Entwicklungsumgebung
Nachdem Sie die erforderlichen Tools installiert haben, richten Sie die Entwicklungsumgebung ein.
Microsoft 365 Agents Toolkit installieren
Microsoft 365 Agents Toolkit (früher als Teams Toolkit bezeichnet) hilft dabei, den Entwicklungsprozess mit Tools zum Bereitstellen und Bereitstellen von Cloudressourcen für Ihre App und zur Veröffentlichung im Teams Store zu vereinfachen.
Sie können Agents Toolkit mit Visual Studio Code oder eine Befehlszeilenschnittstelle namens Microsoft 365 Agents Toolkit CLI (früher als TeamsFx CLI bezeichnet) verwenden.
Öffne Visual Studio Code und wähle Erweiterungen aus (STRG+UMSCHALT+X oderErweiterungenanzeigen>).
Geben Sie im Suchfeld "Microsoft 365 Agents Toolkit" ein.
Wählen Sie Installieren aus.
Das Symbol Microsoft 365 Agents Toolkit
wird in der Aktivitätsleiste von Visual Studio Code angezeigt.
Sie können Agents Toolkit auch aus dem Visual Studio Code Marketplace installieren.
Einrichten Ihres Teams-Entwicklungsmandanten
Ein Mandant ist ein Raum oder Container für Ihre organization in Teams, in dem Sie chatten, Dateien freigeben und Besprechungen abhalten. In diesen Bereich laden Sie auch Ihre App hoch und testen sie. Lassen Sie uns überprüfen, ob Sie bereit sind, mit dem Mandanten zu entwickeln.
Option zum Hochladen einer App überprüfen
Nachdem Sie Ihre benutzerdefinierte App erstellt haben, müssen Sie Ihre App mit der Option "Benutzerdefinierte App hochladen " in Teams hochladen. Melden Sie sich bei Ihrem Microsoft 365-Konto an, um zu überprüfen, ob diese Option aktiviert ist.
Mithilfe der folgenden Schritte können Sie überprüfen, ob Sie Apps in Teams hochladen können:
Wählen Sie im Teams-Client das Symbol "Apps " aus.
Wählen Sie Apps verwalten aus.
Wählen Sie App hochladen aus.
Suchen Sie nach der Option zum Hochladen einer benutzerdefinierten App. Wenn die Option angezeigt wird, können Sie benutzerdefinierte Apps hochladen.
Hinweis
Wenn Sie die Option zum Hochladen einer benutzerdefinierten App nicht finden, wenden Sie sich an Ihren Teams-Administrator.
Erstellen eines kostenlosen Teams-Entwicklermandanten (optional)
Wenn Sie kein Teams-Entwicklerkonto haben, treten Sie dem Microsoft 365-Entwicklerprogramm bei.
Wechseln Sie zum Microsoft 365-Entwicklerprogramm.
Wählen Sie "Jetzt teilnehmen" aus, und folgen Sie den Anweisungen auf dem Bildschirm.
Wählen Sie auf dem Willkommensbildschirm E5-Abonnement einrichten aus.
Richten Sie Ihr Administratorkonto ein. Nach Abschluss des Vorgangs wird der folgende Bildschirm angezeigt:
Melden Sie sich mit dem soeben eingerichteten Administratorkonto bei Teams an. Stellen Sie sicher, dass die Option "Benutzerdefinierte App hochladen " in Teams vorhanden ist.
Erstellen eines proaktiven Nachrichtenbots
Um einen proaktiven Nachrichtenbot mit Visual Studio Code zu erstellen, gehe folgendermaßen vor:
Öffne Visual Studio Code.
Wählen Sie das Symbol Microsoft 365 Agents Toolkit
in der Aktivitätsleiste von Visual Studio Code aus.Wählen Sie im linken Bereich Beispiele anzeigen aus.
Wählen Sie in der Liste der Beispiele Proaktives Messaging aus. Ein vorgefertigtes Beispiel, das zum Debuggen bereit ist, wird geöffnet.
Wählen Sie Erstellen aus.
Wähle Standardordner, um den Projektstammordner am Standardspeicherort zu speichern.
Wenn Sie den Standardspeicherort ändern möchten, führen Sie die folgenden Schritte aus:
Wählen Sie Durchsuchen aus.
Wählen Sie den Speicherort für den Projektarbeitsbereich aus.
Wählen Sie "Ordner auswählen" aus.
Der proaktive Nachrichtenbot ist in wenigen Sekunden erstellt und zeigt in der unteren rechten Ecke das Dialogfeld "Erfolg des proaktiven Nachrichtenbots" mit der Option zum Debuggen an:
Wählen Sie das Symbol Ausführen und Debuggen
in der oberen linken Ecke aus.Wählen Sie in der Dropdownliste Debuggen (Edge) oder Debuggen (Chrome) aus.
Wenn das Debuggen erfolgreich ist, werden Sie aufgefordert, den proaktiven Nachrichtenbot in Teams auf Ihrem lokalen Computer hochzuladen.
Wählen Sie Hinzufügen aus.
Suchen Sie den gewünschten Bereich, und wählen Sie ihn aus, oder wählen Sie einen Kanal, Chat oder eine Besprechung aus der Liste aus, und navigieren Sie durch das Dialogfeld, um Los auszuwählen.
Die proaktive Nachrichten-Bot-App wird in den Teams-Client hochgeladen und die folgende Nachricht wird als Antwort auf die gesendete Nachricht angezeigt.
Kopieren Sie die URL, fügen Sie sie ein, oder navigieren Sie im Browser zur URL. Eine proaktive Hallo-Nachricht wird ausgelöst und im Chat geteilt.
Wechseln Sie zu Teams. Sie erhalten eine proaktive Hallo-Nachricht vom Bot.
Unternehmen Sie eine Tour durch den Quellcode
Agents Toolkit stellt Komponenten zum Erstellen einer App bereit. Nach dem Erstellen des Projekts kannst du die Projektordner und -dateien im EXPLORER-Bereich von Visual Studio Code anzeigen.
Der neue Projektordner enthält den folgenden Inhalt:
| Ordner / Datei | Inhalt |
|---|---|
.vscode/ |
Visual Studio Code-Dateien für das Debuggen. |
appManifest/ |
Vorlagen für das App-Manifest (zuvor als Teams-App-Manifest bezeichnet). |
env/ |
Name/Wert-Paare werden in Umgebungsdateien gespeichert und von m365agents.yml zum Anpassen der Bereitstellungs- und Bereitstellungsregeln verwendet. |
manifest.json |
Das App-Manifest für die Veröffentlichung über das Entwicklerportal für Teams wird in Properties/manifest.jsongespeichert. |
m365agents.yml |
Die Hauptprojektdatei beschreibt Ihre App-Konfiguration und definiert die Aktionen, die in den einzelnen Lebenszyklusphasen ausgeführt werden sollen. |
m365agents.local.yml |
Dies setzt Aktionen außer Kraft m365agents.yml , die lokale Ausführung und Debugging ermöglichen. |
Bereitstellen Ihres proaktiven Nachrichtenbots
Sie haben gelernt, eine Teams-App mit proaktiver Nachrichtenbotfunktion zu erstellen und auszuführen. Lassen Sie uns die erste App mit proaktiver Nachrichtenbotfunktion in Azure mit dem Agents Toolkit bereitstellen.
Anmelden bei Ihrem Azure-Konto
Verwenden Sie Ihr Konto, um auf die Microsoft Azure-Portal zuzugreifen und neue Cloudressourcen zur Unterstützung Ihrer App bereitzustellen.
Öffne Visual Studio Code.
Öffnen Sie den Projektordner, in dem Sie die proaktive Nachrichten-Bot-App erstellt haben.
Wählen Sie das Symbol Microsoft 365 Agents Toolkit
in der Aktivitätsleiste von Visual Studio Code aus.Wählen Sie Bei Azure anmelden mit Ihren Anmeldeinformationen aus.
Tipp
Wenn Sie die AZURE ACCOUNT-Erweiterung installiert haben und dasselbe Konto verwenden, können Sie diesen Schritt überspringen.
Ihr Standardwebbrowser wird geöffnet, damit Sie sich beim Konto anmelden können.
Schließen Sie den Browser, wenn Sie dazu aufgefordert werden, und kehren Sie zu Visual Studio Code zurück.
Im Abschnitt "KONTEN " der Randleiste werden die beiden Konten separat angezeigt. Außerdem wird die Anzahl der nutzbaren Azure-Abonnements aufgeführt, die Ihnen zur Verfügung stehen. Stellen Sie sicher, dass mindestens ein nutzbares Azure-Abonnement verfügbar ist. Wenn nicht, melden Sie sich ab und verwenden Sie ein anderes Konto.
Bereitstellen Ihrer App in Azure
Die Bereitstellung besteht aus zwei Schritten. Zunächst werden die erforderlichen Cloud-Ressourcen erstellt (auch als Bereitstellung bezeichnet). Anschließend wird der Code Ihrer App in die erstellten Cloudressourcen kopiert. Für dieses Tutorial stellen Sie die Bot-App bereit.
Was ist der Unterschied zwischen Bereitstellen und Bereitstellen?
Bereitstellen erstellt Ressourcen in Azure und Microsoft 365 für Ihre App, aber es wird kein Code (HTML, CSS und JavaScript) in die Ressourcen kopiert.
Beim Bereitstellen wird der Code für Ihre App auf die Ressourcen kopiert, die Sie während der Bereitstellung erstellt haben. Es kommt häufig vor, dass mehrere Stellen bereitgestellt werden, ohne dass neue Ressourcen bereitgestellt werden. Da die Bereitstellung einige Zeit in Anspruch nehmen kann, ist sie von der Bereitstellung getrennt.
Wählen Sie das Symbol Microsoft 365 Agents Toolkit
in der Aktivitätsleiste von Visual Studio Code aus.Wählen Sie unter "LEBENSZYKLUS"die Option "Bereitstellen" aus.
Wählen Sie eines der vorhandenen Abonnements aus.
Wählen Sie eine vorhandene Ressourcengruppe aus, oder erstellen Sie eine neue Ressourcengruppe. Weitere Informationen finden Sie unter Erstellen einer Ressourcengruppe.
Hinweis
Es wird in einem Dialogfeld darauf hingewiesen, dass beim Ausführen von Ressourcen in Azure Kosten anfallen können.
Wählen Sie "Bereitstellen" aus.
Beim Bereitstellungsprozess werden Ressourcen in der Azure-Cloud erstellt. Sie können den Fortschritt in den Dialogfeldern überwachen, die in der unteren rechten Ecke angezeigt werden. Nach einigen Minuten wird das folgende Dialogfeld angezeigt:
Wählen Sie unter "LEBENSZYKLUS"die Option "Bereitstellen" aus.
Wählen Sie Bereitstellen aus.
Die Bereitstellung nimmt einige Zeit in Anspruch. Sie können den Fortschritt in den Dialogfeldern überwachen, die in der unteren rechten Ecke angezeigt werden. Nach ein paar Minuten wird das folgende Dialogfeld angezeigt.
Öffnen Sie den Debugbereich (STRG+UMSCHALT+D / ⌘⇧-D oderAusführunganzeigen>) in Visual Studio Code.
Wählen Sie "Remote starten (Edge)" aus der Dropdownliste der Startkonfiguration aus.
Wenn das Debuggen erfolgreich ist, werden Sie aufgefordert, die proaktive Nachrichten-Bot-App in Teams hochzuladen.
Wählen Sie Hinzufügen aus.
Suchen Sie den gewünschten Bereich, und wählen Sie ihn aus, oder wählen Sie einen Kanal, Chat oder eine Besprechung aus der Liste aus, und navigieren Sie durch das Dialogfeld, um Los auszuwählen.
Die proaktive Nachrichten-Bot-App wird in den Teams-Client hochgeladen und die folgende Nachricht wird als Antwort auf die gesendete Nachricht angezeigt.
Kopieren Sie die URL, fügen Sie sie ein, oder navigieren Sie im Browser zur URL. Eine proaktive Hallo-Nachricht wird ausgelöst und im Chat geteilt.
Wechseln Sie zu Teams. Sie erhalten eine proaktive Hallo-Nachricht vom Bot.
Herausforderung abschließen
Hast du dir so etwas ausgedacht?
Sie haben das Szenario abgeschlossen.
- Sie können täglich Benachrichtigungen senden oder regelmäßig Feedback von Benutzern anfordern.
- Sie können mit Drosselungsgrenzwerten umgehen, um Mehrfachbenachrichtigungen zu vermeiden.
API-basierte Nachrichtenerweiterung erstellen
Nachrichtenerweiterungen, die mit API (API-basiert) erstellt wurden, verbessern die Funktionalität Ihrer Teams-Apps erheblich, indem sie ihnen die Interaktion mit externen Diensten ermöglichen. API-basierte Nachrichtenerweiterungen können dazu beitragen, Workflows zu optimieren, indem sie die Notwendigkeit reduzieren, zwischen verschiedenen Anwendungen zu wechseln.
Lernprogramm: Erstellen einer API-basierten Nachrichtenerweiterung
Hinweis
API-basierte Nachrichtenerweiterungen unterstützen nur Suchbefehle.
Sie können API-basierte Nachrichtenerweiterungen verwenden, um externe Dienste zu integrieren, die häufig im Geschäftsworkflow verwendet werden. Beispielsweise könnte ein Unternehmen, das häufig ein CRM-System für die Kundenverwaltung verwendet, eine Nachrichtenerweiterung verwenden, um Kundendaten direkt aus Teams abzurufen und anzuzeigen. Diese App hilft, Zeit zu sparen und verbessert die Effizienz, indem die Notwendigkeit reduziert wird, zwischen verschiedenen Anwendungen zu wechseln. Dieses Feature wird auf allen Plattformen unterstützt, auf denen Teams verfügbar ist, einschließlich Desktop, Web und Mobilgeräte.
Voraussetzungen für das Erstellen einer Nachrichtenerweiterung
Hier ist eine Liste der Tools, die Sie zum Erstellen und Bereitstellen Ihrer Apps benötigen.
| Installieren | Zur Verwendung... |
|---|---|
| Microsoft Teams | Microsoft Teams für die Zusammenarbeit mit allen Personen, mit denen Sie zusammenarbeiten, über Apps für Chats, Besprechungen oder Anrufe – alles an einem Ort. |
| Microsoft Edge (empfohlen) oder Google Chrome | Ein Browser mit Entwicklertools. |
| Visual Studio Code | JavaScript, TypeScript oder SharePoint-Framework (SPFx)-Buildumgebungen. Verwenden Sie Version 1.55 oder höher. |
| Microsoft 365-Entwicklerkonto | Zugriff auf ein Teams-Konto mit den entsprechenden Berechtigungen zum Installieren einer App. |
| Azure-Konto | Zugriff auf Azure-Ressourcen. |
| OpenAPI-Beschreibungsdokument (OAD) | Ein Dokument, das die Funktionen Ihrer API beschreibt. Weitere Informationen finden Sie unter OpenAPI-Beschreibung. |
Einrichten Ihres Teams-Entwicklungsmandanten
Ein Mandant ist wie ein Raum oder ein Container für Ihre organization in Teams, in dem Sie chatten, Dateien freigeben und Besprechungen abhalten. In diesen Bereich können Sie auch Ihre benutzerdefinierte App hochladen und testen. Lassen Sie uns überprüfen, ob Sie bereit sind, mit dem Mandanten zu entwickeln.
Option zum Hochladen benutzerdefinierter Apps überprüfen
Nachdem Sie die App erstellt haben, müssen Sie Ihre App in Teams laden, ohne sie zu verteilen. Dieser Vorgang wird als benutzerdefinierter App-Upload bezeichnet. Melden Sie sich bei Ihrem Microsoft 365-Konto an, um diese Option anzuzeigen.
Hinweis
Der benutzerdefinierte App-Upload ist erforderlich, um Apps in der lokalen Teams-Umgebung anzuzeigen und zu testen. Wenn sie nicht aktiviert ist, können Sie Ihre App nicht in der lokalen Teams-Umgebung in der Vorschau anzeigen und testen.
Haben Sie bereits einen Mandanten und verfügen Sie über Administratorzugriff? Lassen Sie uns überprüfen, ob Sie das wirklich tun!
Überprüfen Sie, ob Sie eine benutzerdefinierte App in Teams hochladen können:
Wählen Sie im Teams-Client das Symbol "Apps " aus.
Wählen Sie Apps verwalten aus.
Wählen Sie App hochladen aus.
Suchen Sie nach der Option zum Hochladen einer benutzerdefinierten App. Wenn die Option angezeigt wird, ist der benutzerdefinierte App-Upload aktiviert.
Hinweis
Wenden Sie sich an Ihren Teams-Administrator, wenn Sie die Option zum Hochladen einer benutzerdefinierten App nicht finden.
Erstellen eines kostenlosen Teams-Entwicklermandanten (optional)
Wenn Sie kein Teams-Entwicklerkonto haben, können Sie es kostenlos erhalten. Treten Sie dem Microsoft 365-Entwicklerprogramm bei!
Wechseln Sie zum Microsoft 365-Entwicklerprogramm.
Wählen Sie "Jetzt teilnehmen" aus, und folgen Sie den Anweisungen auf dem Bildschirm.
Wählen Sie auf dem Willkommensbildschirm E5-Abonnement einrichten aus.
Richten Sie Ihr Administratorkonto ein. Nach Abschluss des Vorgangs wird der folgende Bildschirm angezeigt.
Melden Sie sich mit dem soeben eingerichteten Administratorkonto bei Teams an. Stellen Sie sicher, dass die Option "Benutzerdefinierte App hochladen " in Teams vorhanden ist.
Kostenloses Azure-Konto erhalten
Wenn Sie Ihre App hosten oder auf Ressourcen in Azure zugreifen möchten, benötigen Sie ein Azure-Abonnement. Erstellen Sie ein kostenloses Konto , bevor Sie beginnen.
Sie verfügen über alle Tools, um Ihr Konto einzurichten. Als Nächstes richten wir deine Entwicklungsumgebung ein und beginnen mit dem Erstellen! Wählen Sie zuerst die App aus, die Sie erstellen möchten.
OpenAPI-Beschreibungsdokument erstellen
OpenAPI Description (OAD) ist die branchenübliche Spezifikation, die beschreibt, wie OpenAPI-Dateien strukturiert und gegliedert sind. Es handelt sich um ein sprachunabhängiges, für Menschen lesbares Format zur Beschreibung von APIs. Es ist sowohl für Menschen als auch für Maschinen einfach zu lesen und zu schreiben. Das Schema ist maschinenlesbar und wird entweder in YAML oder JSON dargestellt.
Für die Interaktion mit den APIs ist ein OpenAPI-Beschreibungsdokument erforderlich. Das OpenAPI-Beschreibungsdokument muss die folgenden Kriterien erfüllen:
Die
authEigenschaft darf nicht angegeben werden.JSON und YAML sind die unterstützten Formate.
OpenAPI-Versionen 2.0 und 3.0.x werden unterstützt.
Teams unterstützt die Konstrukte "oneOf", "anyOf", "allOf" und "nicht (swagger.io)" nicht.
Das Erstellen von Arrays für die Anforderung wird nicht unterstützt, jedoch werden geschachtelte Objekte innerhalb eines JSON-Anforderungstexts unterstützt.
Der Anforderungstext muss, falls vorhanden, application/json sein, um die Kompatibilität mit einer Vielzahl von APIs sicherzustellen.
Definieren Sie eine HTTPS-Protokollserver-URL für die
servers.urlEigenschaft.Es wird nur die Suche mit einem einzelnen Parameter unterstützt.
Es ist nur ein erforderlicher Parameter ohne Standardwert zulässig.
Es werden nur POST- und GET-HTTP-Methoden unterstützt.
Das OpenAPI-Beschreibungsdokument muss über eine .
operationIdDer Vorgang darf keine Header- oder Cookie-Parameter ohne Standardwerte erfordern.
Ein Befehl muss genau einen Parameter haben.
Stellen Sie sicher, dass keine Remoteverweise im OpenAPI-Beschreibungsdokument vorhanden sind.
Ein erforderlicher Parameter mit einem Standardwert gilt als optional.
Wir haben die folgende OpenAPI-Beschreibung als Beispiel für dieses Tutorial verwendet:
OpenAPI-Beschreibung
openapi: 3.0.1 info: title: OpenTools Plugin description: A plugin that allows the user to find the most appropriate AI tools for their use cases, with their pricing information. version: 'v1' servers: - url: https://gptplugin.opentools.ai paths: /tools: get: operationId: searchTools summary: Search for AI Tools parameters: - in: query name: search required: true schema: type: string description: Used to search for AI tools by their category based on the keywords. For example, a search for "tool to create music" provides a list of tools that can create music. responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/searchToolsResponse' "400": description: Search Error content: application/json: schema: ref: '#/components/schemas/searchToolsError' components: schemas: searchToolsResponse: required: - search type: object properties: tools: type: array items: type: object properties: name: type: string description: The name of the tool. opentools_url: type: string description: The URL to access the tool. main_summary: type: string description: A summary of what the tool is. pricing_summary: type: string description: A summary of the pricing of the tool. categories: type: array items: type: string description: The categories assigned to the tool. platforms: type: array items: type: string description: The platforms that this tool is available on. description: The list of AI tools. searchToolsError: type: object properties: message: type: string description: Message of the error.Hinweis
Stellen Sie sicher, dass die
required: trueEigenschaft nur für einen Parameter verfügbar ist. Wenn mehr als ein erforderlicher Parameter vorhanden ist, können Sie die erforderliche Eigenschaftrequired: falsefür die anderen Parameter aktualisieren.
Sie können überprüfen, ob das OpenAPI-Beschreibungsdokument gültig ist. Führen Sie zur Überprüfung die folgenden Schritte aus:
Gehen Sie zu Swagger oder OpenAPI-Validator und validieren Sie das OpenAPI-Beschreibungsdokument.
Speichern Sie das OpenAPI-Beschreibungsdokument.
Wechsle zum Swagger-Editor.
Fügen Sie im linken Bereich die OpenAPI-Beschreibung in den Editor ein.
Wählen Sie im rechten Bereich GET aus.
Wählen Sie "Ausprobieren" aus.
Geben Sie die Werte für den Suchparameter als Werkzeug zum Erstellen von Musik ein.
Wählen Sie Ausführen aus. Der Swagger-Editor zeigt eine Antwort mit einer Liste von Produkten an.
Wechseln Sie zumAntworttextder Serverantwort>.
Kopieren
productsSie unter das erste Produkt aus der Liste und speichern Sie es zum späteren Nachschlagen.
Erstellen einer Vorlage für das Antwortrendering
Ein OpenAPI-Beschreibungsdokument erfordert eine Antwortrenderingvorlage, damit die App auf die GET- oder POST-Anforderungen reagieren kann. Die Vorlage für das Antwortrendering besteht aus einer adaptiven Kartenvorlage, einer Vorschau der Kartenvorlage und Metadaten.
Adaptive Kartenvorlage
Führen Sie die folgenden Schritte aus, um eine adaptive Kartenvorlage zu erstellen:
Gehen Sie zu ChatGPT , und stellen Sie die folgende Abfrage im Bereich zum Verfassen von Nachrichten:
Create an Adaptive Card Template that binds to the following response: "categories": [ "Music Generation", "AI Detection" ], "chatbot_short_url": "https://goto.opentools.ai/c/ai-music-generator", "main_summary": "AI Music Generator is an AI-powered music composing tool that allows users to create original and personalized music for various purposes. It can generate melodies, harmonies, and rhythms tailored to specific needs and preferences, with customization options such as genre, mood, length, and instrumentation. The tool is designed for creative individuals, from beginners to professionals, and can produce high-quality music in seconds. Every generated piece of music is royalty-free and can be used instantly, with no limitations on beat creation. With advanced AI technology, AI Music Generator makes music production accessible to everyone.", "name": "AI Music Generator", "opentools_url": "https://goto.opentools.ai/ai-music-generator", "platforms": [ "Web", "App", "API" ]Wählen Sie "Nachricht senden" aus.
ChatGPT generiert eine Antwort mit einer adaptiven Kartenvorlage, die an die Beispieldaten gebunden wird. Speichern Sie die Vorlage "Adaptive Karten" zur späteren Referenz.
Im Folgenden finden Sie ein Beispiel für die Vorlage "Adaptive Karten":
Adaptive Kartenvorlage
{ "$schema": "http://adaptivecards.io/schemas/adaptive-card.json", "type": "AdaptiveCard", "version": "1.4", "body": [ { "type": "TextBlock", "text": "AI Music Generator", "weight": "Bolder", "size": "Large" }, { "type": "TextBlock", "text": "Categories", "size": "Medium" }, { "type": "TextBlock", "text": "Music Generation, AI Detection", "wrap": true }, { "type": "TextBlock", "text": "Description", "size": "Medium" }, { "type": "TextBlock", "text": "AI Music Generator is an AI-powered music composing tool that allows users to create original and personalized music for various purposes. It can generate melodies, harmonies, and rhythms tailored to specific needs and preferences, with customization options such as genre, mood, length, and instrumentation. The tool is designed for creative individuals, from beginners to professionals, and can produce high-quality music in seconds. Every generated piece of music is royalty-free and can be used instantly, with no limitations on beat creation. AI Music Generator is powered by advanced AI technology, and it makes music production accessible to everyone.", "wrap": true }, { "type": "TextBlock", "text": "Platform", "size": "Medium" }, { "type": "TextBlock", "text": "Web, App, API", "wrap": true } ], "actions": [ { "type": "Action.OpenUrl", "title": "Learn More", "url": "https://goto.opentools.ai/ai-music-generator" }, { "type": "Action.OpenUrl", "title": "Try It", "url": "https://goto.opentools.ai/c/ai-music-generator" } ] }Führen Sie die folgenden Schritte aus, um zu überprüfen, ob die generierte adaptive Karte an die Beispieldaten gebunden ist:
Wechseln Sie zum Adaptiven Karten-Designer.
Wechseln Sie zu Host-App auswählen und wählen Sie dann Microsoft Teams aus der Dropdownliste aus.
Wechseln Sie zum KARTENNUTZLAST-EDITOR , und fügen Sie den Vorlagencode für adaptive Karten ein.
Wechseln Sie zum BEISPIELDATEN-EDITOR , und fügen Sie die zuvor gespeicherte GET-API-Antwort ein.
Vorschaumodus auswählen. Der Designer für adaptive Karten zeigt eine adaptive Karte mit den Daten an, die die Antwort an die Vorlage binden.
Erstellen einer Vorschau der Kartenvorlage
Die Vorschauvorlage für die Karte kann ein title, subtitleund image Eigenschaften enthalten. Wenn die API-Antwort kein Bild enthält, können Sie die image-Eigenschaft entfernen.
Im Folgenden finden Sie ein Beispiel für eine Vorschau einer Kartenvorlage:
Vorschau der Kartenvorlage
"previewCardTemplate": {
"title": "${if(name, name, 'N/A')}",
"subtitle": "$${if(price, price, 'N/A')}"
}
Erstellen Sie eine if-Bedingung für das title und subtitle, wobei:
- Wenn ein Name vorhanden ist, verwendet der Bot den Namen.
- Wenn der Name nicht vorhanden ist, verwendet der Bot die NA.
Beispiel: "title": "Name: ${if(name, name, 'N/A')}".
Speichern Sie die Vorschau der Kartenvorlage zum späteren Nachschlagen.
Vorlage für das Rendern von Antworten
Die Vorlage für das Antwortrendering muss dem Schema entsprechen, das unter gehostet wird https://developer.microsoft.com/json-schemas/teams/v1.20/MicrosoftTeams.ResponseRenderingTemplate.schema.json.
Führen Sie die folgenden Schritte aus, um eine Antwortrenderingvorlage zu erstellen:
Erstellen Sie eine JSON-Datei, und fügen Sie der Datei den folgenden Code hinzu:
{ "$schema": "https://developer.microsoft.com/json-schemas/teams/v1.20/MicrosoftTeams.ResponseRenderingTemplate.schema.json", "version": "1.0", "jsonPath": "", "responseLayout": "", "responseCardTemplate": { }, "previewCardTemplate": { } }Aktualisieren Sie die Eigenschaften in der Vorlage für das Antwortrendering wie folgt:
# Eigenschaftsname Value 1. "$schema""https://developer.microsoft.com/json-schemas/teams/v1.20/MicrosoftTeams.ResponseRenderingTemplate.schema.json"2. "version""1.0"
versionist die Version der Renderingvorlage, die verwendet werden soll.3. "jsonPath""tools"
jsonPathist der Pfad zu einem oder mehreren Ergebnissen in der JSON-Antwort der Antwort. Fügen Sie diejsonPathzu den relevanten Daten/Arrays aus der Produktliste in der API-Antwort hinzu. In diesem Fall sind dasjsonPathWerkzeuge. Weitere Informationen zum Ermitteln des JSON-Pfads finden Sie unter Abfragen von JSON mit JSON-Pfad.4. "responseLayout""list"
responseLayoutGibt das Layout der Anlagen an. Wird für Antworten des Typs "Ergebnis" verwendet. Unterstützte Typen sind "list" und "grid". Wenn der Antworttext ein Objekt mit mehreren Elementen wie Text, Titel und Bild enthält, muss das Antwortlayout auflistfestgelegt werden. Wenn die API-Antwort nur Bilder oder Miniaturansichten enthält, muss das Antwortlayout aufgridfestgelegt werden.5. "responseCardTemplate"Fügen Sie den zuvor gespeicherten Vorlagencode für adaptive Karten ein.
responseCardTemplateist eine adaptive Kartenvorlage zum Zuordnen der JSON-Antwort zu einer adaptiven Karte.6. "previewCardTemplate"Fügen Sie den Code der Vorschau-Kartenvorlage ein, den Sie zuvor gespeichert haben.
previewCardTemplateist eine Vorschau der Karte wird verwendet, um eine Vorschau der Ergebnisse im Flyout der Nachrichtenerweiterung anzuzeigen.Speichern Sie die Antwortrenderingvorlage in demselben Ordner, in dem Sie das OpenAPI-Beschreibungsdokument gespeichert haben.
Der folgende Code ist ein Beispiel für eine Antwortrenderingvorlage:
Vorlage für das Rendern von Antworten
{
"$schema": "https://developer.microsoft.com/json-schemas/teams/v1.20/MicrosoftTeams.ResponseRenderingTemplate.schema.json",
"version": "1.0",
"jsonPath": "tools",
"responseLayout": "list",
"responseCardTemplate": {
"type": "AdaptiveCard",
"version": "1.4",
"body": [
{
"type": "TextBlock",
"text": "AI Music Generator",
"weight": "Bolder",
"size": "Large"
},
{
"type": "TextBlock",
"text": "Categories",
"size": "Medium"
},
{
"type": "TextBlock",
"text": "Music Generation, AI Detection",
"wrap": true
},
{
"type": "TextBlock",
"text": "Description",
"size": "Medium"
},
{
"type": "TextBlock",
"text": "AI Music Generator is an AI-powered music composing tool that allows users to create original and personalized music for various purposes. It can generate melodies, harmonies, and rhythms tailored to specific needs and preferences, with customization options such as genre, mood, length, and instrumentation. The tool is designed for creative individuals, from beginners to professionals, and can produce high-quality music in seconds. Every generated piece of music is royalty-free and can be used instantly, with no limitations on beat creation. With advanced AI technology, AI Music Generator makes music production accessible to everyone.",
"wrap": true
},
{
"type": "TextBlock",
"text": "Platform",
"size": "Medium"
},
{
"type": "TextBlock",
"text": "Web, App, API",
"wrap": true
}
],
"actions": [
{
"type": "Action.OpenUrl",
"title": "Learn More",
"url": "https://goto.opentools.ai/ai-music-generator"
},
{
"type": "Action.OpenUrl",
"title": "Try It",
"url": "https://goto.opentools.ai/c/ai-music-generator"
}
]
},
"previewCardTemplate": {
"title": "${if(name, name, 'N/A')}",
"subtitle": "$${if(price, price, 'N/A')}"
}
}
App-Manifest erstellen
Jetzt müssen Sie ein App-Manifest (zuvor als Teams-App-Manifest bezeichnet) erstellen. Das App-Manifest beschreibt, wie Ihre App in das Microsoft Teams-Produkt integriert wird.
Erstellen eines Teams-App-Manifests
Gehen Sie folgendermaßen vor, um das Manifest zu erstellen:
Erstelle eine neue JSON-Datei. Ihr App-Manifest muss mit der Version 1.20 des Schemas konform sein, das unter App-Manifestschema definiert ist.
Fügen Sie der JSON-Datei den folgenden Code hinzu:
App-Manifest
{ "$schema": "https://developer.microsoft.com/json-schemas/teams/v1.20/MicrosoftTeams.schema.json", "manifestVersion": "1.20", "version": "1.0.3", "id": "<<YOUR-MICROSOFT-APP-ID>>", "packageName": "com.microsoft.teams.extension", "developer": { "name": "Teams App, Inc.", "websiteUrl": "https://www.example.com", "privacyUrl": "https://www.example.com/termofuse", "termsOfUseUrl": "https://www.example.com/privacy" }, "icons": { "color": "color.png", "outline": "outline.png" }, "name": { "short": "Search ME API", "full": "Search ME API full" }, "description": { "short": "product app for testing API Message Extensions", "full": "product app for testing API Message Extensions" }, "accentColor": "#FFFFFF", "composeExtensions": [ { "composeExtensionType": "", "apiSpecificationFile": "", "commands": [ { "context": [ "compose" ], "type": "query", "title": "API for fetching Klarna.", "id": "", "parameters": [ { "name": "", "title": "", "description": "" } ], "description": "", "apiResponseRenderingTemplateFile": "" } ] } ], "permissions": [ "identity", "messageTeamMembers" ], "validDomains": [] }Aktualisieren Sie die App-Manifesteigenschaften wie folgt:
- Ersetzen Sie
<<YOUR-MICROSOFT-APP-ID>>dies durch die Microsoft-App-ID des Bots. - Aktualisieren Sie den Wert für
composeExtensionTypeinapiBased. - Aktualisieren Sie den Wert für
apiSpecificationFileauf den Pfad Ihrer OpenAPI-Beschreibungsdatei. - Aktualisieren Sie den Wert für
commands.idinsearchTools. - Aktualisieren Sie den Wert für
commands.titleinSearch for AI Tools. - Aktualisieren Sie den Wert für
commands.descriptioninSearch for AI Tools. - Aktualisieren Sie den Wert für
parameters.nameinsearch. Wenn keine Parameter vorhanden sind, müssen die Werte Abfrageparameter sein oderproperties.namewenn sie auf eine Eigenschaft im Schema des Anforderungstexts verweisen. - Aktualisieren Sie den
apiResponseRenderingTemplateFilePfad Ihrer Antwortrenderingvorlagendatei. - Aktualisieren Sie den Wert für
validDomainsauf den Endpunkt, der in derservice URLOpenAPI-Beschreibungsdatei definiert ist.
- Ersetzen Sie
Speichern Sie das Teams-App-Manifest in demselben Ordner, in dem Sie das OpenAPI-Beschreibungsdokument und die Antwortrenderingvorlage gespeichert haben.
Sie benötigen ein Farbbild und ein Konturbild. Diese Bilder sollten in den Ordner aufgenommen und in Ihrem Teams-App-Manifest referenziert werden.
Öffnen Sie den Inhalt des Ordners mit einem Reißverschluss. Die ZIP-Datei muss die folgenden Dateien enthalten:
- OpenAPI-Beschreibungsdokument
- Vorlage für das Rendern von Antworten
- App-Manifest
- Farbsymbol
- Symbol 'Gliederung'
Hochladen einer benutzerdefinierten App in Teams
Melden Sie sich bei der Teams-Testumgebung an, um Ihre App in Teams zu testen. Führen Sie die folgenden Schritte aus, um eine benutzerdefinierte App in Teams hochzuladen:
Wechseln Sie zu Microsoft Teams, und melden Sie sich mit den Anmeldeinformationen Ihres Testmandanten an.
Wechseln Sie zu Apps>App verwalten>Laden Sie eine App hoch.
Wählen Sie "Benutzerdefinierte App hochladen" aus.
Wählen Sie die erstellte ZIP-Datei und dann "Öffnen" aus.
Wählen Sie Hinzufügen aus.
Wählen Sie Öffnen aus.
Wechseln Sie zu einem Chat, wählen Sie im Bereich zum Verfassen von Nachrichten eine Auswahl + aus, und suchen Sie nach Ihrer App.
Wählen Sie die App aus, und erstellen Sie eine Suchabfrage.
Die App antwortet mit einer adaptiven Karte im Chatfenster.
Wählen Sie Senden aus.
Herzlichen Glückwunsch. Fertig! Sie haben gelernt, eine API-basierte Nachrichtenerweiterung mithilfe des OpenAPI-Beschreibungsdokuments zu erstellen.
Erstellen einer aktionsbasierten Nachrichtenerweiterung
Die aktionsbasierte Teams-Nachrichtenerweiterung ermöglicht Benutzern die Interaktion mit Webdiensten im Microsoft Teams-Client. Nachrichtenerweiterungen helfen dabei, Aktionen in einem externen System aus dem Bereich zum Verfassen von Nachrichten, dem Befehlsfeld oder direkt aus einer Nachricht heraus zu initiieren.
Lernprogramm: Erstellen einer aktionsbasierten Nachrichtenerweiterung
Hauptmerkmale der aktionsbasierten Nachrichtenerweiterung:
- Stellt dem Benutzer ein modales Popupfenster zum Sammeln oder Anzeigen von Informationen bereit.
- Löst die Aktionsbefehle im Bereich zum Verfassen einer Nachricht, im Befehlsfeld oder in einer Nachricht aus.
Diese schrittweise Anleitung hilft Ihnen beim Erstellen der aktionsbasierten Nachrichtenerweiterung in Teams, um Aktionen aus dem Bereich zum Verfassen von Nachrichten und Nachrichten zu initiieren. Am Ende dieses Lernprogramms können Sie die folgende Ausgabe erzielen:
Voraussetzungen
Stellen Sie sicher, dass Sie die folgenden Tools installieren und Ihre Entwicklungsumgebung einrichten:
| Installieren | Zur Verwendung... | |
|---|---|---|
| Microsoft Teams | Microsoft Teams für die Zusammenarbeit mit allen Personen, mit denen Sie zusammenarbeiten, über Apps für Chats, Besprechungen und Anrufe – alles an einem Ort. | |
| Visual Studio 2022 | Sie können die Enterprise-Version in Visual Studio 2022 installieren und die Workloads ASP.NET und Webentwicklung installieren. Verwenden Sie die neueste Version. | |
| .NET Core SDK | Angepasste Bindungen für lokales Debuggen und Bereitstellungen von Azure Functions-Apps. Wenn Sie nicht die neueste Version installiert haben, installieren Sie die portable Version. | |
| Dev-Tunnel | Microsoft Teams-App-Features (Unterhaltungsbots, Nachrichtenerweiterungen und eingehende Webhooks) benötigen eingehende Verbindungen. Ein Tunnel verbindet Ihr Entwicklungssystem mit Teams. Dev Tunnel ist ein leistungsstarkes Tool, um Ihren lokalen Host sicher für das Internet zu öffnen und zu steuern, wer Zugriff hat. Der Dev-Tunnel ist in Visual Studio 2022, Version 17.7.0 oder höher, verfügbar. oder Sie können ngrok auch als Tunnel verwenden, um Ihr Entwicklungssystem mit Microsoft Teams zu verbinden. Für Apps, die nur Registerkarten enthalten, ist dies nicht erforderlich. Dieses Paket wird im Projektverzeichnis installiert (mit npm devDependencies). |
Hinweis
Melden Sie sich nach dem Herunterladen von ngrok an und installieren Sie authtoken.
Einrichten der lokalen Umgebung
Wählen Sie "Code" aus.
Wähle im Dropdownmenü "Mit GitHub Desktop öffnen" aus.
Wählen Sie "Klonen" aus.
Registrieren der Microsoft Entra-App
Die folgenden Schritte helfen Ihnen beim Erstellen und Registrieren Ihres Bots in Azure-Portal:
- Erstellen und registrieren Sie Ihre Azure-App.
- Erstellen Sie einen geheimen Clientschlüssel, um die SSO-Authentifizierung des Bots zu ermöglichen.
- Fügen Sie den Teams-Kanal hinzu, um den Bot bereitzustellen.
- Erstellen Sie einen Tunnel zu den Endpunkten Ihres Webservers mithilfe von dev tunnel (empfohlen) oder ngrok.
- Fügen Sie dem von Ihnen erstellten Dev-Tunnel einen Messagingendpunkt hinzu.
Hinzufügen einer App-Registrierung
Wechseln Sie zum Azure-Portal.
Wählen Sie "App-Registrierungen" aus.
Wählen Sie "+ Neue Registrierung" aus.
Geben Sie den Namen Ihrer App ein.
Wählen Sie Konten in einem beliebigen Organisationsverzeichnis (beliebiger Microsoft Entra ID-Mandant – mehrinstanzfähig) aus.
Wählen Sie Registrieren aus.
Ihre App ist in Microsoft Entra ID registriert. Die App-Übersichtsseite wird angezeigt.
Hinweis
Speichern Sie die App-ID aus Anwendungs-ID (Client) undVerzeichnis-ID (Mandant) zur weiteren Verwendung.
Erstellen eines Tunnels
Führen Sie eine der folgenden beiden Methoden aus, um einen Tunnel zu erstellen.
Öffnen Sie Visual Studio.
Wähle "Neues Projekt erstellen" aus.
Geben Sie im Suchfeld ASP.NET ein. Wählen Sie in den Suchergebnissen "ASP.NET Core Web App" aus.
Wählen Sie Weiter aus.
Geben Sie den Projektnamen ein, und wählen Sie Weiter aus.
Wählen Sie Erstellen aus.
Ein Übersichtsfenster erscheint.
Wählen Sie in der Dropdownliste debuggen die Option Dev Tunnels (kein aktiver Tunnel)>Tunnel erstellen....
Ein Pop-up-Fenster wird angezeigt.
Aktualisieren Sie im Popupfenster die folgenden Details:
- Konto: Geben Sie ein Microsoft- oder GitHub-Konto ein.
- Name: Geben Sie einen Namen für Ihren Tunnel ein.
- Tunneltyp: Wählen Sie in der Dropdownliste die Option Temporär aus.
- Zugriff: Wählen Sie in der Dropdownliste Öffentlich aus.
Wählen Sie OK aus.
Ein Popupfenster wird angezeigt, das zeigt, dass der Dev-Tunnel erfolgreich erstellt wurde.
Wählen Sie OK aus.
Du findest den erstellten Tunnel in der Debug-Dropdownliste wie folgt:
Drücken Sie F5 , um die Anwendung im Debugmodus auszuführen.
Wenn ein Dialogfeld mit einer Sicherheitswarnung angezeigt wird, wählen Sie Ja aus.
Ein Pop-up-Fenster wird angezeigt.
Wählen Sie Weiter aus.
Die Dev Tunnel-Startseite wird in einem neuen Browserfenster geöffnet, und der Dev Tunnel ist jetzt aktiv.
Wechseln Sie zu Visual Studio und wählen Sie Ausgabe anzeigen >aus.
Wählen Sie im Dropdownmenü der Ausgabekonsole die Option Dev Tunnels aus.
Die Ausgabekonsole zeigt die Dev-Tunnel-URL an.
Webauthentifizierung hinzufügen
Wählen Sie im linken Bereich unter Verwaltendie Option Authentifizierung aus.
Wählen Sie Plattform>hinzufügen Web aus.
Geben Sie den Umleitungs-URI für Ihre App ein, indem Sie ihn an den vollqualifizierten Domänennamen anfügen
auth-end. Beispielsweisehttps://your-devtunnel-domain/auth-endoderhttps://your-ngrok-domain/auth-end.Aktivieren Sie unter Implizite Gewährung und Hybridflüsse die Kontrollkästchen Zugriffstoken und ID-Token .
Wählen Sie "Konfigurieren" aus.
Wählen Sie unter Web die Option "URI hinzufügen" aus.
Geben Sie
https://token.botframework.com/.auth/web/redirectein.Wählen Sie Speichern aus.
Einen geheimen Clientschlüssel erstellen
Hinweis
Wenn der Fehler " Geheime Clientschlüssel werden durch mandantenweite Richtlinie blockiert" auftritt. Wenden Sie sich an Ihren Mandantenadministrator, um weitere Informationen zu erhalten. können Sie stattdessen ein Zertifikat erstellen. Eine schrittweise Anleitung finden Sie unter Erstellen eines Zertifikats für die App-Registrierung.
Wählen Sie im linken Bereich unter Verwalten die Option Zertifikate & Geheimnisse aus.
Wählen Sie unter Geheime Clientschlüsseldie Option + Neues geheime Clientschlüssel aus.
Das Fenster Einen geheimen Clientschlüssel hinzufügen wird angezeigt.
Beschreibung eingeben.
Wählen Sie Hinzufügen aus.
Wählen Sie unter "Wert" die Option "In Zwischenablage kopieren " aus, um den Wert des geheimen Clientschlüssels zur weiteren Verwendung zu speichern.
API-Berechtigungen hinzufügen
Wählen Sie im linken Bereich API-Berechtigungen aus.
Wählen Sie "+ Berechtigung hinzufügen" aus.
Wählen Sie Microsoft Graph aus.
Wählen Sie Delegierte Berechtigungen aus.
Wählen Sie User>User.Read aus.
Wählen Sie Berechtigungen hinzufügen aus.
Hinweis
- Wenn einer App keine Zustimmung des IT-Administrators erteilt wird, müssen Benutzer bei der ersten Verwendung einer App ihre Zustimmung erteilen.
- Benutzer müssen den API-Berechtigungen nur zustimmen, wenn die Microsoft Entra-App in einem anderen Mandanten registriert ist.
Anwendungs-ID-URI hinzufügen
Wählen Sie im linken Bereich unter Verwaltendie Option API verfügbar machen.
Wählen Sie neben Anwendungs-ID-URIdie Option Hinzufügen aus.
Aktualisieren Sie den Anwendungs-ID-URI im
api://botid-{AppID}Format, und wählen Sie Speichern aus.
Hinzufügen eines Bereichs
Wählen Sie im linken Bereich unter Verwaltendie Option API verfügbar machen.
Wählen Sie "+ Bereich hinzufügen" aus.
Geben Sie access_as_user als Bereichsnamen ein.
Wählen Sie unter Wer kann zustimmen?die Option Administratoren und Benutzer aus.
Aktualisieren Sie die Werte für die übrigen Felder wie folgt:
Geben Sie Teams kann als Anzeigename der Admin-Zustimmungauf das Profil des Benutzers zugreifen.
EINGABE Ermöglicht Teams das Aufrufen der Web-APIs der App als aktueller Benutzer als Beschreibung der Admin-Einwilligung.
Geben Sie Teams kann als Anzeigename der Benutzereinwilligungauf das Benutzerprofil zugreifen und Anforderungen im Namen des Benutzers stellen.
Geben Aktivieren Sie Teams, um die APIs dieser App mit denselben Rechten wie der Benutzer aufzurufenBeschreibung der Benutzerzustimmung.
Stellen Sie sicher, dass State auf Aktiviert festgelegt ist.
Wählen Sie Bereich hinzufügen aus.
Die folgende Abbildung zeigt die Felder und die Werte:
Hinweis
Der Bereichsname muss mit dem Anwendungs-ID-URI übereinstimmen, der
/access_as_useram Ende angefügt ist.
Clientanwendung hinzufügen
Wählen Sie im linken Bereich unter Verwaltendie Option API verfügbar machen.
Identifizieren Sie unter Autorisierte Clientanwendungen die Anwendungen, die Sie für die Webanwendung Ihrer App autorisieren möchten.
Wählen Sie "+ Clientanwendung hinzufügen" aus.
Hinzufügen von Teams Mobile oder Desktop und der Teams-Webanwendung.
Für Teams Mobile oder Desktop: Geben Sie die Client-ID als
1fec8e78-bce4-4aaf-ab1b-5451cc387264ein.
Für Teams Web: Geben Sie die Client-ID als
5e3ce6c0-2b1f-4285-8d4b-75ee78787346ein.
Aktivieren Sie das Kontrollkästchen Autorisierte Bereiche .
Wählen Sie Anwendung hinzufügen aus.
In der folgenden Abbildung wird die Client-ID angezeigt:
Erstellen Ihres Bots
Erstellen einer Azure Bot-Ressource
Hinweis
Wenn Sie Ihren Bot bereits in Teams testen, melden Sie sich von dieser App und Teams ab. Melden Sie sich erneut an, um diese Änderung zu sehen.
Zur Startseite.
Wählen Sie + Ressource erstellen aus.
Geben Sie im Suchfeld Azure Bot ein.
Drücken Sie die EINGABETASTE.
Wählen Sie Azure Bot aus.
Wählen Sie Erstellen aus.
Geben Sie den Botnamen in Bothandle ein.
Wählen Sie Ihr Abonnement aus der Dropdownliste aus.
Wählen Sie in der Dropdownliste Ihre Ressourcengruppe aus.
Wenn Sie über keine vorhandene Ressourcengruppe verfügen, können Sie eine neue Ressourcengruppe erstellen. Gehen Sie folgendermaßen vor, um eine neue Ressourcengruppe zu erstellen:
- Wählen Sie Neu erstellen aus.
- Geben Sie den Ressourcennamen ein, und wählen Sie OK aus.
- Wählen Sie einen Standort aus der Dropdownliste "Neuer Standort der Ressourcengruppe " aus.
Wählen Sie unter "Preise" die Option "Plan ändern" aus.
Wählen Sie FO Free>Select.
Wählen Sie unter Microsoft-App-IDden App-Typ "Multi-Tenant" aus.
Wählen Sie unter Erstellungstypdie Option Vorhandene App-Registrierung verwenden aus.
Geben Sie die App-ID ein.
Hinweis
Sie können nicht mehr als einen Bot mit derselben Microsoft-App-ID erstellen.
Wählen Sie Überprüfen + erstellen.
Nachdem die Überprüfung erfolgreich war, wählen Sie Erstellen aus.
Die Bereitstellung des Bots dauert ein paar Minuten.
Wählen Sie "Zu Ressource wechseln aus".
Sie haben erfolgreich Ihren Azure-Bot erstellt.
Hinzufügen eines Teams-Kanals
Wählen Sie im linken Bereich Kanäle aus.
Wählen Sie unter "Verfügbare Kanäle"die Option "Microsoft Teams" aus.
Aktivieren Sie das Kontrollkästchen, um die Nutzungsbedingungen zu akzeptieren.
Wählen Sie Zustimmen aus.
Wählen Sie Anwenden aus.
Messagingendpunkt hinzufügen
Verwenden Sie eine der folgenden Methoden, um einen Messaging-Endpunkt hinzuzufügen:
Verwenden Sie die Dev-Tunnel-URL in der Ausgabekonsole als Messagingendpunkt.
Wählen Sie im linken Bereich unter Einstellungen die Option Konfiguration.
Aktualisieren Sie den Messagingendpunkt im Format
https://your-devtunnel-domain/api/messages.
Wählen Sie Anwenden aus.
Sie haben erfolgreich einen Bot in Azure Bot Service eingerichtet.
Hinweis
Wenn der Application Insights-Instrumentierungsschlüssel einen Fehler anzeigt, aktualisieren Sie mit der App-ID.
Einrichten von App-Einstellungen und Anwendungsmanifestdateien
Wechseln Sie zur appsettings.json Datei im geklonten Repository.
Öffnen Sie die appsettings.json Datei, und aktualisieren Sie die folgenden Informationen:
- Auf die Microsoft-App-ID Ihres Bots festlegen
"MicrosoftAppId". - Auf den ID-Wert des geheimen Clientschlüssels Ihres Bots festlegen
"MicrosoftAppPassword". - Als OAuth-Verbindungsname festlegen
ConnectionName. - Auf MultiTenant festlegen
"MicrosoftAppType". - Auf gewöhnlich festlegen
"MicrosoftAppTenantId".
- Auf die Microsoft-App-ID Ihres Bots festlegen
Wechseln Sie zur manifest.json Datei im geklonten Repository.
Öffnen Sie die manifest.json Datei, und aktualisieren Sie die folgenden Änderungen:
- Ersetzen Sie alle Vorkommen von
"{TODO: MicrosoftAppId}"durch Ihre Microsoft-App-ID. - Auf Ihre ngrok- oder dev tunnel-Domäne festlegen
"<<domain-name>>".
- Ersetzen Sie alle Vorkommen von
Erstellen und Ausführen des Diensts
Verwenden Sie zum Erstellen und Ausführen des Diensts Visual Studio oder die Befehlszeile.
Öffnen Sie Visual Studio.
Gehe zu Datei>Projekt/Projektmappeöffnen>.....
Wählen Sie im Ordner csharp die Datei TeamsMessagingExtensionsAction.csproj aus.
Drücken Sie F5 , um das Projekt auszuführen.
Wählen Sie Ja aus, wenn das folgende Dialogfeld angezeigt wird:
Eine Webseite wird mit einer Meldung angezeigt: Ihr Bot ist bereit!.
Hinzufügen der App "Aktionsnachrichtenerweiterung" zu Teams
Wechseln Sie in Ihrem geklonten Repository zu den Beispielen>msgext-action>csharp>TeamsAppManifest.
Erstellen Sie eine .zip mit den folgenden Dateien, die im Ordner "Manifest" vorhanden sind:
- manifest.json
- icon-outline.png
- icon-color.png
Wählen Sie im Teams-Client das Symbol "Apps " aus.
Wählen Sie Apps verwalten aus.
Wählen Sie App hochladen aus.
Suchen Sie nach der Option zum Hochladen einer benutzerdefinierten App. Wenn die Option angezeigt wird, ist der benutzerdefinierte App-Upload aktiviert.
Hinweis
Wenden Sie sich an Ihren Teams-Administrator, wenn Sie die Option zum Hochladen einer benutzerdefinierten App nicht finden.
Wählen Sie "Öffnen " aus, um die messaging.zip Datei hochzuladen, die Sie im Ordner "TeamsAppManifest" erstellt haben.
Wählen Sie Hinzufügen aus.
Wählen Sie "Öffnen " aus, um die App im persönlichen Bereich zu öffnen.
Alternativ können Sie entweder den gewünschten Bereich durchsuchen und auswählen oder einen Kanal, Chat oder eine Besprechung aus der Liste auswählen und durch das Dialogfeld navigieren, um Los auszuwählen.
Interagieren mit der App in Teams
Wählen Sie in der Befehlsliste des Verfassungsfelds den Befehl "Karte erstellen " aus.
Geben Sie Ihre Informationen in das modale Popupfenster ein.
Wählen Sie Absenden aus.
Wählen Sie im Überlaufmenü Weitere Optionen (...) aus.
Weitere Aktionen> auswählenNachricht freigeben.
Wenn Sie ein Bild einschließen möchten, aktivieren Sie das Kontrollkästchen Bild in Hero-Karte einschließen , und wählen Sie dann Senden aus.
Herausforderung abschließen
Hast du dir so etwas ausgedacht?
Sie haben das Tutorial für die ersten Schritte mit einer Aktionsnachrichtenerweiterungs-App abgeschlossen!
Erstellen eines Bots mit SSO-Authentifizierung
Unterhaltungs-Bots in Microsoft Teams führen sich wiederholende automatisierte Aufgaben aus, die von Benutzern initiiert werden, z. B. Kundenservice. Der Benutzer muss sich mehrmals ohne Single Sign-On (SSO)-Authentifizierung anmelden. Mit SSO-Authentifizierungsmethoden müssen sich die Benutzer nicht mehrmals beim Bot anmelden.
Tutorial: Erstellen eines Bots mit SSO-Authentifizierung
Ein Bot verhält sich je nach der Konversation, an der er beteiligt ist, anders:
- Bots in Kanal- und Gruppenchatunterhaltungen erfordern, dass die Benutzer den Bot verwenden @mention .
- Bots in einer 1:1-Unterhaltung benötigen keine @mention. Alle vom Benutzer gesendeten Nachrichten werden an den Bot weitergeleitet.
Diese schrittweise Anleitung hilft Ihnen, einen Bot mit SSO-Authentifizierung zu erstellen. Die folgende Ausgabe wird angezeigt:
Voraussetzungen für die Erstellung eines Bots
Stellen Sie sicher, dass Sie die folgenden Tools installieren und Ihre Entwicklungsumgebung einrichten:
| Installieren | Zur Verwendung... |
|---|---|
| Microsoft Teams | Microsoft Teams für die Zusammenarbeit mit allen Personen, mit denen Sie zusammenarbeiten, über Apps für Chats, Besprechungen und Anrufe an einem Ort. |
| Visual Studio 2022 | Sie können die Enterprise-Version in Visual Studio 2022 installieren und die Workloads ASP.NET und Webentwicklung installieren. Verwenden Sie die neueste Version. |
| Microsoft 365-Entwicklerkonto | Zugriff auf ein Teams-Konto mit den entsprechenden Berechtigungen zum Installieren einer App. |
| Dev-Tunnel | Microsoft Teams-App-Features (Unterhaltungsbots, Nachrichtenerweiterungen und eingehende Webhooks) benötigen eingehende Verbindungen. Ein Tunnel verbindet Ihr Entwicklungssystem mit Teams. Dev Tunnel ist ein leistungsstarkes Tool, um Ihren lokalen Host sicher für das Internet zu öffnen und zu steuern, wer Zugriff hat. Der Dev-Tunnel ist in Visual Studio 2022, Version 17.7.0 oder höher, verfügbar. oder Sie können ngrok auch als Tunnel verwenden, um Ihr Entwicklungssystem mit Microsoft Teams zu verbinden. Für Apps, die nur Registerkarten enthalten, ist dies nicht erforderlich. Dieses Paket wird im Projektverzeichnis installiert (mit npm devDependencies). |
Hinweis
Melden Sie sich nach dem Herunterladen von ngrok an und installieren Sie authtoken.
Einrichten des Teams-Entwicklungsmandanten
Ein Mandant ist mit einem Raum oder Container vergleichbar, in dem Sie chatten, Dateien freigeben und Besprechungen für Ihre organization in Teams durchführen. Sie können auch die benutzerdefinierte App hochladen und testen.
Überprüfen auf eine Option zum Hochladen einer benutzerdefinierten App
Nachdem Sie die App erstellt haben, müssen Sie Ihre App in Teams laden, ohne sie zu verteilen. Dieser Vorgang wird als benutzerdefinierter App-Upload bezeichnet. Melden Sie sich bei Ihrem Microsoft 365-Konto an, um diese Option anzuzeigen.
Hinweis
Der benutzerdefinierte App-Upload ist erforderlich, um Apps in der lokalen Teams-Umgebung anzuzeigen und zu testen. Aktivieren Sie den App-Upload, um eine Vorschau Ihrer App anzuzeigen und Ihre App lokal in Teams zu testen.
Haben Sie bereits einen Mandanten und verfügen Sie über Administratorzugriff? Lassen Sie uns überprüfen, ob Sie das wirklich tun!
So überprüfen Sie benutzerdefinierte Upload-Apps in Teams:
Wählen Sie im Teams-Client das Symbol "Apps " aus.
Wählen Sie Apps verwalten aus.
Wählen Sie "App hochladen" aus.
Suchen Sie nach der Option Hochladen einer benutzerdefinierten App. Wenn die Option angezeigt wird, ist der benutzerdefinierte App-Upload aktiviert.
Hinweis
Wenden Sie sich an den Teams-Administrator, wenn Sie nicht die Möglichkeit haben, eine benutzerdefinierte App hochzuladen.
Erstellen eines kostenlosen Microsoft Teams-Entwicklermandanten
Wenn Sie kein Teams-Entwicklerkonto haben, können Sie es kostenlos erhalten. Treten Sie dem Microsoft 365-Entwicklerprogramm bei!
Wechseln Sie zum Microsoft 365-Entwicklerprogramm.
Wählen Sie "Jetzt teilnehmen" aus, und folgen Sie den Anweisungen auf dem Bildschirm.
Wählen Sie auf dem Willkommensbildschirm "E5-Abonnement einrichten" aus.
Richten Sie ein Administratorkonto ein. Nach Abschluss des Vorgangs wird der folgende Bildschirm angezeigt.
Melden Sie sich mit dem soeben eingerichteten neuen Administratorkonto bei Teams an. Stellen Sie sicher, dass die Option "Benutzerdefinierte App hochladen " in Teams vorhanden ist.
Einrichten der lokalen Umgebung
Führen Sie die folgenden Schritte aus, um das Repository zu klonen:
Wählen Sie "Code" aus.
Wähle im Dropdownmenü "Mit GitHub Desktop öffnen" aus.
Wählen Sie "Klonen" aus.
Registrieren der Microsoft Entra-App
Die folgenden Schritte helfen Ihnen, Ihren Bot im Azure-Portal zu erstellen und zu registrieren:
- Erstellen und registrieren Sie Ihre Azure-App.
- Erstellen Sie einen geheimen Clientschlüssel, um die SSO-Authentifizierung des Bots zu ermöglichen.
- Fügen Sie den Teams-Kanal hinzu, um den Bot bereitzustellen.
- Erstellen Sie einen Tunnel zu den Endpunkten Ihres Webservers mithilfe von dev tunnel (empfohlen) oder ngrok.
- Fügen Sie dem von Ihnen erstellten Dev-Tunnel einen Messagingendpunkt hinzu.
Hinzufügen einer App-Registrierung
Wechseln Sie zum Azure-Portal.
Wählen Sie "App-Registrierungen" aus.
Wählen Sie "+ Neue Registrierung" aus.
Geben Sie den Namen Ihrer App ein.
Wählen Sie nach Bedarf die Mandantenoption aus.
Wählen Sie Registrieren aus.
Ihre App ist in Microsoft Entra ID registriert. Die App-Übersichtsseite wird angezeigt.
Hinweis
Speichern Sie die App-ID aus Anwendungs-ID (Client) undVerzeichnis-ID (Mandant) zur weiteren Verwendung.
Erstellen eines Tunnels
Führen Sie eine der folgenden beiden Methoden aus, um einen Tunnel zu erstellen.
Öffnen Sie Visual Studio.
Wähle "Neues Projekt erstellen" aus.
Geben Sie im Suchfeld ASP.NET ein. Wählen Sie in den Suchergebnissen "ASP.NET Core Web App" aus.
Wählen Sie Weiter aus.
Geben Sie den Projektnamen ein, und wählen Sie Weiter aus.
Wählen Sie Erstellen aus.
Ein Übersichtsfenster erscheint.
Wählen Sie in der Dropdownliste debuggen die Option Dev Tunnels (kein aktiver Tunnel)>Tunnel erstellen....
Ein Pop-up-Fenster wird angezeigt.
Aktualisieren Sie im Popupfenster die folgenden Details:
- Konto: Geben Sie ein Microsoft- oder GitHub-Konto ein.
- Name: Geben Sie einen Namen für Ihren Tunnel ein.
- Tunneltyp: Wählen Sie in der Dropdownliste die Option Temporär aus.
- Zugriff: Wählen Sie in der Dropdownliste Öffentlich aus.
Wählen Sie OK aus.
Ein Popupfenster wird angezeigt, das zeigt, dass der Dev-Tunnel erfolgreich erstellt wurde.
Wählen Sie OK aus.
Du findest den erstellten Tunnel in der Debug-Dropdownliste wie folgt:
Drücken Sie F5 , um die Anwendung im Debugmodus auszuführen.
Wenn ein Dialogfeld mit einer Sicherheitswarnung angezeigt wird, wählen Sie Ja aus.
Ein Pop-up-Fenster wird angezeigt.
Wählen Sie Weiter aus.
Die Dev Tunnel-Startseite wird in einem neuen Browserfenster geöffnet, und der Dev Tunnel ist jetzt aktiv.
Wechseln Sie zu Visual Studio und wählen Sie Ausgabe anzeigen >aus.
Wählen Sie im Dropdownmenü der Ausgabekonsole die Option Dev Tunnels aus.
Die Ausgabekonsole zeigt die Dev-Tunnel-URL an.
Webauthentifizierung hinzufügen
Wählen Sie im linken Bereich unter Verwaltendie Option Authentifizierung aus.
Wählen Sie Plattform>hinzufügen Web aus.
Geben Sie den Umleitungs-URI für Ihre App ein, indem Sie ihn an den vollqualifizierten Domänennamen anfügen
auth-end. Beispielsweisehttps://your-devtunnel-domain/auth-endoderhttps://your-ngrok-domain/auth-end.Aktivieren Sie unter Implizite Gewährung und Hybridflüsse die Kontrollkästchen Zugriffstoken und ID-Token .
Wählen Sie "Konfigurieren" aus.
Wählen Sie unter Web die Option "URI hinzufügen" aus.
Geben Sie
https://token.botframework.com/.auth/web/redirectein.Wählen Sie Speichern aus.
Einen geheimen Clientschlüssel erstellen
Hinweis
Wenn der Fehler " Geheime Clientschlüssel werden durch mandantenweite Richtlinie blockiert" auftritt. Wenden Sie sich an Ihren Mandantenadministrator, um weitere Informationen zu erhalten. können Sie stattdessen ein Zertifikat erstellen. Eine schrittweise Anleitung finden Sie unter Erstellen eines Zertifikats für die App-Registrierung.
Wählen Sie im linken Bereich unter Verwalten die Option Zertifikate & Geheimnisse aus.
Wählen Sie unter Geheime Clientschlüsseldie Option + Neues geheime Clientschlüssel aus.
Das Fenster Einen geheimen Clientschlüssel hinzufügen wird angezeigt.
Beschreibung eingeben.
Wählen Sie Hinzufügen aus.
Wählen Sie unter "Wert" die Option "In Zwischenablage kopieren " aus, um den Wert des geheimen Clientschlüssels zur weiteren Verwendung zu speichern.
API-Berechtigungen hinzufügen
Wählen Sie im linken Bereich API-Berechtigungen aus.
Wählen Sie "+ Berechtigung hinzufügen" aus.
Wählen Sie Microsoft Graph aus.
Wählen Sie Delegierte Berechtigungen aus.
Wählen Sie User>User.Read aus.
Wählen Sie Berechtigungen hinzufügen aus.
Hinweis
- Wenn einer App keine Zustimmung des IT-Administrators erteilt wird, müssen Benutzer bei der ersten Verwendung einer App ihre Zustimmung erteilen.
- Benutzer müssen den API-Berechtigungen nur zustimmen, wenn die Microsoft Entra-App in einem anderen Mandanten registriert ist.
Anwendungs-ID-URI hinzufügen
Wählen Sie im linken Bereich unter Verwaltendie Option API verfügbar machen.
Wählen Sie neben Anwendungs-ID-URIdie Option Hinzufügen aus.
Aktualisieren Sie den Anwendungs-ID-URI im
api://botid-{AppID}Format, und wählen Sie Speichern aus.
Hinzufügen eines Bereichs
Wählen Sie im linken Bereich unter Verwaltendie Option API verfügbar machen.
Wählen Sie "+ Bereich hinzufügen" aus.
Geben Sie access_as_user als Bereichsnamen ein.
Wählen Sie unter Wer kann zustimmen?die Option Administratoren und Benutzer aus.
Aktualisieren Sie die Werte für die übrigen Felder wie folgt:
Geben Sie Teams kann als Anzeigename der Admin-Zustimmungauf das Profil des Benutzers zugreifen.
EINGABE Ermöglicht Teams das Aufrufen der Web-APIs der App als aktueller Benutzer als Beschreibung der Admin-Einwilligung.
Geben Sie Teams kann als Anzeigename der Benutzereinwilligungauf das Benutzerprofil zugreifen und Anforderungen im Namen des Benutzers stellen.
Geben Aktivieren Sie Teams, um die APIs dieser App mit denselben Rechten wie der Benutzer aufzurufenBeschreibung der Benutzerzustimmung.
Stellen Sie sicher, dass State auf Aktiviert festgelegt ist.
Wählen Sie Bereich hinzufügen aus.
Die folgende Abbildung zeigt die Felder und die Werte:
Hinweis
Der Bereichsname muss mit dem Anwendungs-ID-URI übereinstimmen, der
/access_as_useram Ende angefügt ist.
Clientanwendung hinzufügen
Wählen Sie im linken Bereich unter Verwaltendie Option API verfügbar machen.
Identifizieren Sie unter Autorisierte Clientanwendungen die Anwendungen, die Sie für die Webanwendung Ihrer App autorisieren möchten.
Wählen Sie "+ Clientanwendung hinzufügen" aus.
Hinzufügen von Teams Mobile oder Desktop und der Teams-Webanwendung.
Für Teams Mobile oder Desktop: Geben Sie die Client-ID als
1fec8e78-bce4-4aaf-ab1b-5451cc387264ein.
Für Teams Web: Geben Sie die Client-ID als
5e3ce6c0-2b1f-4285-8d4b-75ee78787346ein.
Aktivieren Sie das Kontrollkästchen Autorisierte Bereiche .
Wählen Sie Anwendung hinzufügen aus.
In der folgenden Abbildung wird die Client-ID angezeigt:
Aktualisieren des Manifests
Wählen Sie im linken Bereich Manifest aus.
Legen Sie den Wert für "
requestedAccessTokenVersionAn" fest,2und wählen Sie "Speichern" aus.
Erstellen Ihres Bots
Erstellen einer Azure Bot-Ressource
Hinweis
Wenn Sie Ihren Bot bereits in Teams testen, melden Sie sich von dieser App und Teams ab. Melden Sie sich erneut an, um diese Änderung zu sehen.
Zur Startseite.
Wählen Sie + Ressource erstellen aus.
Geben Sie im Suchfeld Azure Bot ein.
Drücken Sie die EINGABETASTE.
Wählen Sie Azure Bot aus.
Wählen Sie Erstellen aus.
Geben Sie den Botnamen in Bothandle ein.
Wählen Sie Ihr Abonnement aus der Dropdownliste aus.
Wählen Sie in der Dropdownliste Ihre Ressourcengruppe aus.
Wenn Sie über keine vorhandene Ressourcengruppe verfügen, können Sie eine neue Ressourcengruppe erstellen. Gehen Sie folgendermaßen vor, um eine neue Ressourcengruppe zu erstellen:
- Wählen Sie Neu erstellen aus.
- Geben Sie den Ressourcennamen ein, und wählen Sie OK aus.
- Wählen Sie einen Standort aus der Dropdownliste "Neuer Standort der Ressourcengruppe " aus.
Wählen Sie unter "Preise" die Option "Plan ändern" aus.
Wählen Sie FO Free>Select.
Wählen Sie unter Microsoft-App-IDden App-Typ "Multi-Tenant" aus.
Wählen Sie unter Erstellungstypdie Option Vorhandene App-Registrierung verwenden aus.
Geben Sie die App-ID ein.
Hinweis
Sie können nicht mehr als einen Bot mit derselben Microsoft-App-ID erstellen.
Wählen Sie Überprüfen + erstellen.
Nachdem die Überprüfung erfolgreich war, wählen Sie Erstellen aus.
Die Bereitstellung des Bots dauert ein paar Minuten.
Wählen Sie "Zu Ressource wechseln aus".
Sie haben erfolgreich Ihren Azure-Bot erstellt.
Hinzufügen eines Teams-Kanals
Wählen Sie im linken Bereich Kanäle aus.
Wählen Sie unter "Verfügbare Kanäle"die Option "Microsoft Teams" aus.
Aktivieren Sie das Kontrollkästchen, um die Nutzungsbedingungen zu akzeptieren.
Wählen Sie Zustimmen aus.
Wählen Sie Anwenden aus.
Messagingendpunkt hinzufügen
Verwenden Sie eine der folgenden Methoden, um einen Messaging-Endpunkt hinzuzufügen:
Verwenden Sie die Dev-Tunnel-URL in der Ausgabekonsole als Messagingendpunkt.
Wählen Sie im linken Bereich unter Einstellungen die Option Konfiguration.
Aktualisieren Sie den Messagingendpunkt im Format
https://your-devtunnel-domain/api/messages.
Wählen Sie Anwenden aus.
Sie haben erfolgreich einen Bot in Azure Bot Service eingerichtet.
Hinweis
Wenn der Application Insights-Instrumentierungsschlüssel einen Fehler anzeigt, aktualisieren Sie mit der App-ID.
OAuth-Verbindungseinstellungen hinzufügen
Wählen Sie im linken Bereich Konfiguration aus.
Wählen Sie OAuth-Verbindungseinstellungen hinzufügen aus.
Aktualisieren Sie unter Neue Verbindungseinstellung die folgenden Details:
- Name: Geben Sie einen Namen für Ihre neue Verbindungseinstellung ein. Sie können den Namen in den Einstellungen Ihres Bot-Dienstcodes verwenden.
- Dienstanbieter: Wählen Sie in der Dropdownliste Azure Active Directory v2 aus.
- Client-ID: Aktualisieren Sie Ihre Microsoft-App-ID.
- Geheimer Clientschlüssel: Aktualisieren Sie den Wert des geheimen Clientschlüssels.
- Tokenaustausch-URL: Aktualisieren Sie den Anwendungs-ID-URI.
- Mandanten-ID: Geben Sie Common ein.
- Bereiche: Geben Sie User.Read ein.
Wählen Sie Speichern aus.
Einrichten von App-Einstellungen und Anwendungsmanifestdateien
Wechseln Sie zur appsettings.json Datei im geklonten Repository.
Öffnen Sie die appsettings.json Datei, und aktualisieren Sie die folgenden Informationen:
- Auf die Microsoft-App-ID Ihres Bots festlegen
"MicrosoftAppId". - Auf den ID-Wert des geheimen Clientschlüssels Ihres Bots festlegen
"MicrosoftAppPassword". - Als OAuth-Verbindungsname festlegen
ConnectionName. - Auf MultiTenant festlegen
"MicrosoftAppType". - Auf gewöhnlich festlegen
"MicrosoftAppTenantId".
- Auf die Microsoft-App-ID Ihres Bots festlegen
Wechseln Sie zur manifest.json Datei im geklonten Repository.
Öffnen Sie die manifest.json Datei, und aktualisieren Sie die folgenden Änderungen:
- Ersetzen Sie alle Vorkommen von
"{TODO: MicrosoftAppId}"durch Ihre Microsoft-App-ID. - Auf Ihre ngrok- oder dev tunnel-Domäne festlegen
"<<domain-name>>".
- Ersetzen Sie alle Vorkommen von
Erstellen und Ausführen des Diensts
Öffnen Sie Visual Studio.
Wechseln Sie zu Datei>Projekt/Projektmappe öffnen>....
Gehen Sie zu bot-conversation-sso-quickstart>csharp_dotnetcore Ordner, und wählen Sie BotConversationSsoQuickstart.sln Datei aus.
Wählen Sie F5 , um das Projekt auszuführen.
Wenn ein Dialogfeld mit einer Sicherheitswarnung angezeigt wird, wählen Sie Ja aus.
Eine Webseite wird mit einer Meldung geöffnet: Ihr Bot ist bereit!.
Hinweis
Diese Seite wird nur angezeigt, wenn Sie zur localhost URL navigieren.
Problembehandlung
Wenn Sie die Fehlermeldung "Paket kann nicht gefunden werden" erhalten, führen Sie die folgenden Schritte aus:
- Wechseln Sie zu Extras>NuGet-Paket-Manager-Paket-Manager-Einstellungen>.
- Wählen Sie im angezeigten Fenster Optionen die Option NuGet-Paket-Manager-Paketquellen> aus.
- Wählen Sie Hinzufügen aus.
- Geben Sie unter Name, und
nuget.orgin Quelle einhttps://api.nuget.org/v3/index.json. - Wählen Sie Aktualisieren und OK aus.
- Erstellen Sie Ihr Projekt neu.
Hochladen des Bots in Teams
Wechseln Sie in Ihrem geklonten Repository zu "Microsoft-Teams-Samples>"-Beispiele:bot-conversation-sso-quickstart>>csharp_dotnetcore>TeamsApp>appPackage.
Erstellen Sie eine .zip Datei mit den folgenden Dateien, die im Ordner appPackage vorhanden sind:
- manifest.json
- outline.png
- color.png
Wechseln Sie zu Microsoft Teams.
- Wählen Sie im Teams-Client "Apps" aus.
- Wählen Sie Apps verwalten aus.
- Wählen Sie App hochladen aus.
- Suchen Sie nach der Option zum Hochladen einer benutzerdefinierten App.
Wähle "Öffnen" aus, um die .zip Datei hochzuladen, die du im Ordner "Manifest" erstellt hast.
Wählen Sie Hinzufügen aus, um den Bot zu Ihrem Chat hinzuzufügen.
Wählen Sie Öffnen aus.
Sie können mit dem Bot interagieren, indem Sie ihm eine Nachricht senden. Der Bot tauscht ein SSO-Token aus und ruft die Graph-API in Ihrem Namen auf. Sie bleiben angemeldet, es sei denn, Sie senden eine Nachricht, um sich abzumelden.
Senden Sie eine Nachricht an den Bot. Der Unterhaltungsbot fragt zum ersten Mal nach Einwilligung.
Für Desktop: Wählen Sie "Weiter " aus, um dem Teams-Client Berechtigungen für den Zugriff auf den Bot zu erteilen.
Hinweis
Jetzt haben Sie SSO mit Ihrer Bot-App konfiguriert, und es ist das einzige Mal, dass Sie Ihre Zustimmung geben müssen.
Für Mobilgeräte: Wählen Sie Annehmen aus.
Hinweis
Jetzt haben Sie SSO mit Ihrer Bot-App auf Mobilgeräten konfiguriert, und es ist das einzige Mal, dass Sie Ihre Zustimmung geben müssen.
Hast du dir so etwas ausgedacht?
Sie haben das Tutorial für die ersten Schritte mit dem Erstellen eines Bots mit SSO-Authentifizierung abgeschlossen.
Erstellen Ihrer ersten Nachrichtenerweiterungs-App mit JavaScript
Beginnen Sie die Entwicklung von Microsoft Teams-Apps mit Ihrer ersten Teams-App mit JavaScript.
In diesem Tutorial lernst du Folgendes:
- Einrichten eines neuen Projekts mit dem Microsoft 365 Agents Toolkit (früher bekannt als Teams Toolkit).
- Erstellen einer Nachrichtenerweiterungs-App.
- Bereitstellen Ihrer App.
Tutorial: Erstellen Ihrer ersten Nachrichtenerweiterungs-App mit JavaScript
Diese schrittweise Anleitung hilft Ihnen, eine Teams-App für Nachrichtenerweiterungen mit dem Agents Toolkit in Visual Studio Code zu erstellen. Nach Abschluss dieses Handbuchs wird die folgende Ausgabe angezeigt:
Voraussetzungen
Stellen Sie sicher, dass Sie die folgenden Tools zum Erstellen und Bereitstellen Ihrer Apps installieren.
| Installieren | Zur Verwendung... | |
|---|---|---|
| Erforderlich | ||
| Visual Studio Code | JavaScript- oder TypeScript-Buildumgebungen. Verwenden Sie die neueste Version. | |
| Microsoft 365 Agents Toolkit | Microsoft Visual Studio Code-Erweiterung, die ein Projektgerüst für Ihre App erstellt. Verwenden Sie die neueste Version. | |
| Node.js | Back-End-JavaScript-Laufzeitumgebung. Weitere Informationen finden Sie in Node.js Versionskompatibilitätstabelle. | |
| Microsoft Teams | Arbeiten Sie mit Ihren Mitarbeitern über Apps für Chats, Besprechungen und Anrufe an einem Ort zusammen. | |
| Microsoft Edge (empfohlen) oder Google Chrome | Ein Browser mit Entwicklertools, die zum Debuggen und Testen unerlässlich sind. | |
| Microsoft 365-Entwicklerkonto | Zugriff auf Teams-Konto mit den entsprechenden Berechtigungen zum Installieren einer benutzerdefinierten App. | |
| Optional | ||
| Azure-Tools für Visual Studio Code und Azure CLI | Azure-Tools für den Zugriff auf gespeicherte Daten oder für die Bereitstellung eines cloudbasierten Back-Ends für Ihre Teams-App in Azure. | |
| React Developer Tools für Chrome oder React Developer Tools für Microsoft Edge | Eine Browser-DevTools-Erweiterung für die Open-Source-JavaScript-Bibliothek React. |
Vorbereiten der Entwicklungsumgebung
Nachdem Sie die erforderlichen Tools installiert haben, richten Sie die Entwicklungsumgebung ein.
Microsoft 365 Agents Toolkit installieren
Microsoft 365 Agents Toolkit (früher als Teams Toolkit bezeichnet) hilft dabei, den Entwicklungsprozess mit Tools zum Bereitstellen und Bereitstellen von Cloudressourcen für Ihre App und zur Veröffentlichung im Teams Store zu vereinfachen.
Sie können Agents Toolkit mit Visual Studio Code oder eine Befehlszeilenschnittstelle namens Microsoft 365 Agents Toolkit CLI (früher als TeamsFx CLI bezeichnet) verwenden.
Öffne Visual Studio Code und wähle Erweiterungen aus (STRG+UMSCHALT+X oderErweiterungenanzeigen>).
Geben Sie im Suchfeld "Microsoft 365 Agents Toolkit" ein.
Wählen Sie Installieren aus.
Das Symbol Microsoft 365 Agents Toolkit
wird in der Aktivitätsleiste von Visual Studio Code angezeigt.
Sie können Agents Toolkit auch aus dem Visual Studio Code Marketplace installieren.
Einrichten Ihres Teams-Entwicklungsmandanten
Ein Mandant ist ein Raum oder Container für Ihre organization in Teams, in dem Sie chatten, Dateien freigeben und Besprechungen abhalten. In diesen Bereich laden Sie auch Ihre App hoch und testen sie. Lassen Sie uns überprüfen, ob Sie bereit sind, mit dem Mandanten zu entwickeln.
Option zum Hochladen einer App überprüfen
Nachdem Sie Ihre benutzerdefinierte App erstellt haben, müssen Sie Ihre App mit der Option "Benutzerdefinierte App hochladen " in Teams hochladen. Melden Sie sich bei Ihrem Microsoft 365-Konto an, um zu überprüfen, ob diese Option aktiviert ist.
Mithilfe der folgenden Schritte können Sie überprüfen, ob Sie Apps in Teams hochladen können:
Wählen Sie im Teams-Client das Symbol "Apps " aus.
Wählen Sie Apps verwalten aus.
Wählen Sie App hochladen aus.
Suchen Sie nach der Option zum Hochladen einer benutzerdefinierten App. Wenn die Option angezeigt wird, können Sie benutzerdefinierte Apps hochladen.
Hinweis
Wenn Sie die Option zum Hochladen einer benutzerdefinierten App nicht finden, wenden Sie sich an Ihren Teams-Administrator.
Erstellen eines kostenlosen Teams-Entwicklermandanten (optional)
Wenn Sie kein Teams-Entwicklerkonto haben, treten Sie dem Microsoft 365-Entwicklerprogramm bei.
Wechseln Sie zum Microsoft 365-Entwicklerprogramm.
Wählen Sie "Jetzt teilnehmen" aus, und folgen Sie den Anweisungen auf dem Bildschirm.
Wählen Sie auf dem Willkommensbildschirm E5-Abonnement einrichten aus.
Richten Sie Ihr Administratorkonto ein. Nach Abschluss des Vorgangs wird der folgende Bildschirm angezeigt:
Melden Sie sich mit dem soeben eingerichteten Administratorkonto bei Teams an. Stellen Sie sicher, dass die Option "Benutzerdefinierte App hochladen " in Teams vorhanden ist.
Kostenloses Azure-Konto erhalten
Wenn Sie Ihre App hosten oder auf Ressourcen in Azure zugreifen möchten, benötigen Sie ein Azure-Abonnement. Erstellen Sie ein kostenloses Konto , bevor Sie beginnen.
Erstellen Sie einen Projektarbeitsbereich für Ihre Nachrichtenerweiterungs-App
Nun erstellen wir Ihre erste Nachrichtenerweiterungs-App.
Die Nachrichtenerweiterungsfunktion ermöglicht Ihnen die Interaktion mit einem Webdienst über Schaltflächen und Formulare. Verwenden Sie den Bereich zum Verfassen von Nachrichten, das Befehlsfeld oder eine Nachricht direkt im Teams-Client, um Aktionen in einem externen System zu suchen und zu initiieren. Nachrichtenerweiterungen basieren auf Bots, um einen Dialog zwischen dem Benutzer und Ihrem Code bereitzustellen.
Es gibt zwei Arten von Teams-Nachrichtenerweiterungen:
- Suchbefehle: Sie können externe Systeme durchsuchen und die Ergebnisse in eine Nachricht in Form einer Karte einfügen.
- Aktionsbefehle: Sie können Ihren Benutzern ein modales Popupfenster zum Sammeln oder Anzeigen von Informationen bereitstellen. Anschließend können Sie ihre Interaktion verarbeiten und die Informationen zurück an Teams senden.
Lassen Sie uns eine Nachrichtenerweiterungs-App mit einem Suchbefehl erstellen. Richten Sie zunächst ein neues Teams-Projekt zum Erstellen der Nachrichtenerweiterungs-App ein.
In diesem Tutorial lernst du Folgendes:
- So richten Sie ein neues Nachrichtenerweiterungsprojekt mit dem Agents Toolkit ein.
- Über die Verzeichnisstruktur Ihres App-Projekts.
Erstellen Sie Ihren Projektarbeitsbereich für die Nachrichtenerweiterung
Wenn die Voraussetzungen gegeben sind, kann es losgehen!
Hinweis
Die gezeigte Visual Studio Code-Benutzeroberfläche kann je nach Betriebssystem, Toolkit-Version, Design und Umgebung unterschiedlich sein.
Öffne Visual Studio Code.
Wählen Sie das Symbol Microsoft 365 Agents Toolkit
in der Aktivitätsleiste von Visual Studio Code aus.Wählen Sie "Neue Agent-/App-Teams-App> erstellen" aus.
Nachrichtenerweiterung auswählen.
Wählen Sie "Benutzerdefinierte Suchergebnisse" aus.
Wählen Sie "Mit einem Bot starten" aus.
Wählen Sie JavaScript.
Wähle Standardordner aus, um den Projektstammordner am Standardspeicherort zu speichern.
Sie können den Standardspeicherort auch wie folgt ändern:
Wählen Sie Durchsuchen aus.
Wählen Sie den Speicherort für den Projektarbeitsbereich aus.
Wählen Sie "Ordner auswählen" aus.
Geben Sie einen geeigneten Namen für Ihre App ein. Drücken Sie die EINGABETASTE.
Agents Toolkit erstellt die App in wenigen Sekunden.
Nachdem Ihre App erstellt wurde, zeigt Agents Toolkit die folgende Meldung an:
Tour durch den Quellcode der Nachrichtenerweiterungs-App
Eine Nachrichtenerweiterung verwendet Bot Framework, um über eine Unterhaltung mit Ihrem Dienst zu interagieren. Zeigen Sie nach dem Gerüstbau die Projektverzeichnisse und Dateien unter EXPLORER an.
| Ordner / Datei | Inhalt |
|---|---|
m365agents.yml |
Die Hauptprojektdatei beschreibt Ihre Anwendungskonfiguration und definiert die Aktionen, die in jeder Lebenszyklusphase ausgeführt werden sollen. |
m365agents.local.yml |
Überschreibt m365agents.yml mit Aktionen, die lokale Ausführung und Debugging ermöglichen. |
.vscode/ |
Visual Studio Code-Dateien für das lokale Debuggen. |
appPackage/ |
Vorlagen für das Teams-Anwendungsmanifest. |
infra/ |
Vorlagen für die Bereitstellung von Azure-Ressourcen. |
index.js |
Anwendungseinstiegspunkt und express -handler. |
Tipp
Machen Sie sich mit Bots und Nachrichtenerweiterungen außerhalb von Teams vertraut, bevor Sie Ihre App in Teams integrieren.
Erstellen und Ausführen Ihrer ersten Nachrichtenerweiterungs-App
Nachdem Sie Ihren Projektarbeitsbereich mit Agents Toolkit eingerichtet haben, ist es an der Zeit, Ihr Projekt zu erstellen. Sie müssen sich bei Ihrem Microsoft 365-Konto anmelden.
Anmelden bei Ihrem Microsoft 365-Konto
Melden Sie sich mit dem Administratorkonto an, das Sie beim Beitreten zum Microsoft 365-Entwicklerprogramm erstellt haben.
Öffne Visual Studio Code.
Wählen Sie das Symbol Microsoft 365 Agents Toolkit
in der Aktivitätsleiste aus.Wählen Sie "Bei Microsoft 365 anmelden" mit Ihren Anmeldeinformationen aus. Ihr Standardwebbrowser wird geöffnet, damit Sie sich anmelden können.
Schließen Sie den Browser, nachdem Sie sich mit Ihren Anmeldeinformationen angemeldet haben.
Zurück zum Agents-Toolkit in Visual Studio Code.
Im Abschnitt KONTEN der Randleiste wird der Name Ihres Microsoft 365-Kontos angezeigt. Wenn der benutzerdefinierte App-Upload für Ihr Microsoft 365-Konto aktiviert ist, zeigt das Agents-Toolkit den benutzerdefinierten App-Upload aktiviert an.
Jetzt können Sie die App erstellen und lokal ausführen!
Erstellen und Ausführen Ihrer App in der lokalen Umgebung
Jetzt können Sie Ihre erste Teams-Nachrichtenerweiterungs-App lokal erstellen und debuggen.
Lokales Erstellen und Ausführen Ihrer App
Drücke in Visual Studio Code die Taste F5 , um deine Anwendung im Debugmodus auszuführen.
Hinweis
Wenn Agents Toolkit eine bestimmte Voraussetzung nicht überprüfen kann, werden Sie aufgefordert, dies zu überprüfen.
Erfahren Sie, was geschieht, wenn Sie Ihre App lokal im Debugger ausführen.
Wenn Sie F5 auswählen, führt Agents Toolkit die folgenden Funktionen aus:
Überprüft die folgenden Voraussetzungen:
- Sie sind mit einem Microsoft 365-Konto angemeldet.
- Der benutzerdefinierte App-Upload ist für Ihr Microsoft 365-Konto aktiviert.
- Unterstützte Node.js-Version ist installiert.
- Von Bot-App erforderlicher Port ist verfügbar.
Installiert npm-Pakete
Startet den Dev-Tunnel, um einen HTTP-Tunnel zu erstellen.
Registriert die App in Microsoft Entra ID und konfiguriert die App.
Registriert die Bot-App im Bot Framework und konfiguriert die App.
Registriert die App im Teams-Entwicklerportal und konfiguriert die App.
Startet die lokal gehostete Nachrichtenerweiterungs-App.
Startet Teams in einem Webbrowser und lädt die Teams-App hoch.
Wenn Sie die App zum ersten Mal debuggen, lädt Teams die Abhängigkeiten herunter und erstellt die App. Dieser Vorgang kann 3 bis 5 Minuten in Anspruch nehmen.
Teams wird in einem Browserfenster geöffnet, wenn der Build abgeschlossen ist. Melden Sie sich mit Ihrem Microsoft 365-Konto an, wenn Sie dazu aufgefordert werden.
Ein Dialogfeld wird geöffnet, in dem Sie Teams die Nachrichtenerweiterungs-App hinzufügen können. Wählen Sie Hinzufügen aus.
Teams lädt die Nachrichtenerweiterungs-App.
Da Nachrichtenerweiterungs-Apps auf Bots angewiesen sind, um die Kommunikation zwischen dem Benutzer und dem Webdienst zu ermöglichen, wird Ihre App in ein Chatfeature eines Bots geladen.
- Wenn Sie eine Bot-App erstellt haben, bevor Sie die Nachrichtenerweiterungs-App erstellt haben, lädt Teams die Nachrichtenerweiterung in die von Ihnen erstellte Bot-App. Vorherige Chatnachrichten der Bot-App sind sichtbar.
- Wenn Sie zuerst eine Nachrichtenerweiterung erstellt haben, lädt Teams Ihre App im letzten Chat, der in Teams geöffnet ist.
Testen Ihrer App
Wenn Ihre App zum ersten Mal geladen wird, können Sie die Nachrichtenerweiterungs-App testen. Mit dieser Beispiel-App können Sie Open-Source-npm-Pakete in der Softwareregistrierung durchsuchen.
Ausführen einer Suchabfrage
Geben Sie den Namen eines Open-Source-npm-Pakets in das Suchfeld der Nachrichtenerweiterung ein, z. B. cli. Die Nachrichtenerweiterung zeigt eine Liste der übereinstimmenden Elemente an.
Wählen Sie eines der Elemente aus der Liste aus. Die App erstellt eine adaptive Karte mit dem Element im Bereich zum Verfassen von Nachrichten, damit Sie sie in einem Chat oder Kanal senden können.
Drücken Sie die EINGABETASTE. Die Nachrichtenerweiterungs-App sendet die adaptive Karte mit dem Element im Chat oder Kanal.
Öffnen der Nachrichtenerweiterungs-App
Sie haben die Suchfunktion der Nachrichtenerweiterungs-App im vorherigen Schritt getestet. Lernen Sie nun die verschiedenen Möglichkeiten zum Öffnen der Nachrichtenerweiterungs-App kennen.
App über Befehlsfeld öffnen
Geben Sie gefolgt vom Namen Ihrer Nachrichtenerweiterungs-App in das Befehlsfeld ein / .
Die App wird im Befehlsfeld geöffnet und Sie können sie zum Ausführen einer Abfrage verwenden.
Hinweis
- Die Verwendung / zum Öffnen Ihrer Nachrichtenerweiterungs-App über das Befehlsfeld funktioniert nur im neuen Teams-Client.
- Wird verwendet @ , um Ihre Nachrichtenerweiterungs-App über das Befehlsfeld im klassischen Teams-Client zu öffnen.
Öffnen Sie Ihre App über den Bereich zum Verfassen von Nachrichten.
Wählen Sie die drei Punkte unten im Bereich zum Verfassen von Nachrichten aus.
Wählen Sie Ihre Nachrichtenerweiterungs-App aus.
Die Nachrichtenerweiterungs-App wird mit den Optionen zum Ausführen einer Suche geladen.
Öffnen Sie Ihre App aus hochgeladenen benutzerdefinierten Apps
Wählen Sie Apps>aus, verwalten Sie Ihre Apps.
Wählen Sie das Dropdown-Menü für Ihre App aus der Liste der Apps und dann Persönliche App aus.
Ein Dialogfeld wird angezeigt, in dem Sie Ihre App ausprobieren sollten. Wenn Sie "Verstanden" auswählen, wird das Dialogfeld ausgeblendet. Wählen Sie "Ausprobieren" aus.
Eine Liste Ihrer Nachrichtenerweiterungs-Apps wird in Ihrem letzten Teams-Chat angezeigt. Wählen Sie in der Liste Ihre Nachrichtenerweiterungs-App aus.
Erfahren Sie, wie Sie Probleme beheben können, wenn Ihre App nicht lokal ausgeführt wird
Um Ihre App in Teams ausführen zu können, müssen Sie über ein Microsoft 365-Entwicklungskonto verfügen, das das Hochladen benutzerdefinierter Apps zulässt. Weitere Informationen zum Hochladen benutzerdefinierter Apps finden Sie im Abschnitt Voraussetzungen.
Bereitstellen Ihrer ersten Teams-App
Lassen Sie uns Ihre erste Nachrichtenerweiterungs-App in Azure mit dem Agents Toolkit bereitstellen.
Anmelden bei Ihrem Azure-Konto
Melden Sie sich bei Ihrem Azure Konto an, um auf die Microsoft Azure-Portal zuzugreifen und neue Cloud-Ressourcen zur Unterstützung Ihrer App bereitzustellen.
Öffne Visual Studio Code.
Öffnen Sie den Projektordner, in dem Sie die Nachrichtenerweiterungs-App erstellt haben.
Wählen Sie das Symbol Microsoft 365 Agents Toolkit
in der Aktivitätsleiste aus.Wählen Sie Bei Azure anmelden mit Ihren Anmeldeinformationen aus. Ihr Standardwebbrowser wird geöffnet, damit Sie sich anmelden können.
Tipp
Wenn Sie die AZURE ACCOUNT-Erweiterung installiert haben und dasselbe Konto verwenden, können Sie diesen Schritt überspringen.
Schließen Sie den Browser, wenn Sie dazu aufgefordert werden, und kehren Sie zu Visual Studio Code zurück.
Im Abschnitt KONTEN der Randleiste wird die Anzahl der nutzbaren Azure-Abonnements aufgeführt, die Ihnen zur Verfügung stehen. Stellen Sie sicher, dass mindestens ein nutzbares Azure-Abonnement verfügbar ist. Wenn nicht, melden Sie sich ab und verwenden Sie ein anderes Konto.
Bereitstellen Ihrer App in Azure
Die Bereitstellung besteht aus zwei Schritten. Zunächst werden die erforderlichen Cloud-Ressourcen erstellt (auch als Bereitstellung bezeichnet). Anschließend wird der Code Ihrer App in die erstellten Cloudressourcen kopiert. In diesem Lernprogramm wird die Nachrichtenerweiterungs-App bereitgestellt.
Was ist der Unterschied zwischen Bereitstellen und Bereitstellen?
Der Bereitstellungsschritt erstellt Ressourcen in Azure und Microsoft 365 für Ihre App, aber es wird kein Code (z. B. HTML, CSS oder JavaScript) in die Ressourcen kopiert. Im Bereitstellungsschritt wird der Code für Ihre App in die Ressourcen kopiert, die Sie während des Bereitstellungsschritts erstellt haben. Es kommt häufig vor, dass mehrere Stellen bereitgestellt werden, ohne dass neue Ressourcen bereitgestellt werden. Da der Bereitstellungsschritt einige Zeit in Anspruch nimmt, ist er vom Bereitstellungsschritt getrennt.
Wählen Sie das Symbol Microsoft 365 Agents Toolkit
in der Aktivitätsleiste von Visual Studio Code aus.
Wählen Sie "Bereitstellen" aus.
Wählen Sie ein Abonnement aus.
Wählen Sie eine Ressourcengruppe aus.
Wenn Sie keine Ressourcengruppe auswählen können, können Sie mit den folgenden Schritten eine neue Ressourcengruppe erstellen:
Wählen Sie "+ Neue Ressourcengruppe" aus.
Wählen Sie den Standardnamen aus, oder geben Sie einen geeigneten Namen für Ihre Ressourcengruppe ein.
Wählen Sie den Standort für Ihre Ressourcengruppe aus.
Ein Dialogfeld warnt Sie, dass beim Ausführen von Ressourcen in Azure Kosten anfallen können. Wählen Sie "Bereitstellen" aus.
Beim Bereitstellungsprozess werden Ressourcen in der Azure-Cloud erstellt. Dies kann einige Zeit dauern. Nach ein paar Minuten wird die folgende Meldung angezeigt:
Sie können sich die bereitgestellten Ressourcen anzeigen lassen. Für dieses Tutorial müssen Sie keine Ressourcen anzeigen.
Die bereitgestellte Ressource wird unter ENVIRONMENT angezeigt.
Wählen Sie unter LEBENSZYKLUS die Option Bereitstellen aus.
Ein Dialogfeld wird angezeigt, in dem Sie gefragt werden, ob Sie Ressourcen in der Entwicklungsumgebung bereitstellen möchten. Wählen Sie Bereitstellen aus.
Wie bei der Bereitstellung nimmt die Bereitstellung einige Zeit in Anspruch. Nach ein paar Minuten wird eine Abschlussmeldung angezeigt.
Ausführen der bereitgestellten App
Wechseln Sie nach Abschluss der Bereitstellungs- und Bereitstellungsschritte zu Ausführen und Debuggen (STRG+UMSCHALT+D oder Ausführen anzeigen>) im Agents-Toolkit.
Wählen Sie das Dropdownmenü AUSFÜHREN UND DEBUGGEN aus.
Wählen Sie "Remote starten" in Teams (Edge) aus.
Wählen Sie die Schaltfläche ▷ .
Ein Dialogfeld wird geöffnet, um Ihre bereitgestellte App in Teams zu installieren. Wählen Sie Hinzufügen aus.
Teams öffnet die Nachrichtenerweiterungs-App im letzten Chat.
Erfahren Sie, was geschieht, wenn Sie Ihre App in Azure bereitstellen.
Vor der Bereitstellung wird die App lokal ausgeführt.
- Das Back-End wird mithilfe der Azure Functions Core Tools ausgeführt.
- Der HTTP-Endpunkt der Anwendung, auf den Microsoft Teams die Anwendung lädt, wird lokal ausgeführt.
Die Bereitstellung erfolgt in zwei Schritten. Sie stellen die Ressourcen in einem aktiven Azure-Abonnement bereit und laden dann den Back-End- und Front-End-Code der App in Azure hoch.
- Wenn das Back-End konfiguriert ist, verwendet es verschiedene Azure-Dienste, einschließlich Azure App Service und Azure Storage.
- Die Front-End-App wird in einem Azure Storage-Konto bereitgestellt, das für statisches Webhosting konfiguriert ist.
Herzlichen Glückwunsch
Sie haben das Tutorial zum Erstellen einer Nachrichtenerweiterungs-App mit JavaScript abgeschlossen!
Hast du dir so etwas ausgedacht?
Erstellen Ihrer ersten Registerkarten-App mit C-sharp
Beginnen Sie mit der Entwicklung von Microsoft Teams-Apps, indem Sie Ihre erste Teams-App mit Registerkartenfunktion erstellen.
In diesem Tutorial lernst du Folgendes:
- Einrichten eines neuen Projekts.
- Erstellen von Apps mit Registerkartenfunktion mit C# und Microsoft Visual Studio 2022.
Tutorial: Erstellen Ihrer ersten Registerkarten-App mit C#
Diese schrittweise Anleitung hilft Ihnen beim Erstellen einer Registerkarte mit dem Microsoft 365 Agents Toolkit (früher als Teams Toolkit bezeichnet). Nach Abschluss dieses Leitfadens wird die folgende Ausgabe angezeigt:
Voraussetzungen für die Erstellung Ihrer App
Hier ist eine Liste der Tools, die Sie zum Erstellen und Bereitstellen einer Teams-App installieren müssen.
| Installieren | Zur Verwendung... |
|---|---|
| Microsoft Teams | Microsoft Teams für die Zusammenarbeit mit allen Personen, mit denen Sie zusammenarbeiten, über Apps für Chats, Besprechungen und Anrufe – alles an einem Ort. |
|
Visual Studio 2022 |
Sie können die Enterprise-Version in Visual Studio 2022 installieren und die Workloads ASP.NET und Webentwicklung installieren. Verwenden Sie die neueste Version. |
| Microsoft 365 Agents Toolkit | Eine Visual Studio-Erweiterung, die ein Projektgerüst für Ihre App erstellt. Verwenden Sie die neueste Version. |
Agents Toolkit installieren
Das Agents Toolkit hilft Ihnen, den Entwicklungsprozess mit Tools zum Erstellen eines Projektgerüsts für Ihre App zu vereinfachen. Es erstellt die erforderliche Verzeichnisstruktur für alle ausgewählten Funktionen mit den erforderlichen Dateien, die zum Erstellen des Projekts bereit sind.
Sie können das neueste Visual Studio-Installationsprogramm herunterladen. Agents Toolkit ist als Erweiterung in Visual Studio verfügbar.
Nachdem Sie das Visual Studio-Installationsprogramm im Popupfenster "Arbeitsauslastungen" geöffnet haben:
Wählen Sie ASP.NET und Webentwicklung aus.
Wählen Sie unter "Installationsdetails>", "Optional", " Microsoft Teams-Entwicklungstools" aus.
Wählen Sie Installieren aus.
Wählen Sie "Starten" aus. Das App-Fenster Visual Studio 2022 wird angezeigt.
Wechseln Sie zu Erweiterungen>Erweiterungen verwalten.
Das Fenster "Erweiterung verwalten" wird angezeigt:
Wählen Sie im linken Bereich "Installiert" aus. Die Erweiterung "Microsoft 365 Agents Toolkit " ist verfügbar.
Einrichten Ihres Teams-Entwicklungsmandanten
Ein Mandant ist wie ein Raum oder Container für Ihre organization in Teams, in dem Sie chatten, Dateien freigeben und Besprechungen abhalten. In diesen Bereich können Sie auch Ihre benutzerdefinierte App hochladen und testen. Lassen Sie uns überprüfen, ob Sie bereit sind, mit dem Mandanten zu entwickeln.
Option zum Hochladen benutzerdefinierter Apps überprüfen
Nachdem Sie die App erstellt haben, müssen Sie Ihre App in Teams laden, ohne sie zu verteilen. Dieser Vorgang wird als benutzerdefinierter App-Upload bezeichnet. Melden Sie sich bei Ihrem Microsoft 365-Konto an, um diese Option anzuzeigen.
Hinweis
Der benutzerdefinierte App-Upload ist erforderlich, um Apps in der lokalen Teams-Umgebung anzuzeigen und zu testen. Wenn sie nicht aktiviert ist, können Sie Ihre App nicht in der lokalen Teams-Umgebung in der Vorschau anzeigen und testen.
Haben Sie bereits einen Mandanten und Administratorzugriff? Lassen Sie uns überprüfen, ob Sie das tun!
Überprüfen Sie, ob Sie benutzerdefinierte Apps in Teams hochladen können:
Öffnen Sie Microsoft Teams, und wählen Sie das Symbol "Apps " aus.
Wählen Sie Apps verwalten aus.
Wählen Sie App hochladen aus.
Suchen Sie nach der Option "Benutzerdefinierte App hochladen ". Wenn die Option angezeigt wird, ist der benutzerdefinierte App-Upload aktiviert.
Hinweis
Wenn Sie die Option zum Hochladen einer benutzerdefinierten App nicht finden, wenden Sie sich an Ihren Teams-Administrator.
Erstellen eines kostenlosen Teams-Entwicklermandanten (optional)
Wenn Sie kein Teams-Konto haben, können Sie es kostenlos erhalten. Treten Sie dem Microsoft 365-Entwicklerprogramm bei!
Wechseln Sie zum Microsoft 365-Entwicklerprogramm.
Wählen Sie "Jetzt teilnehmen" aus, und folgen Sie den Anweisungen auf dem Bildschirm.
Wählen Sie auf dem Willkommensbildschirm "E5-Abonnement einrichten" aus.
Richten Sie Ihr Administratorkonto ein. Nach Abschluss des Vorgangs wird der folgende Bildschirm angezeigt:
Melden Sie sich mit dem von Ihnen eingerichteten Administratorkonto bei Teams an. Stellen Sie sicher, dass die Option "Benutzerdefinierte App hochladen " in Teams vorhanden ist.
Kostenloses Azure-Konto erhalten
Wenn Sie Ihre App hosten oder auf Ressourcen in Azure zugreifen möchten, benötigen Sie ein Azure-Abonnement. Erstellen Sie ein kostenloses Konto, bevor Sie beginnen.
Jetzt verfügen Sie über alle Tools, um Ihr Konto einzurichten. Als Nächstes richten wir deine Entwicklungsumgebung ein und beginnen mit dem Erstellen! Wählen Sie zuerst die App aus, die Sie erstellen möchten.
Erstellen Sie einen Projektarbeitsbereich für Ihre Registerkarten-App mit C sharp
Beginnen Sie mit der Entwicklung von Microsoft Teams-Apps, indem Sie Ihre erste App erstellen. Diese App verwendet die Registerkartenfunktion. Wenn die Voraussetzungen gegeben sind, kann es losgehen!
Die folgenden Schritte helfen Ihnen beim Erstellen eines Projektarbeitsbereichs für Ihre Registerkarten-App in Visual Studio:
Öffnen Sie Visual Studio.
Wählen Sie Neues Projekt aus.
Geben Sie " Teams" in das Suchfeld ein.
Wählen Sieals nächstesMicrosoft 365-Agents> aus.
Geben Sie die folgenden Details ein, um Ihr neues Projekt zu konfigurieren.
Geben Sie den erforderlichen Projektnamen in Projektname ein.
Wählen Sie den erforderlichen Speicherort für Projektdateien und -ordner aus.
Wählen Sie Erstellen aus.
Wählen Sie Registerkarte>Erstellen aus.
Die Teams-Registerkarten-App ist in wenigen Sekunden erstellt.
Erstellen und Ausführen Ihrer ersten Registerkarten-App mit C sharp
Nachdem Sie Ihren Projektarbeitsbereich mit Agents Toolkit eingerichtet haben, erstellen Sie Ihre Registerkarten-App.
Anmelden bei Ihrem Microsoft 365-Konto
Melden Sie sich mit Ihrem Microsoft 365-Konto bei Teams an. Wenn Sie einen Microsoft 365-Entwicklerprogrammmandanten verwenden, ist das Administratorkonto, das Sie bei der Registrierung einrichten, Ihr Microsoft 365-Konto.
Klicken Sie im Projektmappen-Explorer unter Projektmappe MyTeamsApp mit der rechten Maustaste auf MyTeamsApp.
Wählen Sie das Microsoft 365 Agents Toolkit>aus. Wählen Sie Microsoft 365-Konto aus.
Wählen Sie Microsoft 365-Konto>"Weiter" aus.
Lokales Erstellen und Ausführen Ihrer App in Visual Studio
So erstellen und führen Sie Ihre App lokal aus:
Wählen Sie Debuggen>starten oder F5 aus.
Visual Studio startet den Debugprozess und öffnet den Teams-Webclient in einem Browser. Melden Sie sich mit Ihrem Microsoft 365-Konto an, wenn Sie dazu aufgefordert werden.
Wählen Sie Hinzufügen aus.
Wählen Sie "Öffnen " aus, um die App im persönlichen Bereich zu öffnen.
Alternativ können Sie entweder den gewünschten Bereich durchsuchen und auswählen oder einen Kanal oder Chat aus der Liste auswählen und durch das Dialogfeld navigieren, um Los auszuwählen.
Herzlichen Glückwunsch, Ihre erste Registerkarten-App wird in Teams ausgeführt!
Erfahren Sie, wie Sie Probleme beheben können, wenn Ihre App nicht lokal ausgeführt wird.
Um Ihre App erfolgreich in Teams auszuführen, stellen Sie sicher, dass Sie den benutzerdefinierten App-Upload in Ihrem Teams-Konto aktiviert haben. Weitere Informationen zum Hochladen benutzerdefinierter Apps finden Sie im Abschnitt "Voraussetzungen ".
Sie haben erfolgreich eine Registerkarten-App mit C# erstellt. Agents Toolkit hat der Verzeichnisstruktur Ihrer App das erforderliche Gerüst hinzugefügt. Das Tutorial ist jetzt abgeschlossen.
Hinzufügen von SSO zur Registerkarten- und Nachrichtenerweiterungs-App
Microsoft Microsoft Entra Single Sign-On (SSO) ermöglicht die nahtlose Benutzerauthentifizierung in Teams.
Wichtige Aspekte von Microsoft Entra SSO:
- Ermöglicht dem Benutzer die automatische Anmeldung nach der ersten Anmeldung.
- Ermöglicht dem Benutzer, sich bei anderen Geräten anzumelden, ohne Anmeldeinformationen erneut eingeben zu müssen.
- Ruft das Token für den angemeldeten Benutzer ab.
Tutorial: Hinzufügen von SSO zur Registerkarten- und Nachrichtenerweiterungs-App
Diese schrittweise Anleitung unterstützt Sie beim Erstellen von Registerkarten und Nachrichtenerweiterungen, die die Authentifizierung mit Microsoft Entra SSO aktivieren. Die folgende Ausgabe wird angezeigt:
Voraussetzungen für das Hinzufügen von SSO zu Apps
Stellen Sie sicher, dass Sie die folgenden Tools installieren und Ihre Entwicklungsumgebung einrichten:
| # | Installieren | Zur Verwendung... |
|---|---|---|
| 1. | Microsoft Teams | Microsoft Teams für die Zusammenarbeit mit allen Personen, mit denen Sie zusammenarbeiten, über Apps für Chats, Besprechungen und Anrufe an einem Ort. |
| 2. | Microsoft 365-Entwicklerkonto | Zugriff auf ein Teams-Konto mit den entsprechenden Berechtigungen zum Installieren einer App. |
| 3. | .NET Core SDK | Angepasste Bindungen für lokales Debuggen und Bereitstellungen von Azure Functions-Apps. Wenn Sie nicht die neueste Version installiert haben, installieren Sie die portable Version. |
| 4. | Visual Studio 2022 | Sie können die Enterprise-Version in Visual Studio 2022 installieren und die Workloads ASP.NET und Webentwicklung installieren. Verwenden Sie die neueste Version. |
| 5. | Dev-Tunnel | Microsoft Teams-App-Features (Unterhaltungsbots, Nachrichtenerweiterungen und eingehende Webhooks) benötigen eingehende Verbindungen. Ein Tunnel verbindet Ihr Entwicklungssystem mit Teams. Dev Tunnel ist ein leistungsstarkes Tool, um Ihren lokalen Host sicher für das Internet zu öffnen und zu steuern, wer Zugriff hat. Der Dev-Tunnel ist in Visual Studio 2022, Version 17.7.0 oder höher, verfügbar. oder Sie können ngrok auch als Tunnel verwenden, um Ihr Entwicklungssystem mit Microsoft Teams zu verbinden. Für Apps, die nur Registerkarten enthalten, ist dies nicht erforderlich. Dieses Paket wird im Projektverzeichnis installiert (mit npm devDependencies). |
Hinweis
Melden Sie sich nach dem Herunterladen von ngrok an und installieren Sie authtoken.
Einrichten der lokalen Umgebung
Wählen Sie "Code" aus.
Wähle im Dropdownmenü "Mit GitHub Desktop öffnen" aus.
Wählen Sie "Klonen" aus.
Registrieren der Microsoft Entra-App
Die folgenden Schritte helfen Ihnen beim Erstellen und Registrieren Ihres Bots in Azure-Portal:
- Erstellen und registrieren Sie Ihre Azure-App.
- Erstellen Sie einen geheimen Clientschlüssel, um die SSO-Authentifizierung des Bots zu ermöglichen.
- Fügen Sie den Teams-Kanal hinzu, um den Bot bereitzustellen.
- Erstellen Sie einen Tunnel zu den Endpunkten Ihres Webservers mithilfe von dev tunnel (empfohlen) oder ngrok.
- Fügen Sie dem von Ihnen erstellten Dev-Tunnel einen Messagingendpunkt hinzu.
Hinzufügen einer App-Registrierung
Wechseln Sie zum Azure-Portal.
Wählen Sie "App-Registrierungen" aus.
Wählen Sie "+ Neue Registrierung" aus.
Geben Sie den Namen Ihrer App ein.
Wählen Sie Konten in einem beliebigen Organisationsverzeichnis (beliebiger Microsoft Entra ID-Mandant – mehrinstanzfähig) aus.
Wählen Sie Registrieren aus.
Ihre App ist in Microsoft Entra ID registriert. Die App-Übersichtsseite wird angezeigt.
Hinweis
Speichern Sie die App-ID aus Anwendungs-ID (Client) undVerzeichnis-ID (Mandant) zur weiteren Verwendung.
Erstellen eines Tunnels
Wählen Sie eine der folgenden Möglichkeiten aus, um einen Tunnel zu erstellen:
Öffnen Sie Visual Studio.
Wähle "Neues Projekt erstellen" aus.
Geben Sie im Suchfeld ASP.NET ein. Wählen Sie in den Suchergebnissen "ASP.NET Core Web App" aus.
Wählen Sie Weiter aus.
Geben Sie den Projektnamen ein, und wählen Sie Weiter aus.
Wählen Sie Erstellen aus.
Ein Übersichtsfenster erscheint.
Wählen Sie in der Dropdownliste debuggen die Option Dev Tunnels (kein aktiver Tunnel)>Tunnel erstellen....
Ein Pop-up-Fenster wird angezeigt.
Aktualisieren Sie im Popupfenster die folgenden Details:
- Konto: Geben Sie ein Microsoft- oder GitHub-Konto ein.
- Name: Geben Sie einen Namen für Ihren Tunnel ein.
- Tunneltyp: Wählen Sie in der Dropdownliste die Option Temporär aus.
- Zugriff: Wählen Sie in der Dropdownliste Öffentlich aus.
Wählen Sie OK aus.
Ein Popupfenster wird angezeigt, das zeigt, dass der Dev-Tunnel erfolgreich erstellt wurde.
Wählen Sie OK aus.
Du findest den erstellten Tunnel in der Debug-Dropdownliste wie folgt:
Drücken Sie F5 , um die Anwendung im Debugmodus auszuführen.
Wenn ein Dialogfeld mit einer Sicherheitswarnung angezeigt wird, wählen Sie Ja aus.
Ein Pop-up-Fenster wird angezeigt.
Wählen Sie Weiter aus.
Die Dev Tunnel-Startseite wird in einem neuen Browserfenster geöffnet, und der Dev Tunnel ist jetzt aktiv.
Wechseln Sie zu Visual Studio und wählen Sie dann Ausgabe anzeigen >aus.
Wählen Sie im Dropdownmenü der Ausgabekonsole die Option Dev Tunnels aus.
Die Ausgabekonsole zeigt die Dev-Tunnel-URL an.
Hinzufügen einer Webauthentifizierung
Wählen Sie im linken Bereich unter Verwaltendie Option Authentifizierung aus.
Wählen Sie Plattform>hinzufügen Web aus.
Geben Sie den Umleitungs-URI für Ihre App ein, indem Sie ihn an den vollqualifizierten Domänennamen anfügen
auth-end. Beispielsweisehttps://your-devtunnel-domain/auth-endoderhttps://your-ngrok-domain/auth-end.Aktivieren Sie unter Implizite Gewährung und Hybridflüsse die Kontrollkästchen Zugriffstoken und ID-Token .
Wählen Sie "Konfigurieren" aus.
Wählen Sie unter Web die Option "URI hinzufügen" aus.
Geben Sie
https://token.botframework.com/.auth/web/redirectein.Wählen Sie Speichern aus.
Einen geheimen Clientschlüssel erstellen
Hinweis
Wenn der Fehler " Geheime Clientschlüssel werden durch mandantenweite Richtlinie blockiert" auftritt. Wenden Sie sich an Ihren Mandantenadministrator, um weitere Informationen zu erhalten. können Sie stattdessen ein Zertifikat erstellen. Eine schrittweise Anleitung finden Sie unter Erstellen eines Zertifikats für die App-Registrierung.
Wählen Sie im linken Bereich unter Verwalten die Option Zertifikate & Geheimnisse aus.
Wählen Sie unter Geheime Clientschlüsseldie Option + Neues geheime Clientschlüssel aus.
Das Fenster Einen geheimen Clientschlüssel hinzufügen wird angezeigt.
Beschreibung eingeben.
Wählen Sie Hinzufügen aus.
Wählen Sie unter "Wert" die Option "In Zwischenablage kopieren " aus, um den Wert des geheimen Clientschlüssels zur weiteren Verwendung zu speichern.
API-Berechtigungen hinzufügen
Wählen Sie im linken Bereich API-Berechtigungen aus.
Wählen Sie "+ Berechtigung hinzufügen" aus.
Wählen Sie Microsoft Graph aus.
Wählen Sie Delegierte Berechtigungen aus.
Wählen Sie User>User.Read aus.
Wählen Sie Berechtigungen hinzufügen aus.
Hinweis
- Wenn einer App keine Zustimmung des IT-Administrators erteilt wird, müssen Benutzer bei der ersten Verwendung einer App ihre Zustimmung erteilen.
- Benutzer müssen den API-Berechtigungen nur zustimmen, wenn die Microsoft Entra-App in einem anderen Mandanten registriert ist.
Anwendungs-ID-URI hinzufügen
Wählen Sie im linken Bereich unter Verwaltendie Option API verfügbar machen.
Wählen Sie neben Anwendungs-ID-URIdie Option Hinzufügen aus.
Aktualisieren Sie den Anwendungs-ID-URI im
api://your-devtunnel-domain/botid-{AppID}Format oderapi://your-ngrok-domain/botid-{AppID}und wählen Sie Speichern aus.
Die folgende Abbildung zeigt den Domänennamen:
Hinzufügen eines Bereichs
Wählen Sie im linken Bereich unter Verwaltendie Option API verfügbar machen.
Wählen Sie "+ Bereich hinzufügen" aus.
Geben Sie access_as_user als Bereichsnamen ein.
Wählen Sie unter Wer kann zustimmen?die Option Administratoren und Benutzer aus.
Aktualisieren Sie die Werte für die übrigen Felder wie folgt:
Geben Sie Teams kann als Anzeigename der Admin-Zustimmungauf das Profil des Benutzers zugreifen.
EINGABE Ermöglicht Teams das Aufrufen der Web-APIs der App als aktueller Benutzer als Beschreibung der Admin-Einwilligung.
Geben Sie Teams kann als Anzeigename der Benutzereinwilligungauf das Benutzerprofil zugreifen und Anforderungen im Namen des Benutzers stellen.
Geben Aktivieren Sie Teams, um die APIs dieser App mit denselben Rechten wie der Benutzer aufzurufenBeschreibung der Benutzerzustimmung.
Stellen Sie sicher, dass State auf Aktiviert festgelegt ist.
Wählen Sie Bereich hinzufügen aus.
Die folgende Abbildung zeigt die Felder und die Werte:
Hinweis
Der Bereichsname muss mit dem Anwendungs-ID-URI übereinstimmen, der
/access_as_useram Ende angefügt ist.
Clientanwendung hinzufügen
Wählen Sie im linken Bereich unter Verwaltendie Option API verfügbar machen.
Identifizieren Sie unter Autorisierte Clientanwendungen die Anwendungen, die Sie für die Webanwendung Ihrer App autorisieren möchten.
Wählen Sie "+ Clientanwendung hinzufügen" aus.
Hinzufügen von Teams Mobile oder Desktop und der Teams-Webanwendung.
Für Teams Mobile oder Desktop: Geben Sie die Client-ID als
1fec8e78-bce4-4aaf-ab1b-5451cc387264ein.
Für Teams Web: Geben Sie die Client-ID als
5e3ce6c0-2b1f-4285-8d4b-75ee78787346ein.
Aktivieren Sie das Kontrollkästchen Autorisierte Bereiche .
Wählen Sie Anwendung hinzufügen aus.
In der folgenden Abbildung wird die Client-ID angezeigt:
Aktualisieren des Manifests
Wählen Sie im linken Bereich Manifest aus.
Legen Sie den Wert für "
requestedAccessTokenVersionAn" fest,2und wählen Sie "Speichern" aus.
Erstellen eines Bots
Erstellen einer Azure Bot-Ressource
Hinweis
Wenn Sie Ihren Bot bereits in Teams testen, melden Sie sich von dieser App und Teams ab. Melden Sie sich erneut an, um diese Änderung zu sehen.
Zur Startseite.
Wählen Sie + Ressource erstellen aus.
Geben Sie im Suchfeld Azure Bot ein.
Drücken Sie die EINGABETASTE.
Wählen Sie Azure Bot aus.
Wählen Sie Erstellen aus.
Geben Sie den Botnamen in Bothandle ein.
Wählen Sie Ihr Abonnement aus der Dropdownliste aus.
Wählen Sie in der Dropdownliste Ihre Ressourcengruppe aus.
Wenn Sie über keine vorhandene Ressourcengruppe verfügen, können Sie eine neue Ressourcengruppe erstellen. Gehen Sie folgendermaßen vor, um eine neue Ressourcengruppe zu erstellen:
- Wählen Sie Neu erstellen aus.
- Geben Sie den Ressourcennamen ein, und wählen Sie OK aus.
- Wählen Sie einen Standort aus der Dropdownliste "Neuer Standort der Ressourcengruppe " aus.
Wählen Sie unter "Preise" die Option "Plan ändern" aus.
Wählen Sie FO Free>Select.
Wählen Sie unter Microsoft-App-IDden App-Typ "Multi-Tenant" aus.
Wählen Sie unter Erstellungstypdie Option Vorhandene App-Registrierung verwenden aus.
Geben Sie die App-ID ein.
Hinweis
Sie können nicht mehr als einen Bot mit derselben Microsoft-App-ID erstellen.
Wählen Sie Überprüfen + erstellen.
Nachdem die Überprüfung erfolgreich war, wählen Sie Erstellen aus.
Die Bereitstellung des Bots dauert ein paar Minuten.
Wählen Sie "Zu Ressource wechseln aus".
Sie haben erfolgreich Ihren Azure-Bot erstellt.
Hinzufügen eines Teams-Kanals
Wählen Sie im linken Bereich Kanäle aus.
Wählen Sie unter "Verfügbare Kanäle"die Option "Microsoft Teams" aus.
Aktivieren Sie das Kontrollkästchen, um die Nutzungsbedingungen zu akzeptieren.
Wählen Sie Zustimmen aus.
Wählen Sie Anwenden aus.
So fügen Sie einen Messaging-Endpunkt hinzu
Verwenden Sie die Dev-Tunnel-URL in der Ausgabekonsole als Messagingendpunkt.
Wählen Sie im linken Bereich unter Einstellungen die Option Konfiguration.
Aktualisieren Sie den Messagingendpunkt im Format
https://your-devtunnel-domain/api/messages.
Wählen Sie Anwenden aus.
Sie haben erfolgreich einen Bot in Azure Bot Service eingerichtet.
Hinweis
Wenn der Application Insights-Instrumentierungsschlüssel einen Fehler anzeigt, aktualisieren Sie mit der App-ID.
OAuth-Verbindungseinstellungen hinzufügen
Wählen Sie im linken Bereich Konfiguration aus.
Wählen Sie OAuth-Verbindungseinstellungen hinzufügen aus.
Aktualisieren Sie unter Neue Verbindungseinstellung die folgenden Details:
- Name: Geben Sie einen Namen für Ihre neue Verbindungseinstellung ein. Sie können den Namen in den Einstellungen Ihres Bot-Dienstcodes verwenden.
- Dienstanbieter: Wählen Sie in der Dropdownliste Azure Active Directory v2 aus.
- Client-ID: Aktualisieren Sie Ihre Microsoft-App-ID.
- Geheimer Clientschlüssel: Aktualisieren Sie den Wert des geheimen Clientschlüssels.
- Tokenaustausch-URL: Aktualisieren Sie den Anwendungs-ID-URI.
- Mandanten-ID: Geben Sie Common ein.
- Bereiche: Geben Sie User.Read ein.
Wählen Sie Speichern aus.
Einrichten von App-Einstellungen
Wechseln Sie zur appsettings.json Datei im geklonten Repository.
Öffnen Sie die appsettings.json Datei in Visual Studio.
Aktualisieren Sie die folgenden Informationen:
- Ersetzen Sie
"MicrosoftAppId"sie durch die Microsoft-App-ID Ihres Bots. - Ersetzen
"MicrosoftAppPassword"durch die Clientschlüssel Ihres Bots Wert. - Ersetzen Sie
"SiteUrl"sie durch Ihre ngrok-URL. - Ersetzen Sie
"ConnectionName"ihn durch den Namen der OAuth-Verbindungseinstellung. - Ersetzen Sie
"TenantId"diese durch die Mandanten-ID des Mandanten, in dem die App verwendet wird. - Ersetzen Sie
"ClientId"sie durch die Microsoft-App-ID Ihres Bots. - Ersetzen
"AppSecret"durch die Clientschlüssel Ihres Bots Wert. - Ersetzen Sie die Form
"ApplicationIdURI"vonapi://*******.ngrok.io/botid-{AppID}.
- Ersetzen Sie
Manifestdatei einrichten
Wechseln Sie zur manifest.json Datei im geklonten Repository.
Öffnen Sie die manifest.json Datei in Visual Studio, und nehmen Sie die folgenden Änderungen vor:
Ersetzen Sie
DOMAIN-NAMEdurch Ihre ngrok-URL.Ersetzen Sie
YOUR-MICROSOFT-APP-IDdies durch die Microsoft-App-ID Ihres Bots.Hinweis
Je nach Szenario
[YOUR-MICROSOFT-APP-ID]und[DOMAIN-NAME]kann mehrmals auftreten.Ersetzen
resourcealsapi://*******.ngrok.io/botid-{AppID}.
Erstellen und Ausführen des Diensts
Verwenden Sie zum Erstellen und Ausführen des Diensts Visual Studio oder die Befehlszeile.
Öffnen Sie Visual Studio.
Wählen Sie Datei>Öffnen> *Projekt/Projektmappe...
Wählen Sie im Ordner "csharp " die Datei App SSO Sample.csproj aus.
Drücken Sie F5 , um das Projekt auszuführen.
Wählen Sie Ja aus, wenn das folgende Dialogfeld angezeigt wird:
Eine Webseite wird mit einer Meldung angezeigt: Ihr Bot ist bereit!