Add description to all bicep files. (Azure#2534)

* add description * capitalize-service-name * update-following-requests
0003BFFD43886488 · Aug 14, 2023 · bab62cb · bab62cb
1 parent 9c278e8
commit bab62cb
Show file tree

Hide file tree

Showing 38 changed files with 38 additions and 1 deletion.
diff --git a/templates/common/infra/bicep/core/ai/cognitiveservices.bicep b/templates/common/infra/bicep/core/ai/cognitiveservices.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates an Azure Cognitive Services instance.'
 param name string
 param location string = resourceGroup().location
 param tags object = {}

diff --git a/templates/common/infra/bicep/core/database/cosmos/cosmos-account.bicep b/templates/common/infra/bicep/core/database/cosmos/cosmos-account.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates an Azure Cosmos DB account.'
 param name string
 param location string = resourceGroup().location
 param tags object = {}

diff --git a/templates/common/infra/bicep/core/database/cosmos/mongo/cosmos-mongo-account.bicep b/templates/common/infra/bicep/core/database/cosmos/mongo/cosmos-mongo-account.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates an Azure Cosmos DB for MongoDB account.'
 param name string
 param location string = resourceGroup().location
 param tags object = {}

diff --git a/templates/common/infra/bicep/core/database/cosmos/mongo/cosmos-mongo-db.bicep b/templates/common/infra/bicep/core/database/cosmos/mongo/cosmos-mongo-db.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates an Azure Cosmos DB for MongoDB account with a database.'
 param accountName string
 param databaseName string
 param location string = resourceGroup().location

diff --git a/templates/common/infra/bicep/core/database/cosmos/sql/cosmos-sql-account.bicep b/templates/common/infra/bicep/core/database/cosmos/sql/cosmos-sql-account.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates an Azure Cosmos DB for NoSQL account.'
 param name string
 param location string = resourceGroup().location
 param tags object = {}

diff --git a/templates/common/infra/bicep/core/database/cosmos/sql/cosmos-sql-db.bicep b/templates/common/infra/bicep/core/database/cosmos/sql/cosmos-sql-db.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates an Azure Cosmos DB for NoSQL account with a database.'
 param accountName string
 param databaseName string
 param location string = resourceGroup().location

diff --git a/templates/common/infra/bicep/core/database/cosmos/sql/cosmos-sql-role-assign.bicep b/templates/common/infra/bicep/core/database/cosmos/sql/cosmos-sql-role-assign.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates a SQL role assignment under an Azure Cosmos DB account.'
 param accountName string
 
 param roleDefinitionId string

diff --git a/templates/common/infra/bicep/core/database/cosmos/sql/cosmos-sql-role-def.bicep b/templates/common/infra/bicep/core/database/cosmos/sql/cosmos-sql-role-def.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates a SQL role definition under an Azure Cosmos DB account.'
 param accountName string
 
 resource roleDefinition 'Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2022-08-15' = {

diff --git a/templates/common/infra/bicep/core/database/postgresql/flexibleserver.bicep b/templates/common/infra/bicep/core/database/postgresql/flexibleserver.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates an Azure Database for PostgreSQL - Flexible Server.'
 param name string
 param location string = resourceGroup().location
 param tags object = {}

diff --git a/templates/common/infra/bicep/core/database/sqlserver/sqlserver.bicep b/templates/common/infra/bicep/core/database/sqlserver/sqlserver.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates an Azure SQL Server instance.'
 param name string
 param location string = resourceGroup().location
 param tags object = {}

diff --git a/templates/common/infra/bicep/core/gateway/apim.bicep b/templates/common/infra/bicep/core/gateway/apim.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates an Azure API Management instance.'
 param name string
 param location string = resourceGroup().location
 param tags object = {}

diff --git a/templates/common/infra/bicep/core/host/aks-agent-pool.bicep b/templates/common/infra/bicep/core/host/aks-agent-pool.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Adds an agent pool to an Azure Kubernetes Service (AKS) cluster.'
 param clusterName string
 
 @description('The agent pool name')

diff --git a/templates/common/infra/bicep/core/host/aks-managed-cluster.bicep b/templates/common/infra/bicep/core/host/aks-managed-cluster.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates an Azure Kubernetes Service (AKS) cluster with a system agent pool.'
 @description('The name for the AKS managed cluster')
 param name string
 

diff --git a/templates/common/infra/bicep/core/host/aks.bicep b/templates/common/infra/bicep/core/host/aks.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates an Azure Kubernetes Service (AKS) cluster with a system agent pool as well as an additional user agent pool.'
 @description('The name for the AKS managed cluster')
 param name string
 

diff --git a/templates/common/infra/bicep/core/host/appservice-appsettings.bicep b/templates/common/infra/bicep/core/host/appservice-appsettings.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Updates app settings for an Azure App Service.'
 @description('The name of the app service resource within the current resource group scope')
 param name string
 

diff --git a/templates/common/infra/bicep/core/host/appservice.bicep b/templates/common/infra/bicep/core/host/appservice.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates an Azure App Service in an existing Azure App Service plan.'
 param name string
 param location string = resourceGroup().location
 param tags object = {}

diff --git a/templates/common/infra/bicep/core/host/appserviceplan.bicep b/templates/common/infra/bicep/core/host/appserviceplan.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates an Azure App Service plan.'
 param name string
 param location string = resourceGroup().location
 param tags object = {}

diff --git a/templates/common/infra/bicep/core/host/container-app-upsert.bicep b/templates/common/infra/bicep/core/host/container-app-upsert.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates or updates an existing Azure Container App.'
 param name string
 param location string = resourceGroup().location
 param tags object = {}

diff --git a/templates/common/infra/bicep/core/host/container-app.bicep b/templates/common/infra/bicep/core/host/container-app.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates a container app in an Azure Container App environment.'
 param name string
 param location string = resourceGroup().location
 param tags object = {}

diff --git a/templates/common/infra/bicep/core/host/container-apps-environment.bicep b/templates/common/infra/bicep/core/host/container-apps-environment.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates an Azure Container Apps environment.'
 param name string
 param location string = resourceGroup().location
 param tags object = {}

diff --git a/templates/common/infra/bicep/core/host/container-apps.bicep b/templates/common/infra/bicep/core/host/container-apps.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates an Azure Container Registry and an Azure Container Apps environment.'
 param name string
 param location string = resourceGroup().location
 param tags object = {}

diff --git a/templates/common/infra/bicep/core/host/container-registry.bicep b/templates/common/infra/bicep/core/host/container-registry.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates an Azure Container Registry.'
 param name string
 param location string = resourceGroup().location
 param tags object = {}

diff --git a/templates/common/infra/bicep/core/host/functions.bicep b/templates/common/infra/bicep/core/host/functions.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates an Azure Function in an existing Azure App Service plan.'
 param name string
 param location string = resourceGroup().location
 param tags object = {}

diff --git a/templates/common/infra/bicep/core/host/staticwebapp.bicep b/templates/common/infra/bicep/core/host/staticwebapp.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates an Azure Static Web Apps instance.'
 param name string
 param location string = resourceGroup().location
 param tags object = {}

diff --git a/templates/common/infra/bicep/core/monitor/applicationinsights-dashboard.bicep b/templates/common/infra/bicep/core/monitor/applicationinsights-dashboard.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates a dashboard for an Application Insights instance.'
 param name string
 param applicationInsightsName string
 param location string = resourceGroup().location

diff --git a/templates/common/infra/bicep/core/monitor/applicationinsights.bicep b/templates/common/infra/bicep/core/monitor/applicationinsights.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates an Application Insights instance based on an existing Log Analytics workspace.'
 param name string
 param dashboardName string
 param location string = resourceGroup().location

diff --git a/templates/common/infra/bicep/core/monitor/loganalytics.bicep b/templates/common/infra/bicep/core/monitor/loganalytics.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates a Log Analytics workspace.'
 param name string
 param location string = resourceGroup().location
 param tags object = {}

diff --git a/templates/common/infra/bicep/core/monitor/monitoring.bicep b/templates/common/infra/bicep/core/monitor/monitoring.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates an Application Insights instance and a Log Analytics workspace.'
 param logAnalyticsName string
 param applicationInsightsName string
 param applicationInsightsDashboardName string

diff --git a/templates/common/infra/bicep/core/networking/cdn-endpoint.bicep b/templates/common/infra/bicep/core/networking/cdn-endpoint.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Adds an endpoint to an Azure CDN profile.'
 param name string
 param location string = resourceGroup().location
 param tags object = {}

diff --git a/templates/common/infra/bicep/core/networking/cdn-profile.bicep b/templates/common/infra/bicep/core/networking/cdn-profile.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates an Azure CDN profile.'
 param name string
 param location string = resourceGroup().location
 param tags object = {}

diff --git a/templates/common/infra/bicep/core/networking/cdn.bicep b/templates/common/infra/bicep/core/networking/cdn.bicep
@@ -1,4 +1,4 @@
-// Module to create a CDN profile with a single endpoint
+metadata description = 'Creates an Azure CDN profile with a single endpoint.'
 param location string = resourceGroup().location
 param tags object = {}
 

diff --git a/templates/common/infra/bicep/core/search/search-services.bicep b/templates/common/infra/bicep/core/search/search-services.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates an Azure Cognitive Search instance.'
 param name string
 param location string = resourceGroup().location
 param tags object = {}

diff --git a/templates/common/infra/bicep/core/security/keyvault-access.bicep b/templates/common/infra/bicep/core/security/keyvault-access.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Assigns an Azure Key Vault access policy.'
 param name string = 'add'
 
 param keyVaultName string

diff --git a/templates/common/infra/bicep/core/security/keyvault-secret.bicep b/templates/common/infra/bicep/core/security/keyvault-secret.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates or updates a secret in an Azure Key Vault.'
 param name string
 param tags object = {}
 param keyVaultName string

diff --git a/templates/common/infra/bicep/core/security/keyvault.bicep b/templates/common/infra/bicep/core/security/keyvault.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates an Azure Key Vault.'
 param name string
 param location string = resourceGroup().location
 param tags object = {}

diff --git a/templates/common/infra/bicep/core/security/registry-access.bicep b/templates/common/infra/bicep/core/security/registry-access.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Assigns ACR Pull permissions to access an Azure Container Registry.'
 param containerRegistryName string
 param principalId string
 

diff --git a/templates/common/infra/bicep/core/security/role.bicep b/templates/common/infra/bicep/core/security/role.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates a role assignment for a service principal.'
 param principalId string
 
 @allowed([

diff --git a/templates/common/infra/bicep/core/storage/storage-account.bicep b/templates/common/infra/bicep/core/storage/storage-account.bicep
@@ -1,3 +1,4 @@
+metadata description = 'Creates an Azure storage account.'
 param name string
 param location string = resourceGroup().location
 param tags object = {}