Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add description to all bicep files. #2534

Merged
merged 3 commits into from
Aug 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
metadata description = 'Creates an Azure Cognitive Services instance.'
jongio marked this conversation as resolved.
Show resolved Hide resolved
param name string
param location string = resourceGroup().location
param tags object = {}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
metadata description = 'Creates an Azure Cosmos DB account.'
param name string
param location string = resourceGroup().location
param tags object = {}
Expand Down
Original file line number Diff line number Diff line change
@@ -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 = {}
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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 = {}
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
metadata description = 'Creates a SQL role assignment under an Azure Cosmos DB account.'
param accountName string

param roleDefinitionId string
Expand Down
Original file line number Diff line number Diff line change
@@ -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' = {
Expand Down
Original file line number Diff line number Diff line change
@@ -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 = {}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
metadata description = 'Creates an Azure SQL Server instance.'
param name string
param location string = resourceGroup().location
param tags object = {}
Expand Down
1 change: 1 addition & 0 deletions templates/common/infra/bicep/core/gateway/apim.bicep
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
metadata description = 'Creates an Azure API Management instance.'
param name string
param location string = resourceGroup().location
param tags object = {}
Expand Down
Original file line number Diff line number Diff line change
@@ -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')
Expand Down
Original file line number Diff line number Diff line change
@@ -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

Expand Down
1 change: 1 addition & 0 deletions templates/common/infra/bicep/core/host/aks.bicep
Original file line number Diff line number Diff line change
@@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -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

Expand Down
1 change: 1 addition & 0 deletions templates/common/infra/bicep/core/host/appservice.bicep
Original file line number Diff line number Diff line change
@@ -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 = {}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
metadata description = 'Creates an Azure App Service plan.'
param name string
param location string = resourceGroup().location
param tags object = {}
Expand Down
Original file line number Diff line number Diff line change
@@ -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 = {}
Expand Down
Original file line number Diff line number Diff line change
@@ -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 = {}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
metadata description = 'Creates an Azure Container Apps environment.'
param name string
param location string = resourceGroup().location
param tags object = {}
Expand Down
Original file line number Diff line number Diff line change
@@ -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 = {}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
metadata description = 'Creates an Azure Container Registry.'
param name string
param location string = resourceGroup().location
param tags object = {}
Expand Down
1 change: 1 addition & 0 deletions templates/common/infra/bicep/core/host/functions.bicep
Original file line number Diff line number Diff line change
@@ -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 = {}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
metadata description = 'Creates an Azure Static Web Apps instance.'
param name string
param location string = resourceGroup().location
param tags object = {}
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
metadata description = 'Creates a Log Analytics workspace.'
param name string
param location string = resourceGroup().location
param tags object = {}
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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 = {}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
metadata description = 'Creates an Azure CDN profile.'
param name string
param location string = resourceGroup().location
param tags object = {}
Expand Down
2 changes: 1 addition & 1 deletion templates/common/infra/bicep/core/networking/cdn.bicep
Original file line number Diff line number Diff line change
@@ -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 = {}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
metadata description = 'Creates an Azure Cognitive Search instance.'
param name string
param location string = resourceGroup().location
param tags object = {}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
metadata description = 'Assigns an Azure Key Vault access policy.'
param name string = 'add'

param keyVaultName string
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
metadata description = 'Creates an Azure Key Vault.'
param name string
param location string = resourceGroup().location
param tags object = {}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
metadata description = 'Assigns ACR Pull permissions to access an Azure Container Registry.'
param containerRegistryName string
param principalId string

Expand Down
1 change: 1 addition & 0 deletions templates/common/infra/bicep/core/security/role.bicep
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
metadata description = 'Creates a role assignment for a service principal.'
param principalId string

@allowed([
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
metadata description = 'Creates an Azure storage account.'
param name string
param location string = resourceGroup().location
param tags object = {}
Expand Down