Skip to content

[Doc Improvement][Teams Toolkit rename 3] #12722

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[Doc Improvement][Teams Toolkit rename 3] #12722

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions msteams-platform/toolkit/debug-your-Teams-app-test-tool.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Debug bot using Teams App Test Tool
author: surbhigupta
description: Learn about Teams app Test Tool in Teams Toolkit and debug existing app, advantages, activity triggers, and customize Teams context.
description: Learn about Teams app Test Tool in Microsoft 365 Agents Toolkit and debug existing app, advantages, activity triggers, and customize Teams context.
ms.author: surbhigupta
ms.localizationpriority: high
ms.topic: overview
Expand All @@ -12,7 +12,7 @@ ms.date: 11/16/2023

> [!NOTE]
>
> Teams App Test Tool is available in the latest prerelease version of the Microsoft Teams Toolkit. Ensure that you install the [latest prerelease version](install-Teams-Toolkit.md#install-a-prerelease-version) of the Teams Toolkit.
> Teams App Test Tool is available in the latest prerelease version of the Microsoft 365 Agents Toolkit. Ensure that you install the [latest prerelease version](install-Teams-Toolkit.md#install-a-prerelease-version) of Microsoft 365 Agents Toolkit.

Teams App Test Tool (Test Tool) makes debugging bot-based apps effortless. You can chat with your bot and see its messages and Adaptive Cards as they appear in Microsoft Teams. You don’t need a Microsoft 365 developer account, tunneling, or Teams app and bot registration to use Test Tool.

Expand Down Expand Up @@ -44,7 +44,7 @@ Ensure you install the following tools for building and deploying your bots in T

|   | 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. |

Expand All @@ -57,23 +57,23 @@ To use a Teams bot on Test Tool, you need to provide:
* Message endpoint: A bot message endpoint is the URL that links Test Tool and your bot. You can update the endpoint with the `BOT_ENDPOINT` environment variable or use the default value of `http://localhost:3978/api/messages`.
* Configuration file (Optional): A configuration file informs Test Tool about your customized contextual information in Teams. The file is named **.teamsapptesttool.yml** in the project's root folder. If Teams can't find this file, it uses the default configuration. For more information, see [customize Teams context](#customize-teams-context).

## Test Tool experience in Teams Toolkit
## Test Tool experience in Microsoft 365 Agents Toolkit

Test Tool offers a faster debug experience for bot applications when compared to the Teams client.

# [Visual Studio Code](#tab/vscode)

1. Open Visual Studio Code.

1. Select the Teams Toolkit :::image type="icon" source="../assets/images/teams-toolkit-v2/teams-toolkit-sidebar-icon.PNG" border="false"::: icon in the Visual Studio Code **Activity Bar**.
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 Visual Studio Code **Activity Bar**.

1. Select **Create a New App**.

:::image type="content" source="../assets/images/teams-toolkit-v2/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/create-project.png" alt-text="Screenshot shows the location of the Create New Project link in the Microsoft 365 Agents Toolkit sidebar.":::

1. Select **Bot**.

:::image type="content" source="../assets/images/teams-toolkit-v2/first-bot/create-new-app1.png" alt-text="Screenshot shows the Teams Toolkit app templates.":::
:::image type="content" source="../assets/images/teams-toolkit-v2/first-bot/create-new-app1.png" alt-text="Screenshot shows the Microsoft 365 Agents Toolkit app templates.":::

1. Select **AI Chat Bot**. If you need a different functionality for your bot, pick a different option.

Expand Down Expand Up @@ -131,7 +131,7 @@ Test Tool offers a faster debug experience for bot applications when compared to

:::image type="content" source="../assets/images/teams-toolkit-v2/debug/npm-teams-app-test-tool.png" alt-text="Screenshot shows install teams app test tool cli.":::

1. Use the `teamsapp` command from [Teams Toolkit CLI](Teams-Toolkit-CLI.md) to create your first project. Start from the folder where you want to create the project folder.
1. Use the `teamsapp` command from [Microsoft 365 Agents Toolkit CLI](Teams-Toolkit-CLI.md) to create your first project. Start from the folder where you want to create the project folder.

```cmd
teamsapp new
Expand Down Expand Up @@ -429,9 +429,9 @@ It's vital to recognize that updating the configuration file has three major imp

## Debug an existing app with Test Tool

Ensure you have an existing bot created using Teams Toolkit. To debug your bot with Test Tool, follow these steps:
Ensure you have an existing bot created using Microsoft 365 Agents Toolkit. To debug your bot with Test Tool, follow these steps:

1. Open the existing bot's project folder in Teams Toolkit.
1. Open the existing bot's project folder in Microsoft 365 Agents Toolkit.

1. Go to **EXPLORER** > **.vscode**.
1. Select **launch.json** and add the following code at the end of the file:
Expand Down Expand Up @@ -593,8 +593,8 @@ Follow the [step-by-step guide](../sbs-teams-app-test-tool.yml) to debug an AI c

## See also

* [Teams Toolkit Overview](teams-toolkit-fundamentals.md)
* [Install Teams Toolkit](install-Teams-Toolkit.md)
* [Microsoft 365 Agents Toolkit Overview](teams-toolkit-fundamentals.md)
* [Install Microsoft 365 Agents Toolkit](install-Teams-Toolkit.md)
* [Build bots for Teams](../bots/what-are-bots.md)
* [Adaptive Card](../task-modules-and-cards/cards/cards-reference.md#adaptive-card)
* [Bot Framework SDK](https://dev.botframework.com/)
34 changes: 17 additions & 17 deletions msteams-platform/toolkit/deploy-Teams-app-to-container-service.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Before you get started, ensure that you have the following tools:

Azure Container Apps is a fully managed service that enables you to run containerized applications in the cloud. It's an ideal choice if you don't need direct access to all native Kubernetes APIs and cluster management and you prefer a fully managed experience grounded on best practices.

With the help of sample applications, you can run the provision and deploy commands in Teams Toolkit. Teams Toolkit creates an Azure Container Registry and Azure Container Apps for you and constructs your app into a container image and deploys it to Azure Container Apps.
With the help of sample applications, you can run the provision and deploy commands in Microsoft 365 Agents Toolkit. Microsoft 365 Agents Toolkit creates an Azure Container Registry and Azure Container Apps for you and constructs your app into a container image and deploys it to Azure Container Apps.

The `provision` command creates and configures the following resources:

Expand Down Expand Up @@ -102,17 +102,17 @@ You can use Microsoft Entra ID to authenticate your bot with Azure Bot Service.
> [!div class="nextstepaction"]
> [I ran into an issue](https://github.com/MicrosoftDocs/msteams-docs/issues/new?template=Doc-Feedback.yaml&title=%5BI%20ran%20into%20an%20issue%5D%20Setup%20ingress%20with%20HTTPS%20on%20AKS&pageUrl=https%3A%2F%2Flearn.microsoft.com%2Fen-us%2Fmicrosoftteams%2Fplatform%2Ftoolkit%2Fdeploy-teams-app-to-container-service&contentSourceUrl=https%3A%2F%2Fgithub.com%2FMicrosoftDocs%2Fmsteams-docs%2Fblob%2Fmain%2Fmsteams-platform%2Ftoolkit%2Fdeploy-Teams-app-to-container-service.md&documentVersionIndependentId=1276497c-0a84-5a91-c324-3cedca1a2298&author=surbhigupta&metadata=*%2BID%253A%2Be473e1f3-69f5-bcfa-bcab-54b098b59c80%2B%250A*%2BService%253A%2B**msteams**)

### Provision resources with Teams Toolkit
### Provision resources with Microsoft 365 Agents Toolkit

You can use the `provision` command in Teams Toolkit to create a Teams app with bot capability, incorporate the Azure Bot Service, and add the Microsoft Entra ID for authentication.
You can use the `provision` command in Microsoft 365 Agents Toolkit to create a Teams app with bot capability, incorporate the Azure Bot Service, and add the Microsoft Entra ID for authentication.

To provision resources with Teams Toolkit, follow these steps:
To provision resources with Microsoft 365 Agents Toolkit, follow these steps:

1. Open the sample app that you've downloaded earlier.

1. Go to the `env/.env.${envName}` file and update the `BOT_DOMAIN` value with your FQDN.

1. Go to the `teamsapp.yml` file and update the following `arm/deploy` action to ensure that Teams Toolkit provisions an Azure Bot Service during the execution of the `provision` command:
1. Go to the `teamsapp.yml` file and update the following `arm/deploy` action to ensure that Microsoft 365 Agents Toolkit provisions an Azure Bot Service during the execution of the `provision` command:

```bash
- uses: arm/deploy
Expand All @@ -126,7 +126,7 @@ To provision resources with Teams Toolkit, follow these steps:
bicepCliVersion: v0.9.1
```

1. Run the `provision` command in Teams Toolkit.
1. Run the `provision` command in Microsoft 365 Agents Toolkit.

1. After provisioning, locate the `BOT_ID` in `env/.env.${envName}` file and the encrypted `SECRET_BOT_PASSWORD` in `env/.env.${envName}.user` file. To obtain the actual value of `BOT_PASSWORD`. Select the Decrypt secret annotation.

Expand Down Expand Up @@ -176,17 +176,17 @@ The Teams backend server interacts with your bot through the Azure Bot Service.

You can use Microsoft Entra ID to authenticate your bot with Azure Bot Service. Create a Kubernetes secret that includes the app ID and password and integrate the secret into your container's runtime configuration.

### Provision resources with Teams Toolkit
### Provision resources with Microsoft 365 Agents Toolkit

You can use the `provision` command in Teams Toolkit to create a Teams app with bot capability, incorporate the Azure Bot Service, and add the Microsoft Entra ID for authentication.
You can use the `provision` command in Microsoft 365 Agents Toolkit to create a Teams app with bot capability, incorporate the Azure Bot Service, and add the Microsoft Entra ID for authentication.

To provision resources with Teams Toolkit, follow these steps:
To provision resources with Microsoft 365 Agents Toolkit, follow these steps:

1. Open the sample app that you've downloaded earlier.

1. Go to the `env/.env.${envName}` file and update the `BOT_DOMAIN` value with your FQDN.

1. Go to the `teamsapp.yml` file and update the following `arm/deploy` action to ensure that Teams Toolkit provisions an Azure Bot Service during the execution of the `provision` command:
1. Go to the `teamsapp.yml` file and update the following `arm/deploy` action to ensure that Microsoft 365 Agents Toolkit provisions an Azure Bot Service during the execution of the `provision` command:

```yml
- uses: arm/deploy
Expand All @@ -200,7 +200,7 @@ To provision resources with Teams Toolkit, follow these steps:
bicepCliVersion: v0.9.1
```

1. In the `teamsapp.yml` file, update the `botFramework/create` action during the provision stage. This action enables Teams Toolkit to create a bot registration with the appropriate messaging endpoint.
1. In the `teamsapp.yml` file, update the `botFramework/create` action during the provision stage. This action enables Microsoft 365 Agents Toolkit to create a bot registration with the appropriate messaging endpoint.

>[!NOTE]
> We recommend you use Azure Bot Service for channeling. If you don't have an Azure account and can't create Azure Bot Service, you can create a bot registration.
Expand All @@ -218,7 +218,7 @@ To provision resources with Teams Toolkit, follow these steps:

You can remove the `arm/deploy` action in `teamsapp.yml` file, as we don't need any Azure resources.

1. Run the `provision` command in Teams Toolkit.
1. Run the `provision` command in Microsoft 365 Agents Toolkit.

1. After provisioning, locate the `BOT_ID` in the `env/.env.${envName}` file and the encrypted `SECRET_BOT_PASSWORD` in the `env/.env.${envName}.user` file. To obtain the actual value of `BOT_PASSWORD`. Select the Decrypt secret annotation.

Expand Down Expand Up @@ -310,21 +310,21 @@ You can also deploy a Teams tab app to your personal Kubernetes cluster or a Kub
> [!div class="nextstepaction"]
> [I ran into an issue](https://github.com/MicrosoftDocs/msteams-docs/issues/new?template=Doc-Feedback.yaml&title=%5BI%20ran%20into%20an%20issue%5D%20Setup%20ingress%20with%20HTTPS%20on%20AKS&pageUrl=https%3A%2F%2Flearn.microsoft.com%2Fen-us%2Fmicrosoftteams%2Fplatform%2Ftoolkit%2Fdeploy-teams-app-to-container-service&contentSourceUrl=https%3A%2F%2Fgithub.com%2FMicrosoftDocs%2Fmsteams-docs%2Fblob%2Fmain%2Fmsteams-platform%2Ftoolkit%2Fdeploy-Teams-app-to-container-service.md&documentVersionIndependentId=1276497c-0a84-5a91-c324-3cedca1a2298&author=surbhigupta&metadata=*%2BID%253A%2Be473e1f3-69f5-bcfa-bcab-54b098b59c80%2B%250A*%2BService%253A%2B**msteams**)

### Provision resources with Teams Toolkit
### Provision resources with Microsoft 365 Agents Toolkit

You can use the `provision` command in Teams Toolkit to create a Teams app with tab capability, incorporate the Azure Bot Service, and add the Microsoft Entra ID for authentication.
You can use the `provision` command in Microsoft 365 Agents Toolkit to create a Teams app with tab capability, incorporate the Azure Bot Service, and add the Microsoft Entra ID for authentication.

To provision resources with Teams Toolkit, follow these steps:
To provision resources with Microsoft 365 Agents Toolkit, follow these steps:

1. Open the sample app that you've downloaded earlier.

1. Go to the `env/.env.${envName}` file and update the `TAB_DOMAIN` value with your FQDN.

1. Go to the `teamsapp.yml` file and remove the `arm/deploy` action, as no additional Azure resources are required.

1. Run the `provision` command in Teams Toolkit.
1. Run the `provision` command in Microsoft 365 Agents Toolkit.

1. Use the Teams Toolkit to create a Microsoft Entra ID, which you might want to set as your apps environment variables.
1. Use the Microsoft 365 Agents Toolkit to create a Microsoft Entra ID, which you might want to set as your apps environment variables.

1. After provisioning, locate the `AAD_APP_CLIENT_ID` in the `env/.env.${envName}` file and the encrypted `SECRET_AAD_APP_CLIENT_SECRET` in the `env/.env.${envName}.user` file.

Expand Down
14 changes: 7 additions & 7 deletions msteams-platform/toolkit/deploy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ ms.date: 11/29/2021

# Deploy Microsoft Teams app to the cloud using Microsoft Visual Studio Code

Microsoft Teams Toolkit helps to deploy or upload the front-end and back-end code in your app to your provisioned cloud resources in Azure.
Microsoft 365 Agents Toolkit helps to deploy or upload the front-end and back-end code in your app to your provisioned cloud resources in Azure.

You can deploy to the following types of cloud resources:

Expand All @@ -22,17 +22,17 @@ You can deploy to the following types of cloud resources:
> [!NOTE]
> Before you deploy app code to Azure cloud, you need to successfully complete the [provisioning of cloud resources](provision.md).

## Deploy Teams apps using Teams Toolkit
## Deploy Teams apps using Microsoft 365 Agents Toolkit

The Get started guide helps to deploy using Teams Toolkit. You can use the following to deploy your Teams app:
The Get started guide helps to deploy using Microsoft 365 Agents Toolkit. You can use the following to deploy your Teams app:

### Sign in to your Azure account

Use this account to access the Microsoft Azure portal and to provision new cloud resources to support your app. Before deploying your app to Azure App Service, Azure Functions, or Azure Storage, you must sign in to your Azure account.

1. Open Visual Studio Code.
1. Open the project folder in which you created app.
1. Select the Teams Toolkit icon in the sidebar.
1. Select the Microsoft 365 Agents Toolkit icon in the sidebar.
1. Select **Sign in to Azure**.

> [!TIP]
Expand All @@ -47,7 +47,7 @@ The ACCOUNTS section of the sidebar shows the two accounts separately. It also l

Now you're ready to deploy your app to Azure!

Congratulations, you've created a Teams app! Now let's go ahead and learn how to deploy one of the apps to Azure using the Teams Toolkit.
Congratulations, you've created a Teams app! Now let's go ahead and learn how to deploy one of the apps to Azure using the Microsoft 365 Agents Toolkit.

## Deploy to Azure

Expand All @@ -60,7 +60,7 @@ Congratulations, you've created a Teams app! Now let's go ahead and learn how to

:::image type="content" source="../assets/images/teams-toolkit-v2/click_deploy.png" alt-text="Screenshot showing the selection of Deploy under Visual Studio Code.":::

1. Select the Teams Toolkit icon in the sidebar.
1. Select the Microsoft 365 Agents Toolkit icon in the sidebar.

### Customize deploy lifecycle in Teams

Expand Down Expand Up @@ -250,7 +250,7 @@ This action upload and deploys generated sppkg to SharePoint app catalog. You ca

## See also

* [Teams Toolkit Overview](teams-toolkit-fundamentals.md)
* [Microsoft 365 Agents Toolkit Overview](teams-toolkit-fundamentals.md)
* [Create and deploy an Azure cloud service](/azure/cloud-services/cloud-services-how-to-create-deploy-portal)
* [Add How-to guides to Teams app](add-how-to-guides-vsc.md)
* [Add cloud resources to Teams app](add-resource.md)
Expand Down
Loading