Skip to content

feat: Centralize resource name abbreviations and update Bicep files for consistent naming #411

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

Conversation

Harmanpreet-Microsoft
Copy link
Contributor

Purpose

This pull request introduces a centralized JSON file (abbreviations.json) to manage resource name abbreviations and updates various Bicep deployment files to use these abbreviations. This change simplifies resource naming conventions and ensures consistency across the infrastructure codebase.

Centralized Abbreviation Management:

  • Added infra/abbreviations.json to define a comprehensive mapping of resource types to their abbreviations, categorized by themes such as AI, analytics, compute, databases, and more.

Updates to Resource Naming in Bicep Files:

  • Updated infra/deploy_ai_foundry.bicep to replace hardcoded resource names with dynamic names derived from abbreviations.json. This includes variables like storageName, aiServicesName, applicationInsightsName, and others.
  • Modified infra/deploy_app_service.bicep to use abbreviations for HostingPlanName and WebsiteName, ensuring consistent naming. [1] [2]
  • Updated infra/deploy_cosmos_db.bicep to use the abbreviation for Cosmos DB account names.
  • Adjusted infra/deploy_keyvault.bicep to derive the Key Vault name dynamically from the abbreviation file.
  • Applied the same abbreviation-based naming convention to infra/deploy_managed_identity.bicep and infra/deploy_storage_account.bicep for managed identity and storage account names, respectively. [1] [2]

Minor Adjustments:

  • Commented out the statisticsEnabled property in the aiServices resource definition in infra/deploy_ai_foundry.bicep.
  • ...

Does this introduce a breaking change?

  • Yes
  • No

Golden Path Validation

  • I have tested the primary workflows (the "golden path") to ensure they function correctly without errors.

Deployment Validation

  • I have validated the deployment process successfully and all services are running as expected with this change.

What to Check

Verify that the following are valid

  • I have built and tested the code locally and in a deployed app
  • For frontend changes, I have pulled the latest code from main, built the frontend, and committed all static files.
  • This is a change for all users of this app. No code or asset is specific to my use case or my organization.

Other Information

@Harmanpreet-Microsoft Harmanpreet-Microsoft changed the base branch from main to refactor/bicep-use-abbreviations April 28, 2025 12:01
@Harmanpreet-Microsoft Harmanpreet-Microsoft merged commit 3073b4d into microsoft:refactor/bicep-use-abbreviations Apr 28, 2025
9 of 10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant