Skip to content

feat: Introduce abbreviations.json and update Bicep files for consistent resource naming #412

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

Merged
merged 13 commits into from
May 2, 2025

Conversation

Harmanpreet-Microsoft
Copy link
Contributor

Purpose

This pull request introduces a centralized abbreviation system for resource naming in Azure infrastructure deployment scripts. The changes streamline naming conventions by loading abbreviations from a new abbreviations.json file and applying them across multiple Bicep deployment files. Additionally, a minor change comments out a property in the AI services resource configuration.

Centralized Abbreviation Management:

  • Added infra/abbreviations.json to define a standardized set of abbreviations for Azure resource types, categorized by service domains like AI, compute, storage, networking, etc.
  • Updated multiple Bicep files (deploy_ai_foundry.bicep, deploy_app_service.bicep, deploy_cosmos_db.bicep, deploy_keyvault.bicep, deploy_managed_identity.bicep, deploy_storage_account.bicep, and main.bicep) to load and use these abbreviations for resource naming. Examples include:
    • AI services (aiServicesName) now use ${abbrs.ai.aiServices} instead of hardcoded prefixes like ais-.
    • Storage accounts (saName) now use ${abbrs.storage.storageAccount} instead of st.
    • Key Vaults (keyvaultName) now use ${abbrs.security.keyVault} instead of kv-.

Minor AI Services Configuration Change:

  • Commented out the statisticsEnabled property in the AI services resource definition in deploy_ai_foundry.bicep. This change might require further clarification on its intent.
  • ...

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

@Roopan-Microsoft Roopan-Microsoft merged commit 8ebf4b7 into main May 2, 2025
10 checks passed
@Roopan-Microsoft Roopan-Microsoft deleted the refactor/bicep-use-abbreviations branch May 2, 2025 05:17
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.

2 participants