fix: Standardize environment variable naming conventions#867
Merged
Roopan-Microsoft merged 14 commits intoApr 23, 2026
Conversation
- Renamed AZURE_ENV_OPENAI_LOCATION to AZURE_ENV_AI_SERVICE_LOCATION - Renamed AZURE_ENV_MODEL_NAME to AZURE_ENV_GPT_MODEL_NAME - Renamed AZURE_ENV_MODEL_VERSION to AZURE_ENV_GPT_MODEL_VERSION - Renamed AZURE_ENV_MODEL_CAPACITY to AZURE_ENV_GPT_MODEL_CAPACITY - Renamed AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID to AZURE_ENV_LOG_ANALYTICS_WORKSPACE_RID - Renamed AZURE_EXISTING_AI_PROJECT_RESOURCE_ID to AZURE_ENV_FOUNDRY_PROJECT_RID Updated 14 files across workflows, parameter files, scripts, and documentation to maintain consistency throughout the project.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR standardizes Azure-related environment variable names across infrastructure parameter files, deployment validation scripts, GitHub Actions workflows, and related documentation to improve consistency and clarity (notably for AI service location, GPT model settings, Log Analytics, and Foundry project resource IDs).
Changes:
- Renamed AI service region env var from
AZURE_ENV_OPENAI_LOCATIONtoAZURE_ENV_AI_SERVICE_LOCATIONacross scripts/workflows/docs. - Renamed GPT model env vars to
AZURE_ENV_GPT_MODEL_{NAME,VERSION,CAPACITY}in infra parameter mappings and docs. - Renamed resource ID env vars to
*_RIDfor Log Analytics and Foundry project across workflows, infra parameters, and docs.
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| infra/scripts/validate_model_quota.sh | Updates user guidance text to reference AZURE_ENV_AI_SERVICE_LOCATION. |
| infra/scripts/validate_model_quota.ps1 | Updates user guidance text to reference AZURE_ENV_AI_SERVICE_LOCATION. |
| infra/main.waf.parameters.json | Maps standardized env var names into WAF deployment parameters. |
| infra/main.parameters.json | Maps standardized env var names into default deployment parameters. |
| docs/re-use-log-analytics.md | Updates azd env set example to AZURE_ENV_LOG_ANALYTICS_WORKSPACE_RID. |
| docs/re-use-foundry-project.md | Updates azd env set example to AZURE_ENV_FOUNDRY_PROJECT_RID. |
| docs/CustomizingAzdParameters.md | Updates parameter table and examples to standardized env var names. |
| .github/workflows/job-deploy.yml | Renames workflow-call inputs/outputs and internal variables to standardized names. |
| .github/workflows/job-deploy-windows.yml | Renames reusable workflow inputs/env usage to standardized names. |
| .github/workflows/job-deploy-linux.yml | Renames reusable workflow inputs/env usage to standardized names. |
| .github/workflows/job-cleanup-deployment.yml | Updates cleanup workflow inputs/env usage for AI service location rename. |
| .github/workflows/deploy-v2.yml | Updates dispatch inputs validation and wiring to standardized names. |
| .github/workflows/deploy-orchestrator.yml | Updates orchestration wiring to standardized names. |
| .github/workflows/azure-dev.yml | Updates template validation env vars to standardized names. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…ramter in workflow
- azure-dev.yml: Fix AZURE_AI_DEPLOYMENT_LOCATION -> AZURE_ENV_AI_SERVICE_LOCATION to match standardized naming - job-deploy-windows.yml: Fix AZURE_ENV_FOUNDRY_PROJECT_ID -> AZURE_ENV_FOUNDRY_PROJECT_RID typo in fallback Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…URE_ENV_AI_SERVICE_LOCATION - Updated azure-dev.yml to use vars.AZURE_AI_DEPLOYMENT_LOCATION instead of secrets.AZURE_ENV_AI_SERVICE_LOCATION - Updated azd-template-validation.yml to map AZURE_AI_DEPLOYMENT_LOCATION to standardized variable name AZURE_ENV_AI_SERVICE_LOCATION - Both workflows now consistently use the existing GitHub repository variable - No changes required to GitHub repository settings
- Changed AZURE_ENV_EXISTING_LOG_ANALYTICS_WORKSPACE_RID back to AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID - Changed AZURE_EXISTING_AIPROJECT_RESOURCE_ID back to AZURE_ENV_FOUNDRY_PROJECT_ID
- Rename virtualMachineSize -> vmSize - Rename virtualMachineAdminUsername -> vmAdminUsername - Rename virtualMachineAdminPassword -> vmAdminPassword - Rename gptModelDeploymentType -> deploymentType - Rename gptModelCapacity -> gptDeploymentCapacity - Rename existingAiFoundryAiProjectResourceId -> existingFoundryProjectResourceId - Rename azureopenaiVersion -> azureOpenaiAPIVersion Updated files: - infra/main.bicep & main_custom.bicep (parameter declarations and references) - infra/main.json (regenerated from Bicep) - infra/main.parameters.json & main.waf.parameters.json (parameter mappings) - .github/workflows/deploy.yml & deploy-waf.yml (workflow parameter passing) All parameter names now consistently map to standardized azd environment variables.
Resolved conflict in infra/main_custom.bicep by keeping standardized parameter name: - Keep: azureOpenaiAPIVersion (standardized naming) - Reject: azureopenaiVersion (old inconsistent naming)
The nested if was checking and assigning the same secret value that was just assigned in the else block above it, making it redundant. This was caused by commit de40f53 which unified the secret names, making the original fallback mechanism obsolete.
…in azd-template-validation.yml Standardize environment variable name to match the convention used in: - azure-dev.yml - main.parameters.json - main.waf.parameters.json - Documentation .
Roopan-Microsoft
approved these changes
Apr 23, 2026
|
🎉 This PR is included in version 4.2.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
This pull request updates several GitHub Actions workflow files to standardize and clarify environment variable names related to Azure resources. The changes focus on renaming variables for consistency and clarity, particularly those associated with AI services, Log Analytics, and AI project resources. No logic or functional changes are introduced—only variable names are updated across all affected workflows.
Does this introduce a breaking change?
Golden Path Validation
Deployment Validation
How to Test
What to Check
Verify that the following are valid
Other Information