refactor: environment variable names to follow a consistent naming convention by Pavan-Microsoft · Pull Request #787 · microsoft/content-generation-solution-accelerator

Pavan-Microsoft · 2026-03-23T15:49:50Z

Purpose

This pull request standardizes and updates environment variable names across multiple GitHub Actions workflows and the .env.sample file to improve consistency, readability, and reduce confusion. The changes primarily affect variables related to Azure AI services, image models, and resource IDs.

Environment variable renaming and standardization:

Renamed AZURE_OPENAI_GPT_MODEL, AZURE_OPENAI_IMAGE_MODEL, and AZURE_OPENAI_API_VERSION to AZURE_ENV_GPT_MODEL_NAME, AZURE_ENV_IMAGE_MODEL_NAME, and AZURE_ENV_OPENAI_API_VERSION in .env.sample for greater clarity and consistency. [1] [2]
Updated resource ID variable names throughout workflows, e.g., AZURE_EXISTING_AI_PROJECT_RESOURCE_ID to AZURE_EXISTING_AIPROJECT_RESOURCE_ID, and AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID to AZURE_ENV_EXISTING_LOG_ANALYTICS_WORKSPACE_RID, ensuring consistent naming conventions. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12]
Changed AZURE_ENV_OPENAI_LOCATION to AZURE_ENV_AI_SERVICE_LOCATION and IMAGE_TAG to AZURE_ENV_IMAGE_TAG in all relevant workflow files for improved clarity and to avoid ambiguity. [1] [2] [3] [4] [5] [6]

Workflow input and output updates:

Updated workflow input parameter names and validation logic to match the new variable names, ensuring that input/output handling in deploy-v2.yml and deploy-orchestrator.yml is consistent with the new standards. [1] [2] [3] [4] [5]

Validation and assignment logic:

Refactored validation and assignment blocks in workflow scripts to use the new variable names, reducing the risk of misconfiguration and improving maintainability. [1] [2] [3]

These changes help ensure that environment variables are consistently named and used throughout the codebase, making it easier to configure, maintain, and debug deployments.

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 environment variable names to follow a consistent naming convention, replacing `AZURE_OPENAI_*` with `AZURE_ENV_*` for clarity and consistency across the codebase. - Modified GitHub Actions workflow to reflect new environment variable names for Docker image tagging. - Adjusted deployment scripts and local development scripts to utilize the new environment variable names. - Updated documentation to reflect changes in environment variable names for Azure OpenAI configuration. - Ensured backward compatibility by adding aliases for the old variable names where necessary.

Copilot

Pull request overview

Standardizes Azure-related environment variable and workflow input names across the repo to improve consistency and readability, while updating backend settings/tests/docs/infra to match.

Changes:

Renames Azure OpenAI model/API-version env vars to AZURE_ENV_* variants across code, scripts, docs, infra, and GitHub workflows.
Updates backend settings to accept both new (AZURE_ENV_*) and legacy (AZURE_OPENAI_*) env var names via Pydantic aliasing.
Updates workflow validation/output plumbing to use the new variable names (including image tag and location naming).

Reviewed changes

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

Show a summary per file

File	Description
`src/tests/test_settings.py`	Updates tests to use `AZURE_ENV_IMAGE_MODEL_NAME`.
`src/tests/conftest.py`	Updates test env to use `AZURE_ENV_OPENAI_API_VERSION`.
`src/backend/settings.py`	Adds Pydantic `AliasChoices` to support new + legacy env var names.
`src/backend/agents/image_content_agent.py`	Updates docstring to reference new image model env var name.
`scripts/sample_image_generation.py`	Updates usage docs to reference new image model env var name.
`scripts/sample_content_generation.py`	Updates usage docs to reference new GPT/image env var names.
`scripts/local_dev.sh`	Renames `.env` lookup + error message for Foundry project resource id var.
`scripts/local_dev.ps1`	Renames `.env` lookup + error message for Foundry project resource id var.
`scripts/deploy.sh`	Renames ACR and image tag env var names used by deployment helper script.
`scripts/deploy.ps1`	Renames ACR and image tag env var names used by deployment helper script.
`infra/main.waf.parameters.json`	Renames parameter substitution variables to `AZURE_ENV_*` equivalents.
`infra/main.parameters.json`	Renames parameter substitution variables to `AZURE_ENV_*` equivalents.
`infra/main.json`	Propagates renamed env vars into generated ARM template outputs/vars; also changes one parameter requiredness.
`infra/main.bicep`	Renames output/env var names emitted by infra to `AZURE_ENV_*` equivalents.
`docs/TECHNICAL_GUIDE.md`	Updates documented env var names.
`docs/LOCAL_DEPLOYMENT.md`	Updates documented env var names and sample dotenv block.
`docs/IMAGE_GENERATION.md`	Updates image generation docs to reference new env var names.
`docs/DEPLOYMENT.md`	Updates troubleshooting guidance to reference new env var name.
`docs/CustomizingAzdParameters.md`	Updates AZD parameter names and example commands to new naming scheme.
`docs/AZD_DEPLOYMENT.md`	Updates AZD env set examples to new naming scheme.
`azure.yaml`	Updates printed output variable names to match renamed env vars.
`.github/workflows/job-docker-build.yml`	Renames image-tag output to `AZURE_ENV_IMAGE_TAG` and updates downstream references.
`.github/workflows/job-deploy.yml`	Renames inputs/outputs to new names and updates validation/output wiring.
`.github/workflows/job-deploy-windows.yml`	Renames inputs and validation variables to new names.
`.github/workflows/job-deploy-linux.yml`	Renames inputs and validation variables to new names.
`.github/workflows/job-cleanup-deployment.yml`	Renames inputs/env vars for location and image tag.
`.github/workflows/deploy-v2.yml`	Renames workflow_dispatch inputs/outputs for EXP-related IDs to new names.
`.github/workflows/deploy-orchestrator.yml`	Renames forwarded inputs and docker-build output references to new names.
`.github/workflows/azure-dev.yml`	Renames secret/env var reference for AI service location.
`.env.sample`	Updates sample env var names to the new convention.

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

infra/main.json

.github/workflows/job-deploy.yml

.github/workflows/job-docker-build.yml

…ld job

Copilot

Pull request overview

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

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

docs/CustomizingAzdParameters.md

infra/main.parameters.json

infra/main.waf.parameters.json

…oss workflows and scripts

Copilot

Pull request overview

Copilot reviewed 31 out of 31 changed files in this pull request and generated 5 comments.

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

.github/workflows/job-deploy.yml

.github/workflows/job-deploy-linux.yml

.github/workflows/job-deploy-windows.yml

scripts/checkquota.sh

…ntation and scripts

Copilot

Pull request overview

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

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

src/tests/test_settings.py

src/tests/conftest.py

…pport in tests

- Updated workflow files to replace AZURE_ENV_LOG_ANALYTICS_WORKSPACE_RID with AZURE_ENV_EXISTING_LOG_ANALYTICS_WORKSPACE_RID and AZURE_ENV_FOUNDRY_PROJECT_RID with AZURE_EXISTING_AIPROJECT_RESOURCE_ID. - Modified validation logic for the new identifiers in job-deploy, job-deploy-linux, and job-deploy-windows workflows. - Adjusted output parameters in Bicep templates to reflect the new naming conventions. - Updated documentation to guide users on setting the new environment variables for existing resources. - Refactored local development scripts to accommodate the new environment variable names.

Copilot

Pull request overview

Copilot reviewed 34 out of 34 changed files in this pull request and generated 4 comments.

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

.github/workflows/job-deploy.yml

scripts/deploy.sh

docs/AZD_DEPLOYMENT.md

.env.sample

…docs region example - Fix deploy.sh: use backend/ApiApp.Dockerfile instead of WebApp.Dockerfile - Fix AZD_DEPLOYMENT.md: use eastus2 (allowed region) instead of eastus in example Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

Pull request overview

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

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

scripts/deploy.ps1

scripts/checkquota.sh

…aults - Fix deploy.ps1: use src\backend\ApiApp.Dockerfile instead of src\WebApp.Dockerfile - Remove eastus from checkquota.sh default regions (not in allowed azureAiServiceLocation values) - Add missing allowed regions to checkquota defaults Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

….ps1

Pavan-Microsoft requested a review from Copilot March 23, 2026 15:49

Pavan-Microsoft temporarily deployed to production March 23, 2026 15:49 — with GitHub Actions Inactive

Pavan-Microsoft changed the title ~~Refactor environment variable names for Azure OpenAI settings~~ refactor: environment variable names to follow a consistent naming convention Mar 23, 2026

Copilot started reviewing on behalf of Pavan-Microsoft March 23, 2026 15:51 View session

Copilot AI reviewed Mar 23, 2026

View reviewed changes

infra/main.json Show resolved Hide resolved

.github/workflows/job-deploy.yml Outdated Show resolved Hide resolved

.github/workflows/job-docker-build.yml Outdated Show resolved Hide resolved

fix: rename environment variable for container registry in Docker bui…

4211d9d

…ld job

Pavan-Microsoft temporarily deployed to production March 24, 2026 05:06 — with GitHub Actions Inactive

Pavan-Microsoft requested a review from Copilot March 24, 2026 06:09

Copilot started reviewing on behalf of Pavan-Microsoft March 24, 2026 06:10 View session

Copilot AI reviewed Mar 24, 2026

View reviewed changes

docs/CustomizingAzdParameters.md Outdated Show resolved Hide resolved

infra/main.parameters.json Show resolved Hide resolved

infra/main.waf.parameters.json Show resolved Hide resolved

refactor: rename image_model_choice to AZURE_ENV_IMAGE_MODEL_NAME acr…

947ae2d

…oss workflows and scripts

Pavan-Microsoft temporarily deployed to production March 24, 2026 08:22 — with GitHub Actions Inactive

Pavan-Microsoft requested a review from Copilot March 24, 2026 08:22

Copilot started reviewing on behalf of Pavan-Microsoft March 24, 2026 08:23 View session

Copilot AI reviewed Mar 24, 2026

View reviewed changes

fix: update environment variable references for image model in docume…

bd0aff5

…ntation and scripts

Pavan-Microsoft temporarily deployed to production March 24, 2026 09:21 — with GitHub Actions Inactive

Pavan-Microsoft requested a review from Copilot March 24, 2026 09:21

Copilot started reviewing on behalf of Pavan-Microsoft March 24, 2026 09:23 View session

Copilot AI reviewed Mar 24, 2026

View reviewed changes

src/tests/test_settings.py Show resolved Hide resolved

src/tests/conftest.py Show resolved Hide resolved

fix: update usage instructions and add legacy environment variable su…

14b3547

…pport in tests

Pavan-Microsoft temporarily deployed to production March 24, 2026 11:19 — with GitHub Actions Inactive

Vamshi-Microsoft and others added 2 commits March 27, 2026 08:58

fix: add RG_TAGS environment variable for resource group creation

ef25e8a

Merge remote-tracking branch 'origin/dev' into psl-pk-standparam

7d89978

Pavan-Microsoft temporarily deployed to production March 30, 2026 06:54 — with GitHub Actions Inactive

Merge remote-tracking branch 'origin/dev' into psl-pk-standparam

fd4f1ab

Pavan-Microsoft temporarily deployed to production April 8, 2026 11:57 — with GitHub Actions Inactive

Pavan-Microsoft temporarily deployed to production April 8, 2026 12:39 — with GitHub Actions Inactive

Pavan-Microsoft marked this pull request as ready for review April 8, 2026 15:57

Pavan-Microsoft requested review from Avijit-Microsoft, Prajwal-Microsoft, Roopan-Microsoft, Vinay-Microsoft, aniaroramsft, malrose07, nchandhi and toherman-msft as code owners April 8, 2026 15:57

Pavan-Microsoft temporarily deployed to production April 8, 2026 15:57 — with GitHub Actions Inactive

Pavan-Microsoft added 2 commits April 9, 2026 11:58

refactor: update environment variable names to use AZURE_ENV prefix

9f272f9

Merge remote-tracking branch 'origin/dev' into psl-pk-standparam

8d1866b

Pavan-Microsoft temporarily deployed to production April 9, 2026 06:33 — with GitHub Actions Inactive

Pavan-Microsoft requested a review from Copilot April 9, 2026 06:34

Copilot started reviewing on behalf of Pavan-Microsoft April 9, 2026 06:34 View session

Copilot AI reviewed Apr 9, 2026

View reviewed changes

.github/workflows/job-deploy.yml Show resolved Hide resolved

scripts/deploy.sh Outdated Show resolved Hide resolved

docs/AZD_DEPLOYMENT.md Outdated Show resolved Hide resolved

.env.sample Show resolved Hide resolved

Pavan-Microsoft temporarily deployed to production April 9, 2026 06:51 — with GitHub Actions Inactive

fix: uncomment metadata section in azure.yaml

eff00ed

Pavan-Microsoft temporarily deployed to production April 9, 2026 06:54 — with GitHub Actions Inactive

Pavan-Microsoft requested a review from Copilot April 9, 2026 06:58

Copilot started reviewing on behalf of Pavan-Microsoft April 9, 2026 06:59 View session

Copilot AI reviewed Apr 9, 2026

View reviewed changes

scripts/deploy.ps1 Show resolved Hide resolved

scripts/checkquota.sh Show resolved Hide resolved

Pavan-Microsoft temporarily deployed to production April 9, 2026 07:11 — with GitHub Actions Inactive

fix: update environment variable names to use AZURE_ prefix in deploy…

c72e70e

….ps1

Pavan-Microsoft temporarily deployed to production April 9, 2026 07:18 — with GitHub Actions Inactive

Roopan-Microsoft approved these changes Apr 9, 2026

View reviewed changes

Roopan-Microsoft merged commit b028039 into dev Apr 9, 2026
5 checks passed

Pavan-Microsoft deleted the psl-pk-standparam branch April 10, 2026 08:35

Conversation

Pavan-Microsoft commented Mar 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose

Does this introduce a breaking change?

Golden Path Validation

Deployment Validation

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Pavan-Microsoft commented Mar 23, 2026 •

edited

Loading