feat: Docgen Bicep Standard Changes - vars

[Kingshuk-Microsoft]

Purpose

• This pull request introduces significant improvements to the Azure infrastructure deployment scripts, focusing on standardizing parameter names, supporting resource tagging, and enhancing output variables for better integration and management. The changes primarily update the Bicep templates and deployment workflows to align with best practices, improve maintainability, and provide more flexibility for resource configuration.

Key changes include:

Standardization and Parameterization

• Standardized parameter names across Bicep modules (e.g., solutionName, hostingPlanName, websiteName) and added descriptions to improve clarity and consistency in infra/deploy_ai_foundry.bicep, infra/deploy_app_service.bicep, and related files. [1] [2] [3]
• Updated the deployment workflow (.github/workflows/deploy.yml) to use solutionName instead of environmentName for consistency with Bicep modules.

Resource Tagging Support

• Introduced a tags parameter (with default empty object) to multiple Bicep files and ensured all major Azure resources (e.g., Log Analytics, Application Insights, Cognitive Services, Key Vault secrets, Search services) propagate this tags object, enabling consistent resource tagging for management and cost tracking. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19] [20] [21] [22] [23]

Output Enhancements

• Added numerous output variables to infra/deploy_ai_foundry.bicep for key resource names, IDs, endpoints, and connection strings, making it easier to integrate deployed resources with downstream systems or modules.

Naming Conventions

• Replaced dynamic abbreviations with fixed resource name prefixes (e.g., aif-, appi-, kv-, srch-, log-) for resource names, improving predictability and reducing dependency on external abbreviation files.

Miscellaneous Improvements

• Added or updated parameters in infra/deploy_app_service.bicep to support additional configuration options such as API versions, enabling/disabling chat history, and specifying AI resource/project details.

These changes collectively improve the maintainability, clarity, and operational flexibility of the Azure deployment process.

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

[github-actions]

🎉 This PR is included in version 1.6.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀