From bb846f7880aa16987e39deeb28758c6a050b9a38 Mon Sep 17 00:00:00 2001 From: Lunasbytecode <190076472+Lunasbytecode@users.noreply.github.com> Date: Thu, 24 Apr 2025 12:46:50 +0530 Subject: [PATCH] [Teams Toolkit renaming6] --- .../toolkit/configure-bot-capability.md | 14 ++--- .../configure-message-extension-capability.md | 14 ++--- .../toolkit/configure-tab-capability.md | 10 ++-- .../toolkit/create-new-project.md | 18 +++---- .../debug-apps-in-Teams-desktop-client.md | 22 ++++---- .../toolkit/debug-background-process.md | 54 +++++++++---------- msteams-platform/toolkit/debug-local.md | 26 ++++----- ...ebug-message-extension-app-in-test-tool.md | 4 +- msteams-platform/toolkit/debug-overview.md | 38 ++++++------- 9 files changed, 100 insertions(+), 100 deletions(-) diff --git a/msteams-platform/toolkit/configure-bot-capability.md b/msteams-platform/toolkit/configure-bot-capability.md index 73450dc3dc1..f581a54124d 100644 --- a/msteams-platform/toolkit/configure-bot-capability.md +++ b/msteams-platform/toolkit/configure-bot-capability.md @@ -24,15 +24,15 @@ To configure bot as an additional capability, ensure the following prerequisites The following steps help you to add bot to a tab app: -* [Create bot app using Microsoft Teams Toolkit](#create-bot-app-using-microsoft-teams-toolkit) +* [Create bot app using Microsoft 365 Agents Toolkit](#create-bot-app-using-microsoft-teams-toolkit) * [Configure bot capability in app manifest](#configure-bot-capability-in-app-manifest) * [Add bot code to your project](#add-bot-code-to-your-project) * [Setup local debug environment](#setup-local-debug-environment) * [Provision the app to Azure](#provision-the-app-to-azure) -## Create bot app using Microsoft Teams Toolkit +## Create bot app using Microsoft 365 Agents Toolkit -To create a bot app using Teams Toolkit, see [create a bot app with Teams Toolkit](create-new-project.md). +To create a bot app using Microsoft 365 Agents Toolkit, see [create a bot app with Microsoft 365 Agents Toolkit](create-new-project.md). ## Configure bot capability in app manifest @@ -460,13 +460,13 @@ You can add the bot capability to a message extension app easily as message exte The following steps help you to add the bot capability to a message extension app: -* [Create bot app using Teams Toolkit](#create-bot-app-using-teams-toolkit) +* [Create bot app using Microsoft 365 Agents Toolkit](#create-bot-app-using-teams-toolkit) * [Update manifest file](#update-manifest-file) * [Add bot code to project](#add-bot-code-to-project) -## Create bot app using Teams Toolkit +## Create bot app using Microsoft 365 Agents Toolkit -To create a bot app with Teams Toolkit, see [create a new Teams bot app](create-new-project.md). +To create a bot app with Microsoft 365 Agents Toolkit, see [create a new Teams bot app](create-new-project.md). ## Update manifest file @@ -510,7 +510,7 @@ The following code snippet is an example: ## Add bot code to project -1. Your message extension app contains a class that extends `TeamsActivityHandler`. Copy your configured bot code from the bot app into this class in Visual Studio Code. The following code is an example of a message extension that contains functions from a bot app created in Teams Toolkit: +1. Your message extension app contains a class that extends `TeamsActivityHandler`. Copy your configured bot code from the bot app into this class in Visual Studio Code. The following code is an example of a message extension that contains functions from a bot app created in Microsoft 365 Agents Toolkit: ```javascript public class YourHandler extends TeamsActivityHandler{ diff --git a/msteams-platform/toolkit/configure-message-extension-capability.md b/msteams-platform/toolkit/configure-message-extension-capability.md index d5f067b6308..275900376fb 100644 --- a/msteams-platform/toolkit/configure-message-extension-capability.md +++ b/msteams-platform/toolkit/configure-message-extension-capability.md @@ -28,15 +28,15 @@ To configure the message extension capability in your app, ensure the following To add a message extension to a tab app, follow these steps: -1. [Create message extension app using Microsoft Teams Toolkit](#create-message-extension-app-using-microsoft-teams-toolkit) +1. [Create message extension app using Microsoft 365 Agents Toolkit](#create-message-extension-app-using-microsoft-teams-toolkit) 1. [Configure message extension in app manifest](#configure-message-extension-in-app-manifest) 1. [Add message extension code to your project](#add-message-extension-code-to-your-project) 1. [Setup local debug environment](#setup-local-debug-environment) 1. [Provision your app to Azure](#provision-your-app-to-azure) -### Create message extension app using Microsoft Teams Toolkit +### Create message extension app using Microsoft 365 Agents Toolkit -To create a message extension app with Teams Toolkit, see [create a message extension app with Teams Toolkit](create-new-project.md). +To create a message extension app with Microsoft 365 Agents Toolkit, see [create a message extension app with Microsoft 365 Agents Toolkit](create-new-project.md). ### Configure message extension in app manifest @@ -507,13 +507,13 @@ You can add the message extension capability to a bot app easily as message exte To add a message extension to a bot app, follow these steps: -1. [Create a message extension app using Teams Toolkit](#create-a-message-extension-using-teams-toolkit) +1. [Create a message extension app using Microsoft 365 Agents Toolkit](#create-a-message-extension-using-teams-toolkit) 1. [Configure message extension in app manifest](#configure-message-extension-in-app-manifest) 1. [Add message extension code to project](#add-message-extension-code-to-project) -### Create a message extension using Teams Toolkit +### Create a message extension using Microsoft 365 Agents Toolkit -To create a message extension app, see [create a message extension app with Teams Toolkit](create-new-project.md). +To create a message extension app, see [create a message extension app with Microsoft 365 Agents Toolkit](create-new-project.md). ### Configure message extension in app manifest @@ -607,7 +607,7 @@ The following code snippet is an example: ### Add message extension code to project -1. Your bot app contains a class that extends `TeamsActivityHandler`. Copy your message extension functions from the message extension app into this class in Visual Studio Code. The following code is an example of a bot that contains functions from a message extension app created in Teams Toolkit: +1. Your bot app contains a class that extends `TeamsActivityHandler`. Copy your message extension functions from the message extension app into this class in Visual Studio Code. The following code is an example of a bot that contains functions from a message extension app created in Microsoft 365 Agents Toolkit: ```javascript class YourHandler extends TeamsActivityHandler { diff --git a/msteams-platform/toolkit/configure-tab-capability.md b/msteams-platform/toolkit/configure-tab-capability.md index 776809513a2..b25ecc02b9f 100644 --- a/msteams-platform/toolkit/configure-tab-capability.md +++ b/msteams-platform/toolkit/configure-tab-capability.md @@ -12,7 +12,7 @@ ms.date: 12/17/2024 Tabs are webpages embedded in Microsoft Teams. Tabs function as simple HTML `iframe` tags that point to domains declared in app manifest (previously called Teams app manifest). You can add tab as a capability to a Teams app in a channel within a team, group chat, or personal app for an individual user. You can include custom tabs with your app to embed your own web content in Teams or add Teams-specific functionality to your web content. For more information, see [build tabs for Teams](../tabs/what-are-tabs.md). -Before you start, we recommend that you create and go through a tab app. For more information, see [create tab app with Teams Toolkit](create-new-project.md). +Before you start, we recommend that you create and go through a tab app. For more information, see [create tab app with Microsoft 365 Agents Toolkit](create-new-project.md). ## Prerequisites @@ -31,7 +31,7 @@ The following steps help you to configure the tab capability in a Teams app: 1. [Provision app to Azure](#provision-app-to-azure) > [!TIP] -> If you develop a server-side tab app, you don't need to update the folder structure, debug profile, or bicep infrastructure. Add new routes to the tab in your bot service and update the app manifest in Teams Toolkit. +> If you develop a server-side tab app, you don't need to update the folder structure, debug profile, or bicep infrastructure. Add new routes to the tab in your bot service and update the app manifest in Microsoft 365 Agents Toolkit. For more information, see [sample app](https://github.com/OfficeDev/TeamsFx-Samples/tree/main/hello-world-bot-with-tab). ### Update app manifest @@ -63,11 +63,11 @@ For more information, see [sample app](https://github.com/OfficeDev/TeamsFx-Samp ``` > [!NOTE] - > `TAB_ENDPOINT` and `TAB_DOMAIN` are built-in variables of Teams Toolkit. They're replaced with the true endpoint during runtime based on your current environment. + > `TAB_ENDPOINT` and `TAB_DOMAIN` are built-in variables of Microsoft 365 Agents Toolkit. They're replaced with the true endpoint during runtime based on your current environment. ### Setup local debug environment -1. Bring your tab app code into your project in Visual Studio Code. If you don't have one, you can [create a new tab app with Teams Toolkit](create-new-project.md) and copy the source code into your current project. By default, your tab app's folder structure looks as follows: +1. Bring your tab app code into your project in Visual Studio Code. If you don't have one, you can [create a new tab app with Microsoft 365 Agents Toolkit](create-new-project.md) and copy the source code into your current project. By default, your tab app's folder structure looks as follows: ``` |-- appPackage/ @@ -167,7 +167,7 @@ For more information, see [sample app](https://github.com/OfficeDev/TeamsFx-Samp For more information on how to configure the debug profile, see [sample app](https://github.com/OfficeDev/teams-toolkit-samples/tree/dev/hello-world-bot-with-tab/.vscode). -1. To enable your tab project to work with Teams Toolkit, add the following actions to the `teamsapp.local.yml` file: +1. To enable your tab project to work with Microsoft 365 Agents Toolkit, add the following actions to the `teamsapp.local.yml` file: ```yaml provision: diff --git a/msteams-platform/toolkit/create-new-project.md b/msteams-platform/toolkit/create-new-project.md index 806da79f01c..0e101a7f8b3 100644 --- a/msteams-platform/toolkit/create-new-project.md +++ b/msteams-platform/toolkit/create-new-project.md @@ -1,7 +1,7 @@ --- -title: Create New Teams App in Teams Toolkit +title: Create New Teams App in Microsoft 365 Agents Toolkit author: zyxiaoyuer -description: Learn how to create basic and scenario-based Teams app in Visual Studio Code, its directory structure, and Teams app template available in Teams Toolkit. +description: Learn how to create basic and scenario-based Teams app in Visual Studio Code, its directory structure, and Teams app template available in Microsoft 365 Agents Toolkit. ms.author: surbhigupta ms.localizationpriority: high ms.topic: overview @@ -14,7 +14,7 @@ In this section, you can learn how to create a new Microsoft Teams project using ## Create a new Teams project using Visual Studio Code -You can build a new Teams project by selecting **Create a New App** in Microsoft Teams Toolkit. You can start from built-in Teams app templates or start from official Teams app samples in Teams Toolkit. What's more, Teams Toolkit supports to start with Outlook Add-in templates to build your own Outlook Add-ins. +You can build a new Teams project by selecting **Create a New App** in Microsoft 365 Agents Toolkit. You can start from built-in Teams app templates or start from official Teams app samples in Microsoft 365 Agents Toolkit. What's more, Microsoft 365 Agents Toolkit supports to start with Outlook Add-in templates to build your own Outlook Add-ins. :::image type="content" source="../assets/images/teams-toolkit-v2/first-tab/select-capabilities-tabapp_1.png" alt-text="Screenshot shows the App Capability options."::: @@ -34,9 +34,9 @@ To create a basic Teams app: 1. Open **Visual Studio Code**. -1. Select the **Teams Toolkit** > **Create a New App**. +1. Select the **Microsoft 365 Agents Toolkit** > **Create a New App**. - :::image type="content" source="../assets/images/teams-toolkit-v2/first-tab/create-project.png" alt-text="Screenshot shows the Create New Project button in the Teams Toolkit sidebar."::: + :::image type="content" source="../assets/images/teams-toolkit-v2/first-tab/create-project.png" alt-text="Screenshot shows the Create New Project button in the Microsoft 365 Agents Toolkit sidebar."::: 1. In this example, select **Tab** as app capability. @@ -81,7 +81,7 @@ To create a basic Teams app: ### Directory structure for different app types -Teams Toolkit provides all components for building an app. After creating the project, you can view the project folders and files under **EXPLORER** section. +Microsoft 365 Agents Toolkit provides all components for building an app. After creating the project, you can view the project folders and files under **EXPLORER** section.
@@ -99,7 +99,7 @@ The following example shows a basic Teams tab app directory structure: | `src/app.js` | Application entry point and `express` handlers for website. | | `src/views/hello.html`| An HTML template that is bind to the tab endpoint. | | `src/static` | The web server can serve static assets such as CSS and JavaScript files. | -| `teamsapp.yml` | This configuration file defines the Teams Toolkit behavior for provision, deploy, and publish lifecycle. You can customize this file to change the behavior of Teams Toolkit in each lifecycle. | +| `teamsapp.yml` | This configuration file defines the Microsoft 365 Agents Toolkit behavior for provision, deploy, and publish lifecycle. You can customize this file to change the behavior of Microsoft 365 Agents Toolkit in each lifecycle. | | `teamsapp.local.yml` | This overrides teamsapp.yml with actions that enable local execution and debugging. | > [!NOTE] @@ -128,7 +128,7 @@ The new project folder contains the following content: | `appPackage` | The app manifest file and icon files that Teams used to recognize your Teams app. | | `env` | Stores different environment parameters. | | `infra` | Azure `bicep` template files. Used for deploy your Teams app to Azure. | -| `teamsapp.yml` | This configuration file defines the Teams Toolkit behavior for provision, deploy, and publish lifecycle. You can customize this file to change the behavior of Teams Toolkit in each lifecycle. | +| `teamsapp.yml` | This configuration file defines the Microsoft 365 Agents Toolkit behavior for provision, deploy, and publish lifecycle. You can customize this file to change the behavior of Microsoft 365 Agents Toolkit in each lifecycle. | | `teamsapp.local.yml` | This overrides teamsapp.yml with actions that enable local execution and debugging. | The core notification implementation is stored in the **src** folder and it contains: @@ -158,7 +158,7 @@ To learn more about the directory structure of different types of scenario-based ## See also -* [Teams Toolkit Overview](teams-toolkit-fundamentals.md) +* [Microsoft 365 Agents Toolkit Overview](teams-toolkit-fundamentals.md) * [Build a Teams app with Blazor](../sbs-gs-blazorupdate.yml) * [Build a Teams app with C# or .NET](../sbs-gs-csharp.yml) * [Prerequisites for all types of environment and create your Teams app](tools-prerequisites.md) diff --git a/msteams-platform/toolkit/debug-apps-in-Teams-desktop-client.md b/msteams-platform/toolkit/debug-apps-in-Teams-desktop-client.md index 2e54be499f5..67bf5cdc554 100644 --- a/msteams-platform/toolkit/debug-apps-in-Teams-desktop-client.md +++ b/msteams-platform/toolkit/debug-apps-in-Teams-desktop-client.md @@ -1,7 +1,7 @@ --- title: Debug your apps in Teams Desktop Client author: surbhigupta -description: Learn how to debug your bot, agent, custom engine agent, message extension apps in Teams desktop client using Teams Toolkit. +description: Learn how to debug your bot, agent, custom engine agent, message extension apps in Teams desktop client using Microsoft 365 Agents Toolkit. ms.author: surbhigupta ms.localizationpriority: high ms.topic: overview @@ -10,7 +10,7 @@ ms.date: 10/22/2024 # Debug in Teams desktop client -Microsoft Teams Toolkit helps you to debug and preview your Microsoft Teams app in desktop client. During the debug process, Teams Toolkit automatically starts app services, opens debuggers, and uploads Teams app. You can preview your Teams app in Teams desktop client after debugging. +Microsoft 365 Agents Toolkit helps you to debug and preview your Microsoft Teams app in desktop client. During the debug process, Microsoft 365 Agents Toolkit automatically starts app services, opens debuggers, and uploads Teams app. You can preview your Teams app in Teams desktop client after debugging. The following are the advantages of Teams desktop client: @@ -20,7 +20,7 @@ The following are the advantages of Teams desktop client: ## Capabilities of Teams desktop client -Teams desktop client incorporates debugging capabilities in the following app templates scaffolded by the Teams Toolkit: +Teams desktop client incorporates debugging capabilities in the following app templates scaffolded by the Microsoft 365 Agents Toolkit: * Bot. * Agent. @@ -33,7 +33,7 @@ Ensure you install the following tools for building and deploying your app in Te |   | Install | For using... | | --- | --- | --- | -|   | [Teams Toolkit](install-Teams-Toolkit.md) | A Microsoft Visual Studio Code extension that creates a project scaffolding for your app. Use the latest prerelease version. | +|   | [Microsoft 365 Agents Toolkit](install-Teams-Toolkit.md) | A Microsoft Visual Studio Code extension that creates a project scaffolding for your app. Use the latest prerelease version. | |   | [Node.js](https://nodejs.org/en/download) | Back-end JavaScript runtime environment. For more information, see [node.js version compatibility table for project type](~/toolkit/build-environments.md#nodejs-version-compatibility-table-for-project-type). | |   | [Visual Studio Code](https://code.visualstudio.com/download) | JavaScript, TypeScript, or SharePoint Framework (SPFx) build environments. Use the latest version. | |   | [Microsoft 365 developer account](../concepts/build-and-test/prepare-your-o365-tenant.md)| Access to Teams account with the appropriate permissions to install an app. | @@ -42,15 +42,15 @@ Ensure you install the following tools for building and deploying your app in Te **To debug your custom engine agent app in Teams desktop client** -1. Open Visual Studio Code (VS Code) and log into your Microsoft 365 account through Teams Toolkit. +1. Open Visual Studio Code (VS Code) and log into your Microsoft 365 account through Microsoft 365 Agents Toolkit. -1. Select the Teams Toolkit :::image type="icon" source="../assets/images/teams-toolkit-v2/teams-toolkit-sidebar-icon.PNG" border="false"::: icon in the VS Code **Activity Bar** and then select **Create a New App**. +1. Select the Microsoft 365 Agents Toolkit :::image type="icon" source="../assets/images/teams-toolkit-v2/teams-toolkit-sidebar-icon.PNG" border="false"::: icon in the VS Code **Activity Bar** and then select **Create a New App**. - :::image type="content" source="../assets/images/teams-toolkit-v2/debug-apps-in-teams-desktop-client/create-project.png" alt-text="Screenshot shows the location of the Create New Project link in the Teams Toolkit sidebar."::: + :::image type="content" source="../assets/images/teams-toolkit-v2/debug-apps-in-teams-desktop-client/create-project.png" alt-text="Screenshot shows the location of the Create New Project link in the Microsoft 365 Agents Toolkit sidebar."::: 1. Select **Custom Engine Agent**. - :::image type="content" source="../assets/images/teams-toolkit-v2/debug-apps-in-teams-desktop-client/custom-engine-copilot.png" alt-text="Screenshot shows the Teams Toolkit app templates."::: + :::image type="content" source="../assets/images/teams-toolkit-v2/debug-apps-in-teams-desktop-client/custom-engine-copilot.png" alt-text="Screenshot shows the Microsoft 365 Agents Toolkit app templates."::: 1. Select **Basic AI Chatbot**. @@ -91,7 +91,7 @@ Ensure you install the following tools for building and deploying your app in Te :::image type="content" source="../assets/images/teams-toolkit-v2/debug-apps-in-teams-desktop-client/debug-in-teams-desktop.png" alt-text="Screenshot shows the option to select debug in Teams (Desktop)."::: -1. Ensure your Teams desktop login matches your Microsoft 365 account used in Teams Toolkit and then select **Continue**. +1. Ensure your Teams desktop login matches your Microsoft 365 account used in Microsoft 365 Agents Toolkit and then select **Continue**. :::image type="content" source="../assets/images/teams-toolkit-v2/debug-apps-in-teams-desktop-client/desktop-login-matches.png" alt-text="Screenshot shows the desktop login."::: @@ -109,7 +109,7 @@ Ensure you install the following tools for building and deploying your app in Te > [!NOTE] > - > The system level notification for account matching appears only once per project. In subsequent debug sessions, Teams Toolkit sends reminders about the account through VS Code notifications. + > The system level notification for account matching appears only once per project. In subsequent debug sessions, Microsoft 365 Agents Toolkit sends reminders about the account through VS Code notifications. > > :::image type="content" source="../assets/images/teams-toolkit-v2/debug-apps-in-teams-desktop-client/subsequent-desktop-login.png" alt-text="Screenshot shows the subsequent desktop login notification in vs code."::: @@ -123,5 +123,5 @@ You can continue to debug your custom engine agent app in Teams desktop client. ## See also -* [Teams Toolkit Overview](teams-toolkit-fundamentals.md) +* [Microsoft 365 Agents Toolkit Overview](teams-toolkit-fundamentals.md) * [Debug for mobile](debug-mobile.md) diff --git a/msteams-platform/toolkit/debug-background-process.md b/msteams-platform/toolkit/debug-background-process.md index 13c26337e13..097af70bd5a 100644 --- a/msteams-platform/toolkit/debug-background-process.md +++ b/msteams-platform/toolkit/debug-background-process.md @@ -1,7 +1,7 @@ --- title: Debug background processes author: surbhigupta -description: In this module, learn how Visual Studio Code and Teams Toolkit work during debugging process. Also learn how to register and configure your Teams app. +description: In this module, learn how Visual Studio Code and Microsoft 365 Agents Toolkit work during debugging process. Also learn how to register and configure your Teams app. ms.author: surbhigupta ms.localizationpriority: high ms.topic: overview @@ -24,19 +24,19 @@ The debugging process workflow is as follows: ## Validate prerequisites -Microsoft Teams Toolkit checks the following prerequisites during the debugging process: +Microsoft 365 Agents Toolkit checks the following prerequisites during the debugging process: -* Teams Toolkit checks if Node.js is installed. If Node.js isn't installed, the debugging terminates. -* Teams Toolkit checks if Node.js version matches the versions defined in `package.json` file. If the version doesn't match, Teams Toolkit displays a warning message in output channel. -* Teams Toolkit prompts you to sign in to Microsoft 365 account, if you haven't signed in with your valid credentials. +* Microsoft 365 Agents Toolkit checks if Node.js is installed. If Node.js isn't installed, the debugging terminates. +* Microsoft 365 Agents Toolkit checks if Node.js version matches the versions defined in `package.json` file. If the version doesn't match, Microsoft 365 Agents Toolkit displays a warning message in output channel. +* Microsoft 365 Agents Toolkit prompts you to sign in to Microsoft 365 account, if you haven't signed in with your valid credentials. * Custom app upload for your developer tenant is turned on to prevent local debug termination. -* If Ngrok isn't installed or the version doesn't match the requirement, Teams Toolkit installs Ngrok npm package `ngrok@4.2.2` in `~/.fx/bin/ngrok`. Ngrok binary version 2.3 is applicable for bot and message extension and is managed by Ngrok npm package in `/.fx/bin/ngrok/node modules/ngrok/bin`. +* If Ngrok isn't installed or the version doesn't match the requirement, Microsoft 365 Agents Toolkit installs Ngrok npm package `ngrok@4.2.2` in `~/.fx/bin/ngrok`. Ngrok binary version 2.3 is applicable for bot and message extension and is managed by Ngrok npm package in `/.fx/bin/ngrok/node modules/ngrok/bin`. > [!NOTE] - > Teams Toolkit project templates use the ngrok@4.3.3 npm package, which contains v2.3.40. For more information on how to get a valid license, see [ngrok](https://ngrok.com/). + > Microsoft 365 Agents Toolkit project templates use the ngrok@4.3.3 npm package, which contains v2.3.40. For more information on how to get a valid license, see [ngrok](https://ngrok.com/). -* If Azure Functions Core Tools version 4 isn't installed or the version doesn't match the requirement, Teams Toolkit installs Azure Functions Core Tools npm package `azure-functions-core-tools@3` for Windows and macOS in `~/.fx/bin/func`. The Azure Functions Core Tools npm package in `~/.fx/bin/func/node_modules/azure-functions-core-tools/bin` manages Azure Functions Core Tools binary. For Linux, the local debug terminates. -* If .NET Core SDK isn't installed or the version doesn't match the requirement, Teams Toolkit installs .NET Core SDK for Windows and macOS in `~/.fx/bin/dotnet`. .NET Core SDK version is applicable for Azure Functions. For Linux, the local debug terminates. +* If Azure Functions Core Tools version 4 isn't installed or the version doesn't match the requirement, Microsoft 365 Agents Toolkit installs Azure Functions Core Tools npm package `azure-functions-core-tools@3` for Windows and macOS in `~/.fx/bin/func`. The Azure Functions Core Tools npm package in `~/.fx/bin/func/node_modules/azure-functions-core-tools/bin` manages Azure Functions Core Tools binary. For Linux, the local debug terminates. +* If .NET Core SDK isn't installed or the version doesn't match the requirement, Microsoft 365 Agents Toolkit installs .NET Core SDK for Windows and macOS in `~/.fx/bin/dotnet`. .NET Core SDK version is applicable for Azure Functions. For Linux, the local debug terminates. The following table lists the .NET Core versions: @@ -45,10 +45,10 @@ Microsoft Teams Toolkit checks the following prerequisites during the debugging |Windows, macOS (x64), and Linux | **3.1 (recommended)**, 5.0, 6.0 | |macOS (arm64) |6.0 | -* If the development certificate for localhost isn't installed for tab in Windows or macOS, then Teams Toolkit prompts you to install it. -* If Azure Functions binding extensions isn't installed, then Teams Toolkit installs Azure Functions binding extensions in `api/extensions.csproj`. -* If npm packages aren't installed, then Teams Toolkit installs all npm packages applicable for tab app, bot app, message extension, and Azure Functions. -* Teams Toolkit starts Ngrok to create an HTTP tunnel for bot and message extension. +* If the development certificate for localhost isn't installed for tab in Windows or macOS, then Microsoft 365 Agents Toolkit prompts you to install it. +* If Azure Functions binding extensions isn't installed, then Microsoft 365 Agents Toolkit installs Azure Functions binding extensions in `api/extensions.csproj`. +* If npm packages aren't installed, then Microsoft 365 Agents Toolkit installs all npm packages applicable for tab app, bot app, message extension, and Azure Functions. +* Microsoft 365 Agents Toolkit starts Ngrok to create an HTTP tunnel for bot and message extension. * If tab, bot, message extension, and Azure Functions ports aren't available, the local debug terminates. The following table lists the ports available for components: @@ -69,9 +69,9 @@ Microsoft Teams Toolkit checks the following prerequisites during the debugging |Tab with Azure functions | Node.js LTS versions 10, 12, **14 (recommended)** |The local debug terminates, if Node.js isn't installed or the version doesn't match the requirement.| |Bot | Node.js LTS versions 10, 12, **14 (recommended)**, 16|The local debug terminates, if Node.js isn't installed or the version doesn't match the requirement.| |Message extension | Node.js LTS versions 10, 12, **14 (recommended)**, 16 |The local debug terminates, if Node.js isn't installed or the version doesn't match the requirement.| -|Sign-in to Microsoft 365 account | Microsoft 365 credentials |Teams Toolkit prompts you to sign-in to Microsoft 365 account, if you haven't signed in. | -|Bot, message extension | Ngrok version 2.3| • If Ngrok isn't installed or the version doesn't match the requirement, the Teams Toolkit installs Ngrok NPM package `ngrok@4.2.2` in `~/.fx/bin/ngrok`.
• The Ngrok binary is managed by Ngrok NPM package in `/.fx/bin/ngrok/node modules/ngrok/bin`.| -|Azure functions | Azure Functions Core Tools version 3| • If Azure Functions Core Tools isn't installed or the version doesn't match the requirement, the Teams Toolkit installs Azure Functions Core Tools NPM package, azure-functions-core-tools@3 for **Windows** and for **macOs** in `~/.fx/bin/func`.
• The Azure Functions Core Tools NPM package in `~/.fx/bin/func/node_modules/azure-functions-core-tools/bin` manages Azure Functions Core Tools binary. For Linux, the local debug terminates.| +|Sign-in to Microsoft 365 account | Microsoft 365 credentials |Microsoft 365 Agents Toolkit prompts you to sign-in to Microsoft 365 account, if you haven't signed in. | +|Bot, message extension | Ngrok version 2.3| • If Ngrok isn't installed or the version doesn't match the requirement, the Microsoft 365 Agents Toolkit installs Ngrok NPM package `ngrok@4.2.2` in `~/.fx/bin/ngrok`.
• The Ngrok binary is managed by Ngrok NPM package in `/.fx/bin/ngrok/node modules/ngrok/bin`.| +|Azure functions | Azure Functions Core Tools version 3| • If Azure Functions Core Tools isn't installed or the version doesn't match the requirement, the Microsoft 365 Agents Toolkit installs Azure Functions Core Tools NPM package, azure-functions-core-tools@3 for **Windows** and for **macOs** in `~/.fx/bin/func`.
• The Azure Functions Core Tools NPM package in `~/.fx/bin/func/node_modules/azure-functions-core-tools/bin` manages Azure Functions Core Tools binary. For Linux, the local debug terminates.| |Azure functions |.NET Core SDK version|• If .NET Core SDK isn't installed or the version doesn't match the requirement, the Toolkit installs .NET Core SDK for Windows and macOS in `~/.fx/bin/dotnet`.
• For Linux, the local debug terminates.| |Azure functions | Azure functions binding extensions defined in `api/extensions.csproj`| If Azure functions binding extensions isn't installed, the Toolkit installs Azure functions binding extensions.| |NPM packages| NPM packages for tab app, bot app, message extension app, and Azure functions|If NPM isn't installed, the Toolkit installs all NPM packages.| @@ -88,9 +88,9 @@ Use the following .NET Core versions: |macOs (arm64) |6.0 | > [!NOTE] -> If the development certificate for localhost isn't installed for tab in Windows or MacOS, the Teams Toolkit prompts you to install it.
--> +> If the development certificate for localhost isn't installed for tab in Windows or MacOS, the Microsoft 365 Agents Toolkit prompts you to install it.
--> -When you select **Start Debugging (F5)**, Teams Toolkit output channel displays the progress and result after checking the prerequisites. +When you select **Start Debugging (F5)**, Microsoft 365 Agents Toolkit output channel displays the progress and result after checking the prerequisites. :::image type="content" source="../assets/images/teams-toolkit-v2/debug/prerequisites-debugcheck.png" alt-text="Screenshot shows the prerequisites check summary."::: @@ -98,15 +98,15 @@ For more information, see [validate prerequisites task](https://aka.ms/teamsfx-t ## Start local tunnel -For bot and message extension, Teams Toolkit starts a local tunnel service to make the bot messaging endpoint public. For more information, see [start local tunnel task](https://aka.ms/teamsfx-tasks/local-tunnel). +For bot and message extension, Microsoft 365 Agents Toolkit starts a local tunnel service to make the bot messaging endpoint public. For more information, see [start local tunnel task](https://aka.ms/teamsfx-tasks/local-tunnel). ## Create the debug resources -Teams Toolkit executes lifecycle `provision` defined in `teamsapp.local.yml` to create Teams app related resources required for debugging. For more information, see [Provision task](https://aka.ms/teamsfx-tasks/provision) and [available actions](https://aka.ms/teamsfx-actions). +Microsoft 365 Agents Toolkit executes lifecycle `provision` defined in `teamsapp.local.yml` to create Teams app related resources required for debugging. For more information, see [Provision task](https://aka.ms/teamsfx-tasks/provision) and [available actions](https://aka.ms/teamsfx-actions). ## Build project -Teams Toolkit executes lifecycle `deploy` defined in `teamsapp.local.yml` to build the project. For more information, see [Deploy task](https://aka.ms/teamsfx-tasks/deploy) and [available actions](https://aka.ms/teamsfx-actions). +Microsoft 365 Agents Toolkit executes lifecycle `deploy` defined in `teamsapp.local.yml` to build the project. For more information, see [Deploy task](https://aka.ms/teamsfx-tasks/deploy) and [available actions](https://aka.ms/teamsfx-actions). ## Take a tour of your app source code @@ -114,16 +114,16 @@ You can view the project folders and files under **Explorer** in Visual Studio C | Folder name| Contents| Debug configuration type | | --- | --- | --- | -| `teamsapp.local.yml` | The main Teams Toolkit project file for debugging. | This file defines the life cycles and actions required for debugging. | -| `env/.env.local` | Environment variables file for Teams Toolkit project. | The values of each environment variable are consumed or generated during debugging. | +| `teamsapp.local.yml` | The main Microsoft 365 Agents Toolkit project file for debugging. | This file defines the life cycles and actions required for debugging. | +| `env/.env.local` | Environment variables file for Microsoft 365 Agents Toolkit project. | The values of each environment variable are consumed or generated during debugging. | | `.localConfigs` | Environment variables file for the app code. | The values of each environment variable are generated during debugging. | -For more information on the project folder structure, see [Teams Toolkit project](https://aka.ms/teamsfx-v5.0-guide#teams-toolkit-project). +For more information on the project folder structure, see [Microsoft 365 Agents Toolkit project](https://aka.ms/teamsfx-v5.0-guide#teams-toolkit-project). ## See also -* [Teams Toolkit Overview](teams-toolkit-fundamentals.md) -* [Debug your Teams app using Teams Toolkit](debug-local.md) -* [Use Teams Toolkit to provision cloud resources](provision.md) +* [Microsoft 365 Agents Toolkit Overview](teams-toolkit-fundamentals.md) +* [Debug your Teams app using Microsoft 365 Agents Toolkit](debug-local.md) +* [Use Microsoft 365 Agents Toolkit to provision cloud resources](provision.md) * [Deploy to the cloud](deploy.md) * [Preview and customize app manifest](TeamsFx-preview-and-customize-app-manifest.md) diff --git a/msteams-platform/toolkit/debug-local.md b/msteams-platform/toolkit/debug-local.md index c1995aee502..acb742fe83e 100644 --- a/msteams-platform/toolkit/debug-local.md +++ b/msteams-platform/toolkit/debug-local.md @@ -1,7 +1,7 @@ --- -title: Teams Toolkit - Debug your Apps Locally +title: Microsoft 365 Agents Toolkit - Debug your Apps Locally author: surbhigupta -description: Learn how to set up Teams Toolkit to debug Teams app in Visual Studio Code, debug process, dev tunnel, and debug configurations. +description: Learn how to set up Microsoft 365 Agents Toolkit to debug Teams app in Visual Studio Code, debug process, dev tunnel, and debug configurations. ms.author: surbhigupta ms.localizationpriority: high ms.topic: overview @@ -10,18 +10,18 @@ ms.date: 12/11/2024 # Debug your Teams app locally -Microsoft Teams Toolkit helps you to debug and preview your Microsoft Teams app locally. During the debug process, Teams Toolkit automatically starts app services, launches debuggers, and uploads Teams app. You can preview your Teams app in Teams web client locally after debugging. +Microsoft 365 Agents Toolkit helps you to debug and preview your Microsoft Teams app locally. During the debug process, Microsoft 365 Agents Toolkit automatically starts app services, launches debuggers, and uploads Teams app. You can preview your Teams app in Teams web client locally after debugging. ## Debug your Teams app locally for Visual Studio Code -Teams Toolkit in Microsoft Visual Studio Code gives you the features to automate debugging of your Teams app locally. Visual Studio Code allows you to debug tab, bot, and message extension. You need to set up Teams Toolkit before you debug your app. +Microsoft 365 Agents Toolkit in Microsoft Visual Studio Code gives you the features to automate debugging of your Teams app locally. Visual Studio Code allows you to debug tab, bot, and message extension. You need to set up Microsoft 365 Agents Toolkit before you debug your app. > [!NOTE] -> Your old Teams Toolkit project gets upgraded to use new tasks, for more information, see [tasks doc](https://aka.ms/teamsfx-tasks). +> Your old Microsoft 365 Agents Toolkit project gets upgraded to use new tasks, for more information, see [tasks doc](https://aka.ms/teamsfx-tasks). -## Set up your Teams Toolkit for debugging +## Set up your Microsoft 365 Agents Toolkit for debugging -The following steps help you set up your Teams Toolkit before you initiate the debug process: +The following steps help you set up your Microsoft 365 Agents Toolkit before you initiate the debug process: # [Windows](#tab/Windows) @@ -81,7 +81,7 @@ Toolkit launches a new Microsoft Edge or Chrome browser instance based on your s :::image type="content" source="../assets/images/teams-toolkit-v2/debug/mac-settings.png" alt-text="Screenshot shows the mac sign in dialog."::: -Teams Toolkit launches your browser instance and opens a webpage to load Teams client. +Microsoft 365 Agents Toolkit launches your browser instance and opens a webpage to load Teams client. # [Command line](#tab/cli) @@ -142,7 +142,7 @@ npm run prepare-storage:teamsapp ## Debug your app -After the initial setup process, Teams Toolkit starts the following processes: +After the initial setup process, Microsoft 365 Agents Toolkit starts the following processes: * [Starts app services](#starts-app-services) * [Launches debug configurations](#launches-debug-configurations) @@ -209,7 +209,7 @@ The following table lists the required arguments: | **Arguments** | **Type** | **Required** | **Description** | | --- | --- | --- |--------| | `type` | string | required | The type of tunnel service to use. This argument must be set to `dev-tunnel`. | -| `env` | string | optional | The environment name. Teams Toolkit writes the environment variables defined in `output` to `.env.` file. | +| `env` | string | optional | The environment name. Microsoft 365 Agents Toolkit writes the environment variables defined in `output` to `.env.` file. | | `ports` | array | required | An array of port configurations, each specifying the local port number, protocol, and access control settings. | The `ports` argument must be an array of objects, with each object specifying the configuration for a particular port. Each object must contain the following fields: @@ -277,9 +277,9 @@ When Teams client opens in the web browser, perform the following steps: ## See also -* [Teams Toolkit Overview](teams-toolkit-fundamentals.md) +* [Microsoft 365 Agents Toolkit Overview](teams-toolkit-fundamentals.md) * [Introduction to Azure Functions](/azure/azure-functions/functions-overview) -* [Use Teams Toolkit to provision cloud resources](provision.md) +* [Use Microsoft 365 Agents Toolkit to provision cloud resources](provision.md) * [Add How-to guides to Teams app](add-how-to-guides-vsc.md) * [Deploy to the cloud](deploy.md) -* [Manage multiple environments in Teams Toolkit](teamsfx-multi-env.md) +* [Manage multiple environments in Microsoft 365 Agents Toolkit](teamsfx-multi-env.md) diff --git a/msteams-platform/toolkit/debug-message-extension-app-in-test-tool.md b/msteams-platform/toolkit/debug-message-extension-app-in-test-tool.md index 8a6f317744a..31facd40a2c 100644 --- a/msteams-platform/toolkit/debug-message-extension-app-in-test-tool.md +++ b/msteams-platform/toolkit/debug-message-extension-app-in-test-tool.md @@ -23,7 +23,7 @@ Ensure that you install the following tools to build and deploy your bot in Test |   | Install | For using... | | --- | --- | --- | -|   | [Teams Toolkit](install-Teams-Toolkit.md) | A Microsoft Visual Studio Code extension that creates a project scaffolding for your app. Use the latest release version. | +|   | [Microsoft 365 Agents Toolkit](install-Teams-Toolkit.md) | A Microsoft Visual Studio Code extension that creates a project scaffolding for your app. Use the latest release version. | |   | [Node.js](https://nodejs.org/en/download/) | Back-end JavaScript runtime environment. For more information, see [Node.js version compatibility table for project type](~/toolkit/build-environments.md#nodejs-version-compatibility-table-for-project-type). | |   | [Visual Studio Code](https://code.visualstudio.com/download) | JavaScript, TypeScript, or SharePoint Framework (SPFx) build environments. Use the latest version. | @@ -47,7 +47,7 @@ Ensure that you install the following tools to build and deploy your bot in Test :::image type="content" source="../assets/images/teams-toolkit-v2/teams-app-select-folder.png" alt-text="Screenshot shows the test tool sample app folder."::: -1. From the left pane, select **Teams Toolkit**. +1. From the left pane, select **Microsoft 365 Agents Toolkit**. 1. From the left pane, select **Run and Debug (Ctrl+Shift+D)** and select **Debug in Test Tool (Preview)** in dropdown list. diff --git a/msteams-platform/toolkit/debug-overview.md b/msteams-platform/toolkit/debug-overview.md index 298c85dc35e..c2a6cdfb88d 100644 --- a/msteams-platform/toolkit/debug-overview.md +++ b/msteams-platform/toolkit/debug-overview.md @@ -1,7 +1,7 @@ --- -title: Debug Teams App using Teams Toolkit +title: Debug Teams App using Microsoft 365 Agents Toolkit author: surbhigupta -description: Learn how to prepare and debug Teams app locally and in Teams App Test tool, customize debug settings in Teams Toolkit, and its key features. +description: Learn how to prepare and debug Teams app locally and in Teams App Test tool, customize debug settings in Microsoft 365 Agents Toolkit, and its key features. ms.author: surbhigupta ms.localizationpriority: high ms.topic: overview @@ -10,23 +10,23 @@ ms.date: 03/21/2022 # Debug your Teams app -Microsoft Teams Toolkit helps you to debug and preview your Microsoft Teams app. Debug is the process of checking, detecting, and correcting issues or bugs to ensure the program runs successfully in Teams. +Microsoft 365 Agents Toolkit helps you to debug and preview your Microsoft Teams app. Debug is the process of checking, detecting, and correcting issues or bugs to ensure the program runs successfully in Teams. ## Debug your Teams app for Visual Studio Code -Teams Toolkit in Microsoft Visual Studio Code automates the debug process. You can detect errors and fix them as well as preview the teams app. You can also customize debug settings to create your tab or bot. +Microsoft 365 Agents Toolkit in Microsoft Visual Studio Code automates the debug process. You can detect errors and fix them as well as preview the teams app. You can also customize debug settings to create your tab or bot. During the debug process: -* Teams Toolkit automatically starts app services, launches debuggers, and uploads the Teams app. -* Teams Toolkit checks the prerequisites during the debug background process. +* Microsoft 365 Agents Toolkit automatically starts app services, launches debuggers, and uploads the Teams app. +* Microsoft 365 Agents Toolkit checks the prerequisites during the debug background process. * Your Teams app is available for preview in Teams web client locally after debugging. * You can also customize debug settings to use your bot endpoints, development certificate, or debug partial component to load your configured app. * Visual Studio Code allows you to debug tab, bot, message extension, and Azure Functions. -## Key debug features of Teams Toolkit +## Key debug features of Microsoft 365 Agents Toolkit -Teams Toolkit supports the following debug features: +Microsoft 365 Agents Toolkit supports the following debug features: * [Start debugging](#start-debugging) * [Multi-target debugging](#multi-target-debugging) @@ -36,15 +36,15 @@ Teams Toolkit supports the following debug features: * [Teams App Test Tool](#teams-app-test-tool) * [Debug apps in Teams desktop client](#debug-apps-in-teams-desktop-client) -Teams Toolkit performs background functions during debug process, which include verifying the prerequisites required for debug. You can see the progress of the verification process in the output channel of Teams Toolkit. In the setup process you can register and configure your Teams app. +Microsoft 365 Agents Toolkit performs background functions during debug process, which include verifying the prerequisites required for debug. You can see the progress of the verification process in the output channel of Microsoft 365 Agents Toolkit. In the setup process you can register and configure your Teams app. ### Start debugging -You can press **F5** as a single operation to start debugging. Teams Toolkit starts to check prerequisites, registers Microsoft Entra app, Teams app, and registers bot, starts services, and launches browser. +You can press **F5** as a single operation to start debugging. Microsoft 365 Agents Toolkit starts to check prerequisites, registers Microsoft Entra app, Teams app, and registers bot, starts services, and launches browser. ### Multi-target debugging -Teams Toolkit utilizes multi-target debugging feature to debug tab, bot, message extension, and Azure Functions at the same time. +Microsoft 365 Agents Toolkit utilizes multi-target debugging feature to debug tab, bot, message extension, and Azure Functions at the same time. ### Toggle breakpoints @@ -70,7 +70,7 @@ The Teams App Test Tool makes debugging your bot-based apps effortless. You can ### Debug apps in Teams desktop client -Microsoft Teams Toolkit helps you to debug and preview your Microsoft Teams app in desktop client. For more information, see [debug apps in Teams desktop client](debug-apps-in-Teams-desktop-client.md). +Microsoft Microsoft 365 Agents Toolkit helps you to debug and preview your Microsoft Teams app in desktop client. For more information, see [debug apps in Teams desktop client](debug-apps-in-Teams-desktop-client.md). ## Prepare for debug @@ -86,7 +86,7 @@ Ensure that you can toggle breakpoints on the source codes of tabs, bots, messag ## Customize debug settings -Teams Toolkit allows you to customize the debug settings to create your tab or bot. For more information on the full list of customizable options, see [debug settings doc](https://github.com/OfficeDev/TeamsFx/wiki/Teams-Toolkit-Visual-Studio-Code-v5.0-Prerelease-Guide#debug-f5-in-visual-studio-code). +Microsoft 365 Agents Toolkit allows you to customize the debug settings to create your tab or bot. For more information on the full list of customizable options, see [debug settings doc](https://github.com/OfficeDev/TeamsFx/wiki/Teams-Toolkit-Visual-Studio-Code-v5.0-Prerelease-Guide#debug-f5-in-visual-studio-code). You can also customize debug settings for your existing bot app.
@@ -95,7 +95,7 @@ You can also customize debug settings for your existing bot app. Learn how to use an existing bot for debugging -Teams Toolkit creates Microsoft Entra apps for projects with bot by default using [`botAadApp/create`](https://github.com/OfficeDev/TeamsFx/wiki/Available-actions-in-Teams-Toolkit#botaadappcreate) action. +Microsoft 365 Agents Toolkit creates Microsoft Entra apps for projects with bot by default using [`botAadApp/create`](https://github.com/OfficeDev/TeamsFx/wiki/Available-actions-in-Teams-Toolkit#botaadappcreate) action. To use an existing bot, you can set `BOT_ID` and `SECRET_BOT_PASSWORD` in `env/.env.local` with your own values. @@ -196,7 +196,7 @@ In `teamsapp.local.yml`, edit `args` of `cli/runNpmCommand` action.
Use your own app package -Teams Toolkit by default creates a set of `teamsApp` actions to manage app package. You can update those in `teamsapp.local.yml` to use your own app package. +Microsoft 365 Agents Toolkit by default creates a set of `teamsApp` actions to manage app package. You can update those in `teamsapp.local.yml` to use your own app package. ```yml # teamsapp.local.yml @@ -251,7 +251,7 @@ BOT_ENDPOINT={YOUR_OWN_TUNNEL_URL} Add environment variables -You can add environment variables to `.localConfigs` file for tab, bot, message extension, and Azure Functions. Teams Toolkit loads the environment variables you added to start services during local debug. +You can add environment variables to `.localConfigs` file for tab, bot, message extension, and Azure Functions. Microsoft 365 Agents Toolkit loads the environment variables you added to start services during local debug. > [!NOTE] > Ensure to start a new local debug after you add new environment variables, as the environment variables don't support hot reload. @@ -261,7 +261,7 @@ You can add environment variables to `.localConfigs` file for tab, bot, message
Debug partial component -Teams Toolkit utilizes Visual Studio Code multi-target debugging to debug tab, bot, message extension, and Azure Functions at the same time. You can update `.vscode/launch.json` and `.vscode/tasks.json` to debug partial component. If you want to debug tab only in a tab plus bot with Azure Functions project, use the following steps: +Microsoft 365 Agents Toolkit utilizes Visual Studio Code multi-target debugging to debug tab, bot, message extension, and Azure Functions at the same time. You can update `.vscode/launch.json` and `.vscode/tasks.json` to debug partial component. If you want to debug tab only in a tab plus bot with Azure Functions project, use the following steps: 1. Update `"Attach to Bot"` and `"Attach to Backend"` from debug compound in `.vscode/launch.json`. @@ -348,8 +348,8 @@ Teams Toolkit utilizes Visual Studio Code multi-target debugging to debug tab, b ## See also -* [Teams Toolkit Overview](teams-toolkit-fundamentals.md) +* [Microsoft 365 Agents Toolkit Overview](teams-toolkit-fundamentals.md) * [Debug background process](debug-background-process.md) -* [Use Teams Toolkit to provision cloud resources](provision.md) +* [Use Microsoft 365 Agents Toolkit to provision cloud resources](provision.md) * [Deploy to the cloud](deploy.md) * [Preview and customize app manifest](TeamsFx-preview-and-customize-app-manifest.md)