Upgrade to support unify config
We will update the configuration files so that your project is compatible with the latest Teams Toolkit features, including a consistent configuration file schema and a single Teams app manifest template across local and remote environments.
Important Notes: If you collaborate on this project with your co-workers, please ensure your team members update the Teams Toolkit extension to the latest version after committing the changes with this upgrade.
Teams Toolkit continues to improve your Teams application development experience. We are upgrading the Teams app project structure so that you can:
- Use a consistent schema to manage configuration settings for local and remote environments.
- Use a single Teams application manifest template across local and remote environments.
After the project upgrade, the new file structure will consist:
-
localSettings.json
will be updated toconfig.local.json
to ensure consistency between local and remote environment configuration settings. -
manifest.local.template.json
andmanifest.remote.template.json
will be merged into a single manifest template file namedmanifest.template.json
to make managing manifest template files easy.
Your existing localSettings.json
, manifest.local.template.json
, and manifest.remote.template.json
files will be backed up in .backup
folder.
Since Teams Toolkit will use manifest.remote.template.json
as a single manifest template file after the upgrade, if you have customized the manifest.local.template.json
, you will need to update the manifest.template.json
to include your change.
Depending on how different the local and remote manifests are, there are two options you can do to make your project work as before.
- If the two manifest files only have config value difference, i.e., the keys are the same while values are different. You can add the different config value to
.fx/configs/config.local.json
. Teams Toolkit supports placeholder inmanifest.template.json
and{{config.manifest.xx}}
is customized placeholder whose value is resolved fromconfig.{env}.json
. - If the two manifest files’ structure are different, i.e., there are additional keys in previous local manifest than remote manifest file. We recommend you use different Git branches to manage it.
If anything went wrong after the upgrade process, you could restore your old project configuration files by:
- Copy the .backup/.fx folder to your project root path.
- Copy the .backup/templates folder to your project root path.
- Delete
config.local.json
andmanifest.template.json
if needed.
Scenario-based Tutorials
- Send notifications to Teams
- Respond to chat commands in Teams
- Respond to card actions in Teams
- Embed a dashboard canvas in Teams
Extend Teams app across Microsoft 365
- Create and test a personal tab across Microsoft 365
- Create and test a search-based message extension across Microsoft 365
Documentation
- Manage Application settings with Teams Toolkit
- Manage Microsoft Entra Application Registration with Teams Toolkit
How To Guides
- How to use an existing Microsoft Entra app
- How to use a multi-tenant Microsoft Entra app
- How to customize debug tasks
- How to connect to existing APIs
- How to add single sign on in Teams Toolkit for Visual Studio Code
- How to enable Single Sign-on in Teams Toolkit for Visual Studio
- How to configure Tab capability within your Teams app
- How to configure Bot capability within your Teams app
- How to configure an Outlook Add-in capability within your Teams app
- How to configure Message Extension capability within your Teams app
- How to automate ci/cd pipelines
- How to integrate Azure Functions with your Teams app
- How to integrate Azure API Management