Skip to content

Conversation

@Abdul-Microsoft
Copy link
Contributor

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

  • Added a comprehensive abbreviations.json file 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

  • Updated infra/deploy_ai_foundry.bicep to load and use abbreviations from the abbreviations.json file for naming Azure resources like AI services, log analytics workspaces, and AI hubs. This ensures consistency in resource names. [1] [2]
  • Simplified infra/deploy_keyvault.bicep by removing the solutionName parameter and directly using a keyvaultName parameter, aligning with the new naming conventions. [1] [2]
  • Removed the solutionName parameter from infra/deploy_managed_identity.bicep and replaced it with a miName parameter for naming the managed identity, improving flexibility.

Enhanced Parameterization and Defaults

  • Introduced new parameters in infra/main.bicep, such as environmentName and AZURE_LOCATION, to dynamically derive a unique solution prefix and allow deployment in different regions. This replaces static prefixes with a computed solutionPrefix. [1] [2]
  • Set default values for certain parameters, such as azureOpenAILocation, to streamline deployments while maintaining flexibility.

Resource Location and Naming Consistency

  • Updated resource definitions in infra/main.bicep to use the solutionLocation variable and abbreviations for names, ensuring uniformity across all deployed resources (e.g., AI services, log analytics, Cosmos DB). [1] [2] [3]

Minor Fixes

  • Corrected a typo in the keyvaultName output in infra/deploy_ai_foundry.bicep to match the updated parameter name.
  • Removed unused parameters and annotations from several Bicep templates to declutter the codebase. [1] [2]

These changes collectively enhance the scalability, maintainability, and readability of the infrastructure codebase.

  • ...

Does this introduce a breaking change?

  • Yes
  • No

How to Test

  • Get the code
git clone [repo-address]
cd [repo-name]
git checkout [branch-name]
npm install
  • Test the code

What to Check

Verify that the following are valid

  • ...

Other Information

@Roopan-Microsoft Roopan-Microsoft merged commit 2ec5359 into dev May 15, 2025
7 of 8 checks passed
@github-actions
Copy link

🎉 This PR is included in version 1.5.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

blessing-msft pushed a commit that referenced this pull request Aug 1, 2025
feat: Bicep Naming Convention Changes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants