Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
111 commits
Select commit Hold shift + click to select a range
1a8347f
model deployment when reusing existing foundry
Priyanka-Microsoft Jul 25, 2025
383706b
change model deployment name
Priyanka-Microsoft Jul 25, 2025
5ccc7c1
removed system managed identity code
Priyanka-Microsoft Jul 28, 2025
99ad169
seggregated the files
Priyanka-Microsoft Jul 30, 2025
e0747b2
fix: Updated file names
Prajwal-Microsoft Aug 1, 2025
d604cea
Resolved main json commit
Priyanka-Microsoft Aug 1, 2025
d4065d5
Merge pull request #621 from microsoft/model-deployment-resusing-exis…
Prajwal-Microsoft Aug 1, 2025
dc627e4
chore: down merging main into dev (#638)
Rafi-Microsoft Aug 6, 2025
c509549
added for cross-subscription existing AI project resource ID
Kanchan-Microsoft Aug 7, 2025
ad9ba63
update
Kanchan-Microsoft Aug 7, 2025
18f3e78
fix: agent cleanup (#639)
Shreyas-Microsoft Aug 7, 2025
0f8ccc5
TS( 21657) Bicep Standard code changes
Bangarraju-Microsoft Aug 8, 2025
d499936
Merge branch 'dev' of https://github.com/microsoft/Build-your-own-cop…
Bangarraju-Microsoft Aug 8, 2025
e8a113f
Added required env variables for local debugging in .env generated by…
Prasanjeet-Microsoft Aug 8, 2025
12b99bb
Merge pull request #642 from microsoft/PSL-US-21463
Prajwal-Microsoft Aug 8, 2025
2c17025
Added "Required/Optional" and changed aiProjectName suffix.
Bangarraju-Microsoft Aug 8, 2025
51df269
removed location tag
Bangarraju-Microsoft Aug 8, 2025
f9dbf41
Merge branch 'dev' into psl-bug-21342
Kanchan-Microsoft Aug 11, 2025
f202b60
foundry project documentation
Kanchan-Microsoft Aug 11, 2025
313f6e3
Merge branch 'psl-bug-21342' of https://github.com/microsoft/Build-yo…
Kanchan-Microsoft Aug 11, 2025
8b24bca
corrected name
Kanchan-Microsoft Aug 11, 2025
b0e5161
Merge branch 'dev' of https://github.com/microsoft/Build-your-own-cop…
Bangarraju-Microsoft Aug 11, 2025
d455118
updated CAdeploy.yml
Kanchan-Microsoft Aug 11, 2025
a8e25dd
update CAdeploy.yml
Kanchan-Microsoft Aug 11, 2025
2f89864
Merge pull request #640 from microsoft/psl-bug-21342
Prajwal-Microsoft Aug 11, 2025
1df9fc6
changed pipeline variable
Bangarraju-Microsoft Aug 11, 2025
1166aa8
Merge pull request #644 from microsoft/main
Prajwal-Microsoft Aug 12, 2025
d9c999d
Merge branch 'dev' of https://github.com/microsoft/Build-your-own-cop…
Bangarraju-Microsoft Aug 12, 2025
a911f20
updated main.json file
Bangarraju-Microsoft Aug 12, 2025
d3ed0ee
updated yml file
Bangarraju-Microsoft Aug 12, 2025
0742080
test
Kanchan-Microsoft Aug 12, 2025
edd0c97
test
Kanchan-Microsoft Aug 12, 2025
9b812cc
update
Kanchan-Microsoft Aug 12, 2025
a2328c0
update
Kanchan-Microsoft Aug 12, 2025
b84cd26
test
Kanchan-Microsoft Aug 12, 2025
f4b5b14
update CAdeploy.yml
Kanchan-Microsoft Aug 13, 2025
6f083ea
Merge pull request #645 from microsoft/git-actions
Prajwal-Microsoft Aug 13, 2025
fe7c161
CustomizingAzdparamMd
UtkarshMishra-Microsoft Aug 13, 2025
7c5b9d4
Merge pull request #647 from microsoft/customizemd
Prajwal-Microsoft Aug 13, 2025
c317d43
Merge pull request #643 from microsoft/PSLRJ-TS-21657
Prajwal-Microsoft Aug 13, 2025
c38e7a9
deploymentMdUpdate
UtkarshMishra-Microsoft Aug 14, 2025
55aa714
Updated
UtkarshMishra-Microsoft Aug 14, 2025
45fd259
Merge pull request #648 from microsoft/deploymentMd
Prajwal-Microsoft Aug 14, 2025
39e0085
Update infra/main.bicep
Prasanjeet-Microsoft Aug 18, 2025
a1b363d
Update src/App/backend/plugins/chat_with_data_plugin.py
Prasanjeet-Microsoft Aug 18, 2025
4f81d2a
Update infra/main.bicep
Prasanjeet-Microsoft Aug 18, 2025
12ca750
Revert Copilot suggestion: `and project_client` is unnecessary.
Prasanjeet-Microsoft Aug 18, 2025
4fa1c7d
Avm Waf changes-1
Vamshi-Microsoft Aug 25, 2025
e774011
Avm Waf- v2
Vamshi-Microsoft Aug 25, 2025
7232d77
Merge branch 'main' into dev
Roopan-Microsoft Aug 25, 2025
38f16a6
Added Networking
Vamshi-Microsoft Aug 25, 2025
a3f03f7
Added Networking and Sql
Vamshi-Microsoft Aug 25, 2025
b6a3c1d
Merge branch 'psl-avmwaf' of https://github.com/microsoft/Build-your-…
Vamshi-Microsoft Aug 25, 2025
5c8b710
Avm v3
Vamshi-Microsoft Aug 25, 2025
28016fe
Resolved Key valut issue
Vamshi-Microsoft Aug 25, 2025
f37bbd9
Changed ResourceId
Vamshi-Microsoft Aug 25, 2025
ff16543
feat: Add Bicep modules for Cognitive Services, Key Vault export, AI …
Abdul-Microsoft Aug 25, 2025
9c0b3da
docs: Added Troubleshoot.md files for BYOC-Client Advisor (#650)
VishalS-Microsoft Aug 26, 2025
f2e8ab6
Added website and aifoundry related avm changes
Abdul-Microsoft Aug 26, 2025
9ed413c
added colon
VishalS-Microsoft Aug 29, 2025
f9e0c08
Replace 'u' with 'you' for proper grammarUpdate docs/TroubleShootingS…
VishalS-Microsoft Aug 29, 2025
d31d0e8
extra space removed
VishalS-Microsoft Aug 29, 2025
3c2645f
The command block is not properly closed
VishalS-Microsoft Aug 29, 2025
3f092e4
The command should be wrapped in a proper code block with language id…
VishalS-Microsoft Aug 29, 2025
19567e7
Added Log Analytics, App Insights, CosmosDb, Sql Server, Storage Acco…
Vamshi-Microsoft Aug 29, 2025
ccc16de
The total asset value and current asset value are responding correctl…
Prekshith-Microsoft Sep 1, 2025
1565d51
fix: Update OpenAI endpoint reference and improve resource naming con…
Vamshi-Microsoft Sep 2, 2025
a0f3944
Bicep file changes to add CreatedBy tag (#655)
NirajC-Microsoft Sep 3, 2025
18c2cd2
Add role assignments for Search Service to AI Services in Bicep modules
Vamshi-Microsoft Sep 3, 2025
c900215
Update docs/TroubleShootingSteps.md
NirajC-Microsoft Sep 4, 2025
aaf927d
fix: Update search service network access settings to enable public a…
Vamshi-Microsoft Sep 4, 2025
3310a81
Exp changes to Use Existing Log Analytics Workspace ID
Vamshi-Microsoft Sep 4, 2025
8138165
fix: Adding a hardcoded createdBy parameter to the CAdeploy.yml file …
NirajC-Microsoft Sep 5, 2025
3df581e
Merge branch 'main' into dev
Roopan-Microsoft Sep 5, 2025
71eb134
added AIProject_SearchConnection and Cognitive Services OpenAI User …
Vamshi-Microsoft Sep 8, 2025
fee0aa6
Enhance existing AI Foundry project support with resource referencing…
Vamshi-Microsoft Sep 8, 2025
553027d
Code Clean up
Vamshi-Microsoft Sep 8, 2025
70ba906
Moved outadated Bicep files to Old folder and added createdBy Tag
Vamshi-Microsoft Sep 8, 2025
a074063
Merge branch 'dev' into psl-avmwaf
Vamshi-Microsoft Sep 8, 2025
dd22c3e
Remove duplicate 'createdBy' parameter and add VM admin credentials t…
Vamshi-Microsoft Sep 8, 2025
0d81181
readme changes
Vamshi-Microsoft Sep 9, 2025
895aab0
Refactor SQL database module configuration: streamline parameters, ad…
Abdul-Microsoft Sep 9, 2025
7f59fb3
Updated Post deployment Script to support Waf
Vamshi-Microsoft Sep 9, 2025
d2fdd1b
Fix reference to Log Analytics Workspace Resource ID in SQL DB module…
Abdul-Microsoft Sep 9, 2025
7ea3edf
Merge branch 'psl-avmwaf' of https://github.com/microsoft/Build-your-…
Abdul-Microsoft Sep 9, 2025
500380c
Removed unnecessary scopes in main.bicep
Vamshi-Microsoft Sep 10, 2025
daf0612
fix: Return consistent response for 'what is the asset value' query. …
Prekshith-Microsoft Sep 10, 2025
550f682
Add temporary firewall rule for SQL Server public access during data …
Vamshi-Microsoft Sep 10, 2025
396ad67
script update for foundry
AjitPadhi-Microsoft Sep 11, 2025
efeb070
fix: Updated the param name
Prajwal-Microsoft Sep 11, 2025
eeec2e0
Merge branch 'psl-avmwaf' of https://github.com/microsoft/Build-your-…
Prajwal-Microsoft Sep 11, 2025
e4e2789
Merge branch 'dev' into psl-avmwaf
Vamshi-Microsoft Sep 12, 2025
be4ff70
fix: Simplify SQL Server access restoration messages
Vamshi-Microsoft Sep 12, 2025
ec381d7
Refactor bicep code
Vamshi-Microsoft Sep 12, 2025
d6f8a4d
Merge pull request #668 from microsoft/psl-avmwaf
Prajwal-Microsoft Sep 12, 2025
e5d3464
fix: Updated parameter name for Azure AI servicedeployment location
Vamshi-Microsoft Sep 12, 2025
1945904
Merge pull request #669 from microsoft/psl-avmwaf
Prajwal-Microsoft Sep 12, 2025
6704362
Updated paramters in CADeploy pipeline
Vamshi-Microsoft Sep 12, 2025
cadf382
Merge pull request #670 from microsoft/psl-avmwaf
Prajwal-Microsoft Sep 12, 2025
f0bfe3b
update image tag to 'latest_waf' in deployment workflows and document…
Harsh-Microsoft Sep 17, 2025
44a7e57
rebuild main.json
Harsh-Microsoft Sep 17, 2025
ff922b0
Update main.parameters.json
Roopan-Microsoft Sep 17, 2025
25067ef
Update main.waf.parameters.json
Roopan-Microsoft Sep 17, 2025
4f16d56
chore: Fixed Security Vulnerablities (#671)
Kanchan-Microsoft Sep 17, 2025
cc73024
Merge pull request #672 from microsoft/hb-waf-tag-update
Prajwal-Microsoft Sep 17, 2025
6eefc04
fix: update aiSearchName variable to use solutionSuffix instead of so…
Vamshi-Microsoft Sep 18, 2025
ea82b45
Merge pull request #673 from microsoft/psl-searchservice
Prajwal-Microsoft Sep 18, 2025
00b50e3
update location parameter to enforce allowed Azure regions for deplo…
Harsh-Microsoft Sep 18, 2025
b5f688a
Merge branch 'main' into dev
Roopan-Microsoft Sep 18, 2025
9599829
fix: Resolved cnflict issue
Prajwal-Microsoft Sep 18, 2025
185a83a
fix: Added location param for deployment
Prajwal-Microsoft Sep 18, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/CAdeploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -127,10 +127,10 @@ jobs:
id: determine_tag
run: |
BRANCH=${{ github.ref_name }}
if [[ "$BRANCH" == "main" ]]; then TAG="latest"
if [[ "$BRANCH" == "main" ]]; then TAG="latest_waf"
elif [[ "$BRANCH" == "dev" ]]; then TAG="dev"
elif [[ "$BRANCH" == "demo" ]]; then TAG="demo"
else TAG="latest"; fi
else TAG="latest_waf"; fi
echo "IMAGE_TAG=$TAG" >> $GITHUB_ENV
echo "Image Tag: $TAG"
- name: Deploy and extract values from deployment output
Expand All @@ -144,7 +144,7 @@ jobs:
DEPLOY_OUTPUT=$(az deployment group create \
--resource-group ${{ env.RESOURCE_GROUP_NAME }} \
--template-file infra/main.bicep \
--parameters aiDeploymentsLocation=${{ env.AZURE_LOCATION }} solutionName=${{ env.SOLUTION_PREFIX }} cosmosLocation=westus gptDeploymentCapacity=${{ env.GPT_MIN_CAPACITY }} embeddingDeploymentCapacity=${{ env.TEXT_EMBEDDING_MIN_CAPACITY }} imageTag=${{ env.IMAGE_TAG }} createdBy="Pipeline" \
--parameters location=${{ env.AZURE_LOCATION }} azureAiServiceLocation=${{ env.AZURE_LOCATION }} solutionName=${{ env.SOLUTION_PREFIX }} cosmosLocation=westus gptModelCapacity=${{ env.GPT_MIN_CAPACITY }} embeddingDeploymentCapacity=${{ env.TEXT_EMBEDDING_MIN_CAPACITY }} containerImageTag=${{ env.IMAGE_TAG }} createdBy="Pipeline" \
--query "properties.outputs" -o json)

echo "Deployment output: $DEPLOY_OUTPUT"
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/build-docker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ jobs:
id: determine_tag
run: |
if [[ "${{ github.ref_name }}" == "main" ]]; then
echo "tagname=latest" >> $GITHUB_OUTPUT
echo "tagname=latest_waf" >> $GITHUB_OUTPUT
elif [[ "${{ github.ref_name }}" == "dev" ]]; then
echo "tagname=dev" >> $GITHUB_OUTPUT
elif [[ "${{ github.ref_name }}" == "demo" ]]; then
Expand Down
2 changes: 1 addition & 1 deletion docs/CustomizingAzdParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ By default this template will use the environment name as the prefix to prevent
| `AZURE_ENV_MODEL_CAPACITY` | integer | `30` | Set the model capacity for GPT deployment. Choose based on your Azure quota and usage needs. |
| `AZURE_ENV_EMBEDDING_MODEL_NAME` | string | `text-embedding-ada-002` | Set the model name used for embeddings. |
| `AZURE_ENV_EMBEDDING_MODEL_CAPACITY` | integer | `80` | Set the capacity for embedding model deployment. |
| `AZURE_ENV_IMAGETAG` | string | `latest` | Set the image tag (allowed values: `latest`, `dev`, `hotfix`). |
| `AZURE_ENV_IMAGETAG` | string | `latest_waf` | Set the image tag (allowed values: `latest_waf`, `dev`, `hotfix`). |
| `AZURE_LOCATION` | string | `<User selects during deployment>` | Sets the Azure region for resource deployment. |
| `AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID` | string | Guide to get your [Existing Workspace ID](/docs/re-use-log-analytics.md) | Reuses an existing Log Analytics Workspace instead of provisioning a new one. |
| `AZURE_EXISTING_AI_PROJECT_RESOURCE_ID` | string | `<Existing AI Foundry Project Resource Id>` | Reuses an existing AI Foundry Project Resource Id instead of provisioning a new one. |
Expand Down
48 changes: 41 additions & 7 deletions docs/DeploymentGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,53 @@ Check the [Azure Products by Region](https://azure.microsoft.com/en-us/explore/g

Here are some example regions where the services are available: East US, East US2, Australia East, UK South, France Central.


### **Important: Check Azure OpenAI Quota Availability**

⚠️ To ensure sufficient quota is available in your subscription, please follow [quota check instructions guide](./QuotaCheck.md) before you deploy the solution.


### [Optional] Quota Recommendations
By default, the **Gpt-4o-mini model capacity** in deployment is set to **30k tokens**, so we recommend updating the following:

> **For Global Standard | GPT-4o-mini - increase the capacity to at least 150k tokens post-deployment for optimal performance.**

Depending on your subscription quota and capacity, you can [adjust quota settings](AzureGPTQuotaSettings.md) to better meet your specific needs. You can also [adjust the deployment parameters](CustomizingAzdParameters.md) for additional optimization.
­
## Deployment Options

### Sandbox or WAF Aligned Deployment Options

The [`infra`](../infra) folder of the Build-your-own-copilot-Solution-Accelerator contains the [`main.bicep`](../infra/main.bicep) Bicep script, which defines all Azure infrastructure components for this solution.

By default, the `azd up` command uses the [`main.parameters.json`](../infra/main.parameters.json) file to deploy the solution. This file is pre-configured for a **sandbox environment** — ideal for development and proof-of-concept scenarios, with minimal security and cost controls for rapid iteration.

For **production deployments**, the repository also provides [`main.waf.parameters.json`](../infra/main.waf.parameters.json), which applies a [Well-Architected Framework (WAF) aligned](https://learn.microsoft.com/en-us/azure/well-architected/) configuration. This option enables additional Azure best practices for reliability, security, cost optimization, operational excellence, and performance efficiency, such as:

- Enhanced network security (e.g., Network protection with private endpoints)
- Stricter access controls and managed identities
- Logging, monitoring, and diagnostics enabled by default
- Resource tagging and cost management recommendations

**How to choose your deployment configuration:**

* Use the default `main.parameters.json` file for a **sandbox/dev environment**
* For a **WAF-aligned, production-ready deployment**, copy the contents of `main.waf.parameters.json` into `main.parameters.json` before running `azd up`

---

### VM Credentials Configuration

By default, the solution sets the VM administrator username and password from environment variables.

To set your own VM credentials before deployment, use:

```sh
azd env set AZURE_ENV_VM_ADMIN_USERNAME <your-username>
azd env set AZURE_ENV_VM_ADMIN_PASSWORD <your-password>
```

> [!TIP]
> Always review and adjust parameter values (such as region, capacity, security settings and log analytics workspace configuration) to match your organization’s requirements before deploying. For production, ensure you have sufficient quota and follow the principle of least privilege for all identities and role assignments.


> [!IMPORTANT]
> The WAF-aligned configuration is under active development. More Azure Well-Architected recommendations will be added in future updates.

## Deployment Options & Steps

Pick from the options below to see step-by-step instructions for GitHub Codespaces, VS Code Dev Containers, and Local Environments.
Expand Down Expand Up @@ -114,7 +148,7 @@ When you start the deployment, most parameters will have **default values**, but
| **GPT Model Deployment Capacity** | Configure capacity for **GPT models**. Choose based on Azure OpenAI quota. | `30` |
| **Embedding Model** | OpenAI embedding model used for vector similarity. | `text-embedding-ada-002` |
| **Embedding Model Capacity** | Set the capacity for **embedding models**. Choose based on usage and quota. | `80` |
| **Image Tag** | The version of the Docker image to use (e.g., `latest`, `dev`, `hotfix`). | `latest` |
| **Image Tag** | The version of the Docker image to use (e.g., `latest_waf`, `dev`, `hotfix`). | `latest_waf` |
| **Azure OpenAI API Version** | Set the API version for OpenAI model deployments. | `2025-04-01-preview` |
| **AZURE_LOCATION** | Sets the Azure region for resource deployment. | `<User selects during deployment>` |
| **Existing Log Analytics Workspace** | To reuse an existing Log Analytics Workspace ID instead of creating a new one. | *(empty)* |
Expand Down
Loading
Loading