Skip to content

fix: Standardization of parameters and update workflows and documentation#145

Open
Prachig-Microsoft wants to merge 14 commits intodevfrom
psl-prachi-params
Open

fix: Standardization of parameters and update workflows and documentation#145
Prachig-Microsoft wants to merge 14 commits intodevfrom
psl-prachi-params

Conversation

@Prachig-Microsoft
Copy link
Copy Markdown

@Prachig-Microsoft Prachig-Microsoft commented Mar 20, 2026

This pull request updates how AI service and resource IDs are handled throughout the deployment workflows, infrastructure templates, and documentation. The main goal is to standardize environment variable naming (especially for AI service locations and resource IDs), remove deprecated or redundant parameters, and ensure consistency across Linux/Windows workflows, Bicep/ARM templates, and documentation.

Key changes include:
These changes help ensure consistency, reduce confusion, and make it easier to manage and reuse AI-related resources in different environments.] 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.

Does this introduce a breaking change?

  • Yes
  • No

What to Check

Verify that the following are valid

  • ...

Other Information

- Reverted containerRegistryHost to use AZURE_CONTAINER_REGISTRY_HOST
- Reverted AI model parameters to use AZURE_AI_MODEL_NAME, AZURE_AI_MODEL_VERSION, AZURE_AI_MODEL_CAPACITY
- Reverted deployment type to use AZURE_AI_DEPLOYMENT_TYPE
- Removed enableTelemetry parameter customization (uses bicep default)
- Updated workflow files and documentation to reflect original naming
- Kept AZURE_ENV_ prefix only for: AI_SERVICE_LOCATION, LOG_ANALYTICS_WORKSPACE_RID, FOUNDRY_PROJECT_RID, VM_ADMIN credentials, IMAGETAG
Copy link
Copy Markdown
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 how AI service locations and existing resource IDs are passed through AZD deployments by renaming key environment variables, removing redundant parameters, and aligning infra templates, workflows, and docs to the updated naming.

Changes:

  • Updated infra parameter files to use standardized env var names (notably AZURE_ENV_AI_SERVICE_LOCATION, AZURE_ENV_LOG_ANALYTICS_WORKSPACE_RID, AZURE_ENV_FOUNDRY_PROJECT_RID) and removed deprecated/redundant parameters.
  • Removed the aiDeploymentLocation parameter from Bicep/ARM (and corresponding CI invocation).
  • Updated GitHub deployment workflows and documentation to reflect the new env var names.

Reviewed changes

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

Show a summary per file
File Description
infra/main.waf.parameters.json Switches AI location and existing resource ID env vars to standardized names.
infra/main.parameters.json Same standardization for non-WAF parameters; drops deprecated/redundant entries.
infra/main.json Regenerated ARM template; removes aiDeploymentLocation parameter.
infra/main.bicep Removes aiDeploymentLocation parameter definition.
docs/re-use-log-analytics.md Updates env var name for reusing an existing Log Analytics workspace.
docs/re-use-foundry-project.md Updates env var name for reusing an existing Foundry project.
docs/CustomizingAzdParameters.md Updates the parameter list to reflect new standardized env vars.
.github/workflows/job-deploy-windows.yml Sets standardized env vars (AI location + existing resource IDs) during deployment.
.github/workflows/job-deploy-linux.yml Sets standardized env vars (AI location + existing resource IDs) during deployment.
.github/workflows/ci.yml Removes the now-deleted aiDeploymentLocation parameter from CI validation.

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

- Changed all workflow inputs from AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID to AZURE_ENV_LOG_ANALYTICS_WORKSPACE_RID
- Ensures consistency with parameter files and documentation
- Affected files: deploy-orchestrator.yml, deploy-v2.yml, job-deploy.yml, job-deploy-linux.yml, job-deploy-windows.yml
Copy link
Copy Markdown
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

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


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

Prachig-Microsoft and others added 6 commits April 9, 2026 15:25
…_PROJECT_RID to AZURE_EXISTING_AIPROJECT_RESOURCE_ID and AZURE_ENV_LOG_ANALYTICS_WORKSPACE_RID to AZURE_ENV_EXISTING_LOG_ANALYTICS_WORKSPACE_RID
…rkflow validation

Update validation logic and error messages in deploy-v2.yml,
job-deploy-linux.yml, and job-deploy-windows.yml to use the
renamed AZURE_EXISTING_AIPROJECT_RESOURCE_ID consistently.
Previously, validation referenced the old AI_PROJECT_RESOURCE_ID
name causing validation to silently skip.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The uv installer script requires awk for checksum verification.
Without it, the build fails with 'checksum mismatch' due to
missing awk command on Azure Linux base images.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Rename AZURE_AI_DEPLOYMENT_TYPE to AZURE_ENV_MODEL_DEPLOYMENT_TYPE
- Rename AZURE_AI_MODEL_NAME to AZURE_ENV_GPT_MODEL_NAME
- Rename AZURE_AI_MODEL_VERSION to AZURE_ENV_GPT_MODEL_VERSION
- Rename AZURE_AI_MODEL_CAPACITY to AZURE_ENV_GPT_MODEL_CAPACITY
- Rename AZURE_ENV_IMAGETAG to AZURE_ENV_IMAGE_TAG
- Rename AZURE_CONTAINER_REGISTRY_HOST to AZURE_ENV_CONTAINER_REGISTRY_ENDPOINT

Updated files:
- Parameter files (main.parameters.json, main.waf.parameters.json)
- Documentation (CustomizingAzdParameters.md)
- Workflow files (azd-template-validation, azure-dev, job-cleanup-deployment, job-deploy-linux, job-deploy-windows)

All changes validated successfully with bicep parameter validation script.
Copy link
Copy Markdown
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

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


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

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