@microsoft/teamsfx-core 1.2.1 → 1.2.2-alpha.01a113d2.0

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'

package/templates/plugins/resource/identity/bicep/identityProvision.template.bicep

@@ -1,8 +1,9 @@
 @secure()
 param provisionParameters object
 var resourceBaseName = provisionParameters.resourceBaseName
-var identityName = contains(provisionParameters, 'userAssignedIdentityName') ? provisionParameters['userAssignedIdentityName'] : '${resourceBaseName}'
+var identityName = contains(provisionParameters, 'userAssignedIdentityName') ? provisionParameters['userAssignedIdentityName'] : '${resourceBaseName}' // Try to read name for user assigned identity from parameters
 
+// user assigned identity will be used to access other Azure resources
 resource managedIdentity 'Microsoft.ManagedIdentity/userAssignedIdentities@2018-11-30' = {
   name: identityName
   location: resourceGroup().location

package/templates/plugins/resource/keyvault/bicep/keyVaultProvision.template.bicep

@@ -1,15 +1,15 @@
 @secure()
 param provisionParameters object
-param userAssignedIdentityObjectId string
+param userAssignedIdentityObjectId string // User assigned identity that will be grant Key Vault access permission
 
 var resourceBaseName = provisionParameters.resourceBaseName
-var keyVaultName = contains(provisionParameters, 'keyVaultName') ? provisionParameters['keyVaultName'] : '${resourceBaseName}'
+var keyVaultName = contains(provisionParameters, 'keyVaultName') ? provisionParameters['keyVaultName'] : '${resourceBaseName}' // Try to read name for Key Vault from parameters
 var tenantId = subscription().tenantId
-var m365ClientSecretName = 'm365ClientSecret'
-var m365ClientSecret = provisionParameters['m365ClientSecret']
-var botClientSecretName = 'botClientSecret'
-var botClientSecret = contains(provisionParameters, 'botAadAppClientSecret') ? provisionParameters['botAadAppClientSecret'] : ''
-var keyVaultSkuName = contains(provisionParameters, 'keyVaultSkuName') ? provisionParameters['keyVaultSkuName'] : 'standard'
+var m365ClientSecretName = 'm365ClientSecret' // Secret name of AAD app client secret
+var m365ClientSecret = provisionParameters['m365ClientSecret'] // Read AAD app client secret from parameters
+var botClientSecretName = 'botClientSecret' // Secret name of bot's AAD app client secret
+var botClientSecret = contains(provisionParameters, 'botAadAppClientSecret') ? provisionParameters['botAadAppClientSecret'] : '' // Try to read bot's AAD app client secret from parameters
+var keyVaultSkuName = contains(provisionParameters, 'keyVaultSkuName') ? provisionParameters['keyVaultSkuName'] : 'standard' // Try to read SKU for Key Vault from parameters
 
 resource keyVault 'Microsoft.KeyVault/vaults@2019-09-01' = {
   name: keyVaultName
@@ -34,6 +34,7 @@ resource keyVault 'Microsoft.KeyVault/vaults@2019-09-01' = {
   }
 }
 
+// Set or update AAD app client secret if it's not empty in parameters
 resource clientSecretKv 'Microsoft.KeyVault/vaults/secrets@2019-09-01' = if (length(m365ClientSecret) != 0) {
   parent: keyVault
   name: m365ClientSecretName
@@ -42,6 +43,7 @@ resource clientSecretKv 'Microsoft.KeyVault/vaults/secrets@2019-09-01' = if (len
   }
 }
 
+// Set or update bot's AAD app client secret if it's not empty in parameters
 resource botClientSecretKv 'Microsoft.KeyVault/vaults/secrets@2019-09-01' = if (length(botClientSecret) != 0) {
   parent: keyVault
   name: botClientSecretName

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

@@ -1,5 +1,7 @@
+// Get existing app settings and site config for merge
 var simpleAuthCurrentAppSettings = list('${provisionOutputs.simpleAuthOutput.value.webAppResourceId}/config/appsettings', '2021-02-01').properties
 
+// Merge TeamsFx configurations to Simple Auth resources
 module teamsFxSimpleAuthConfig '\{{fx-resource-simple-auth.Configuration.simpleAuth.path}}' = {
   name: 'addTeamsFxSimpleAuthConfiguration'
   params: {

package/templates/plugins/resource/simpleauth/bicep/simpleAuthConfiguration.template.bicep

@@ -47,14 +47,14 @@ var authorizedClientApplicationIds = '${teamsMobileOrDesktopAppClientId};${teams
 resource simpleAuthWebAppSettings 'Microsoft.Web/sites/config@2021-02-01' = {
   name: '${webAppName}/appsettings'
   properties: {
-    AAD_METADATA_ADDRESS: aadMetadataAddress
-    ALLOWED_APP_IDS: authorizedClientApplicationIds
-    IDENTIFIER_URI: m365ApplicationIdUri
-    CLIENT_ID: m365ClientId
-    CLIENT_SECRET: m365ClientSecret
-    OAUTH_AUTHORITY: oauthAuthority
+    AAD_METADATA_ADDRESS: aadMetadataAddress // AAD metadata address used to validate access tokens
+    ALLOWED_APP_IDS: authorizedClientApplicationIds // Only allow access tokens from these clients
+    IDENTIFIER_URI: m365ApplicationIdUri // Application ID URI of AAD app
+    CLIENT_ID: m365ClientId // Client id of AAD app
+    CLIENT_SECRET: m365ClientSecret // Client secret of AAD app
+    OAUTH_AUTHORITY: oauthAuthority // AAD authority
     {{#if (contains "fx-resource-frontend-hosting" plugins)}}
-    TAB_APP_ENDPOINT: tabAppEndpoint
+    TAB_APP_ENDPOINT: tabAppEndpoint // Enable CORS for tab app
     {{/if}}
   }
 }

package/templates/plugins/resource/simpleauth/bicep/simpleAuthProvision.template.bicep

@@ -2,11 +2,12 @@
 param provisionParameters object
 param userAssignedIdentityId string
 var resourceBaseName = provisionParameters.resourceBaseName
-var sku = contains(provisionParameters, 'simpleAuthSku') ? provisionParameters['simpleAuthSku'] : 'F1'
-var serverFarmsName = contains(provisionParameters, 'simpleAuthServerFarmsName') ? provisionParameters['simpleAuthServerFarmsName'] : '${resourceBaseName}simpleAuth'
-var webAppName = contains(provisionParameters, 'simpleAuthWebAppName') ? provisionParameters['simpleAuthWebAppName'] : '${resourceBaseName}simpleAuth'
-var simpleAuthPackageUri = contains(provisionParameters, 'simpleAuthPackageUri') ? provisionParameters['simpleAuthPackageUri'] : 'https://github.com/OfficeDev/TeamsFx/releases/download/simpleauth@0.1.0/Microsoft.TeamsFx.SimpleAuth_0.1.0.zip'
+var sku = contains(provisionParameters, 'simpleAuthSku') ? provisionParameters['simpleAuthSku'] : 'F1' // Try to read SKU for App Service Plan from parameters
+var serverFarmsName = contains(provisionParameters, 'simpleAuthServerFarmsName') ? provisionParameters['simpleAuthServerFarmsName'] : '${resourceBaseName}simpleAuth' // Try to read name for App Service Plan from parameters
+var webAppName = contains(provisionParameters, 'simpleAuthWebAppName') ? provisionParameters['simpleAuthWebAppName'] : '${resourceBaseName}simpleAuth' // Try to read name for Web App from parameters
+var simpleAuthPackageUri = contains(provisionParameters, 'simpleAuthPackageUri') ? provisionParameters['simpleAuthPackageUri'] : 'https://github.com/OfficeDev/TeamsFx/releases/download/simpleauth@0.1.0/Microsoft.TeamsFx.SimpleAuth_0.1.0.zip' // Try to read url of Simple Auth bits from parameters
 
+// Compute resources for Web App
 resource serverFarms 'Microsoft.Web/serverfarms@2021-02-01' = {
   name: serverFarmsName
   location: resourceGroup().location
@@ -16,22 +17,24 @@ resource serverFarms 'Microsoft.Web/serverfarms@2021-02-01' = {
   kind: 'app'
 }
 
+// Web App that hosts Simple Auth
 resource webApp 'Microsoft.Web/sites@2021-02-01' = {
   kind: 'app'
   name: webAppName
   location: resourceGroup().location
   properties: {
     serverFarmId: serverFarms.id
-    keyVaultReferenceIdentity: userAssignedIdentityId
+    keyVaultReferenceIdentity: userAssignedIdentityId // Use given user assigned identity to access Key Vault
   }
   identity: {
     type: 'UserAssigned'
     userAssignedIdentities: {
-      '${userAssignedIdentityId}': {}
+      '${userAssignedIdentityId}': {} // The identity is used to access other Azure resources
     }
   }
 }
 
+// Deploy Simple Auth bits to Web App
 resource simpleAuthDeploy 'Microsoft.Web/sites/extensions@2021-02-01' = {
   parent: webApp
   name: 'MSDeploy'

package/templates/plugins/resource/sql/bicep/newDatabase.orchestration.template.bicep

@@ -0,0 +1,5 @@
+// output for database with name suffix [{{suffix}}]
+output azureSqlOutput_{{suffix}} object = {
+  teamsFxPluginId: 'fx-resource-azure-sql'
+  databaseName_{{suffix}}: azureSqlProvision.outputs.databaseName_{{suffix}}
+}

package/templates/plugins/resource/sql/bicep/newDatabaseProvision.template.bicep

@@ -0,0 +1,15 @@
+// database added with name suffix [{{suffix}}]
+var sqlDatabaseName_{{suffix}} = contains(provisionParameters, 'sqlDatabaseName_{{suffix}}') ? provisionParameters['sqlDatabaseName_{{suffix}}'] : '${resourceBaseName}_{{suffix}}'
+var sqlDatabaseSku_{{suffix}} = contains(provisionParameters, 'sqlDatabaseSku_{{suffix}}') ? provisionParameters['sqlDatabaseSku_{{suffix}}'] : 'Basic'
+
+resource sqlDatabase_{{suffix}} 'Microsoft.Sql/servers/databases@2021-05-01-preview' = {
+  // parent should refer to resource symbolic name of SQL server
+  parent: sqlServer
+  location: resourceGroup().location
+  name: sqlDatabaseName_{{suffix}}
+  sku: {
+    name: sqlDatabaseSku_{{suffix}} 
+  }
+}
+
+output databaseName_{{suffix}} string = sqlDatabaseName_{{suffix}}

package/templates/plugins/resource/sql/bicep/sqlProvision.template.bicep

@@ -1,12 +1,14 @@
 @secure()
 param provisionParameters object
 var resourceBaseName = provisionParameters.resourceBaseName
-var sqlServerName = contains(provisionParameters, 'sqlServerName') ? provisionParameters['sqlServerName'] : '${resourceBaseName}'
-var sqlDatabaseName = contains(provisionParameters, 'sqlDatabaseName') ? provisionParameters['sqlDatabaseName'] : '${resourceBaseName}'
-var sqlDatabaseSku = contains(provisionParameters, 'sqlDatabaseSku') ? provisionParameters['sqlDatabaseSku'] : 'Basic'
-var administratorLogin = contains(provisionParameters, 'azureSqlAdmin') ? provisionParameters['azureSqlAdmin'] : ''
-var administratorLoginPassword = contains(provisionParameters, 'azureSqlAdminPassword') ? provisionParameters['azureSqlAdminPassword'] : ''
+var sqlServerName = contains(provisionParameters, 'sqlServerName') ? provisionParameters['sqlServerName'] : '${resourceBaseName}' // Try to read name for SQL Server from parameters
+var sqlDatabaseName = contains(provisionParameters, 'sqlDatabaseName') ? provisionParameters['sqlDatabaseName'] : '${resourceBaseName}' // Try to read name for SQL Database from parameters
+var sqlDatabaseSku = contains(provisionParameters, 'sqlDatabaseSku') ? provisionParameters['sqlDatabaseSku'] : 'Basic' // Try to read SKU for SQL Database from parameters
+var administratorLogin = contains(provisionParameters, 'azureSqlAdmin') ? provisionParameters['azureSqlAdmin'] : '' // Try to read admin name for SQL Server from parameters, the value must be empty or same with the admin name used to create SQL Server
+var administratorLoginPassword = contains(provisionParameters, 'azureSqlAdminPassword') ? provisionParameters['azureSqlAdminPassword'] : '' // Try to read admin password for SQL Server from parameters, empty means do not update admin password
 
+// SQL Server that hosts the databases
+// The symbolic name of SQL Server will be referenced as parent when adding nmultiple databases
 resource sqlServer 'Microsoft.Sql/servers@2021-05-01-preview' = {
   location: resourceGroup().location
   name: sqlServerName
@@ -16,6 +18,7 @@ resource sqlServer 'Microsoft.Sql/servers@2021-05-01-preview' = {
   }
 }
 
+// SQL Database
 resource sqlDatabase 'Microsoft.Sql/servers/databases@2021-05-01-preview' = {
   parent: sqlServer
   location: resourceGroup().location
@@ -25,6 +28,7 @@ resource sqlDatabase 'Microsoft.Sql/servers/databases@2021-05-01-preview' = {
   }
 }
 
+// Allow Azure services connect to the SQL Server
 resource sqlFirewallRules 'Microsoft.Sql/servers/firewallRules@2021-05-01-preview' = {
   parent: sqlServer
   name: 'AllowAzure'

package/templates/plugins/resource/storage/bicep/azureStorageProvision.bicep

@@ -0,0 +1,25 @@
+@secure()
+param provisionParameters object
+var resourceBaseName = provisionParameters.resourceBaseName
+var storageName = contains(provisionParameters, 'azureStorageName') ? provisionParameters['azureStorageName'] : '${resourceBaseName}tab' // Try to read name for frontend hosting Storage Account from parameters
+var storageSku = contains(provisionParameters, 'azureStorageSku') ? provisionParameters['azureStorageSku'] : '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
+  name: storageName
+  properties: {
+    supportsHttpsTrafficOnly: true
+  }
+  sku: {
+    name: storageSku // You can follow https://aka.ms/teamsfx-bicep-add-param-tutorial to add frontendHostingStorageSku property to provisionParameters to override the default value "Standard_LRS".
+  }
+}
+
+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/storage/bicep/provision.template.bicep

@@ -0,0 +1,15 @@
+// Resources for frontend hosting
+module azureStorageProvision '\{{fx-resource-azure-storage.Provision.azureStorage.path}}' = {
+  name: 'azureStorageProvision'
+  params: {
+    provisionParameters: provisionParameters
+  }
+}
+
+output azureStorageOutput object = {
+  teamsFxPluginId: 'fx-resource-frontend-hosting'
+  domain: azureStorageProvision.outputs.domain
+  endpoint: azureStorageProvision.outputs.endpoint
+  indexPath: azureStorageProvision.outputs.indexPath
+  storageResourceId: azureStorageProvision.outputs.resourceId
+}

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

@@ -0,0 +1,10 @@
+var webappCurrentAppSettings = list('${provisionOutputs.webappOutput.value.webAppResourceId}/config/appsettings', '2021-02-01').properties
+
+module teamsFxWebappConfig '\{{fx-resource-frontend-hosting.Configuration.webapp.path}}' = {
+  name: 'addTeamsFxWebappConfiguration'
+  params: {
+    provisionParameters: provisionParameters
+    provisionOutputs: provisionOutputs
+    currentAppSettings: webappCurrentAppSettings
+  }
+}

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

@@ -0,0 +1,16 @@
+// Resources for web app
+module webappProvision '\{{fx-resource-frontend-hosting.Provision.webapp.path}}' = {
+  name: 'webappProvision'
+  params: {
+    provisionParameters: provisionParameters
+    userAssignedIdentityId: userAssignedIdentityProvision.outputs.identityResourceId
+  }
+}
+
+output webappOutput object = {
+  teamsFxPluginId: 'fx-resource-frontend-hosting'
+  domain: webappProvision.outputs.domain
+  endpoint: webappProvision.outputs.endpoint
+  indexPath: webappProvision.outputs.indexPath
+  webAppResourceId: webappProvision.outputs.resourceId
+}