-| User type | Tabs | Bots | Messaging extensions | Adaptive Cards | Task modules | In-meeting dialog | Meeting Stage |

-| :-- | :-- | :-- | :-- | :-- | :-- | :-- | :-- |

-| Anonymous user | Not available | Not available | Not available | Interactions in the meeting chat are allowed. | Interactions in the meeting chat from Adaptive Card are allowed. | Not available | Can view and interact with app on the meeting stage |

-| Guest, part of the tenant AAD | Interaction is allowed. Create, update, and delete aren't allowed. | Not available | Not available | Interactions in the meeting chat are allowed. | Interactions in the meeting chat from Adaptive Card are allowed. | Available | Can start, view, and interact with app on the meeting stage |

-| Federated user, for more information, see [non-standard users](/microsoftteams/non-standard-users). | Interaction is allowed. Create, update, and delete aren't allowed. | Interaction is allowed. Acquire, update, and delete aren't allowed. | Not available | Interactions in the meeting chat are allowed. | Interactions in the meeting chat from Adaptive Card are allowed. | Not available | Can start, view, and interact with app on the meeting stage |

-keywords: teams feedback developer questions issues contact support request bugs contributions community discussions

-Microsoft Teams community of developers use Stack Overflow to connect with other developers to ideate, get clarifications, and submit queries. In addition, you can also use one of the following contacts or sites, depending on the type of support required to submit your queries, doubts, or clarifications. You can also get product-specific information, such as issues, limitations, and general questions about Microsoft Teams:

-| **Support type** | **Contact** |

-|--||

-| **Bot and Messaging Extension SDK issues or suggestions** | Submit issues and feature requests to the SDK repository for your bot's language ([C#](https://github.com/Microsoft/botbuilder-dotnet/), [Javascript](https://github.com/Microsoft/botbuilder-js), or [Python](https://github.com/Microsoft/botbuilder-python)). Post How-to questions at [Stack Overflow](https://stackoverflow.com/questions/tagged/botframework%20microsoft-teams) using the `botframework & microsoft-teams` tag. |

-| **Community chat group** | Select **SIGN IN TO START TALKING** to join the informal community chat room for [Microsoft Teams app developers](https://gitter.im/OfficeDev/MicrosoftTeamsAppDev), if you are signing in for the first time. Select **JOIN ROOM** if you are already logged in. |

-| **Community support** | <ul><li> [Stack Overflow](https://stackoverflow.com/questions/tagged/microsoft-teams): Use the `botframework & microsoft-teams` tag to post the questions. You must follow the Stack Overflow guidelines, such as provide a descriptive title, a complete and concise problem statement, along with sufficient detail to reproduce your issue. Feature requests or broad questions are off-topic. If you are a new user, for more information, see Stack Overflow Help Center. </li> <li> [Microsoft Q&A](/answers/topics/office-teams-app-dev.html): Use the `office-teams-app-dev` tag to post questions. We love Stack Overflow and our extensive support is assured for customers who ask questions there. However, Stack Overflow has specific criteria about questions that are appropriate for the community and [Microsoft Q&A](/answers/topics/office-teams-app-dev.html) has an open policy regarding this. </li> </ul> |

-| **Teams Toolkit or TeamsFx SDK and CLI issues** | <ul><li> [Github Issues](https://github.com/OfficeDev/TeamsFx/issues) Create new issues on the [TeamsFx (Microsoft Teams Framework) GitHub repository](https://github.com/OfficeDev/TeamsFx) to report issues or raise feature request. We recommend to use Github Issues for queries and to receive support. <li> [Stack Overflow](https://stackoverflow.com/questions/tagged/teams-toolkit): Use the `teams-toolkit` tag to post questions. You can follow the Stack Overflow guidelines, such as provide a descriptive title, a complete and concise problem statement, along with sufficient detail to reproduce your issue. Feature requests or broad questions are off-topic. </li> </ul> |

-| **Documentation issues** | Select `This page` in the **Submit and view feedback** section available at the footer of the documentation, to open an [issue](https://github.com/MicrosoftDocs/msteams-docs/issues) on the Microsoft Teams documentation GitHub repository. |

-| **Documentation updates** | Select **Edit** in the article you want to update, and submit a pull request to the [Microsoft Teams documentation GitHub](https://github.com/MicrosoftDocs/msteams-docs) repository. |

-| **Features suggestions** | Post feature suggestions on [Microsoft Teams feedback portal on UserVoice](https://microsoftteams.uservoice.com/forums/555103-public-preview/category/182881-developer-platform). |

-| **General questions** |Send general questions about the Microsoft Teams developer platform to [Microsoft Teams Community Help](mailto:microsoftteamsdev@microsoft.com). We encourage posting questions on the channels mentioned here and use email only if no other mode of communication is applicable. |

-| **Samples** | Submit issues with samples to respective [Microsoft Teams Samples](https://github.com/OfficeDev/Microsoft-Teams-Samples) repository.|

-| **Tab SDK issues or suggestions** | Submit issues and feature requests to the SDK repository for [Microsoft Teams JavaScript Library](https://github.com/OfficeDev/microsoft-teams-library-js/issues). Use the `microsoft-teams` tag to post how-to questions about the SDK at [Stack Overflow](https://stackoverflow.com/questions/tagged/microsoft-teams). |

-## Product support channels

-The following table lists the support channels to submit Teams product related queries:

-| **Support type** | **Contact** |

-|--||

-| **Microsoft Teams product issues and failures** | Tenant Admin can reach out to [Microsoft 365 Product Support](/microsoft-365/admin/contact-support-for-business-products). |

-| **General questions about Microsoft Teams** | Submit your questions on [Microsoft Teams Community](https://answers.microsoft.com/en-us/msteams/forum). |

-> For the sign in experience to be hosted in a Teams pop-up window, the domain portion of the URL must be in your appΓÇÖs list of valid domains. For more information, see [validDomains](~/resources/schem#validdomains) in the manifest schema.

-# TeamsFx Command Line Interface

-TeamsFx CLI is a text-based command line interface that accelerates Teams application development. It aims you to provide keyboard-centric experience when building Teams applications. It also enables CI/CD scenario where CLI can be easily integrated in scripts for automation.

-Let's start by installing `teamsfx-cli` from `npm` and run `teamsfx -h` to check all available commands:

-## Supported Commands

-| `teamsfx` Commands | Descriptions |

-|:- |:-|

-| `teamsfx new` | Create a new Teams application. |

-| `teamsfx account` | Manage cloud service accounts. The supported cloud services are 'Azure' and 'Microsoft 365'. |

-| `teamsfx env` | Manage the environments. |

-| `teamsfx capability`| Add new capabilities to the current application. |

-| `teamsfx resource` | Manage the resources in the current application. |

-| `teamsfx provision` | Provision the cloud resources in the current application. |

-| `teamsfx deploy` | Deploy the current application. |

-| `teamsfx package` | Build your Teams app into a package for publishing. |

-| `teamsfx validate` | Validate the current application. |

-| `teamsfx publish` | Publish the app to Teams. |

-| `teamsfx preview` | Preview the current application. |

-| `teamsfx config` | Manage the configuration data. |

-`teamsfx new` will by default go into interactive mode and guide you through the process of creating a new Teams application by asking few questions. You can also do it in non-interactive mode by setting `--interactive` flag to `false`.

-| `teamsFx new` Commands | Descriptions |

-| Parameters | Required | Descriptions |

-|:- |:-|:-|

-|`--interactive`| No | Select the options interactively. Options are `true` and `false`. The default value is `true`.|

-|`--capabilities`| No| Choose Teams application capabilities, multiple Options are: `tab`, `bot`, `messaging-extension` and `tab-spfx`. The default value is: `tab`.|

-|`--programming-language`| No| Programming Language for the project. Options are `javascrip` or `typescript` and default value is: `javascript`.|

-|`--folder`| No | Project directory. A sub folder with the your app name will be created under this directory. The default value is: `./`.|

-|`--spfx-framework-type`| No| Applicable if `Tab(SPfx)` capability is selected. Frontend Framework. Options are `none` and `react`, the default value is: `none`.|

-|`--spfx-web part-name`| No | Applicable if `Tab(SPfx)` capability is selected. Web part Name. The default value is: "helloworld". |

-|`--spfx-web part-desp`| No | Applicable if `Tab(SPfx)` capability is selected. Web part Description. The default value is: "helloworld description". |

-|`--azure-resources`| No| Applicable if contains `tab` capability. Add Azure resources to your project. Options(Multiple) are `sql` (Azure SQL Database) and `function` (Azure Functions). |

-Using interactive mode to create a Teams app is super intuitive, please try it by starting with `teamsfx new`. The following are the few scenerios on controlling all the parameters:

-#### A tab app hosted on SPFx using React

-#### A Teams app in JavaScript contains tab, bot capabilities and Azure Functions

-#### A Teams tab app with Azure Functions and Azure SQL

-| `teamsFx account` Commands | Descriptions |

-| `teamsfx account login <service>` | Log in to the selected cloud service. |

-| `teamsfx account logout <service>` | log out of selected cloud service. |

-| `teamsfx account set --subscription` | Update account settings to set a subscription ID. |

-| `teamsfx env` Commands | Descriptions |

-| `teamsFx capability` Commands | Descriptions |

-| `teamsfx capability add tab` | Add a tab. |

-| `teamsfx capability add bot` | Add a bot. |

-| `teamsfx capability add messaging-extension` | Add a Messaging Extension. |

-> Once your project include a bot, messaging extension cannot be added any more and it applies vice versa. You can include both bot and messaging extensions in your project when creating a new Teams app project.

-| `teamsFx resource` Commands | Descriptions |

-| `teamsfx resource add <resource-type>` | Add a resource into current application.|

-| Parameters | Required | Descriptions |

-|:- |:-|:-|

-|`--function-name`| Yes | Provide a function name. The default value is: `getuserprofile`. |

-| Parameters | Required | Descriptions |

-|`--function-name`| Yes | Provide a function name. The default value is: `getuserprofile`. |

-> Function name is verified as SQL needs to be accessed from server workload. If your project doesn't contain `Azure Functions`, it will created one for you.

-> Below options will take effect when you try to use an existing `APIM` instance. By default, you don't have to specify any options and it will create a new instance during `teamsfx provision` step.

-| Parameters | Required | Descriptions |

-|`--apim-service-name`| Yes | The name of the API Management service instance. |

-|`--function-name`| Yes | Provide a function name. The default value is: `getuserprofile`. |

-> We ask for function name because `Azure API Management` needs to work with `Azure Functions`. If your project doesn't contain `Azure Functions` we will create one for you.

-| Parameters | Required | Descriptions |

-This command is used to deploy the current application. By default it will deploy entire project but it's also possible to deploy partially. Options(Multiple) are: `frontend-hosting`, `function`, `apim`, `teamsbot`, `spfx`.

-| Parameters | Required | Descriptions |

-|`--open-api-document`| No | Applicable when there is APIM resource in the project. The Open API document file path. |

-|`--api-prefix`| No | Applicable when there is APIM resource in the project. The API name prefix. The default unique name of the API will be `{api-prefix}-{resource-suffix}-{api-version}`. |

-Validate current application. This command will validate your application's manifest file.

-`--env`: (Required) Select an existing environment for the project.

-`--env`: (Required) Select an existing environment for the project.

-| Parameters | Required | Descriptions |

-|`--env`| No | Select an existing environment for the project when parameter `--remote` appended. |

-|`--browser`| No | The browser to open Teams web client. Options are `chrome`, `edge` and `default` (system default browser). The default value is `default`. |

-|`--browser-arg`| No | Argument to pass to the browser, requires --browser, can be used multiple times (e.g. --browser-args="--guest") |

-|`--sharepoint-site`| No | SharePoint site URL, like `{your-tenant-name}.sharepoint.com` (only for SPFx project remote preview). |

-> [!Note]

-> The logs of the background services like React will be saved in `~/.fx/cli-log/local-preview/`.

-| `teamsfx config` Commands | Descriptions |

-| Parameters | Required | Descriptions |

-|`--folder`| No | Project directory. This is used when get/set project configuration. The default value is: `./`. |

-|`--global`| No | Cope of configuration. If this is true, the scope is limited to user scope instead of project scope. The default value is: `false`. Currently supported global configurations including: `telemetry`, `validate-dotnet-sdk`, `validate-func-core-tools`, `validate-node`. |

-Secrets in `.userdata` file are encrypted, `teamsfx config` could help you view / update these values.

-There are three configs to turn on/off Node.js, .NET SDK and Azure Functions Core Tools validation, and all of them are enabled by default. You are able to set the config to "off" if you do not need the dependencies validation and would like to install the dependencies by yourself. Check the [Node.js installation guide](https://github.com/OfficeDev/TeamsFx/blob/dev/docs/vscode-extension/envchecker-help.md#how-to-install-nodejs), [.NET SDK installation guide](https://github.com/OfficeDev/TeamsFx/blob/dev/docs/vscode-extension/envchecker-help.md#how-to-install-net-sdk) and [Azure Functions Core Tools installation guide](https://github.com/OfficeDev/TeamsFx/blob/dev/docs/vscode-extension/envchecker-help.md#how-to-install-azure-functions-core-tools).

-For example, to disable .NET SDK validation, you can use the following command.

-To enable .NET SDK validation, you can use the following command.

-The secret will automatically decrypted:

-TeamsFx CLI provides `teamsFx permission` Commands for collaboration scenario.

-| `teamsFx permission` Commands | Descriptions |

-| Parameters | Required | Descriptions |

-|`--email`| Yes | Provide collaborator's Microsoft 365 email address. Note that the collaborator's account should be in the same tenant with creator. |

-| Parameters | Required | Descriptions |

-|`--list-all-collaborators` | No | With this flag, Teams Toolkit CLI will print out all collaborators for this project. |

-Here are some examples, for better handling permission for `TeamsFx` projects.

-After successfully granted permission, project creator and collaborators can share the project with the new collaborator by Github, and the new collaborator will have all permission for Microsoft 365 account.

- 

- 

-TeamsFx aims to reduce you the tasks of implementing identity and access to cloud resources down to single-line statements with "zero configuration".

- * [Source code](https://github.com/OfficeDev/TeamsFx/tree/main/packages/sdk)

- * [Package (NPM)](https://www.npmjs.com/package/@microsoft/teamsfx)

- * [API reference documentation](https://aka.ms/teamsfx-sdk-help)

- * [Samples](https://github.com/OfficeDev/TeamsFx-Samples)

-For more information on Teams app project, see [README](https://github.com/OfficeDev/TeamsFx/blob/main/packages/vscode-extension/README.md).

-> [!TIP]

-> A project created by TeamsFx toolkit VS Code extension or CLI tool.

-### Create and authenticate a `MicrosoftGraphClient`

-To create a graph client object to access the Microsoft Graph API, you will need the credential to do authentication. The SDK provides several credential classes to choose that meets various requirements.You need to load configuration before using any credentials.

-Use the snippet below:

-> [Note]

-> You can only use this credential class in browser application like Teams Tab App.

-It doesn't require the interaction with Teams App user. You can call Microsoft Graph as application.

-Use the snippet below:

-There are 3 credential classes located under [credential](https://github.com/OfficeDev/TeamsFx/tree/main/packages/sdk/src/credential) folder to help simplifying authentication.

-Credential classes implement `TokenCredential` interface that is broadly used in Azure library APIs. They are designed to provide access token for specific scopes.

-The credential classes represent different identity under certain scenarios.

-`TeamsUserCredential` represent Teams current user's identity. Using this credential will request user consent at the first time.

-`M365TenantCredential` represent Microsoft 365 tenant identity. It is usually used when user is not involved like time-triggered automation job.

-`OnBehalfOfUserCredential` uses on-behalf-of flow. It needs an access token and you can get a new token for different scope. It's designed to be used in Azure Function or Bot scenarios.

-Bot related classes are stored under [bot](https://github.com/OfficeDev/TeamsFx/tree/main/packages/sdk/src/bot) folder.

-`TeamsBotSsoPrompt` has a good integration with Bot framework. It simplifies the authentication process when you develop bot application.

-TeamsFx SDK provides helper functions to ease the configuration for third-party libraries. They are located under [core](https://github.com/OfficeDev/TeamsFx/tree/main/packages/sdk/src/core) folder.

-API will throw `ErrorWithCode` if error happens. Each `ErrorWithCode` contains error code and error message.

-For example, to filter out specific error, you could use the following check:

-And if credential instance is used in other library like Microsoft Graph, it's possible that error is caught and transformed.

-The following sections provide several code snippets covering some of the most common scenarios:

-You can set customer log level and redirect outputs when using this library.

-Logging is turned off by default, you can turn it on by setting log level.

-When log level is set, logging is enabled. It prints log information to console by default.

-Set log level using the snippet below:

-Note that log function will not take effect if you set a custom logger.

-Multiple developers can work together to debug, provision and deploy for the same TeamsFx project, but it requires manually setting the right permissions of Teams App and AAD App, which is not easy to do.

-Teams Toolkit now supports collaboration feature to allow a developer (project owner) to invite other developers (collaborators) to the TeamsFx project to debug, provision and deploy the same TeamsFx project.

- To provision cloud resources in Azure and Microsoft 365, you must have the following accounts with proper permissions. Refer to [Prepare accounts to build Teams app](accounts.md) for more information.

- * Microsoft 365

-> You should already have a Teams app project opened in VS code.

-### As a project owner

-* In **ENVIRONMENT** section on Teams Toolkit, mouse over environment name to find **Collaborators** buttons, one is **Add M365 Teams App (with AAD App) Owners** button, the other one is **List M365 Teams App (with AAD App) Owners** button as shown in the following image:

- 

-* Select **Add M365 Teams App (with AAD App) Owners** button and add another M365 account email address as collaborator. The account to be added **must be on the same tenant as project owner for remote debug** as shown in the image:

- 

-* To view collaborators in current environment, select **List M365 Teams App (with AAD App) Owners** button, then collaborators will be listed in the output channel as shown in following image:

- 

-> Newly added collaborator will not receive any notification. Project owner needs to notify collaborator.

-### As a project collaborator

-* Clone the project from GitHub

-* Login M365 account

-> [!NOTE]

-> Collaborators should log in using the account added by project owner which is **under the same tenant with project owner**.

-* Login Azure account which has contributor permission for all the Azure resources being used in this project.

-* Working on project code, then deploy the project to remote when you think it's time to preview your Teams app.

-* Launch remote to have a preview of the Teams app. For more information, see [build and run your Teams app in remote environment](/microsoftteams/platform/sbs-gs-javascript?tabs=vscode%2Cvsc%2Cviscode%2Cvcode&tutorial-step=3&branch).

-### Limitations

-> Azure related permissions should be set manually by Azure subscription administrator on Azure portal. Azure account should have contributor role for the subscription at least so that developers can work together to provision and deploy TeamsFx project.

-1. **Cannot delete**:

-You cannot remove collaborators directly from Teams Toolkit extension. Follow the below steps to remove collaborators manually:

- 1. Go to [Teams Developer Portal](https:// dev.teams.microsoft.com/apps), find your Teams App by name or app id.

- 2. Inside the Teams App management page, select **Owners** from left panel.

- 3. Find and remove the collaborator.

- 4. Go to [Azure Active Directory](https://ms.portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/RegisteredApps), select **App registration** from left panel, and find your AAD App.

- 5. Inside the AAD App management page, select **Owners** from left panel.

- 6. Find and remove the collaborator.

-1. Collaborator added to your project will not receive any notification. Project owner needs to notify collaborator offline.

-> [!div class="nextstepaction"]

-> [Provision cloud resources](provision.md)

-> [!div class="nextstepaction"]

-> [Deploy Teams app to the cloud](deploy.md)

-> [!div class="nextstepaction"]

-> [Manage multiple environments](TeamsFx-multi-env.md)

-# Customize Teams App Manifest in Teams Toolkit

-Teams Toolkit consists of two manifest template files under `templates/appPackage` folder:

-> You should already have a Teams app project opened in VS code.

-During provision, Teams Toolkit will load manifest from `manifest.remote.template.json`, combined with configurations from `state.{env}.json` and `config.{env}.json`. Then it creates a teams app in [Dev Portal](https://dev.teams.microsoft.com/apps) with this manifest.

-During local debug, Teams Toolkit will load manifest from `manifest.local.template.json`, combined with configurations from `localSettings.json`. Then it creates a teams app in [Dev Portal](https://dev.teams.microsoft.com/apps) with this manifest.

- - You can add a customized parameter by following:

- Besides each config placeholder in `manifest.remote.template.json`, there is a `Go to config file` button. You can navigate to configuration file by selecting it as shown in the image:

- 

-`{{localSettings.xx}}` is pre-defined placeholder whose value is resolved by Teams Toolkit, defined in `localSettings.json`. You should not modify the values in localSettings.json.

- > Customization of local manifest is not suggested.

-> [!div class="nextstepaction"]

-> [Preview Teams App Manifest in Teams Toolkit](TeamsFx-manifest-preview.md)

-# Preview Teams app Manifest in Teams Toolkit

-After scaffolding, you get two manifest template files under `templates/appPackage` folder.

-These template files containing some placeholders, and the actual values from Teams Toolkit will be resolved in files under `.fx/configs` and `.fx/states`.

-> You should already have a Teams app project opened in VS code.

-## Preview Manifest

-To preview manifest with real content, Teams Toolkit will generate preview manifest files under `build/appPackage` folder:

-### Local debug Teams app

-To preview manifest file of local teams app, you need to press **F5** to run local debug first. This step will generate default local settings for you, then the app package and preview manifest will be built under **build/appPackage** folder.

-The other ways are:

-The preview local appears as shown in the following image:

-

-### Remote environment

-To preview manifest file of remote teams app, you need to select **Provision in the cloud** in DEVELOPMENT panel of Teams Toolkit extension Treeview, or trigger **Teams: Provision in the cloud** from command palette first. This step will generate configurations for remote teams app, then the app package and preview manifest will be built under **build/appPackage** folder.

-The other ways are:

-

-> If there are more than one environment, you need to select the env you want to preview as shown in the image:

-

-## Sync local changes to Dev Portal

-After previewing the manifest file, you can sync your local changes to Dev Portal by the following ways:

-

-

-> Trigger from editor codelens or title button will update current manifest file to Teams platform. Trigger from command palette will require selecting target environment.

-If the manifest file is outdated due to configuration file change or template change, user will be asked to confirm their action:

-

-> [!div class="nextstepaction"]

-> [Customize Teams App Manifest in Teams Toolkit](TeamsFx-manifest-customization.md)

- Teams Toolkit provides a simple way for developers to create and manage multiple environments, provision, and deploy artifacts to the target environment for Teams App.

- With multiple environments, developers can:

-1. **Test before production**: It is a common practice to set up multiple environments (dev, test, staging) before publishing a Teams App to production environment in modern app development lifecycle.

-2. **Manage app behaviors in different environments**: Developers can set different behaviors for different environment such as developers may want to enable telemetry in production environment but disable it in development environment.

->[!TIP]

-> You should already have a Teams app project opened in VS code.

-To add another remote environment, select the Teams icon in the sidebar, click the Plus button under Environment section, and follow the questions to create as shown in the following image:

-

-> If you have more than one existing environments, you will need to select an existing environment to create the environment. The command will copy file contents of `config.<newEnv>.json` and `azure.parameters.<newEnv>.json` from the existing environment you selected to the new environment being created.

-With environment concept introduced in Teams Toolkit, for all environment-related operations, you can select the target environment to perform the operations against. The toolkit will prompt and ask for a target environment when you have multiple remote environments as shown in the following image:

-

-After creating the project, you can view the project folders and files in the Explorer area of Visual Studio Code. Besides the custom codes, some files are used by Teams Toolkit to maintain the config, state, and template of the app. Following list those files and outlines their relationship with multiple environments.

- - `azure.parameters.<envName>.json`: per-environment parameters file for Azure BICEP provision.

- - `azure`: BICEP template files.

-Teams Toolkit allows you to change the config files and template files to customize the resource provision in each environment.

-The table below lists the common scenarios supported for customized provision and where to customize:

-| Scenarios | Where to customize | How to customize |

-| Customize Azure Resource | <ul> <li>BICEP files under `templates/azure`.</li> <li>`.fx/azure.parameters.<envName>.json`.</li></ul> | Refer to [customize ARM parameters and templates](provision.md#customize-arm-parameters-and-templates) for more details. |

-| Reusing existing AAD app for Teams app | <ul> <li>`auth` section in`.fx/config.<envName>.json`.</li> </ul> | Refer to [use an existing AAD app for your Teams app](provision.md#use-an-existing-aad-app-for-your-teams-app) for more details. |

-| Reusing existing AAD app for bot | <ul> <li>`bot` section in`.fx/config.<envName>.json`.</li> </ul> | Refer to [use an existing AAD app for your bot](provision.md#use-an-existing-aad-app-for-your-bot) for more details. |

-| Skip adding user when provisioning SQL | <ul> <li>`skipAddingSqlUser` property in`.fx/config.<envName>.json`.</li> </ul> | Refer to [skip adding user for SQL database](provision.md#skip-adding-user-for-sql-database) for more details. |

-| Customize App Manifest | <ul> <li>`templates/manifest.remote.template.json`.</li> <li>`manifest` section in`.fx/config.<envName>.json`.</li> </ul> | Refer to [customize Teams App Manifest in Teams Toolkit](TeamsFx-manifest-customization.md) for more details. |

-### Scenario 1: customize Teams App name for different environment

-In this example, you will learn how to set the Teams app name to `myapp(dev)` for the default environment `dev` and `myapp(staging)` for the staging environment `staging`.

-Follow the steps for customization:

- Updates to `.fx/configs/config.dev.json`:

-In this scenario, you will learn how to set different Teams App description for different environments:

-Steps to do the customization:

- Updates to `.fx/configs/config.dev.json`

- Updates to `manifest.remote.template.json`:

- "short": "{{config.manifest.description.short}}",

- Updates to `manifest.remote.template.json`:

-You can customize Azure resources for each environment, for example specifying Azure Function name, by editing the environment corresponding `.fx/configs/azure.parameters.{env}.json` file.

-For more information on BICEP template and parameter files, see [provision cloud resources](provision.md)

-> [!div class="nextstepaction"]

-> [Provision cloud resources](provision.md)

-> [!div class="nextstepaction"]

-> [Add more cloud resources](add-resource.md)

-> [!div class="nextstepaction"]

-> [Collaborate with other developers on Teams project](TeamsFx-collaboration.md)

-To develop a Teams app, at least one Microsoft 365 account with a valid subscription is needed. If you want to host your backend resources on Azure, an Azure account is also needed. Azure account is optional if your existing application is hosted on other cloud provider and you want to integrate the existing application to Teams platform.

-## Microsoft 365 Account

-If you donΓÇÖt have an existing Microsoft 365 account with a valid subscription, you can create one by joining the [Microsoft 365 developer program](https://developer.microsoft.com/microsoft-365/dev-program). The Microsoft 365 Developer Program includes a Microsoft 365 E5 developer subscription that you can use to create your own sandbox and develop solutions independent of your production environment.

-If you wish to host your app related resources or access resources **within Azure**, you must have an Azure subscription. You can [create a free account](https://azure.microsoft.com/free/) before you begin.

-## Join Microsoft 365 Developer program

-2. Select **Join Now** and follow the onscreen instructions.

-3. In the welcome screen, select **Set up E5 subscription**.

-## Accounts for Microsoft 365 Developer Program

-You can create for personal use - Provides access to all consumer-oriented Microsoft products and cloud services, such as Outlook, Messenger, OneDrive, MSN, Xbox Live, or Microsoft 365. Signing up for an Outlook.com mailbox automatically creates a Microsoft account. After a Microsoft account is created, it can be used to access consumer-related Microsoft cloud services or Azure.

- Admin can issue for business use - Provides access to all small, medium, and enterprise business-level Microsoft cloud services, such as Azure, Microsoft Intune, or Microsoft 365. When you sign up to one of these services as an organization, a cloud-based directory is automatically provisioned in Azure Active Directory to represent your organization.

-You can create for your Visual Studio Professional or Enterprise subscriptions - We recommend that you use this option to join the developer program from within the Visual Studio Gallery to get the full benefits as a Visual Studio subscriber.

-## Teams customer app uploading (sideloading permission) check

-One of the ways to check if you have a Teams account, verify if you can sideload apps in Teams:

-1. In the Teams client, select **Apps** in left bar.

-2. Select **Manage your apps**.

-3. Check whether you can see the option **Upload a custom app** as shown in the image:

-If you cannot see **Upload a custom app** option, this indicates that you don't have sideloading permission. Without sideloading permission, you wonΓÇÖt be able to do any local/remote debugging. So itΓÇÖs very important to get the sideloading permission for your account before you do any debugging for your Teams app. If you are admin for your tenant, you can open the sideloading setting for your tenant/organization, while if you are not admin, please contact your tenant admin for the permission.

-## Enable custom app uploading (sideloading) for your organization

-5. Select **Save**. Your test tenant can permit custom app sideloading.

-> It can take up to 24 hours for the sideloading to be active. In the meantime, you can use **[upload for your tenant]** to test your app. To upload the .zip package file of the app, see [upload custom apps](/microsoftteams/teams-app-setup-policies).

-> [!div class="nextstepaction"]

-> [Create new Teams project](create-new-project.md)

-> [!div class="nextstepaction"]

-> [Provision cloud resources](provision.md)

-You can start to create a Teams app with one of the Teams app capabilities. During app development, you can use Teams Toolkit to flexibly add more capabilities to your Teams app. The following table describes the Teams app capabilities:

-> You should already have a Teams app project opened in VS code.

-1. Select **Teams Toolkit** from left panel:

- 

-

- 

- You can also open the command palette and enter **Teams: Add Capabilities**:

- > [!NOTE]

- > This is an equivalent to trigger from Tree View.

- 

-1. From the pop-up, select the capabilities to include into your project:

- 

-## Add capabilities Using TeamsFx CLI in Command Window

- |To add a tab|`teamsfx capability add tab`|

- |To add a bot|`teamsfx capability add bot`|

- |To add a messaging extension|`teamsfx capability add messaging-extension`|

-Apart from the capabilities your Teams app already have, you can choose to add different capabilities to your Teams app.The following table gives various supported Teams app capabilities:

-|Existing capabilities|Other capabilities can be added|

-## What happens when you add capabilities

-After adding bot and messaging extension, the following changes in your project are:

-After added tab, the following changes in your project are:

-Currently, there are limitations with TeamsFx when adding more capabilities. The limitations are as follows:

-> If you want to include both bot and messaging extension capabilities, then select them at the same time. You can add them either when you create a new project or a tab application.

-> [!div class="nextstepaction"]

-> [Provision cloud resources](provision.md)

-> [!div class="nextstepaction"]

-> [Create new Teams project](create-new-project.md)

-> You should already have a Teams app project.

-1. Select **Teams Toolkit** from left panel:

- 

- 

- You can also open the command palette and enter **Teams: Add cloud resources**:

-

- > [!NOTE]

- > Follow the same process as itΓÇÖs triggered from Tree View:

- 

-1. From the pop-up, select any cloud resources you want to add to your Teams app project:

- 

-## Add cloud resources using TeamsFx CLI in Command Window

-1. Change directory to your **project directory**.

-1. Execute command to add different capabilities.

-The following table describes cloud resources and the corresponding commands to add them:

-|Cloud Resources|Command|

-## What cloud resources can be added

-TeamsFx provides seamless integrations with Azure services that are common for the following application scenarios:

-## What happens when you add resources

-The following changes will happen to your project when you add any resources:

-In the meanwhile, there're some additional changes for each kind of resource:

-|Resources Added|What changed|Why these changes are made|

-|Azure Functions|An Azure Functions template code is added into a subfolder with path `yourProjectFolder/api`</br></br>`launch.json` and `task.json` updated under `.vscode` folder.| Include a hello world http trigger template into your project.</br></br> To include necessary scripts for Visual Studio Code executed when you want to debug your application locally.|

-|Azure API Management|An Open API Specification file added into a subfolder with path `yourProjectFolder/openapi`|This is the API specification file defines your API after publishing.|

-> [!div class="nextstepaction"]

-> [Provision cloud resources](provision.md)

-You can either **Create new project** or **Create from samples**, to use the Teams Toolkit for Teams app building.

-The following steps guide to create a new Teams app project using Teams Toolkit:

-If you don't want to start with "hello world" application, you can try to explore **sample gallery** and find something you are interested to start your own work with. The following steps help you to create apps from samples:

- 1. Select **View samples**. The sample gallery appears.

-In the sample gallery, you can explore samples and download as shown in following image:

-

-You can download and either run apps locally or remotely to preview in Teams web client. Follow the instructions of each sample or browse the source code of samples by selecting **View on GitHub**. Then,you can open source repo for Samples.

-> [!div class="nextstepaction"]

-> [Provision cloud resources](provision.md)

-> [!div class="nextstepaction"]

-> [Deploy Teams app to the cloud](deploy.md)

-> [!div class="nextstepaction"]

-> [Publish your Teams app](TeamsFx-collaboration.md)

-> [!div class="nextstepaction"]

-> [Manage multiple environments](TeamsFx-multi-env.md)

-> [!div class="nextstepaction"]

-> [Collaborate with other developers on Teams project](TeamsFx-collaboration.md)

-* The Tab, such as frontend applications are deployed to Azure storage and configured for static web hosting or a SharePoint site.

-* The backend APIs are deployed to Azure Functions.

-* The Bot or Messaging Extension is deployed to Azure App Service.

-> [!TIP]

-> You should already have a Teams app project opened in VS code.

-> Before you deploy project code to cloud, perform the [provision cloud resources](provision.md) steps first.

-In Get started tutorials, there are step-by-step guides of how to deploy using Teams Toolkit. You can use the following to deploy your Teams app:

-## Details on Teams app workloads

-| Teams App Workloads| Source Code | Build Artifacts| Target Resources |

-|Tabs with React </br> The frontend workload| `yourProjectFolder/tabs`| `tabs/build` |Azure Storage |

-|APIs on Azure Functions </br> The backend workload | `yourProjectFolder/api`| N/A |Azure Functions |

-|Bots and messaging extensions </br> The backend workload | `yourProjectFolder/bot` | N/A | Azure App Service |

-> When you include Azure API management resource in your project and trigger deploy. You can publish your APIs in Azure Functions to Azure API Management Service.

-> [!div class="nextstepaction"]

-> [Add more cloud resources](add-resource.md)

-> [!div class="nextstepaction"]

-> [Add more Teams app capabilities](add-capability.md)

-> [!div class="nextstepaction"]

-> [Deploy project code with CI/CD pipelines](use-CICD-template.md)

-> [!div class="nextstepaction"]

-> [Manage multiple environments](TeamsFx-multi-env.md)

-> [!div class="nextstepaction"]

-> [Collaborate with other developers on Teams project](TeamsFx-collaboration.md)

-TeamsFx provides seamless integration with Azure and Microsoft 365 cloud that allows you to place your application in Azure with a single command. TeamsFx integrates with Azure Resource Manager that enables you to declaratively provision Azure resources your application needs using infrastructure as code approach.

- To provision cloud resources, you must have the following accounts with proper permissions. For more information, see [prepare accounts to build Teams app](accounts.md).

- * Microsoft 365

-> You should already have a Teams app project opened in VS code.

-When you create a new project, you get all the Azure resources to be created. The generated ARM template defines all the Azure resources and helps to create required Azure resources during provision. When you [adds new capability/resource](./add-resource.md) to an existing project, the updated ARM template reflects the latest change.

-> Azure services incur costs in your subscription, you can refer to [pricing calculator](https://azure.microsoft.com/pricing/calculator/) to understand an estimate.

-|Resources|Purpose of this resource| Notes |

-| Azure Storage | Host your tab app | Enables static web app feature to host your tab app |

-| App Service Plan for Simple Auth | Host the web app of Simple Auth | |

-| Web App for Simple Auth | Host simple auth server that helps you gain access to other services in your single page application | Adds user assigned identity to make it easy to access other Azure resources |

-| User Assigned Identity | Authenticate Azure service-to-service requests | Shared across different capabilities and resources |

-### Resources created for Teams Bot or Messaging Extension application

-|Resources|Purpose of this resource| Notes |

-| Azure Bot Service | Registers your app as a bot with the Bot Framework | Connects the bot to Teams |

-| App Service Plan for Bot | Host the web app of Bot | |

-| Web App for Bot | Host your bot app | Adds user assigned identity to make it easy to access other Azure resources. <br /> Adds app settings required by [TeamsFx SDK](https://www.npmjs.com/package/@microsoft/teamsfx) |

-| User Assigned Identity | Authenticate Azure service-to-service requests | Shared across different capabilities and resources |

-### Resources created when including Azure Functions in the project

-|Resources|Purpose of this resource| Notes |

-| App Service Plan for Function App | Host the Function App | |

-| Function App | Host your Azure Functions APIs | Adds user assigned identity to make it easy to access other Azure resources. <br /> Adds CORS rule to allow requests from your tab app <br /> Adds authentication setting that only allows requests from your Teams app. <br /> Adds app settings required by [TeamsFx SDK](https://www.npmjs.com/package/@microsoft/teamsfx) |

-| Azure Storage for Function App | Required when creating Function App | |

-| User Assigned Identity | Authenticate Azure service-to-service requests | Shared across different capabilities and resources |

-### Resources created when including Azure SQL in the project

-|Resources|Purpose of this resource| Notes |

-| Azure SQL Server | Host the Azure SQL Database instance | Allows all Azure services to access the server |

-| Azure SQL Database | Store data for your app | Grants user assigned identity read/write permission to the database |

-| User Assigned Identity | Authenticate Azure service-to-service requests | Shared across different capabilities and resources |

-### Resources created when including Azure API Management in the project

-| Azure Active Directory application for API Management service | Allows Microsoft Power Platform access APIs managed by API Management service |

-| API Management Service | Manage your APIs hosted in Function App |

-| API Management Product | Group your APIs, define terms of use and runtime policies |

-| API Management OAuth Server | Enables Microsoft Power Platform to access your APIs hosted in Function App |

-Teams Toolkit enables you to use an infrastructure as code approach to define what Azure resources you want to provision, and how you want to configure them. The tooling uses ARM template to define Azure resources. The ARM template is a set of bicep files that defines the infrastructure and configuration for your project. You can customize Azure resources created by modifying the ARM template. For more information, see [bicep document](/azure/azure-resource-manager/bicep.md). Provision with ARM involves changing following two sets of files, parameters and templates:

-* ARM parameter files (`azure.parameters.{your_env_name}.json`) are located at `.fx/configs` folder, for passing parameters to templates.

-| File | What does it do | Allow customization |

-| provision.bicep | Create and config Azure resources | Yes |

-| provision/xxx.bicep | create and config each Azure resource consumed by `provision.bicep` | Yes |

-> when you add resources or capabilities to your project, `teamsfx/xxx.bicep` will be regenerated. That's why it's marked as not customizable. If you really have requirement to modify these bicep files, we recommend to use Git to track your changes to `teamsfx/xxx.bicep` files so you won't lose your changes while adding resources or capabilities.

-The toolkit provides a set of predefined parameters for you to customize the Azure resources. The parameter files are located at `.fx/configs/azure.parameters.{env}.json` and all the available parameters are defined in the `provisionParameters` property. It's preferred to customize the parameter files if the predefined parameters satisfies your requirement.

-Here's a list of predefined parameters available:

-| Parameter name | Default Value | What can be customized by the parameter | Value constraints |

-| simpleAuthServerFarmsName | ${resourceBaseName}simpleAuth | Name of Simple Auth App Service Plan | 1-40 alphanumerics and hyphens |

-| simpleAuthWebAppName | ${resourceBaseName}simpleAuth | Name of Simple Auth Web App | 2-60 alphanumerics and hyphens <br /> Cannot start or end with hyphen |

-| simpleAuthSku | F1 | SKU of Simple Auth App Service Plan | |

-| frontendHostingStorageName | ${resourceBaseName}tab | Name of Frontend Hosting Storage Account | 3-24 lowercase letters and numbers |

-| frontendHostingStorageSku | Standard_LRS | SKU of Frontend Hosting Storage Account | Please refer this [page](/azure/templates/microsoft.storage/storageaccounts?tabs=bicep&branch) for available SKUs |

-| functionServerfarmsName | ${resourceBaseName}api | Name of Function App's App Service Plan | 1-40 alphanumerics and hyphens |

-| functionServerfarmsSku | Y1 | SKU of FUnction App's App Service Plan |

-| functionAppName | ${resourceBaseName}api | Name of Function App | 2-60 alphanumerics and hyphens <br /> Cannot start or end with hyphen |

-| functionStorageName | ${resourceBaseName}api | Name of Function App's Storage Account | 3-24 lowercase letters and numbers |

-| functionStorageSku | Standard_LRS | SKU of Function App's Storage Account | Please refer this [page](/azure/templates/microsoft.storage/storageaccounts?tabs=bicep&branch=pr-en-us-4713)for available SKUs |

-| botServiceName | ${resourceBaseName} | Name of Azure Bot service | 2-64 alphanumerics, underscores, periods, and hyphens <br /> Start with alphanumeric |

-| botServiceSku | F0 | SKU of Azure Bot service | Please refer this [page](/azure/templates/microsoft.botservice/2021-05-01-preview/botservices?tabs=bicep&branch) for available SKUs |

-| botServerfarmsName | ${resourceBaseName}bot | Name of Bot's App Service Plan | 1-40 alphanumerics and hyphens |

-| botWebAppName | ${resourceBaseName}bot | Name of Bot's Web App | 2-60 alphanumerics and hyphens <br /> Cannot start or end with hyphen |

-| botWebAppSKU | F1 | SKU of Bot App Service Plan | |

-| sqlServerName | ${resourceBaseName} | Name of Azure SQL Server | 1-63 lowercase letters, numbers, and hyphens <br /> Cannot start or end with hyphen |

-| sqlDatabaseName | ${resourceBaseName} | Name of Azure SQL Database | 1-128 characters, can't use <>*%&:\/? or control characters <br /> Can't end with period or space |

-| sqlDatabaseSku | Basic | SKU of Azure SQL Database | |

-| apimServiceName | ${resourceBaseName} | Name of APIM Service | 1-50 alphanumerics and hyphens <br /> Start with letter and end with alphanumeric |

-| apimServiceSku | Consumption | SKU of APIM Service | Please refer this [page](/azure/templates/microsoft.apimanagement/service?tabs=bicep&branch)for available SKUs |

-| apimProductName | ${resourceBaseName} | Name of APIM Product | 1-80 alphanumerics and hyphens <br /> Start with letter and end with alphanumeric |

-| apimOauthServerName | ${resourceBaseName} | Name of APIM OAuth Server | 1-80 alphanumerics and hyphens <br /> Start with letter and end with alphanumeric |

-In the meanwhile, following parameters are available with values populated during provision. The purpose of these placeholders is to ensure we can create new resources for you when you created a new environment. The actual values are resolved from `.fx/states/state.{env}.json`.

-| Microsoft 365 ClientId | {{state.fx-resource-aad-app-for-teams.clientId}} | Your app's AAD app client id created during provision | Refer [this section](#use-an-existing-aad-app-for-your-teams-app) to customize the value |

-| Microsoft 365 ClientSecret | {{state.fx-resource-aad-app-for-teams.clientSecret}} | Your app's AAD app client secret created during provision | Refer [this section](#use-an-existing-aad-app-for-your-teams-app) to customize the value |

-| Microsoft 365TenantId | {{state.fx-resource-aad-app-for-teams.tenantId}} | Tenant Id of your app's AAD app | Refer [this section](#use-an-existing-aad-app-for-your-teams-app) to customize the value |

-| Microsoft 365 OauthAuthorityHost | {{state.fx-resource-aad-app-for-teams.oauthHost}} | OAuth authority host of your app's AAD app | Refer [this section](#use-an-existing-aad-app-for-your-teams-app) to customize the value |

-| botAadAppClientId | {{state.fx-resource-bot.botId}} | Bot's AAD app client Id created during provision | Refer [this section](#use-an-existing-aad-app-for-your-bot) to customize the value |

-| botAadAppClientSecret | {{state.fx-resource-bot.botPassword}} | Bot's AAD app client secret created during provision | Refer [this section](#use-an-existing-aad-app-for-your-bot) to customize the value |

-| apimClientId | {{state.fx-resource-apim.apimClientAADClientId}} | APIM's AAD app client Id created during provision | Delete the placeholder and fill the actual value |

-Some times you may not want to hardcode the values in parameter files. For example, when the value is a secret. The parameter files support referencing the values from environment variables. You can use syntax `{{$env.YOUR_ENV_VARIABLE_NAME}}` in parameter values to tell the tooling that the value needs to be resolved from current environment variable.

-Following example will read the value of `mySelfHostedDbConnectionString` parameter from environment variable `DB_CONNECTION_STRING`:

-If the predefined templates does not meet your application requirement, you can customize the ARM templates under `templates/azure` folder. For example, you can customize the ARM template to create some additional Azure resources for your app. This is an advance scenario and requires you have basic knowledge of bicep language which is used to author ARM template. You can get started with bicep at [bicep documentation](/azure/azure-resource-manager/bicep/?branch).

-> The ARM template is shared by all environments. You can use [conditional deployment](/azure/azure-resource-manager/bicep/conditional-resource-deployment?branch) if the provision behavior various between environments.

-To ensure the TeamsFx tooling functions properly, please ensure your customized ARM template satisfies following requirement. If you use other tooling for further development, you can ignore these requirements.

-* Keep the folder structure and file name unchanged. The tool may append new content to existing files when you add more resources / capabilities to your project.

-* Keep the name of auto-generated parameters as well as its property names unchanged. The auto-generated parameters may be used when you add more resources / capabilities to your project.

-* Keep the output of auto-generated ARM template unchanged. You can add additional outputs to ARM template. The output will be persisted to `.fx/states/state.{env}.json` and used in other features like deploy, validate manifest file, etc.

-These are some common scenarios you can customize the provision behavior.

-After added above snippet, add your secret to related environment variable so the tooling can resolve the actual secret during provision.

-> You should not share one AAD app in multiple environments. If you do not have permission to update the AAD app, you will get a warning with instructions about how to manually update the AAD app. Please follow the instructions to update your AAD app after provision.

-You can add following configuration snippet to `.fx/configs/config.{env}.json` file to use an AAD app created by yourself for your bot.

-After added above snippet, add your secret to related environment variable so the tooling can resolve the actual secret during provision.

-> [!NOTE]

-> You should not share one AAD app in multiple environments.

-Sometimes you may get insufficient permission error when the tool tries to add user to SQL database. You can add following configuration snippet to `.fx/configs/config.{env}.json` file to skip adding SQL database user.

-This example, I will specify another name `contosoteamsappapi` for Function App instance instead of using the default name.

-> If you already provisioned the environment, specifying the name will create a new Function App instance for you, instead of renaming the instance created previously.

-3. Fill "contosoteamsappapi" as value of `functionAppName`

-4. The final parameter file is shown as following:

-**To add other Azure resource (Azure storage) to the application**

-Consider the scenario, you want to add Azure Storage to your Azure Function backend to store some blob data. There is no auto flow to update the bicep template with Azure Storage support. However, you can edit the bicep file and add the resource. The steps are as follows

-1. Create a tab project

-2. Add a function to the project. You can visit [Add Resources](./add-resource.md) to learn more about adding resources.

-3. Declare the new Storage Account in ARM template. For simplify, we will declare the resource at `templates/azure/provision/function.bicep` directly. You're free to declare the resources in other places.

-4. Update the Azure Function App Settings with Azure Storage connection string in `templates/azure/provision/function.bicep`, which is the same file in step 3. Add following snippet to `functionApp` resource's `appSettings` array.

-5. Now your can update your function with Azure Storage output bindings.

-If you met errors with Teams Toolkit in Visual Studio Code, you can click the `Get Help` button on the error notification to navigate to related help doc. If you're using TeamsFx CLI, there will be a hyper link at the end of error message that points to the help doc. You can also view [provision help doc](https://aka.ms/teamsfx-arm-help) directly.

-2. If you already provisioned current environment, you need to create a new environment and perform provision because ARM does not support moving resources.

-3. If you did not provision current environment, you can trigger provision directly.

-<summary><b>How can I provision SharePoint-based app?</b></summary>

-You can follow [Provision SharePoint-based app](/microsoftteams/platform/sbs-gs-spfx?tabs=vscode%2Cviscode&tutorial-step=4&branch) to provision SharePoint-based app.

-> Currently, the building Teams App with SharePoint Framework using Teams Toolkit doesn't have direct integration with Azure, contents in this doc does not apply to SPFx based apps.

-> [!div class="nextstepaction"]

-> [Deploy Teams app to the cloud](deploy.md)

-> [!div class="nextstepaction"]

-> [Manage multiple environments](TeamsFx-multi-env.md)

-> [!div class="nextstepaction"]

-> [Collaborate with other developers on Teams project](TeamsFx-collaboration.md)

-After creating the app, you can distribute your app to different scope, such as individual, team, organization, or anyone. The distribution depends on multiple factors, including needs, business and technical requirements, and your goal for the app. Distribution to different scope may need different review process. In general, the bigger the scope, the more review the app need to go through for security and compliance concerns.

-> You should already have a Teams app project.

-## Publish to individual scope (sideloading permission)

-Users can add custom app to Teams by uploading an app package in a .zip file directly to a team or in personal context. Adding a custom app by uploading an app package, also known as side loading, allows you test app as it's being developed, before it's ready to be widely distributed as mentioned in the following scenarios:

-* Test and debug an app locally yourself or with other developers.

-* Built an app just for yourself. For example, to automate a workflow.

-* You built an app for a small set of users, such as, your work group.

-It also lets you build an app for internal use only and share it with your team without submitting it to the Teams app catalog in the Teams app store.

-* Build your app to *.zip app package file

- You can build the app package by selecting `Zip Teams metadata package` from DEPLOYMENT panel in Treeview of Teams Toolkit. You may need to run `Provision in the cloud` at first. The generated app package will be located in `{your project folder}/build/appPackage/appPackage.{env}.zip` as shown in the following image:

- 

-When the app is ready for use in production, the developer can submit the app using the Teams App Submission API, called from Graph API, an integrated development environment (IDE) such as Visual Studio Code installed with Teams toolkit. You can either select **Publish to Teams** from DEPLOYMENT panel in TreeView of Teams Toolkit, or trigger **Teams: Publish to Teams** from command palette. Then select **Install for your organization** as shown in the following image:

-Doing this makes the app available on the Manage apps page of the Microsoft Teams admin center, where you, and the admin, can review and approve it.

-As an admin, the manage apps page in the [Microsoft Teams admin center](https://admin.teams.microsoft.com/policies/manage-apps) is where you view and manage all Teams apps for your organization. Here, you can see the org-level status and properties of apps, approve or upload new custom apps to your organization's app store, block or allow apps at the org level, add apps to teams, purchase services for third-party apps, view permissions requested by apps, grant admin consent to apps, and manage org-wide app settings.

-[Manage apps page in teams admin center](https://admin.teams.microsoft.com/policies/manage-apps)

-> Keep in mind that this doesn't publish the app to your organization's app store yet. This step submits the app to the Microsoft Teams admin center where you can approve it for publishing to your organization's app store.

-## Admin approval for submitted Teams apps

-The admin of your Teams tenant can then go to the Manage apps page in the Microsoft Teams admin center (in the left navigation, go to Teams apps > Manage apps), gives you a view into all Teams apps for your organization. The Pending approval widget at the top of the page lets you know when a custom app is submitted for approval.

-In the table, a newly submitted app automatically shows a Publishing status of Submitted and Status of Blocked. You can sort the Publishing status column in descending order to quickly find the app:

- 

-Select the app name to go to the app details page. On the About tab, you can view details about the app, including description, status, submitter, and app ID:

- 

-When you're ready to make the app available to users, follow the steps to publish the app:

-1. In the left navigation of the Microsoft Teams admin center, go to Teams apps > Manage apps.

-2. Select the app name to go to the app details page, and then in the Publishing status box, select Publish.

-After you publish the app, the Publishing status changes to Published and the Status automatically changes to Allowed.

-## Publish to Microsoft Store

-You can distribute your app directly to the store inside Microsoft Teams and reach millions of users around the world. If your app is also featured in the store, you can instantly reach potential customers.

-Apps published to the Teams store also automatically list on Microsoft AppSource, which is the official marketplace for Microsoft 365 apps and solutions.

-Understand the publishing process

-When you feel your app is production ready, you can begin the process of getting it listed on the Teams store.

->[!Tip]

-> Following the pre-submission steps closely can increase the possibility that Microsoft approves your app for publishing.

-

-* Review the Teams store validation guidelines to make sure your app meets Teams app and store standards.

-* Create a Partner Center developer account.

-* Prepare your store submission, which includes running automated tests, compiling test notes, creating a store listing, among other important tasks to help expedite the review process.

-* Submit your app through Partner Center.

-* Work with Microsoft directly to resolve the issues and resubmit your app (link to resolve the issues and resubmit your app).

-> [!div class="nextstepaction"]

-> [Manage multiple environments](TeamsFx-multi-env.md)

-> [!div class="nextstepaction"]

-> [Collaborate with other developers on Teams project](TeamsFx-collaboration.md)

-Teams Toolkit for Visual Studio Code helps the developers to create and deploy Teams apps with integrated identity, access to cloud storage, data from Microsoft Graph, and other services in Azure and Microsoft 365 with a zero-configuration approach to the developer experience.

-There is a Teams Toolkit for Visual Studio and a [CLI tool](https://github.com/OfficeDev/TeamsFx/blob/dev/docs/cli/user-manual.md) for Teams app development (called `teamsfx`).

-## Install the Teams Toolkit for Visual Studio Code

-1. Select the Extensions view (**Ctrl+Shift+X** / **⌘⇧-X** or **View > Extensions**).

-1. In the search box, enter **Teams Toolkit**.

-1. Select **install** button next to the Teams Toolkit.

-Or you can find the Teams Toolkit on the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=TeamsDevApp.ms-teams-vscode-extension).

-## Support Teams apps capabilities

-[Microsoft Teams app capabilities](../concepts/capabilities-overview.md) are Teams extensibility points.Teams Toolkit for Visual Studio Code supports developers to work on project with the following Teams App Capabilities:

-* [Tabs](../tabs/what-are-tabs.md#build-tabs-for-microsoft-teams)

-* [Bots](../bots/what-are-bots.md#bots-in-microsoft-teams)

-* [Messaging extensions](../messaging-extensions/what-are-messaging-extensions.md#messaging-extensions)

-Your Teams project can contain either one of the capabilities or all three capabilities from above. You can select any capability when you create the Teams Project.

-

-Teams Toolkit provides flexibility to add more capabilities in further process of Teams app development.

-

-Teams Toolkit provides features of Teams app development to make it easy to debug, deploy, and publish. Teams Toolkit automates manual work and provides great integration of Teams and Azure resources. The following picture shows Teams Toolkit user journey:

-If you don't open any Teams project in VS Code, or you open any project that is not created using Teams Toolkit v2.+, you will see the Teams Toolkit UI with limited functionalities as shown in following image:

-You can select **Quick Start** to explore the Teams Toolkit, or select **Create a new Teams App** to create one Teams project. If you have a Teams Project created by Teams Toolkit v2.+ opened in VS Code, you will see Teams Toolkit UI with more functionalities as shown in the following image:

-Let's take a tour of functionalities that are available in Teams Toolkit:

-* [Accounts](#accounts)

-* [Environment](#environment)

-* [Development](#development)

-* [Deployment](#deployment)

-* [Help and Feedback](#help-and-feedback)

-### Accounts

-Developers must have a Microsoft 365 account to build Teams app. If you don't have one, you can get free Teams developer account by joining the [Microsoft 365 developer program](https://developer.microsoft.com/microsoft-365/dev-program):

-

-Azure account is commonly used in Teams app development. If you wish to host your Teams app or access resources on Azure, you must have an Azure account. Teams Toolkit support integrated experience to sign in, provision and deployment for Azure resources. You can [create a free Azure account](https://azure.microsoft.com/free/) before you start.

- For more information, see [prepare accounts to build Teams app](accounts.md)

-### Environment

-Teams Toolkit helps you to manage multiple environments. You can add, configure, and customize environments. You can choose to add collaborators for each environment:

-

- For more information, see [manage multiple environments](TeamsFx-multi-env.md) and [collaborate with other developers on Teams project](TeamsFx-collaboration.md).

-### Development

-Teams Toolkit provides convenience for you to create and customize your Teams app project that makes the Teams app development work easily and quickly:

-

-1. **Create a new Teams app**, helps to start Teams app development work with either a "hello world" template project or a sample project. For more information, see [create new Teams project](create-new-project.md)

-1. **View samples**, shows a set of Teams sample apps for you to explore, refer, and develop.

-1. **Add capabilities**, helps to add another Teams capabilities to Teams app at any time during development process. For more information, see [add capabilities to your Teams app](add-capability.md)

-1. **Add cloud resources** lets you add additional cloud resources according to the requirement change.For more information, see [add cloud resources for your Teams app](add-resource.md)

-1. **Edit manifest file** lets you easily edit how the Teams app integrates with Teams client. For more information, see [preview Teams manifest file](TeamsFx-manifest-preview.md) and [edit Teams manifest file](TeamsFx-manifest-customization.md).

-### Deployment

-During or after the development, you should follow the process to do provision, deployment, and publish Teams app before it is accessible to your users:

-

-1. If you want to host your Teams app on Azure or you need to use Azure resources, **Provision in the cloud** helps you automate the process to create Azure resources. To use it you must have an Azure Subscription. For more information, see [provision cloud resources](provision.md).

-1. Before publishing your app or sharing, you can build your Teams app into packages by selecting **Zip Teams metadata package**.

-1. **Deploy to the cloud** helps you to deploy their source code to Azure. The prerequisite to run deploy is to have provisioned resources by running **Provision in the cloud** or you have to create the Azure resources manually and specify the resource parameter in your project environment settings. For more information, see [deploy Teams app to the cloud](deploy.md).

-1. Instead of manually publishing your custom Teams app, you can use **Publish to Teams** function to call Teams api to publish Teams app. You need the permission to upload Teams app. For more information, see [publish your app to Teams](publish.md).

-1. Developer Portal for Teams is where you can manage and distribute your Teams app.For more information, see [developer portal](/microsoftteams/platform/concepts/build-and-test/teams-developer-portal)

-1. Teams Toolkit also provides CI/CD template for CI/CD tools like GitHub workflow, Azure Devops and Jenkins. For more information, see [build CI/CD pipelines for Teams application](use-CICD-template.md)

-### Help and Feedback

-In this section, you can easily find the documentation and resources you need. You can select **Report issues on GitHub** in the Teams Toolkit to get **Quick support** from product expert. Browse the issue before you create a new one, or visit [StackOverflow tag `teams-toolkit`](https://stackoverflow.com/questions/tagged/teams-toolkit) to browse and ask questions:

-

-## See also

-> [!div class="nextstepaction"]

-> [Create new project use Teams Toolkit](create-new-project.md)

-> [!div class="nextstepaction"]

->[Prepare accounts to build Teams apps](accounts.md)

-# CI or CD support for Teams application developers

-TeamsFx helps to automate your development workflow while building Teams application. The document provides tools and pre-cooked templates for you to get started while setting up CI or CD pipelines with the most popular development platforms including GitHub, Azure Devops and Jenkins.

-|Tools and Templates|Description|

-|[teamsfx-cli-action](https://github.com/OfficeDev/teamsfx-cli-action)|A ready-to-use GitHub Action that integrates with TeamsFx CLI.|

-|[github-ci-template.yml](https://github.com/OfficeDev/TeamsFx/blob/main/docs/cicd_insider/github-ci-template.yml) and [github-cd-template.yml](https://github.com/OfficeDev/TeamsFx/blob/main/docs/cicd_insider/github-cd-template.yml)| GitHub CI or CD templates for a Teams app. |

-|[script-ci-template.sh](https://github.com/OfficeDev/TeamsFx/blob/main/docs/cicd_insider/others-script-ci-template.sh) and [script-cd-template.sh](https://github.com/OfficeDev/TeamsFx/blob/main/docs/cicd_insider/others-script-cd-template.sh)| Script templates for automation everywhere else outside of GitHub. |

-1. Create a folder under `.github/workflows`

-1. Copy the template files (either one or both of them):

-1. Customize these workflows to fit your scenarios.

-You can make the following changes to adapt the workflow for your project:

-1. Change how the CI flow is triggered. We default to when a pull request is created targeting the `dev` branch.

-1. Use a npm build script, or customize the way you build the project in the automation code.

-1. Use a npm test script which returns zero for success, and/or change the test commands.

-The following steps to customize CD workflow:

-1. Create GitHub [repository secrets](https://docs.github.com/en/actions/reference/encrypted-secrets) by environment to hold Azure or Microsoft 365 login credentials. The following table lists all the secrets you need to create on GitHub, and for detailed usage, please refer to the GitHub Actions [README.md](https://github.com/OfficeDev/teamsfx-cli-action/blob/main/README.md).

-1. Remove the test scripts if you don't have tests.

-> [!Note]

-> The provision step is not included in the CD template as it's usually executed only once. You can either execute provision Within Teams Toolkit, TeamsFx CLI, or using a separated workflow. Please remember to commit after provisioning (results of provisioning will be deposited inside the `.fx` folder) and save the file content of `.fx/states/{YOUR_ENV_NAME}.userdata` into GitHub [repository secrets](https://docs.github.com/en/actions/reference/encrypted-secrets) with name `USERDATA_CONTENT` for future usage.

-### Environment variables

-Steps to create environment variables in GitHub::

-1. In the project **Settings** page, navigate to **Environments** section and select **New environment**.

-1. Enter a name for your environment. The default environment name provided in the template is `test_environment`. Select **Configure environment** to proceed.

-1. In the next page, Select **Add Secret** to add secrets for each of the items listed in the table below.

-|AZURE_ACCOUNT_NAME|The account name of Azure which is used to provision resources.|

-|AZURE_ACCOUNT_PASSWORD|The password of Azure account.|

-|Microsoft 365_ACCOUNT_NAME|The Microsoft 365 account for creating and publishing the Teams App.|

-|Microsoft 365_ACCOUNT_PASSWORD|The password of the Microsoft 365 account.|

-|Microsoft 365_TENANT_ID|To identify the tenant in which the Teams App will be created/published. This value is optional unless you have a multi-tenant account and you want to use another tenant. Read more on [how to find your Microsoft 365 tenant ID](/azure/active-directory/fundamentals/active-directory-how-to-find-tenant).|

-> Please refer to the [Configure Microsoft 365/Azure Credentials](https://github.com/OfficeDev/teamsfx-cli-action/blob/main/README.md#configure-m365azure-credentials-as-github-secret) to make sure you have disabled Multi-factor Authentication and Security Defaults for the credentials used in the workflow.

-## Set up CI or CD Pipelines with Azure DevOps

-You can set up automated pipelines in Azure DevOps, and make a reference on the scripts. Follow the steps given below to get started:

-### Set up CI Pipeline

-1. Add [CI Scripts](https://github.com/OfficeDev/TeamsFx/blob/main/docs/cicd_insider/others-script-ci-template.sh) into your Azure DevOps repository, and do necessary customizations as you may infer from the comments in the script file.

-The potential changes you can make for the script or workflow definition:

-1. Change how the CI flow is triggered. We default to when a new commit is pushed into the `dev` branch.

-1. Use npm test script which returns zero for success, and/or change the test commands.

-### Set up CD Pipeline

-1. Create your Azure DevOps Pipeline for CD, as you may refer to [this link](/azure/devops/pipelines/create-first-pipeline). The Pipeline's definition can be referred to the following example definition for CI Pipeline.

- name: userdata

- inputs:

- secureFile: 'staging.userdata'

- inputs:

- targetType: 'inline'

- script: |

- mkdir -p .fx/states/

- cp $(userdata.secureFilePath) .fx/states/staging.userdata

- AZURE_ACCOUNT_NAME: $(AZURE_ACCOUNT_NAME)

- AZURE_ACCOUNT_PASSWORD: $(AZURE_ACCOUNT_PASSWORD)

- AZURE_TENANT_ID: $(AZURE_TENANT_ID)

- Microsoft 365_ACCOUNT_NAME: $(Microsoft 365_ACCOUNT_NAME)

- Microsoft 365_ACCOUNT_PASSWORD: $(Microsoft 365_ACCOUNT_PASSWORD)

-The potential changes you can make for the script or workflow definition:

-> [!Note]

-> The provision step is not included in the CD template as it's usually executed only once. You can either execute provision Within Teams Toolkit, TeamsFx CLI, or using a seperated workflow. Please remember to commit after provisioning (results of provisioning will be deposited inside the `.fx` folder) and upload `.fx/states/{YOUR_ENV_NAME}.userdata` into Azure DevOps [secure files](/azure/devops/pipelines/library/secure-files) for future usage.

-### Environment variables for Azure DevOps

-Steps to create Pipeline variables in Azure DevOps:

-1. In the Pipeline editing page, select **Variables** on top right and select **New variable**.

-1. Enter Name/Value pair for your variable.

-|AZURE_ACCOUNT_NAME|The account name of Azure which is used to provision resources.|

-|AZURE_ACCOUNT_PASSWORD|The password of Azure account.|

-|Microsoft 365_ACCOUNT_NAME|The Microsoft 365 account for creating and publishing the Teams App.|

-|Microsoft 365_ACCOUNT_PASSWORD|The password of the Microsoft 365 account.|

-|Microsoft 365_TENANT_ID|To identify the tenant in which the Teams App will be created/published. This value is optional unless you have a multi-tenant account and you want to use another tenant. Read more on [how to find your Microsoft 365 tenant ID](/azure/active-directory/fundamentals/active-directory-how-to-find-tenant).|

-> [!NOTE]

-> The provision step is not included in the CD template as it's usually executed only once. You can either execute provision Within Teams Toolkit, TeamsFx CLI, or using a seperated workflow. Please remember to commit after provisioning (results of provisioning will be deposited inside the `.fx` folder) and save the file content of `.fx/states/{YOUR_ENV_NAME}.userdata` into Jenkins credentials for future usage.

-## CI or CD Pipeline Templates in Jenkins

-To add these templates to your repository, you will need your versions of [jenkins-ci-template.Jenkinsfile](https://github.com/OfficeDev/TeamsFx/blob/main/docs/cicd_insider/jenkins-ci-template.Jenkinsfile) and [jenkins-cd-template.Jenkinsfile](https://github.com/OfficeDev/TeamsFx/blob/main/docs/cicd_insider/jenkins-cd-template.Jenkinsfile) to be located in your repository by branch.

-### Customize CI Pipeline

-There are some potential changes you can make to adapt your project:

-1. Rename the template file to **Jenkinsfile** since it's a common practice, and put it under the target branch, for example, the **dev** branch.

-### Customize CD Pipeline

-Change the following steps to customize CD pipeline:

-1. Rename the template file to **Jenkinsfile** since it's a common practice, and put it under the target branch, for example, the **main** branch.

-1. How the CD flow is triggered. We default to use the triggers of **pollSCM** when a new change is pushed into the **main** branch.

-1. Create Jenkins [pipeline credentials](https://www.jenkins.io/doc/book/using/using-credentials/) to hold Azure/Microsoft 365 login credentials. The table below lists all the credentials you need to create on Jenkins.

-> [!Note]

- The provision step is not included in the CD template as it's usually executed only once. You can either execute provision Within Teams Toolkit, TeamsFx CLI, or using a separated workflow. Please remember to commit after provisioning (results of provisioning will be deposited inside the `.fx` folder) and save the file content of `.fx/states/{YOUR_ENV_NAME}.userdata` into Jenkins credentials for future usage.

-### Environment variables for Jenkins

-|AZURE_ACCOUNT_NAME|The account name of Azure that is used to provision resources.|

-|AZURE_ACCOUNT_PASSWORD|The password of Azure account.|

-|Microsoft 365_ACCOUNT_NAME|The M3icrosoft 365 account for creating and publishing the Teams App.|

-|Microsoft 365_ACCOUNT_PASSWORD|The password of the Microsoft 365 account.|

-|Microsoft 365_TENANT_ID|To identify the tenant in which the Teams App will be created/published. This value is optional unless you have a multi-tenant account and you want to use another tenant. Read more on [how to find your Microsoft 365 tenant ID](/azure/active-directory/fundamentals/active-directory-how-to-find-tenant).|

-> Note: Please refer to the [Configure Microsoft 365/Azure Credentials](https://github.com/OfficeDev/teamsfx-cli-action/blob/main/README.md#configure-m365azure-credentials-as-github-secret) to make sure you have disabled Multi-factor Authentication and Security Defaults for the credentials used in the pipeline.

-The scripts are pretty straightforward and most parts of them are cross-platform CLI, so it's easy to transform them to other types of script, for example, PowerShell.

-> [!Note]

-> To enable `@microsoft/teamsfx-cli` running in CI mode, turn on `CI_ENABLED` by `export CI_ENABLED=true`. In CI mode, `@microsoft/teamsfx-cli` is friendly for CI or CD.

-Ensure to set Azure and M365 credentials in your environment variables safely. For example if you are using GitHub as your source code repository, you can use the [Github Secrets](https://docs.github.com/en/actions/reference/encrypted-secrets) to securely store your environment variables.

-## Publish Teams app using Teams Developer Portal

-**To publish your app**

-1. Sign in [Developer Portal for Teams](https://dev.teams.microsoft.com) using the corresponding account.

-3. Select the target app in app list, and you will go to the overview page.

-|11/30/2021 | Teams Toolkit for Visual Studio Code | Tools and SDKs > Teams Toolkit for Visual Studio Code > [Teams Toolkit fundamentals](toolkit/teams-toolkit-fundamentals.md) |