fix: Standardize azd parameter names and update documentation#606
Open
Prachig-Microsoft wants to merge 7 commits intodevfrom
Open
fix: Standardize azd parameter names and update documentation#606Prachig-Microsoft wants to merge 7 commits intodevfrom
Prachig-Microsoft wants to merge 7 commits intodevfrom
Conversation
This reverts commit 65bb07a.
- Replace AZURE_ENV_OPENAI_LOCATION with AZURE_ENV_AI_SERVICE_LOCATION - Replace AZURE_ENV_MODEL_CAPACITY with AZURE_ENV_GPT_MODEL_CAPACITY - Replace AZURE_ENV_EMBEDDING_MODEL_CAPACITY with AZURE_ENV_EMBEDDING_DEPLOYMENT_CAPACITY Updated files: - .github/workflows/azure-dev.yml - .github/workflows/azd-template-validation.yml
- Correct AZURE_ENV_GPT_MODEL_NAME default: gpt-4.1 → gpt-4.1-mini - Correct AZURE_ENV_GPT_MODEL_VERSION default: 2024-08-06 → 2025-04-14 - Fix AZURE_ENV_EMBEDDING_MODEL_NAME: Add missing backticks - Fix AZURE_ENV_EMBEDDING_MODEL_VERSION: Correct default from 200 to 1 - Fix AZURE_ENV_EMBEDDING_DEPLOYMENT_CAPACITY: Type int, default 100 - Improve descriptions for capacity parameters - Reorganize AZURE_ENV_EXISTING_LOG_ANALYTICS_WORKSPACE_RID entry
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Standardizes azd parameter/environment variable naming across infra templates and GitHub Actions workflows, and updates documentation to match the new names for Azure AI service location and Log Analytics workspace reuse.
Changes:
- Renamed infra parameter
aiDeploymentsLocationtoazureAiServiceLocationand updated references in Bicep/ARM and parameter files. - Renamed several
AZURE_ENV_*variables (notably OpenAI location, GPT model settings, embedding capacity, and Log Analytics workspace resource ID) across workflows and docs. - Added resource-group tagging support during RG creation in the deploy workflow.
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| infra/main.waf.parameters.json | Updates parameter/env-var names to standardized Azure AI + Log Analytics naming. |
| infra/main.parameters.json | Mirrors standardized parameter/env-var names for the non-WAF parameter file. |
| infra/main.json | Renames ARM parameter and its usages to azureAiServiceLocation (regenerated template metadata). |
| infra/main.bicep | Renames Bicep parameter and updates module input to align with standardized naming. |
| docs/re-use-log-analytics.md | Updates the documented azd env set variable name for reusing Log Analytics. |
| docs/CustomizingAzdParameters.md | Updates the parameter reference table and examples for new env-var names. |
| .github/workflows/job-deploy.yml | Renames workflow inputs/outputs/env-vars and adds RG tags to az group create. |
| .github/workflows/job-deploy-linux.yml | Renames workflow inputs and env-var usage; updates Log Analytics variable name end-to-end. |
| .github/workflows/job-cleanup-deployment.yml | Renames OpenAI location input/env-var to AI service location. |
| .github/workflows/deploy-v2.yml | Renames Log Analytics input/output plumbing to the new *_RID name. |
| .github/workflows/deploy-orchestrator.yml | Propagates renamed inputs/outputs (AI service location + Log Analytics RID). |
| .github/workflows/azure-dev.yml | Updates local dev workflow to set the new AI service location env-var. |
| .github/workflows/azd-template-validation.yml | Updates validation workflow env-vars to the new standardized capacity/location names. |
| .github/workflows/CI.yml | Updates ARM parameter call-site to azureAiServiceLocation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 14 out of 14 changed files in this pull request and generated 6 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Prachig-Microsoft
requested review from
Avijit-Microsoft,
Dongbumlee,
Prajwal-Microsoft,
Roopan-Microsoft,
Vinay-Microsoft,
aniaroramsft,
dgp10801,
nchandhi and
toherman-msft
as code owners
Keep using the existing GitHub secret name instead of renaming to match the standardized environment variable name. This prevents breaking the workflow which depends on the secret configured in repository settings.
- Rename gptModelCapacity to gptDeploymentCapacity - Rename embeddingModelCapacity to embeddingDeploymentCapacity - Update all references in bicep, parameter files, and CI workflow - Regenerate main.json from bicep template This aligns parameter names with their actual usage as deploymentCapacity and matches the environment variable naming convention.
…entType - Renamed parameter 'gptModelDeploymentType' to 'deploymentType' across all files - Updated infra/main.bicep parameter definition and references - Updated infra/main.parameters.json and main.waf.parameters.json - Updated .github/workflows/CI.yml deployment command - Rebuilt infra/main.json (ARM template) with updated parameter - Mapped to azd environment variable: AZURE_ENV_MODEL_DEPLOYMENT_TYPE
Prachig-Microsoft
temporarily deployed
to
production
GitHub Actions
Inactive
Prachig-Microsoft
had a problem deploying
to
production
GitHub Actions
Failure
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.
This pull request standardizes environment variable names and parameters across multiple GitHub Actions workflows, focusing on Azure AI service and Log Analytics workspace integration. The changes improve clarity and consistency in naming, making the workflows easier to maintain and less error prone.
Does this introduce a breaking change?
Golden Path Validation
Deployment Validation
What to Check
Verify that the following are valid
Other Information