feat: Bicep Naming Convention Changes #208
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
This pull request introduces a significant reorganization and enhancement of Azure resource naming conventions by incorporating a centralized abbreviations file. It also refactors multiple Bicep templates to utilize these abbreviations and improve parameterization, resulting in a more consistent and maintainable infrastructure-as-code setup. Below are the most important changes grouped by theme:
Centralized Resource Naming
abbreviations.jsonfile to define consistent abbreviations for Azure resource types across categories such as AI, analytics, compute, networking, and storage. This replaces hardcoded naming patterns in Bicep files.Refactoring of Bicep Templates
infra/deploy_ai_foundry.bicepto load and use abbreviations from theabbreviations.jsonfile for naming Azure resources like AI services, log analytics workspaces, and AI hubs. This ensures consistency in resource names. [1] [2]infra/deploy_keyvault.bicepby removing thesolutionNameparameter and directly using akeyvaultNameparameter, aligning with the new naming conventions. [1] [2]solutionNameparameter frominfra/deploy_managed_identity.bicepand replaced it with amiNameparameter for naming the managed identity, improving flexibility.Enhanced Parameterization and Defaults
infra/main.bicep, such asenvironmentNameandAZURE_LOCATION, to dynamically derive a unique solution prefix and allow deployment in different regions. This replaces static prefixes with a computedsolutionPrefix. [1] [2]azureOpenAILocation, to streamline deployments while maintaining flexibility.Resource Location and Naming Consistency
infra/main.bicepto use thesolutionLocationvariable and abbreviations for names, ensuring uniformity across all deployed resources (e.g., AI services, log analytics, Cosmos DB). [1] [2] [3]Minor Fixes
keyvaultNameoutput ininfra/deploy_ai_foundry.bicepto match the updated parameter name.These changes collectively enhance the scalability, maintainability, and readability of the infrastructure codebase.
Does this introduce a breaking change?
How to Test
What to Check
Verify that the following are valid
Other Information