@microsoft/teamsfx-core 1.2.0-rc.1 → 1.2.2-alpha.01e159e5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/teamsfx-core",
-  "version": "1.2.0-rc.1",
+  "version": "1.2.2-alpha.01e159e5.0",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "license": "MIT",
@@ -8,11 +8,12 @@
     "lint:staged": "lint-staged",
     "lint": "eslint \"src/**/*.ts\" \"tests/**/*.ts\"",
     "test:bot": "nyc mocha \"tests/plugins/resource/bot/**/*.test.ts\"",
-    "test:blazor": "nyc mocha \"tests/plugins/resource/blazor/**/*.test.ts\"",
+    "test:dotnet": "nyc mocha \"tests/plugins/resource/dotnet/**/*.test.ts\"",
     "test:function": "nyc mocha \"tests/plugins/resource/function/**/*.test.ts\"",
     "test:localdebug": "nyc mocha \"tests/plugins/resource/localdebug/**/*.test.ts\"",
     "test:frontend": "nyc mocha \"tests/plugins/resource/frontend/**/*.test.ts\"",
     "test:aad": "nyc mocha \"tests/plugins/resource/aad/**/*.test.ts\"",
+    "test:aadv3": "nyc mocha \"tests/plugins/resource/aad/v3/*.test.ts\"",
     "test:simpleauth": "nyc mocha \"tests/plugins/resource/simpleauth/**/*.test.ts\"",
     "test:sql": "nyc mocha \"tests/plugins/resource/sql/**/*.test.ts\"",
     "test:identity": "nyc mocha \"tests/plugins/resource/identity/**/*.test.ts\"",
@@ -23,6 +24,7 @@
     "test:unit": "nyc --no-clean mocha \"tests/**/*.test.ts\"",
     "test:common": "nyc --no-clean mocha \"tests/common/*.test.ts\"",
     "test:solution": "nyc mocha \"tests/plugins/solution/*.test.ts\"",
+    "test:solution:deploy": "nyc mocha \"tests/plugins/solution/solution.deploy.test.ts\"",
     "test:solution:debug": "nyc mocha \"tests/plugins/solution/debug/**/*.test.ts\"",
     "test:core": "nyc mocha \"tests/core/**/*.test.ts\"",
     "test:core:sample": "nyc mocha \"tests/core/sample.test.ts\"",
@@ -38,10 +40,10 @@
     "prepare": "npm run build && node ./scripts/download-templates-zip.js $(git tag --list)",
     "prepublishOnly": "npm run test:unit && npm run build",
     "package": "rimraf build && webpack --mode production --config ./webpack.config.js",
-    "precommit": "lint-staged",
-    "install:api": "cd api && npm install",
+    "check-sensitive": "npx eslint --plugin 'no-secrets' --cache --ignore-pattern 'package.json' --ignore-pattern 'package-lock.json'",
+    "precommit": "npm run check-sensitive && lint-staged",
     "install:tabs": "cd tabs && npm install",
-    "installAll": "npm run install:api & npm run install:tabs"
+    "installAll": "npm run install:tabs"
   },
   "dependencies": {
     "@apidevtools/swagger-parser": "^10.0.2",
@@ -57,15 +59,18 @@
     "@azure/storage-blob": "^12.7.0",
     "@dbpiper/timer": "1.0.0-beta.2",
     "@feathersjs/hooks": "^0.6.5",
-    "@microsoft/teamsfx-api": "^0.13.0-rc.0",
+    "@microsoft/teamsfx-api": "0.13.1-alpha.01e159e5.0",
+    "@npmcli/arborist": "^4.2.0",
     "@npmcli/package-json": "^1.0.1",
     "@types/jwt-decode": "3.1.0",
     "@types/proper-lockfile": "^4.1.1",
     "adm-zip": "^0.5.5",
-    "ajv": "^7.2.4",
+    "ajv": "^8.5.0",
+    "ajv-draft-04": "^1.0.0",
     "axios": "^0.21.2",
     "cryptr": "^6.0.2",
     "dateformat": "^4.5.1",
+    "detect-port": "^1.3.0",
     "dotenv": "^8.2.0",
     "express": "^4.17.1",
     "fs-extra": "^9.1.0",
@@ -83,7 +88,8 @@
     "md5": "^2.3.0",
     "mime": "^2.5.2",
     "mustache": "^4.2.0",
-    "node-forge": "^0.10.0",
+    "nanoid": "^3.1.31",
+    "node-forge": "^1.0.0",
     "node-ts-uuid": "^1.0.8",
     "openapi-types": "^7.2.3",
     "proper-lockfile": "^4.1.2",
@@ -111,6 +117,7 @@
     "@types/chai-spies": "^1.0.3",
     "@types/cryptr": "^4.0.1",
     "@types/dateformat": "^3.0.1",
+    "@types/detect-port": "^1.3.2",
     "@types/express": "^4.17.9",
     "@types/faker": "^5.5.0",
     "@types/fs-extra": "^9.0.9",
@@ -127,6 +134,8 @@
     "@types/mustache": "^4.1.1",
     "@types/node": "^14.14.21",
     "@types/node-forge": "^0.9.7",
+    "@types/proxyquire": "^1.3.28",
+    "@types/rewire": "^2.5.28",
     "@types/semver": "^7.3.4",
     "@types/sinon": "^9.0.10",
     "@types/tedious": "^4.0.3",
@@ -143,6 +152,7 @@
     "dotenv": "^8.2.0",
     "eslint": "^7.22.0",
     "eslint-plugin-import": "^2.25.2",
+    "eslint-plugin-no-secrets": "^0.8.9",
     "eslint-plugin-prettier": "^4.0.0",
     "faker": "^5.5.2",
     "find-process": "^1.4.4",
@@ -153,6 +163,8 @@
     "mocked-env": "^1.3.5",
     "nyc": "^15.1.0",
     "prettier": "^2.4.1",
+    "proxyquire": "^2.1.3",
+    "rewire": "^6.0.0",
     "sinon": "^9.2.2",
     "source-map-support": "^0.5.19",
     "tmp": "^0.2.1",
@@ -160,7 +172,6 @@
     "ts-node": "^9.1.1",
     "tslint": "^6.1.3",
     "ttypescript": "^1.5.12",
-    "typedoc": "^0.20.35",
     "typescript": "^4.2.3",
     "webpack": "^5.61.0",
     "webpack-cli": "^4.9.1"
@@ -170,7 +181,7 @@
     "resource/**/*",
     "templates/**/*"
   ],
-  "gitHead": "6505dcfa8fdd36be57385f4a9c7fd7e586ae27f1",
+  "gitHead": "f71cbbceb59c688a587f58beb64eba73df852bcd",
   "publishConfig": {
     "access": "public"
   },

package/resource/strings.json

@@ -13,12 +13,22 @@
     "FailedToDeployBeforeProvision": "Failed to deploy because the resources have not been provisioned yet. Make sure you do the provision first. Click Get Help to learn more about why you need to provision.",
     "FailedToPublishBeforeProvision": "Failed to publish because the resources have not been provisioned yet. Make sure you do the provision first. Click Get Help to learn more about why you need to provision.",
     "SPFxAskProvisionBeforePublish": "Failed to publish because the teams app has not been provisioned yet. Please provision first. Click Get Help to learn more about why you need to provision.",
-    "AddResourceNotice": "[Teams Toolkit] Resource \"%s\" have been successfully configured for your project, trigger 'Teams: Provision in the cloud' will create the resource(s) in your Azure subscription.",
-    "AddResourceNoticeForCli": "[Teams Toolkit] Resource \"%s\" have been successfully configured for your project, run 'teamsfx provision' will create the resource(s) in your Azure subscription.",
-    "AddCapabilityNotice": "[Teams Toolkit] Capability %s has been successfully added to your project. F5 to local debug the application or trigger 'Teams: Provision in the cloud' to create resources in your Azure subscription for hosting.",
-    "AddCapabilitiesNotice": "[Teams Toolkit] Capabilities %s have been successfully added to your project. F5 to local debug the application or trigger 'Teams: Provision in the cloud' to create resources in your Azure subscription for hosting.",
-    "AddCapabilityNoticeForCli": "[Teams Toolkit] Capability %s has been successfully added to your project. Run 'teamsfx provision' to create resources in your Azure subscription for hosting.",
-    "AddCapabilitiesNoticeForCli": "[Teams Toolkit] Capabilities %s have been successfully added to your project. Run 'teamsfx provision' to create resources in your Azure subscription for hosting.",
+    "addCapability" : {
+      "OnlySupportAzure": "Add capability is only supported for project hosted in Azure",
+      "ExceedMaxLimit": "Your App reaches maximal limit for Tabs, Bot and Message Extension.",
+      "AddCapabilityNotice": "[Teams Toolkit] Capability %s has been successfully added to your project. F5 to local debug the application or trigger 'Teams: Provision in the cloud' to create resources in your Azure subscription for hosting.",
+      "AddCapabilitiesNotice": "[Teams Toolkit] Capabilities %s have been successfully added to your project. F5 to local debug the application or trigger 'Teams: Provision in the cloud' to create resources in your Azure subscription for hosting.",
+      "AddCapabilityNoticeForCli": "[Teams Toolkit] Capability %s has been successfully added to your project. Run 'teamsfx provision' to create resources in your Azure subscription for hosting.",
+      "AddCapabilitiesNoticeForCli": "[Teams Toolkit] Capabilities %s have been successfully added to your project. Run 'teamsfx provision' to create resources in your Azure subscription for hosting."
+    },
+    "addResource": {
+      "OnlySupportAzure": "Add resource is only supported for project hosted in Azure",
+      "NotSupportForVSProject": "Add resource is not supported for csharp project",
+      "AddResourceNotice": "[Teams Toolkit] Resource \"%s\" has been successfully configured for your project, trigger 'Teams: Provision in the cloud' will create the resource in your Azure subscription.",
+      "AddResourceNoticeForCli": "[Teams Toolkit] Resource \"%s\" has been successfully configured for your project, run 'teamsfx provision' will create the resource in your Azure subscription.",
+      "AddResourcesNotice": "[Teams Toolkit] Resources \"%s\" have been successfully configured for your project, trigger 'Teams: Provision in the cloud' will create the resources in your Azure subscription.",
+      "AddResourcesNoticeForCli": "[Teams Toolkit] Resources \"%s\" have been successfully configured for your project, run 'teamsfx provision' will create the resources in your Azure subscription."
+    },
     "CancelProvision": "CancelProvision",
     "AlreadyProvisionNotice": "'%s' is already provisioned in the cloud, will create the teams app again if it has been removed.",
     "NotProvisionedNotice": "'%s' is not provisioned in the cloud yet. Please provision first.",
@@ -47,14 +57,46 @@
     "ProvisionFinishNotice": "[%s] Provison finished!",
     "DeployStartNotice": "[%s] Deployment start.",
     "SelectedPluginsToDeployNotice": "[%s] Selected plugins to deploy: %s",
-    "PublishStartNotice": "[%s] Publish start."
+    "PublishStartNotice": "[%s] Publish start.",
+    "Collaboration": {
+      "ListCollaboratorsSuccess": "List M365 Teams App%s owners success, you can view it in Teams Toolkit output window",
+      "WithAadApp": "(With AAD App)",
+      "FailedToListCollaborators": "Failed to list Teams App owners for the project.\nError details: \n",
+      "GrantingPermission": "Granting permission",
+      "EmailCannotBeEmptyOrSame":"Collaborator's email cannot be null or same as current user",
+      "CannotFindUserInCurrentTenant":"Cannot find user in current tenant, please check whether your email address is correct",
+      "GrantPermissionForUser":"Grant permission for user",
+      "FailedToGetEnvName": "Failed to get env name.",
+      "AccountToGrantPermission": "Account to grant permission: ",
+      "StartingGrantPermission":"Starting grant permission for environment: ",
+      "TenantId": "Tenant ID: ",
+      "FailedToGrantPermission":"Failed to grant permission for the below resources to user: %s.\n Resource details: \n",
+      "PermissionHasBeenGrantTo":"permission has been granted to ",
+      "GrantPermissionResourceId": ", Resource ID: ",
+      "SharePointTip":"\nIf added user is not a SharePoint App Catalog site admin, you need to manually setup access policy via SharePoint admin center, please refer to this link for more details: ",
+      "AzureTip":"\nIf added user cannot access Azure resources, you need to manually setup access policy via Azure portal, please refer to this link for more details: ",
+      "ListingM365Permission": "Listing M365 permissions\n",
+      "AccountUsedToCheck":"Account used to check: ",
+      "StartingListAllTeamsAppOwners": "Starting list all teams app owners for environment: ",
+      "M365TeamsAppId": "M365 Teams App (ID: ",
+      "SsoAadAppId":"), SSO AAD App (ID: ",
+      "TeamsAppOwner": "Teams App Owner: ",
+      "NotOwnerOfSsoAadApp":"(Not owner of SSO AAD app)",
+      "FailedToConvertProfile": "failed to convert profile ",
+      "StaringCheckPermission": "Starting check permission for environment: ",
+      "FailedToCheckPermission": "Failed to check permission for the below resources.\n Resource details: \n",
+      "CheckPermissionResourceId": "Resource ID: ",
+      "Undefined": "undefined",
+      "ResourceName": ", Resource Name: ",
+      "Permission": ", Permission: "
+    }
   },
   "plugins": {
     "SPFx": {
       "buildNotice": "SharePoint package successfully built at %s.",
       "deployNotice": "SharePoint package %s has been successfully deployed to [%s](%s).",
       "deployFailedNotice": "You don't have permission to upload and deploy package to App Catalog %s, please use site admin account, or you can get your own free Microsoft 365 tenant from [M365 developer program](https://developer.microsoft.com/en-us/microsoft-365/dev-program)",
-      "createAppCatalogNotice": "There is no tenant app catalog under %s, you can Read more about how to create app catalog site."
+      "createAppCatalogNotice": "There is no tenant app catalog under %s, do you want to create one?"
     }
   }
 }

package/templates/plugins/resource/apim/bicep/apimConfiguration.bicep

@@ -38,6 +38,7 @@ var scope = '${m365ApplicationIdUri}/.default'
 var authorizationEndpoint = uri(m365OauthAuthorityHost, '${m365TenantId}/oauth2/v2.0/authorize')
 var tokenEndpoint = uri(m365OauthAuthorityHost, '${m365TenantId}/oauth2/v2.0/token')
 
+//Enables Microsoft Power Platform to access your APIs hosted in Function App
 resource apimServiceAuthServer 'Microsoft.ApiManagement/service/authorizationServers@2020-12-01' = {
   name: '${apimServiceName}/${oauthServerName}'
   properties: {

package/templates/plugins/resource/apim/bicep/apimProvision.bicep

@@ -2,12 +2,13 @@
 param provisionParameters object
 
 var resourceBaseName = provisionParameters['resourceBaseName']
-var apimServiceName = contains(provisionParameters, 'apimServiceName') ? provisionParameters['apimServiceName'] : '${resourceBaseName}'
-var apimServiceSku = contains(provisionParameters, 'apimServiceSku') ? provisionParameters['apimServiceSku'] : 'Consumption'
-var productName = contains(provisionParameters, 'apimProductName') ? provisionParameters['apimProductName'] : '${resourceBaseName}'
-var publisherEmail = provisionParameters['apimPublisherEmail']
-var publisherName = provisionParameters['apimPublisherName']
+var apimServiceName = contains(provisionParameters, 'apimServiceName') ? provisionParameters['apimServiceName'] : '${resourceBaseName}' // Try to read name for APIM Service from parameters
+var apimServiceSku = contains(provisionParameters, 'apimServiceSku') ? provisionParameters['apimServiceSku'] : 'Consumption'  // Try to read SKU for APIM Service from parameters
+var productName = contains(provisionParameters, 'apimProductName') ? provisionParameters['apimProductName'] : '${resourceBaseName}'  // Try to read name for APIM Product from parameters
+var publisherEmail = provisionParameters['apimPublisherEmail']  // Read publisher email for APIM Service from parameters, this parameter is required
+var publisherName = provisionParameters['apimPublisherName'] // Read publisher name for APIM Service from parameters, this parameter is required
 
+// APIM Service that helps manage your APIs
 resource apimService 'Microsoft.ApiManagement/service@2020-12-01' = {
   name: apimServiceName
   location: resourceGroup().location
@@ -21,6 +22,7 @@ resource apimService 'Microsoft.ApiManagement/service@2020-12-01' = {
   }
 }
 
+// Group your APIs, define terms of use and runtime policies
 resource apimServiceProduct 'Microsoft.ApiManagement/service/products@2020-12-01' = {
   parent: apimService
   name: productName

package/templates/plugins/resource/apim/bicep/config.template.bicep

@@ -1,3 +1,4 @@
+// Add TeamsFx configurations to APIM resources
 module teamsFxApimConfig '\{{fx-resource-apim.Configuration.apim.path}}' = {
   name: 'addTeamsFxApimConfiguration'
   params: {

package/templates/plugins/resource/bot/bicep/botConfiguration.template.bicep

@@ -38,21 +38,21 @@ var m365ApplicationIdUri = 'api://botid-${botId}'
 resource botWebAppSettings 'Microsoft.Web/sites/config@2021-02-01' = {
   name: '${botWebAppName}/appsettings'
   properties: union({
-    INITIATE_LOGIN_ENDPOINT: uri(provisionOutputs.botOutput.value.siteEndpoint, 'auth-start.html')
-    M365_AUTHORITY_HOST: m365OauthAuthorityHost
-    M365_CLIENT_ID: m365ClientId
-    M365_CLIENT_SECRET: m365ClientSecret
-    M365_TENANT_ID: m365TenantId
-    M365_APPLICATION_ID_URI: m365ApplicationIdUri
-    BOT_ID: botAadAppClientId
-    BOT_PASSWORD: botAadAppClientSecret
+    INITIATE_LOGIN_ENDPOINT: uri(provisionOutputs.botOutput.value.siteEndpoint, 'auth-start.html') // The page is used to let users consent required OAuth permissions during bot SSO process
+    M365_AUTHORITY_HOST: m365OauthAuthorityHost // AAD authority host
+    M365_CLIENT_ID: m365ClientId // Client id of AAD application
+    M365_CLIENT_SECRET: m365ClientSecret // Client secret of AAD application
+    M365_TENANT_ID: m365TenantId // Tenant id of AAD application
+    M365_APPLICATION_ID_URI: m365ApplicationIdUri // Application ID URI of AAD application
+    BOT_ID: botAadAppClientId // ID of your bot
+    BOT_PASSWORD: botAadAppClientSecret // Secret of your bot
     {{#if (contains "fx-resource-function" plugins) }}
-    API_ENDPOINT: provisionOutputs.functionOutput.value.functionEndpoint
+    API_ENDPOINT: provisionOutputs.functionOutput.value.functionEndpoint // Azure Function endpoint
     {{/if}}
     {{#if (contains "fx-resource-azure-sql" plugins)}}
-    SQL_DATABASE_NAME: \{{fx-resource-azure-sql.References.databaseName}}
-    SQL_ENDPOINT: \{{fx-resource-azure-sql.References.sqlEndpoint}}
+    SQL_DATABASE_NAME: \{{fx-resource-azure-sql.References.databaseName}} // SQL database name
+    SQL_ENDPOINT: \{{fx-resource-azure-sql.References.sqlEndpoint}} // SQL server endpoint
     {{/if}}
-    IDENTITY_ID: \{{fx-resource-identity.References.identityClientId}}
+    IDENTITY_ID: \{{fx-resource-identity.References.identityClientId}} // User assigned identity id, the identity is used to access other Azure resources
   }, currentAppSettings)
 }

package/templates/plugins/resource/bot/bicep/botProvision.template.bicep

@@ -3,14 +3,15 @@ param provisionParameters object
 param userAssignedIdentityId string
 
 var resourceBaseName = provisionParameters.resourceBaseName
-var botAadAppClientId = provisionParameters['botAadAppClientId']
-var botServiceName = contains(provisionParameters, 'botServiceName') ? provisionParameters['botServiceName'] : '${resourceBaseName}'
-var botServiceSku = contains(provisionParameters, 'botServiceSku') ? provisionParameters['botServiceSku'] : 'F0'
-var botDisplayName = contains(provisionParameters, 'botDisplayName') ? provisionParameters['botDisplayName'] : '${resourceBaseName}'
-var serverfarmsName = contains(provisionParameters, 'botServerfarmsName') ? provisionParameters['botServerfarmsName'] : '${resourceBaseName}bot'
-var webAppSKU = contains(provisionParameters, 'botWebAppSKU') ? provisionParameters['botWebAppSKU'] : 'F1'
-var webAppName = contains(provisionParameters, 'botSitesName') ? provisionParameters['botSitesName'] : '${resourceBaseName}bot'
+var botAadAppClientId = provisionParameters['botAadAppClientId'] // Read AAD app client id for Azure Bot Service from parameters
+var botServiceName = contains(provisionParameters, 'botServiceName') ? provisionParameters['botServiceName'] : '${resourceBaseName}' // Try to read name for Azure Bot Service from parameters
+var botServiceSku = contains(provisionParameters, 'botServiceSku') ? provisionParameters['botServiceSku'] : 'F0' // Try to read SKU for Azure Bot Service from parameters
+var botDisplayName = contains(provisionParameters, 'botDisplayName') ? provisionParameters['botDisplayName'] : '${resourceBaseName}' // Try to read display name for Azure Bot Service from parameters
+var serverfarmsName = contains(provisionParameters, 'botServerfarmsName') ? provisionParameters['botServerfarmsName'] : '${resourceBaseName}bot' // Try to read name for App Service Plan from parameters
+var webAppSKU = contains(provisionParameters, 'botWebAppSKU') ? provisionParameters['botWebAppSKU'] : 'F1' // Try to read SKU for Azure Web App from parameters
+var webAppName = contains(provisionParameters, 'botSitesName') ? provisionParameters['botSitesName'] : '${resourceBaseName}bot' // Try to read name for Azure Web App from parameters
 
+// Register your web service as a bot with the Bot Framework
 resource botService 'Microsoft.BotService/botServices@2021-03-01' = {
   kind: 'azurebot'
   location: 'global'
@@ -25,6 +26,7 @@ resource botService 'Microsoft.BotService/botServices@2021-03-01' = {
   }
 }
 
+// Connect the bot service to Microsoft Teams
 resource botServiceMsTeamsChannel 'Microsoft.BotService/botServices/channels@2021-03-01' = {
   parent: botService
   location: 'global'
@@ -34,6 +36,7 @@ resource botServiceMsTeamsChannel 'Microsoft.BotService/botServices/channels@202
   }
 }
 
+// Compute resources for your Web App
 resource serverfarm 'Microsoft.Web/serverfarms@2021-02-01' = {
   kind: 'app'
   location: resourceGroup().location
@@ -43,22 +46,23 @@ resource serverfarm 'Microsoft.Web/serverfarms@2021-02-01' = {
   }
 }
 
+// Web App that hosts your bot
 resource webApp 'Microsoft.Web/sites@2021-02-01' = {
   kind: 'app'
   location: resourceGroup().location
   name: webAppName
   properties: {
     serverFarmId: serverfarm.id
-    keyVaultReferenceIdentity: userAssignedIdentityId
+    keyVaultReferenceIdentity: userAssignedIdentityId // Use given user assigned identity to access Key Vault
     siteConfig: {
       appSettings: [
         {
           name: 'SCM_DO_BUILD_DURING_DEPLOYMENT'
-          value: 'true'
+          value: 'true' // Execute build steps on your site during deployment
         }
         {
           name: 'WEBSITE_NODE_DEFAULT_VERSION'
-          value: '~14'
+          value: '~14' // Set NodeJS version to 14.x for your site
         }
       ]
     }
@@ -66,7 +70,7 @@ resource webApp 'Microsoft.Web/sites@2021-02-01' = {
   identity: {
     type: 'UserAssigned'
     userAssignedIdentities: {
-      '${userAssignedIdentityId}': {}
+      '${userAssignedIdentityId}': {} // The identity is used to access other Azure resources
     }
   }
 }

package/templates/plugins/resource/bot/bicep/config.template.bicep

@@ -1,5 +1,7 @@
+// Get existing app settings for merge
 var botCurrentAppSettings = list('${provisionOutputs.botOutput.value.botWebAppResourceId}/config/appsettings', '2021-02-01').properties
 
+// Merge TeamsFx configurations to Bot resources
 module teamsFxBotConfig '\{{fx-resource-bot.Configuration.bot.path}}' = {
   name: 'addTeamsFxBotConfiguration'
   params: {

package/templates/plugins/resource/botservice/bicep/botServiceProvision.template.bicep

@@ -0,0 +1,34 @@
+@secure()
+param provisionParameters object
+param botEndpoint string
+
+var resourceBaseName = provisionParameters.resourceBaseName
+var botAadAppClientId = provisionParameters['botAadAppClientId'] // Read AAD app client id for Azure Bot Service from parameters
+var botServiceName = contains(provisionParameters, 'botServiceName') ? provisionParameters['botServiceName'] : '${resourceBaseName}' // Try to read name for Azure Bot Service from parameters
+var botServiceSku = contains(provisionParameters, 'botServiceSku') ? provisionParameters['botServiceSku'] : 'F0' // Try to read SKU for Azure Bot Service from parameters
+var botDisplayName = contains(provisionParameters, 'botDisplayName') ? provisionParameters['botDisplayName'] : '${resourceBaseName}' // Try to read display name for Azure Bot Service from parameters
+
+// Register your web service as a bot with the Bot Framework
+resource botService 'Microsoft.BotService/botServices@2021-03-01' = {
+  kind: 'azurebot'
+  location: 'global'
+  name: botServiceName
+  properties: {
+    displayName: botDisplayName
+    endpoint: uri(botEndpoint, '/api/messages')
+    msaAppId: botAadAppClientId
+  }
+  sku: {
+    name: botServiceSku // You can follow https://aka.ms/teamsfx-bicep-add-param-tutorial to add botServiceSku property to provisionParameters to override the default value "F0".
+  }
+}
+
+// Connect the bot service to Microsoft Teams
+resource botServiceMsTeamsChannel 'Microsoft.BotService/botServices/channels@2021-03-01' = {
+  parent: botService
+  location: 'global'
+  name: 'MsTeamsChannel'
+  properties: {
+    channelName: 'MsTeamsChannel'
+  }
+}

package/templates/plugins/resource/botservice/bicep/parameters.json

@@ -0,0 +1,4 @@
+{
+  "botAadAppClientId": "{{state.fx-resource-bot.botId}}",
+  "botAadAppClientSecret": "{{state.fx-resource-bot.botPassword}}"
+}

package/templates/plugins/resource/botservice/bicep/provision.template.bicep

@@ -0,0 +1,13 @@
+// Resources for bot
+module botProvision '\{{fx-resource-bot.Provision.botservice.path}}' = {
+  name: 'botProvision'
+  params: {
+    provisionParameters: provisionParameters
+    botEndpoint: \{{fx-resource-frontend-hosting.References.endpointAsParam}}
+  }
+}
+
+output botOutput object = {
+  teamsFxPluginId: 'fx-resource-bot'
+  validDomain: \{{fx-resource-frontend-hosting.References.domainAsParam}}
+}

package/templates/plugins/resource/frontend/bicep/frontendHostingProvision.bicep

@@ -1,9 +1,10 @@
 @secure()
 param provisionParameters object
 var resourceBaseName = provisionParameters.resourceBaseName
-var storageName = contains(provisionParameters, 'frontendHostingStorageName') ? provisionParameters['frontendHostingStorageName'] : '${resourceBaseName}tab'
-var storageSku = contains(provisionParameters, 'frontendHostingStorageSku') ? provisionParameters['frontendHostingStorageSku'] : 'Standard_LRS'
+var storageName = contains(provisionParameters, 'frontendHostingStorageName') ? provisionParameters['frontendHostingStorageName'] : '${resourceBaseName}tab' // Try to read name for frontend hosting Storage Account from parameters
+var storageSku = contains(provisionParameters, 'frontendHostingStorageSku') ? provisionParameters['frontendHostingStorageSku'] : 'Standard_LRS' // Try to read SKU for frontend hosting Storage Account from parameters
 
+// Azure Storage that hosts your static web site
 resource storage 'Microsoft.Storage/storageAccounts@2021-06-01' = {
   kind: 'StorageV2'
   location: resourceGroup().location
@@ -21,3 +22,4 @@ var siteDomain = replace(replace(storage.properties.primaryEndpoints.web, 'https
 output resourceId string = storage.id
 output endpoint string = 'https://${siteDomain}'
 output domain string = siteDomain
+output indexPath string = '/index.html#'

package/templates/plugins/resource/frontend/bicep/provision.template.bicep

@@ -10,5 +10,6 @@ output frontendHostingOutput object = {
   teamsFxPluginId: 'fx-resource-frontend-hosting'
   domain: frontendHostingProvision.outputs.domain
   endpoint: frontendHostingProvision.outputs.endpoint
+  indexPath: frontendHostingProvision.outputs.indexPath
   storageResourceId: frontendHostingProvision.outputs.resourceId
 }

package/templates/plugins/resource/function/bicep/config.template.bicep

@@ -1,6 +1,8 @@
+// Get existing app settings and site config for merge
 var functionCurrentConfigs = reference('${provisionOutputs.functionOutput.value.functionAppResourceId}/config/web', '2021-02-01')
 var functionCurrentAppSettings = list('${provisionOutputs.functionOutput.value.functionAppResourceId}/config/appsettings', '2021-02-01').properties
 
+// Merge TeamsFx configurations to Azure Functions resources
 module teamsFxFunctionConfig '\{{fx-resource-function.Configuration.function.path}}' = {
   name: 'addTeamsFxFunctionConfiguration'
   params: {

package/templates/plugins/resource/function/bicep/functionConfiguration.template.bicep

@@ -60,7 +60,7 @@ resource appConfig 'Microsoft.Web/sites/config@2021-02-01' = {
   properties: {
     cors: {
       allowedOrigins: union(currentAllowedOrigins, [
-        tabAppEndpoint
+        tabAppEndpoint // allow requests from tab app
       ])
     }
   }
@@ -69,29 +69,29 @@ resource appConfig 'Microsoft.Web/sites/config@2021-02-01' = {
 resource appSettings 'Microsoft.Web/sites/config@2021-02-01' = {
   name: '${functionAppName}/appsettings'
   properties: union({
-    API_ENDPOINT: \{{fx-resource-function.References.functionEndpoint}}
-    ALLOWED_APP_IDS: authorizedClientApplicationIds
-    M365_CLIENT_ID: m365ClientId
-    M365_CLIENT_SECRET: m365ClientSecret
-    M365_TENANT_ID: m365TenantId
-    M365_AUTHORITY_HOST: m365OauthAuthorityHost
-    M365_APPLICATION_ID_URI: m365ApplicationIdUri
-    IDENTITY_ID: \{{fx-resource-identity.References.identityClientId}}
+    API_ENDPOINT: \{{fx-resource-function.References.functionEndpoint}} // Azure Functions endpoint
+    ALLOWED_APP_IDS: authorizedClientApplicationIds // Only allow tokens issued by these AAD applications
+    M365_CLIENT_ID: m365ClientId // Client id of AAD application
+    M365_CLIENT_SECRET: m365ClientSecret // Client secret of AAD application
+    M365_TENANT_ID: m365TenantId // Tenant id of AAD application
+    M365_AUTHORITY_HOST: m365OauthAuthorityHost // AAD authority host
+    M365_APPLICATION_ID_URI: m365ApplicationIdUri // Application ID URI of AAD application
+    IDENTITY_ID: \{{fx-resource-identity.References.identityClientId}} // User assigned identity id, the identity is used to access other Azure resources
     {{#if (contains "fx-resource-azure-sql" plugins) }}
-    SQL_DATABASE_NAME: \{{fx-resource-azure-sql.References.databaseName}}
-    SQL_ENDPOINT: \{{fx-resource-azure-sql.References.sqlEndpoint}}
+    SQL_DATABASE_NAME: \{{fx-resource-azure-sql.References.databaseName}} // SQL database name
+    SQL_ENDPOINT: \{{fx-resource-azure-sql.References.sqlEndpoint}} // SQL server endpoint
     {{/if}}
-  }, currentAppSettings)
+  }, currentAppSettings) // Merge new settings with existing settings
 }
 
 resource authSettings 'Microsoft.Web/sites/config@2021-02-01' = {
   name: '${functionAppName}/authsettings'
   properties: {
-    enabled: true
+    enabled: true // Validate access token in request authorization header
     defaultProvider: 'AzureActiveDirectory'
     clientId: m365ClientId
-    issuer: '${oauthAuthority}/v2.0'
-    allowedAudiences: [
+    issuer: '${oauthAuthority}/v2.0' // Issuer of access token
+    allowedAudiences: [ // Only allow tokens with following audiences
       m365ClientId
       m365ApplicationIdUri
     ]

package/templates/plugins/resource/function/bicep/functionProvision.template.bicep

@@ -3,12 +3,13 @@ param provisionParameters object
 param userAssignedIdentityId string
 
 var resourceBaseName = provisionParameters.resourceBaseName
-var serverfarmsName = contains(provisionParameters, 'functionServerfarmsName') ? provisionParameters['functionServerfarmsName'] : '${resourceBaseName}api'
-var serverfarmsSku = contains(provisionParameters, 'functionServerfarmsSku') ? provisionParameters['functionServerfarmsSku'] : 'Y1'
-var functionAppName = contains(provisionParameters, 'functionWebappName') ? provisionParameters['functionWebappName'] : '${resourceBaseName}api'
-var storageName = contains(provisionParameters, 'functionStorageName') ? provisionParameters['functionStorageName'] : '${resourceBaseName}api'
-var storageSku = contains(provisionParameters, 'functionStorageSku') ? provisionParameters['functionStorageSku'] : 'Standard_LRS'
+var serverfarmsName = contains(provisionParameters, 'functionServerfarmsName') ? provisionParameters['functionServerfarmsName'] : '${resourceBaseName}api' // Try to read name for App Service Plan from parameters
+var serverfarmsSku = contains(provisionParameters, 'functionServerfarmsSku') ? provisionParameters['functionServerfarmsSku'] : 'Y1' // Try to read SKU for App Service Plan from parameters
+var functionAppName = contains(provisionParameters, 'functionWebappName') ? provisionParameters['functionWebappName'] : '${resourceBaseName}api' // Try to read name for Azure Functions from parameters
+var storageName = contains(provisionParameters, 'functionStorageName') ? provisionParameters['functionStorageName'] : '${resourceBaseName}api' // Try to read name for Azure Storage from parameters
+var storageSku = contains(provisionParameters, 'functionStorageSku') ? provisionParameters['functionStorageSku'] : 'Standard_LRS' // Try to read SKU for Azure Storage from parameters
 
+// Compute resources for Azure Functions
 resource serverfarms 'Microsoft.Web/serverfarms@2021-02-01' = {
   name: serverfarmsName
   kind: 'functionapp'
@@ -18,42 +19,43 @@ resource serverfarms 'Microsoft.Web/serverfarms@2021-02-01' = {
   }
 }
 
+// Azure Functions that hosts your function code
 resource functionApp 'Microsoft.Web/sites@2021-02-01' = {
   name: functionAppName
   kind: 'functionapp'
   location: resourceGroup().location
   properties: {
     serverFarmId: serverfarms.id
-    keyVaultReferenceIdentity: userAssignedIdentityId
+    keyVaultReferenceIdentity: userAssignedIdentityId // Use given user assigned identity to access Key Vault
     siteConfig: {
       appSettings: [
         {
           name: 'AzureWebJobsDashboard'
-          value: 'DefaultEndpointsProtocol=https;AccountName=${storage.name};AccountKey=${listKeys(storage.id, storage.apiVersion).keys[0].value};EndpointSuffix=${environment().suffixes.storage}'
+          value: 'DefaultEndpointsProtocol=https;AccountName=${storage.name};AccountKey=${listKeys(storage.id, storage.apiVersion).keys[0].value};EndpointSuffix=${environment().suffixes.storage}' // Azure Functions internal setting
         }
         {
           name: 'AzureWebJobsStorage'
-          value: 'DefaultEndpointsProtocol=https;AccountName=${storage.name};AccountKey=${listKeys(storage.id, storage.apiVersion).keys[0].value};EndpointSuffix=${environment().suffixes.storage}'
+          value: 'DefaultEndpointsProtocol=https;AccountName=${storage.name};AccountKey=${listKeys(storage.id, storage.apiVersion).keys[0].value};EndpointSuffix=${environment().suffixes.storage}' // Azure Functions internal setting
         }
         {
           name: 'FUNCTIONS_EXTENSION_VERSION'
-          value: '~3'
+          value: '~3' // Use Azure Functions runtime v3
         }
         {
           name: 'FUNCTIONS_WORKER_RUNTIME'
-          value: 'node'
+          value: 'node' // Set runtime to NodeJS
         }
         {
           name: 'WEBSITE_CONTENTAZUREFILECONNECTIONSTRING'
-          value: 'DefaultEndpointsProtocol=https;AccountName=${storage.name};AccountKey=${listKeys(storage.id, storage.apiVersion).keys[0].value};EndpointSuffix=${environment().suffixes.storage}'
+          value: 'DefaultEndpointsProtocol=https;AccountName=${storage.name};AccountKey=${listKeys(storage.id, storage.apiVersion).keys[0].value};EndpointSuffix=${environment().suffixes.storage}' // Azure Functions internal setting
         }
         {
           name: 'WEBSITE_RUN_FROM_PACKAGE'
-          value: '1'
+          value: '1' // Run Azure Functions from a package file
         }
         {
           name: 'WEBSITE_NODE_DEFAULT_VERSION'
-          value: '~14'
+          value: '~14' // Set NodeJS version to 14.x
         }
       ]
     }
@@ -61,11 +63,12 @@ resource functionApp 'Microsoft.Web/sites@2021-02-01' = {
   identity: {
     type: 'UserAssigned'
     userAssignedIdentities: {
-      '${userAssignedIdentityId}': {}
+      '${userAssignedIdentityId}': {} // The identity is used to access other Azure resources
     }
   }
 }
 
+// Azure Storage is required when creating Azure Functions instance
 resource storage 'Microsoft.Storage/storageAccounts@2021-06-01' = {
   name: storageName
   kind: 'StorageV2'