Skip to content

refactor: Azure parameters and update API versions across Bicep modules and AVMPostDeploymentGuid#776

Merged
Avijit-Microsoft merged 5 commits intodevfrom
psl-pk-params
Mar 17, 2026
Merged

refactor: Azure parameters and update API versions across Bicep modules and AVMPostDeploymentGuid#776
Avijit-Microsoft merged 5 commits intodevfrom
psl-pk-params

Conversation

@Pavan-Microsoft
Copy link
Collaborator

Purpose

This pull request introduces several improvements and refactors to environment variable naming, documentation, and infrastructure provisioning for the Content Generation solution accelerator. The main focus is on standardizing parameter names, updating module versions, and enhancing post-deployment guidance.

Environment variable and parameter standardization:

  • Updated environment variable and parameter names throughout the .env.sample, infra/main.bicep, and documentation files to use a consistent naming convention (e.g., AZURE_OPENAI_GPT_MODEL, AZURE_OPENAI_IMAGE_MODEL, AZURE_COSMOS_DATABASE_NAME, etc.), replacing previous camelCase and inconsistent names. [1] [2] [3] [4]

Documentation improvements:

  • Added a comprehensive docs/AVMPostDeploymentGuide.md to guide users through post-deployment steps after using the AVM template, including prerequisites, manual script execution, and verification steps.
  • Updated docs/CustomizingAzdParameters.md and docs/TECHNICAL_GUIDE.md to reflect the new standardized parameter names and environment variables. [1] [2] [3]

Infrastructure and module version updates:

  • Upgraded AVM module versions in infra/main.bicep for Log Analytics Workspace, Managed Identity, Cognitive Services Account, Private Endpoint, Search Service, and Storage Account to ensure compatibility and access to new features. [1] [2] [3] [4] [5] [6]
  • Changed AI Search replica count from 2 to 3 when redundancy is enabled and updated hosting mode capitalization.
  • Updated resource group tag handling to reference the existing resource group for tags and switched to a newer API version for tagging. [1] [2]

Telemetry and optional parameters:

  • Clarified telemetry parameter descriptions and added telemetry enablement to relevant modules. [1] [2] [3] [4]
  • Changed ACR (Azure Container Registry) parameter from required to optional in infra/main.bicep.

Minor fixes and enhancements:

  • Fixed data type for Log Analytics Workspace daily quota to string.
  • Updated AI Search connection resource API version for improved compatibility.

These changes collectively improve deployment consistency, documentation clarity, and infrastructure reliability.

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.

- Updated parameter references in main.parameters.json and main.waf.parameters.json to use consistent naming conventions.
- Changed API versions for Cognitive Services and Container Instances in Bicep modules to the latest preview versions.
- Enhanced role assignment module to reference updated API versions for existing AI Services and Projects.
- Modified web-sites.bicep to include telemetry options and updated API versions, ensuring compatibility with the latest Azure features.
- Improved post_deploy.py script to fetch deployment outputs from Azure, allowing for dynamic configuration based on existing resources.
@Pavan-Microsoft Pavan-Microsoft changed the title Refactor Azure parameters and update API versions across Bicep modules Refactor Azure parameters and update API versions across Bicep modules and AVMPostDeploymentGuid Mar 17, 2026
@Pavan-Microsoft Pavan-Microsoft changed the title Refactor Azure parameters and update API versions across Bicep modules and AVMPostDeploymentGuid refactor: Azure parameters and update API versions across Bicep modules and AVMPostDeploymentGuid Mar 17, 2026
@Pavan-Microsoft Pavan-Microsoft marked this pull request as draft March 17, 2026 10:14
@Pavan-Microsoft Pavan-Microsoft requested a review from Copilot March 17, 2026 10:14
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR refactors the solution accelerator’s infrastructure and guidance to standardize Azure parameter/environment naming, upgrade AVM module/API versions in Bicep templates, and improve the AVM post-deployment experience (including automatic resource discovery for the post-deploy script).

Changes:

  • Standardizes infra parameter placeholders and runtime/documented environment variable names (Cosmos/Blob/OpenAI, etc.).
  • Updates multiple AVM/Bicep module and resource API versions, and propagates telemetry enablement through modules.
  • Adds an AVM-specific post-deployment guide and enhances scripts/post_deploy.py to optionally discover resource names from Azure deployment outputs.

Reviewed changes

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

Show a summary per file
File Description
scripts/post_deploy.py Adds Azure deployment-output discovery + improves admin health check behavior.
infra/main.bicep Refactors tags handling, updates AVM module versions/API usage, telemetry propagation, and other infra tweaks.
infra/main.json Regenerated ARM template reflecting Bicep/API/module updates.
infra/main.parameters.json Renames azd parameter placeholders to standardized env var names.
infra/main.waf.parameters.json Same parameter placeholder standardization for WAF profile.
infra/modules/web-sites.bicep Updates Web Sites API typings/versions, adds telemetry param, and adjusts vnet-related config placement for newer APIs.
infra/modules/web-sites.config.bicep Updates API versions for sites/config and storage account references.
infra/modules/container-instance.bicep Removes the registry server parameter and bumps container group API version.
infra/modules/ai-project.bicep Updates Cognitive Services / AI Project API versions.
infra/modules/deploy_foundry_role_assignment.bicep Updates API versions and hardens access to optional identity properties in outputs.
docs/AVMPostDeploymentGuide.md New post-deployment guide for AVM template deployments.
docs/CustomizingAzdParameters.md Updates documentation to new standardized parameter names.
docs/TECHNICAL_GUIDE.md Updates env var documentation to match src/backend/settings.py aliases.
docs/DEPLOYMENT.md Minor documentation formatting adjustments.
.env.sample Renames Foundry image deployment env var to match backend settings alias.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR standardizes Azure parameter/environment variable naming and refreshes Bicep/AVM module/API versions for the Content Generation solution accelerator, while improving post-deployment guidance and automation support (especially for AVM deployments).

Changes:

  • Standardize parameter/env-var names across infra parameter files, .env.sample, and docs; add an AVM post-deployment guide.
  • Update multiple Bicep modules to newer API/module versions and propagate telemetry parameters.
  • Enhance scripts/post_deploy.py to optionally discover required resource names from Azure deployment outputs and include admin API headers in health checks.

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
scripts/post_deploy.py Adds deployment-output discovery via Azure CLI and adjusts admin health check request headers/logging.
infra/modules/web-sites.config.bicep Updates Web/Storage resource API versions used for existing resources and config.
infra/modules/web-sites.bicep Adds telemetry parameter plumbing and updates Web Sites API versions; merges VNet flags into siteConfig.
infra/modules/deploy_foundry_role_assignment.bicep Updates Cognitive Services API versions and makes project principalId output null-safe.
infra/modules/container-instance.bicep Removes registry server param and updates ACI API version.
infra/modules/ai-project.bicep Updates AI Project/Cognitive Services API versions.
infra/main.waf.parameters.json Switches azd parameter placeholders to standardized env var names (WAF config).
infra/main.parameters.json Switches azd parameter placeholders to standardized env var names (default config).
infra/main.json Regenerated ARM template reflecting Bicep/module updates, tag handling refactor, and various API/version bumps.
infra/main.bicep Core infra refactor: RG tag handling, module bumps, telemetry propagation, and parameter standardization.
docs/TECHNICAL_GUIDE.md Updates configuration documentation to match standardized backend env var names.
docs/DEPLOYMENT.md Minor formatting update in the parameter table.
docs/CustomizingAzdParameters.md Updates documented azd env var names/examples to the new standardized convention.
docs/AVMPostDeploymentGuide.md Adds a new AVM-specific post-deployment guide with manual script steps.
.env.sample Updates Foundry image deployment env var name to AZURE_AI_IMAGE_MODEL_DEPLOYMENT.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@Pavan-Microsoft Pavan-Microsoft marked this pull request as ready for review March 17, 2026 11:06
@Avijit-Microsoft Avijit-Microsoft merged commit 7b3a4ae into dev Mar 17, 2026
5 checks passed
@Pavan-Microsoft Pavan-Microsoft deleted the psl-pk-params branch March 18, 2026 08:04
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.

3 participants