refactor: removed commented code, fixes for Standard Gallery validation & updated docs

[Prajwal-Microsoft]

Purpose

This pull request introduces several improvements and updates related to deployment requirements, documentation, error troubleshooting, and workflow automation for the solution accelerator. The most notable changes include raising the minimum required version of the Azure Developer CLI (azd), expanding and clarifying troubleshooting documentation, updating workflow files for better validation and deployment metadata, and adding a new guide for building and pushing container images.

Deployment Requirements & Documentation

• Raised the minimum required version of Azure Developer CLI (azd) to 1.18.0 in azure.yaml, README.md, and docs/DeploymentGuide.md, and added clear notes to documentation to ensure users install the correct version before deployment. [1] [2] [3] [4]
• Added a comprehensive guide (docs/ACRBuildAndPushGuide.md) for building and pushing Docker images to Azure Container Registry (ACR), including step-by-step instructions for both backend and frontend services, verification steps, and best practices.

Troubleshooting Enhancements

• Greatly expanded the troubleshooting documentation (docs/TroubleShootingSteps.md) to cover many additional Azure deployment errors, their causes, and resolutions, including new sections for errors like InvalidRequestContent, ReadOnlyDisabledSubscription, SkuNotAvailable, CrossTenantDeploymentNotPermitted, PrincipalNotFound, and more. [1] [2] [3] [4]

Workflow & Automation Updates

• Updated GitHub workflow files:
  • In .github/workflows/azure-dev.yml: Upgraded the Azure template validation action to v0.4.2, added explicit secrets, set useDevContainer to false, and improved workflow dispatch triggers.
  • In .github/workflows/CAdeploy.yml: Added a step to generate a deployment timestamp and included deployment metadata tags for improved resource tracking.

Infrastructure Template Cleanup

• Removed commented-out parameters in infra/main.bicep to clean up the infrastructure code and improve maintainability.

These changes collectively improve the reliability, maintainability, and clarity of the deployment process and supporting documentation for the solution accelerator.

Deployment and Tooling Requirements

• Updated required Azure Developer CLI (azd) version to 1.18.0 or higher in azure.yaml, README.md, and docs/DeploymentGuide.md to ensure compatibility with deployment scripts and infrastructure templates. [1] [2] [3] [4]
• In .github/workflows/CAdeploy.yml, added logic to generate a UTC timestamp for resource tagging and included new tags in Azure deployment parameters for better resource tracking and auditability.

Documentation Enhancements

• Added a comprehensive guide (docs/ACRBuildAndPushGuide.md) for building and pushing Docker images to Azure Container Registry (ACR), covering both backend and frontend services, manual image updates, and verification steps.

Troubleshooting Improvements

• Significantly expanded docs/TroubleShootingSteps.md with new error scenarios and resolutions, including errors related to request content, subscription status, SKU availability, cross-tenant deployments, policy restrictions, resource restoration, principal not found, storage redundancy, deployment not found, deployment cancellation, resource group deletion timeout, SQL server reference issues, Cosmos DB provisioning failures, OpenAI quota access, and container image build errors. [1] [2] [3] [4]

Infrastructure Template Clean-up

• Removed commented-out parameters (fabricWorkspaceId, AzureOpenAILocation, vmAdminUsername, vmAdminPassword) from infra/main.bicep to improve maintainability and reduce confusion. [1] [2] [3]

Minor Documentation Corrections

• Updated resource provider registration and error references in troubleshooting documentation for accuracy and to point to the latest Microsoft guidance.

Let me know if you'd like to walk through any specific changes in detail!

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

[Copilot]

Pull Request Overview

This PR focuses on infrastructure template clean-up by removing commented-out code parameters while also implementing several related improvements. The changes involve cleaning up the main Bicep template, updating configuration variables for better clarity, adding documentation, and enhancing deployment workflows.

• Removed commented-out parameters from infra/main.bicep to improve template maintainability
• Refactored configuration variables for better naming consistency (MID_ID → SQL_MID_ID)
• Updated Azure Developer CLI version requirements to 1.18.0+ across multiple files

Reviewed Changes

Copilot reviewed 13 out of 15 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
infra/main.bicep	Removed commented parameters and added SQL-specific managed identity with proper role assignments
src/App/backend/common/config.py	Added SQL_MID_ID configuration variable alongside existing MID_ID
src/App/backend/services/sqldb_service.py	Updated to use new SQL_MID_ID configuration variable
infra/scripts/process_sample_data.sh	Renamed variables for SQL managed identity operations
infra/main.json	Updated template hash and deployment dependencies order
tests/e2e-test/pages/homePage.py	Adjusted timeout values for chat history operations
docs/	Added ACR build guide and expanded troubleshooting documentation
azure.yaml, README.md, docs/DeploymentGuide.md	Updated azd version requirement to 1.18.0+
.github/workflows/	Updated template validation action and added deployment tags

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[github-actions]

🎉 This PR is included in version 1.9.2 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀