Skip to content

refactor: standardize naming conventions and parameter handling in Bicep templates1 #106

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 3 commits into from
May 21, 2025

Conversation

Harmanpreet-Microsoft
Copy link
Contributor

Purpose

This pull request focuses on standardizing naming conventions and improving parameter handling in the Bicep infrastructure files. The most significant changes involve replacing inconsistent variable names, refining resource prefixes, and ensuring that parameters conform to updated naming and length constraints.

Naming Convention Updates:

  • Updated variable names to replace prefixCleaned with ResourcePrefix across multiple resources, ensuring consistency in naming conventions. (infra/main.bicep: [1] [2] [3] [4] [5] [6] [7]
  • Renamed variables like aiServicesName to azureAiServicesName for clarity and alignment with Azure naming standards. (infra/main.bicep: infra/main.bicepL81-R77)

Parameter Refinements:

  • Changed the ResourcePrefix parameter to Prefix with updated constraints (3-20 characters) and added logic to truncate longer values to 20 characters. (infra/main.bicep: infra/main.bicepL2-R5)
  • Updated parameter descriptions to better reflect usage and constraints. (infra/main.bicep: infra/main.bicepL2-R5)

Resource Name Adjustments:

  • Standardized resource names by appending ResourcePrefix to ensure unique and descriptive names for resources like storage containers, AI services, and container apps. (infra/main.bicep: [1] [2] [3] [4]

Variable Simplifications:

  • Simplified the construction of resource names by directly using ResourcePrefix and removing unnecessary transformations like replace operations. (infra/main.bicep: infra/main.bicepL52-R52)
  • Removed redundant variables like aiHubName and replaced them with updated counterparts (azureAiHubName). (infra/deploy_ai_foundry.bicep: infra/deploy_ai_foundry.bicepL14-L30)
  • ...

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

  • ...

Other Information

@Roopan-Microsoft Roopan-Microsoft merged commit ba0d243 into dev May 21, 2025
6 checks passed
Copy link

🎉 This PR is included in version 1.3.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

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