Merge pull request Azure#54 from Azure/tj/feature/bicep-docs

Add Bicep Docs

Author: waelkdouh

bicep/main.bicep

@@ -94,7 +94,7 @@ param sendGridKeySecretValue string
 param secretStoreComponentName string
 
 @description('The key vault name store secrets')
-param keyVaultName string
+param keyVaultName string = '${prefix}kv-${uniqueString(resourceGroup().id)}${suffix}'
 
 // Container Registry & Images
 @description('The name of the container registry.')
@@ -112,23 +112,14 @@ param containerRegistryPasswordRefName string
 param containerRegistryPassword string
 
 @description('The image for the backend processor service.')
-param backendProcessoServiceImage string
+param backendProcessorServiceImage string
 
 @description('The image for the backend api service.')
 param backendApiServiceImage string
 
 @description('The image for the frontend web app service.')
 param frontendWebAppServiceImage string
 
-
-// ------------------
-// VARIABLES
-// ------------------
-
-// var keyVaultIdTokens = split(keyVaultId, '/')
-// var keyVaultName = keyVaultIdTokens[8]
-
-
 // ------------------
 // RESOURCES
 // ------------------
@@ -141,8 +132,6 @@ module containerAppsEnvironment 'modules/container-apps-environment.bicep' ={
    applicationInsightName: applicationInsightName
     location: location
     tags: tags
-     prefix: prefix
-     suffix: suffix
   }
 }
 
@@ -164,7 +153,6 @@ module serviceBus 'modules/service-bus.bicep' = {
     serviceBusTopicName: serviceBusTopicName
     serviceBusTopicAuthorizationRuleName: serviceBusTopicAuthorizationRuleName
     backendProcessorServiceName: backendProcessorServiceName
-    
   }
 }
 
@@ -175,8 +163,7 @@ module cosmosDb 'modules/cosmos-db.bicep' = {
     location: location
     tags: tags
     cosmosDbDatabaseName: cosmosDbDatabaseName
-    cosmosDbCollectionName: cosmosDbCollectionName
-    
+    cosmosDbCollectionName: cosmosDbCollectionName 
   }
 }
 
@@ -236,7 +223,7 @@ module containerApps 'modules/container-apps.bicep' = {
     cosmosDbDatabaseName: cosmosDb.outputs.cosmosDbDatabaseName
     cosmosDbCollectionName: cosmosDb.outputs.cosmosDbCollectionName    
     containerRegistryName: containerRegistryName
-    backendProcessoServiceImage: backendProcessoServiceImage
+    backendProcessorServiceImage: backendProcessorServiceImage
     backendApiServiceImage: backendApiServiceImage
     frontendWebAppServiceImage: frontendWebAppServiceImage
     sendGridKeySecretName: sendGridKeySecretName

bicep/main.parameters.json

@@ -59,9 +59,6 @@
     "secretStoreComponentName": {
       "value": "secretstoreakv"
     },
-    "keyVaultName": {
-      "value": "tasks-tracker-akv-4"
-    },
     "containerRegistryName": {
       "value": "<CONTAINER_REGISTRY_NAME>"
     },

bicep/modules/container-apps-environment.bicep

@@ -6,23 +6,17 @@ targetScope = 'resourceGroup'
 @description('The location where the resources will be created.')
 param location string = resourceGroup().location
 
-@description('Optional. The prefix to be used for all resources created by this template.')
-param prefix string = ''
-
-@description('Optional. The suffix to be used for all resources created by this template.')
-param suffix string = ''
-
 @description('Optional. The tags to be assigned to the created resources.')
 param tags object = {}
 
-@description('Optional. The name of the container apps environment. If set, it overrides the name generated by the template.')
-param containerAppsEnvironmentName string = '${prefix}cae-${uniqueString(resourceGroup().id)}${suffix}'
+@description('The name of the container apps environment. If set, it overrides the name generated by the template.')
+param containerAppsEnvironmentName string 
 
-@description('Optional. The name of the log analytics workspace. If set, it overrides the name generated by the template.')
-param logAnalyticsWorkspaceName string = '${prefix}log-${uniqueString(resourceGroup().id)}${suffix}'
+@description('The name of the log analytics workspace. If set, it overrides the name generated by the template.')
+param logAnalyticsWorkspaceName string 
 
-@description('Optional. The name of the application insights. If set, it overrides the name generated by the template.')
-param applicationInsightName string = '${prefix}appi-${uniqueString(resourceGroup().id)}${suffix}'
+@description(' The name of the application insights. If set, it overrides the name generated by the template.')
+param applicationInsightName string 
 
 // ------------------
 // VARIABLES
@@ -81,11 +75,5 @@ resource containerAppsEnvironment 'Microsoft.App/managedEnvironments@2022-10-01'
 // OUTPUTS
 // ------------------
 
-@description('The resource ID of the container apps environment.')
-output containerAppsEnvironmentId string = containerAppsEnvironment.id
-
-@description('The name of the container apps environment.')
-output containerAppsEnvironmentName string = containerAppsEnvironment.name
-
 @description('The name of the application insights.')
 output applicationInsightsName string  = applicationInsights.name

bicep/modules/container-apps.bicep

@@ -7,7 +7,7 @@ targetScope = 'resourceGroup'
 @description('The location where the resources will be created.')
 param location string = resourceGroup().location
 
-@description('Optional. The tags to be assigned to the created resources.')
+@description('The tags to be assigned to the created resources.')
 param tags object = {}
 
 @description('The name of the container apps environment.')
@@ -79,7 +79,7 @@ param containerRegistryPassword string
 param backendApiServiceImage string
 
 @description('The image for the backend processor service.')
-param backendProcessoServiceImage string
+param backendProcessorServiceImage string
 
 @description('The image for the frontend web app service.')
 param frontendWebAppServiceImage string
@@ -156,7 +156,7 @@ module backendProcessorService 'container-apps/processor-backend-service.bicep'
     sendGridKeySecretValue: sendGridKeySecretValue
     externalStorageAccountName: externalStorageAccountName
     externalStorageKeySecretName:externalStorageKeySecretName
-    backendProcessoServiceImage: backendProcessoServiceImage
+    backendProcessorServiceImage: backendProcessorServiceImage
     appInsightsInstrumentationKey: applicationInsights.properties.InstrumentationKey
   }
 }

bicep/modules/container-apps/processor-backend-service.bicep

@@ -36,10 +36,6 @@ param externalStorageKeySecretName string
 @description('The Application Insights Instrumentation.')
 param appInsightsInstrumentationKey string
 
-// @secure()
-// @description('The External Azure Stroage Access key for the Backend Background Processor Service.')
-// param externalAzureStroageKeySecretValue string
-
 // Service Bus
 @description('The name of the service bus namespace.')
 param serviceBusName string
@@ -70,7 +66,7 @@ param containerRegistryPasswordRefName string
 param containerRegistryPassword string
 
 @description('The image for the backend processor service.')
-param backendProcessoServiceImage string
+param backendProcessorServiceImage string
 
 
 // ------------------
@@ -82,9 +78,6 @@ var keyVaultSubscriptionId = keyVaultIdTokens[2]
 var keyVaultResourceGroupName = keyVaultIdTokens[4]
 var keyVaultName = keyVaultIdTokens[8]
 
-// var containerAppName = 'ca-${backendProcessorServiceName}'
-var containerAppName = backendProcessorServiceName
-
 // ------------------
 // RESOURCES
 // ------------------
@@ -109,7 +102,7 @@ resource storageAccount 'Microsoft.Storage/storageAccounts@2021-09-01' existing
 }
 
 resource backendProcessorService 'Microsoft.App/containerApps@2022-06-01-preview' = {
-  name: containerAppName
+  name: backendProcessorServiceName
   location: location
   tags: tags
   identity: {
@@ -153,7 +146,7 @@ resource backendProcessorService 'Microsoft.App/containerApps@2022-06-01-preview
       containers: [
         {
           name: backendProcessorServiceName
-          image: backendProcessoServiceImage
+          image: backendProcessorServiceImage
           resources: {
             cpu: json('0.25')
             memory: '0.5Gi'
@@ -200,8 +193,6 @@ resource backendProcessorService 'Microsoft.App/containerApps@2022-06-01-preview
 }
 
 
-
-
 // Enable consume from servicebus using system managed identity.
 resource backendProcessorService_sb_role_assignment 'Microsoft.Authorization/roleAssignments@2020-04-01-preview' = {
   name: guid(resourceGroup().id, backendProcessorServiceName, '4f6d3b9b-027b-4f4c-9142-0e5a2a2247e0')
@@ -210,11 +201,10 @@ resource backendProcessorService_sb_role_assignment 'Microsoft.Authorization/rol
     roleDefinitionId: resourceId('Microsoft.Authorization/roleDefinitions', '4f6d3b9b-027b-4f4c-9142-0e5a2a2247e0') // Azure Service Bus Data Receiver.
     principalType: 'ServicePrincipal'
   } 
-  //scope: serviceBusTopicSubscription
   scope: serviceBusNamespace
 }
 
-// Create secrets and assigne Secrets User role to the backend processor service
+// Invoke create secrets and assign role 'Azure Role Key Vault Secrets User' to the backend processor service
 module backendProcessorKeySecret 'secrets/processor-backend-service-secrets.bicep' = {
   name: 'backendProcessorKeySecret-${uniqueString(resourceGroup().id)}'
   params: {

bicep/modules/container-apps/secrets/processor-backend-service-secrets.bicep

@@ -51,7 +51,7 @@ resource sendGridKeySecret 'Microsoft.KeyVault/vaults/secrets@2022-07-01' = {
   }
 }
 
-// External Azure Stroage key secret used by Backend Background Processor Service.
+// External Azure storage key secret used by Backend Background Processor Service.
 resource externalAzureStorageKeySecret 'Microsoft.KeyVault/vaults/secrets@2022-07-01' = {
   parent: keyVault
   tags: tags
@@ -61,7 +61,6 @@ resource externalAzureStorageKeySecret 'Microsoft.KeyVault/vaults/secrets@2022-0
   }
 }
 
-//Changed scope to the enture key valut not 1 secret
 resource keyVaultSecretUserRoleAssignment 'Microsoft.Authorization/roleAssignments@2022-04-01' = {
   name: guid(subscription().id, keyVault.id, backendProcessorServicePrincipalId, keyVaultSecretUserRoleGuid) 
   scope: keyVault

bicep/modules/container-apps/webapi-backend-service.bicep

@@ -55,13 +55,6 @@ param backendApiServiceImage string
 @description('The Application Insights Instrumentation.')
 param appInsightsInstrumentationKey string
 
-// ------------------
-// VARIABLES
-// ------------------
-
-// var containerAppName = 'ca-${backendApiServiceName}'
-var containerAppName = backendApiServiceName
-
 // ------------------
 // RESOURCES
 // ------------------
@@ -77,7 +70,6 @@ resource serviceBusTopic 'Microsoft.ServiceBus/namespaces/topics@2021-11-01' exi
 
 resource cosmosDbAccount 'Microsoft.DocumentDB/databaseAccounts@2022-08-15' existing = {
   name: cosmosDbName
-
 }
 
 resource cosmosDbDatabase 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-04-15' existing = {
@@ -91,7 +83,7 @@ resource cosmosDbDatabaseCollection 'Microsoft.DocumentDB/databaseAccounts/sqlDa
 }
 
 resource backendApiService 'Microsoft.App/containerApps@2022-06-01-preview' = {
-  name: containerAppName
+  name: backendApiServiceName
   location: location
   tags: tags
   identity: {
@@ -168,15 +160,14 @@ resource backendApiService_cosmosdb_role_assignment 'Microsoft.DocumentDB/databa
   }
 }
 
-// Enable send to servicebus using app managed identity.
+// Enable publish message to Service Bus using app managed identity.
 resource backendApiService_sb_role_assignment 'Microsoft.Authorization/roleAssignments@2020-04-01-preview' = {
   name: guid(resourceGroup().id, backendApiService.name, '69a216fc-b8fb-44d8-bc22-1f3c2cd27a39')
   properties: {
     principalId: backendApiService.identity.principalId
     roleDefinitionId: resourceId('Microsoft.Authorization/roleDefinitions', '69a216fc-b8fb-44d8-bc22-1f3c2cd27a39')//Azure Service Bus Data Sender
     principalType: 'ServicePrincipal'
   }
-  
   scope: serviceBusTopic
 }
 

bicep/modules/container-apps/webapp-frontend-service.bicep

@@ -34,24 +34,16 @@ param containerRegistryPassword string
 @description('The image for the frontend web app service.')
 param frontendWebAppServiceImage string
 
-
 @secure()
 @description('The Application Insights Instrumentation.')
 param appInsightsInstrumentationKey string
 
-// ------------------
-// VARIABLES
-// ------------------
-
-// var containerAppName = 'ca-${frontendWebAppServiceName}'
-var containerAppName = frontendWebAppServiceName
-
 // ------------------
 // RESOURCES
 // ------------------
 
 resource frontendWebAppService 'Microsoft.App/containerApps@2022-06-01-preview' = {
-  name: containerAppName
+  name: frontendWebAppServiceName
   location: location
   tags: tags
   properties: {

bicep/modules/cosmos-db.bicep

@@ -19,12 +19,6 @@ param cosmosDbDatabaseName string
 @description('The name of Cosmos DB\'s collection.')
 param cosmosDbCollectionName string
 
-
-// ------------------
-// VARIABLES
-// ------------------
-
-
 // ------------------
 // RESOURCES
 // ------------------
@@ -89,5 +83,3 @@ output cosmosDbName string = cosmosDbAccount.name
 output cosmosDbDatabaseName string = cosmosDbDatabase.name
 @description('The name of Cosmos DB\'s collection.')
 output cosmosDbCollectionName string = cosmosDbDatabaseCollection.name
-@description('The document endpoint of Cosmos DB\'s account.')
-output cosmosDbDocumentEndpoint string = cosmosDbAccount.properties.documentEndpoint

bicep/modules/dapr-components.bicep

@@ -69,7 +69,7 @@ resource cosmosDbAccount 'Microsoft.DocumentDB/databaseAccounts@2022-08-15' exis
   name: cosmosDbName
 }
 
-//Secret Store
+//Secret Store Component
 resource secretstoreComponent 'Microsoft.App/managedEnvironments/daprComponents@2022-03-01' = {
   name: secretStoreComponentName
   parent: containerAppsEnvironment
@@ -89,7 +89,7 @@ resource secretstoreComponent 'Microsoft.App/managedEnvironments/daprComponents@
   }
 }
 
-//Cosmos DB State Store
+//Cosmos DB State Store Component
 resource statestoreComponent 'Microsoft.App/managedEnvironments/daprComponents@2022-06-01-preview' = {
   name: 'statestore'
   parent: containerAppsEnvironment
@@ -118,7 +118,7 @@ resource statestoreComponent 'Microsoft.App/managedEnvironments/daprComponents@2
   }
 }
 
-//PubSub service bus
+//PubSub service bus Component
 resource pubsubComponent 'Microsoft.App/managedEnvironments/daprComponents@2022-06-01-preview' = {
   name: 'dapr-pubsub-servicebus'
   parent: containerAppsEnvironment