From 432f192ae24c7b50749f94b7b68c89296725bdb7 Mon Sep 17 00:00:00 2001 From: Rafi-Microsoft Date: Wed, 6 May 2026 13:58:16 +0530 Subject: [PATCH 01/10] docs: add Bicep CLI prerequisite to local deployment guide Adds Bicep CLI (v0.33.0+) to the local deployment prerequisites so users provisioning this accelerator locally have the required Bicep version installed before running 'azd up' / 'az deployment'. Work item: AB#42634 --- documents/DeploymentGuide.md | 1 + 1 file changed, 1 insertion(+) diff --git a/documents/DeploymentGuide.md b/documents/DeploymentGuide.md index ff4200c3..4742fc65 100644 --- a/documents/DeploymentGuide.md +++ b/documents/DeploymentGuide.md @@ -155,6 +155,7 @@ Select one of the following options to deploy the Customer Chatbot Solution Acce **Required Tools:** - [PowerShell 7.0+](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell) - [Azure Developer CLI (azd) 1.18.0+](https://aka.ms/install-azd) +- [Bicep CLI 0.33.0+](https://learn.microsoft.com/azure/azure-resource-manager/bicep/install) - [Python 3.9+](https://www.python.org/downloads/) - [Docker Desktop](https://www.docker.com/products/docker-desktop/) - [Git](https://git-scm.com/downloads) From 29b1637f753820636812dd786f1c60ae617d7cfb Mon Sep 17 00:00:00 2001 From: Rafi-Microsoft Date: Wed, 6 May 2026 19:50:26 +0530 Subject: [PATCH 02/10] docs: Add Bicep CLI (v0.33.0+) version pinning alongside azd/PowerShell --- documents/LocalDevelopmentSetup.md | 1 + 1 file changed, 1 insertion(+) diff --git a/documents/LocalDevelopmentSetup.md b/documents/LocalDevelopmentSetup.md index f8f50d77..9afd1c49 100644 --- a/documents/LocalDevelopmentSetup.md +++ b/documents/LocalDevelopmentSetup.md @@ -73,6 +73,7 @@ Install these tools before you start: - [Git](https://git-scm.com/downloads) - [Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli) - [Azure Developer CLI (azd)](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/install-azd) +- [Bicep CLI](https://learn.microsoft.com/azure/azure-resource-manager/bicep/install) (v0.33.0+) ### Windows Development From 927037a91ab408931887a4c6373abd064512f7e9 Mon Sep 17 00:00:00 2001 From: Rafi-Microsoft Date: Wed, 6 May 2026 21:27:53 +0530 Subject: [PATCH 03/10] docs: Add Bicep CLI version pinning to AVM post-deployment prereqs --- documents/AVMPostDeploymentGuide.md | 1 + 1 file changed, 1 insertion(+) diff --git a/documents/AVMPostDeploymentGuide.md b/documents/AVMPostDeploymentGuide.md index 51a66ef9..1bcac41d 100644 --- a/documents/AVMPostDeploymentGuide.md +++ b/documents/AVMPostDeploymentGuide.md @@ -29,6 +29,7 @@ Before starting the post-deployment process, ensure you have the following: 3. **[Python](https://www.python.org/downloads/)** (v3.9+ recommended) - Required for data processing scripts 4. **[Git](https://git-scm.com/downloads/)** - Version control system for cloning the repository +5. **[Bicep CLI](https://learn.microsoft.com/azure/azure-resource-manager/bicep/install)** (v0.33.0+) - Required for compiling infrastructure templates ### Azure Requirements From f501425a71bd7ec654cfc1afea1445e4ba96aea8 Mon Sep 17 00:00:00 2001 From: Rafi-Microsoft Date: Wed, 6 May 2026 22:27:54 +0530 Subject: [PATCH 04/10] docs: Align Bicep prereq formatting with surrounding list (Copilot review) --- documents/LocalDevelopmentSetup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documents/LocalDevelopmentSetup.md b/documents/LocalDevelopmentSetup.md index 9afd1c49..a354cbd3 100644 --- a/documents/LocalDevelopmentSetup.md +++ b/documents/LocalDevelopmentSetup.md @@ -73,7 +73,7 @@ Install these tools before you start: - [Git](https://git-scm.com/downloads) - [Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli) - [Azure Developer CLI (azd)](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/install-azd) -- [Bicep CLI](https://learn.microsoft.com/azure/azure-resource-manager/bicep/install) (v0.33.0+) +- [Bicep CLI 0.33.0+](https://learn.microsoft.com/azure/azure-resource-manager/bicep/install) ### Windows Development From f048b4e5803737d1c9c0db3fbe96b2163b79d39d Mon Sep 17 00:00:00 2001 From: Rafi-Microsoft Date: Thu, 7 May 2026 17:50:41 +0530 Subject: [PATCH 05/10] docs(AVMPostDeploymentGuide): renumber Azure Requirements to continue sequence after Bicep CLI prerequisite --- documents/AVMPostDeploymentGuide.md | 154 +--------------------------- 1 file changed, 1 insertion(+), 153 deletions(-) diff --git a/documents/AVMPostDeploymentGuide.md b/documents/AVMPostDeploymentGuide.md index 1bcac41d..264931fe 100644 --- a/documents/AVMPostDeploymentGuide.md +++ b/documents/AVMPostDeploymentGuide.md @@ -1,153 +1 @@ -# AVM Post Deployment Guide - -> **📋 Note**: This guide is specifically for post-deployment steps after using the AVM template. For complete deployment from scratch, see the main [Deployment Guide](./DeploymentGuide.md). - ---- - -This document provides guidance on post-deployment steps after deploying the Customer Chatbot Solution Accelerator from the [AVM (Azure Verified Modules) repository](https://github.com/Azure/bicep-registry-modules.git). - -## Overview - -After deploying the infrastructure using AVM, you'll need to complete the application layer setup, which includes: - -- Configuring team agent configurations -- Processing and uploading sample datasets -- Setting up Azure AI Search indexes -- Configuring blob storage containers -- Setting up application authentication - -## Prerequisites - -Before starting the post-deployment process, ensure you have the following: - -### Required Software - -1. **[PowerShell](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.4)** (v7.0+ recommended) - Available for Windows, macOS, and Linux - -2. **[Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli)** (v2.50+) - Command-line tool for managing Azure resources - -3. **[Python](https://www.python.org/downloads/)** (v3.9+ recommended) - Required for data processing scripts - -4. **[Git](https://git-scm.com/downloads/)** - Version control system for cloning the repository -5. **[Bicep CLI](https://learn.microsoft.com/azure/azure-resource-manager/bicep/install)** (v0.33.0+) - Required for compiling infrastructure templates - -### Azure Requirements - -5. **Azure Access** - One of the following roles on the subscription or resource group: - - - `Contributor` - - `Owner` - -6. **Deployed Infrastructure** - A successful Customer Chatbot deployment from the [AVM repository](https://github.com/Azure/bicep-registry-modules/tree/main/avm/ptn/sa/customer-chatbot) - -#### **Important Note for PowerShell Users** - -If you encounter issues running PowerShell scripts due to execution policy restrictions, you can temporarily adjust the `ExecutionPolicy` by running the following command in an elevated PowerShell session: - -```powershell -Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass -``` - -This will allow the scripts to run for the current session without permanently changing your system's policy. - -## Post-Deployment Steps - -### Step 1: Clone the Repository - -First, clone this repository to access the post-deployment scripts: - -```powershell -git clone https://github.com/microsoft/customer-chatbot-solution-accelerator.git -``` - -```powershell -cd customer-chatbot-solution-accelerator -``` - -### Step 2: Run the Post-Deployment Script - -The post-deployment process is automated through a PowerShell or Bash script that completes the following tasks in approximately 5-10 minutes: - -### Initialize Data and Agents - -**Step 1: Populate Product Catalogs and Search Indexes** - -Run the data setup script to load sample product data -- **For PowerShell (Windows/Linux/macOS):** - ```shell - infra\scripts\data_scripts\run_upload_data_scripts.ps1 -resource_group "" - ``` -- **For Bash (Linux/macOS/WSL):** - ```bash - bash ./infra/scripts/data_scripts/run_upload_data_scripts.sh --resource-group "" - ``` -**If you deployed using `azd up` command:** - -- **For PowerShell (Windows/Linux/macOS):** - ```shell - infra\scripts\data_scripts\run_upload_data_scripts.ps1 - ``` -- **For Bash (Linux/macOS/WSL):** - ```bash - bash ./infra/scripts/data_scripts/run_upload_data_scripts.sh - ``` - - -This script will: -- Upload sample product catalog data to Azure Cosmos DB -- Create and configure Azure AI Search indexes -- Populate search indexes with product and policy documents - -**Step 2: Create AI Foundry Agents** -Run the data setup script to load sample product data and create search indexes in Azure AI Search: - -- **For PowerShell (Windows/Linux/macOS):** - ```shell - infra\scripts\agent_scripts\run_create_agents_scripts.ps1 -resourceGroup "" - ``` -- **For Bash (Linux/macOS/WSL):** - ```bash - bash ./infra/scripts/agent_scripts/run_create_agents_scripts.sh --resource-group "" - ``` -**If you deployed using `azd up` command:** - -- **For PowerShell (Windows/Linux/macOS):** - ```shell - infra\scripts\agent_scripts\run_create_agents_scripts.ps1 - ``` -- **For Bash (Linux/macOS/WSL):** - ``` - bash ./infra/scripts/agent_scripts/run_create_agents_scripts.sh - ``` - - -This script creates: - -- Chat Agent -- Product Agent -- Policy Agent - - > **Note**: Replace `` with the actual name of the resource group containing your deployed Azure resources. - - -### Step 3: Provide Required Information - -During script execution, you'll be prompted for: - -- You'll be prompted to authenticate with Azure if not already logged in -- Select the appropriate Azure subscription - -#### Resource Validation - -- The script will automatically detect and validate your deployed Azure resources -- Confirmation prompts will appear before making configuration changes - -### Step 4: Post Deployment Script Completion - -Upon successful completion, you'll see a success message. - -**🎉 Congratulations!** Your post-deployment configuration is complete. - -### Step 5: Set Up App Authentication (Optional) - -Follow the steps in [Set Up Authentication in Azure App Service](AppAuthentication.md) to add app authentication to your web app running on Azure App Service. +# AVM Post Deployment Guide > **­ƒôï Note**: This guide is specifically for post-deployment steps after using the AVM template. For complete deployment from scratch, see the main [Deployment Guide](./DeploymentGuide.md). --- This document provides guidance on post-deployment steps after deploying the Customer Chatbot Solution Accelerator from the [AVM (Azure Verified Modules) repository](https://github.com/Azure/bicep-registry-modules.git). ## Overview After deploying the infrastructure using AVM, you'll need to complete the application layer setup, which includes: - Configuring team agent configurations - Processing and uploading sample datasets - Setting up Azure AI Search indexes - Configuring blob storage containers - Setting up application authentication ## Prerequisites Before starting the post-deployment process, ensure you have the following: ### Required Software 1. **[PowerShell](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.4)** (v7.0+ recommended) - Available for Windows, macOS, and Linux 2. **[Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli)** (v2.50+) - Command-line tool for managing Azure resources 3. **[Python](https://www.python.org/downloads/)** (v3.9+ recommended) - Required for data processing scripts 4. **[Git](https://git-scm.com/downloads/)** - Version control system for cloning the repository 5. **[Bicep CLI](https://learn.microsoft.com/azure/azure-resource-manager/bicep/install)** (v0.33.0+) - Required for compiling infrastructure templates ### Azure Requirements 6. **Azure Access** - One of the following roles on the subscription or resource group: - `Contributor` - `Owner` 7. **Deployed Infrastructure** - A successful Customer Chatbot deployment from the [AVM repository](https://github.com/Azure/bicep-registry-modules/tree/main/avm/ptn/sa/customer-chatbot) #### **Important Note for PowerShell Users** If you encounter issues running PowerShell scripts due to execution policy restrictions, you can temporarily adjust the `ExecutionPolicy` by running the following command in an elevated PowerShell session: ```powershell Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass ``` This will allow the scripts to run for the current session without permanently changing your system's policy. ## Post-Deployment Steps ### Step 1: Clone the Repository First, clone this repository to access the post-deployment scripts: ```powershell git clone https://github.com/microsoft/customer-chatbot-solution-accelerator.git ``` ```powershell cd customer-chatbot-solution-accelerator ``` ### Step 2: Run the Post-Deployment Script The post-deployment process is automated through a PowerShell or Bash script that completes the following tasks in approximately 5-10 minutes: ### Initialize Data and Agents **Step 1: Populate Product Catalogs and Search Indexes** Run the data setup script to load sample product data - **For PowerShell (Windows/Linux/macOS):** ```shell infra\scripts\data_scripts\run_upload_data_scripts.ps1 -resource_group "" ``` - **For Bash (Linux/macOS/WSL):** ```bash bash ./infra/scripts/data_scripts/run_upload_data_scripts.sh --resource-group "" ``` **If you deployed using `azd up` command:** - **For PowerShell (Windows/Linux/macOS):** ```shell infra\scripts\data_scripts\run_upload_data_scripts.ps1 ``` - **For Bash (Linux/macOS/WSL):** ```bash bash ./infra/scripts/data_scripts/run_upload_data_scripts.sh ``` This script will: - Upload sample product catalog data to Azure Cosmos DB - Create and configure Azure AI Search indexes - Populate search indexes with product and policy documents **Step 2: Create AI Foundry Agents** Run the data setup script to load sample product data and create search indexes in Azure AI Search: - **For PowerShell (Windows/Linux/macOS):** ```shell infra\scripts\agent_scripts\run_create_agents_scripts.ps1 -resourceGroup "" ``` - **For Bash (Linux/macOS/WSL):** ```bash bash ./infra/scripts/agent_scripts/run_create_agents_scripts.sh --resource-group "" ``` **If you deployed using `azd up` command:** - **For PowerShell (Windows/Linux/macOS):** ```shell infra\scripts\agent_scripts\run_create_agents_scripts.ps1 ``` - **For Bash (Linux/macOS/WSL):** ``` bash ./infra/scripts/agent_scripts/run_create_agents_scripts.sh ``` This script creates: - Chat Agent - Product Agent - Policy Agent > **Note**: Replace `` with the actual name of the resource group containing your deployed Azure resources. ### Step 3: Provide Required Information During script execution, you'll be prompted for: - You'll be prompted to authenticate with Azure if not already logged in - Select the appropriate Azure subscription #### Resource Validation - The script will automatically detect and validate your deployed Azure resources - Confirmation prompts will appear before making configuration changes ### Step 4: Post Deployment Script Completion Upon successful completion, you'll see a success message. **­ƒÄë Congratulations!** Your post-deployment configuration is complete. ### Step 5: Set Up App Authentication (Optional) Follow the steps in [Set Up Authentication in Azure App Service](AppAuthentication.md) to add app authentication to your web app running on Azure App Service. \ No newline at end of file From 3f6562bad77ae7e9d4dffdd1952c9f3aea42ec7c Mon Sep 17 00:00:00 2001 From: Rafi-Microsoft Date: Thu, 7 May 2026 18:13:26 +0530 Subject: [PATCH 06/10] Revert "docs(AVMPostDeploymentGuide): renumber Azure Requirements to continue sequence after Bicep CLI prerequisite" --- documents/AVMPostDeploymentGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documents/AVMPostDeploymentGuide.md b/documents/AVMPostDeploymentGuide.md index 264931fe..5fb63319 100644 --- a/documents/AVMPostDeploymentGuide.md +++ b/documents/AVMPostDeploymentGuide.md @@ -1 +1 @@ -# AVM Post Deployment Guide > **­ƒôï Note**: This guide is specifically for post-deployment steps after using the AVM template. For complete deployment from scratch, see the main [Deployment Guide](./DeploymentGuide.md). --- This document provides guidance on post-deployment steps after deploying the Customer Chatbot Solution Accelerator from the [AVM (Azure Verified Modules) repository](https://github.com/Azure/bicep-registry-modules.git). ## Overview After deploying the infrastructure using AVM, you'll need to complete the application layer setup, which includes: - Configuring team agent configurations - Processing and uploading sample datasets - Setting up Azure AI Search indexes - Configuring blob storage containers - Setting up application authentication ## Prerequisites Before starting the post-deployment process, ensure you have the following: ### Required Software 1. **[PowerShell](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.4)** (v7.0+ recommended) - Available for Windows, macOS, and Linux 2. **[Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli)** (v2.50+) - Command-line tool for managing Azure resources 3. **[Python](https://www.python.org/downloads/)** (v3.9+ recommended) - Required for data processing scripts 4. **[Git](https://git-scm.com/downloads/)** - Version control system for cloning the repository 5. **[Bicep CLI](https://learn.microsoft.com/azure/azure-resource-manager/bicep/install)** (v0.33.0+) - Required for compiling infrastructure templates ### Azure Requirements 6. **Azure Access** - One of the following roles on the subscription or resource group: - `Contributor` - `Owner` 7. **Deployed Infrastructure** - A successful Customer Chatbot deployment from the [AVM repository](https://github.com/Azure/bicep-registry-modules/tree/main/avm/ptn/sa/customer-chatbot) #### **Important Note for PowerShell Users** If you encounter issues running PowerShell scripts due to execution policy restrictions, you can temporarily adjust the `ExecutionPolicy` by running the following command in an elevated PowerShell session: ```powershell Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass ``` This will allow the scripts to run for the current session without permanently changing your system's policy. ## Post-Deployment Steps ### Step 1: Clone the Repository First, clone this repository to access the post-deployment scripts: ```powershell git clone https://github.com/microsoft/customer-chatbot-solution-accelerator.git ``` ```powershell cd customer-chatbot-solution-accelerator ``` ### Step 2: Run the Post-Deployment Script The post-deployment process is automated through a PowerShell or Bash script that completes the following tasks in approximately 5-10 minutes: ### Initialize Data and Agents **Step 1: Populate Product Catalogs and Search Indexes** Run the data setup script to load sample product data - **For PowerShell (Windows/Linux/macOS):** ```shell infra\scripts\data_scripts\run_upload_data_scripts.ps1 -resource_group "" ``` - **For Bash (Linux/macOS/WSL):** ```bash bash ./infra/scripts/data_scripts/run_upload_data_scripts.sh --resource-group "" ``` **If you deployed using `azd up` command:** - **For PowerShell (Windows/Linux/macOS):** ```shell infra\scripts\data_scripts\run_upload_data_scripts.ps1 ``` - **For Bash (Linux/macOS/WSL):** ```bash bash ./infra/scripts/data_scripts/run_upload_data_scripts.sh ``` This script will: - Upload sample product catalog data to Azure Cosmos DB - Create and configure Azure AI Search indexes - Populate search indexes with product and policy documents **Step 2: Create AI Foundry Agents** Run the data setup script to load sample product data and create search indexes in Azure AI Search: - **For PowerShell (Windows/Linux/macOS):** ```shell infra\scripts\agent_scripts\run_create_agents_scripts.ps1 -resourceGroup "" ``` - **For Bash (Linux/macOS/WSL):** ```bash bash ./infra/scripts/agent_scripts/run_create_agents_scripts.sh --resource-group "" ``` **If you deployed using `azd up` command:** - **For PowerShell (Windows/Linux/macOS):** ```shell infra\scripts\agent_scripts\run_create_agents_scripts.ps1 ``` - **For Bash (Linux/macOS/WSL):** ``` bash ./infra/scripts/agent_scripts/run_create_agents_scripts.sh ``` This script creates: - Chat Agent - Product Agent - Policy Agent > **Note**: Replace `` with the actual name of the resource group containing your deployed Azure resources. ### Step 3: Provide Required Information During script execution, you'll be prompted for: - You'll be prompted to authenticate with Azure if not already logged in - Select the appropriate Azure subscription #### Resource Validation - The script will automatically detect and validate your deployed Azure resources - Confirmation prompts will appear before making configuration changes ### Step 4: Post Deployment Script Completion Upon successful completion, you'll see a success message. **­ƒÄë Congratulations!** Your post-deployment configuration is complete. ### Step 5: Set Up App Authentication (Optional) Follow the steps in [Set Up Authentication in Azure App Service](AppAuthentication.md) to add app authentication to your web app running on Azure App Service. \ No newline at end of file +# AVM Post Deployment Guide > **­ƒôï Note**: This guide is specifically for post-deployment steps after using the AVM template. For complete deployment from scratch, see the main [Deployment Guide](./DeploymentGuide.md). --- This document provides guidance on post-deployment steps after deploying the Customer Chatbot Solution Accelerator from the [AVM (Azure Verified Modules) repository](https://github.com/Azure/bicep-registry-modules.git). ## Overview After deploying the infrastructure using AVM, you'll need to complete the application layer setup, which includes: - Configuring team agent configurations - Processing and uploading sample datasets - Setting up Azure AI Search indexes - Configuring blob storage containers - Setting up application authentication ## Prerequisites Before starting the post-deployment process, ensure you have the following: ### Required Software 1. **[PowerShell](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.4)** (v7.0+ recommended) - Available for Windows, macOS, and Linux 2. **[Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli)** (v2.50+) - Command-line tool for managing Azure resources 3. **[Python](https://www.python.org/downloads/)** (v3.9+ recommended) - Required for data processing scripts 4. **[Git](https://git-scm.com/downloads/)** - Version control system for cloning the repository 5. **[Bicep CLI](https://learn.microsoft.com/azure/azure-resource-manager/bicep/install)** (v0.33.0+) - Required for compiling infrastructure templates ### Azure Requirements 5. **Azure Access** - One of the following roles on the subscription or resource group: - `Contributor` - `Owner` 6. **Deployed Infrastructure** - A successful Customer Chatbot deployment from the [AVM repository](https://github.com/Azure/bicep-registry-modules/tree/main/avm/ptn/sa/customer-chatbot) #### **Important Note for PowerShell Users** If you encounter issues running PowerShell scripts due to execution policy restrictions, you can temporarily adjust the `ExecutionPolicy` by running the following command in an elevated PowerShell session: ```powershell Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass ``` This will allow the scripts to run for the current session without permanently changing your system's policy. ## Post-Deployment Steps ### Step 1: Clone the Repository First, clone this repository to access the post-deployment scripts: ```powershell git clone https://github.com/microsoft/customer-chatbot-solution-accelerator.git ``` ```powershell cd customer-chatbot-solution-accelerator ``` ### Step 2: Run the Post-Deployment Script The post-deployment process is automated through a PowerShell or Bash script that completes the following tasks in approximately 5-10 minutes: ### Initialize Data and Agents **Step 1: Populate Product Catalogs and Search Indexes** Run the data setup script to load sample product data - **For PowerShell (Windows/Linux/macOS):** ```shell infra\scripts\data_scripts\run_upload_data_scripts.ps1 -resource_group "" ``` - **For Bash (Linux/macOS/WSL):** ```bash bash ./infra/scripts/data_scripts/run_upload_data_scripts.sh --resource-group "" ``` **If you deployed using `azd up` command:** - **For PowerShell (Windows/Linux/macOS):** ```shell infra\scripts\data_scripts\run_upload_data_scripts.ps1 ``` - **For Bash (Linux/macOS/WSL):** ```bash bash ./infra/scripts/data_scripts/run_upload_data_scripts.sh ``` This script will: - Upload sample product catalog data to Azure Cosmos DB - Create and configure Azure AI Search indexes - Populate search indexes with product and policy documents **Step 2: Create AI Foundry Agents** Run the data setup script to load sample product data and create search indexes in Azure AI Search: - **For PowerShell (Windows/Linux/macOS):** ```shell infra\scripts\agent_scripts\run_create_agents_scripts.ps1 -resourceGroup "" ``` - **For Bash (Linux/macOS/WSL):** ```bash bash ./infra/scripts/agent_scripts/run_create_agents_scripts.sh --resource-group "" ``` **If you deployed using `azd up` command:** - **For PowerShell (Windows/Linux/macOS):** ```shell infra\scripts\agent_scripts\run_create_agents_scripts.ps1 ``` - **For Bash (Linux/macOS/WSL):** ``` bash ./infra/scripts/agent_scripts/run_create_agents_scripts.sh ``` This script creates: - Chat Agent - Product Agent - Policy Agent > **Note**: Replace `` with the actual name of the resource group containing your deployed Azure resources. ### Step 3: Provide Required Information During script execution, you'll be prompted for: - You'll be prompted to authenticate with Azure if not already logged in - Select the appropriate Azure subscription #### Resource Validation - The script will automatically detect and validate your deployed Azure resources - Confirmation prompts will appear before making configuration changes ### Step 4: Post Deployment Script Completion Upon successful completion, you'll see a success message. **­ƒÄë Congratulations!** Your post-deployment configuration is complete. ### Step 5: Set Up App Authentication (Optional) Follow the steps in [Set Up Authentication in Azure App Service](AppAuthentication.md) to add app authentication to your web app running on Azure App Service. \ No newline at end of file From 72792c7dede8767796436dc94311fd1e60dab0eb Mon Sep 17 00:00:00 2001 From: Rafi-Microsoft Date: Thu, 7 May 2026 18:14:19 +0530 Subject: [PATCH 07/10] Restore documents/AVMPostDeploymentGuide.md formatting --- documents/AVMPostDeploymentGuide.md | 154 +++++++++++++++++++++++++++- 1 file changed, 153 insertions(+), 1 deletion(-) diff --git a/documents/AVMPostDeploymentGuide.md b/documents/AVMPostDeploymentGuide.md index 5fb63319..1bcac41d 100644 --- a/documents/AVMPostDeploymentGuide.md +++ b/documents/AVMPostDeploymentGuide.md @@ -1 +1,153 @@ -# AVM Post Deployment Guide > **­ƒôï Note**: This guide is specifically for post-deployment steps after using the AVM template. For complete deployment from scratch, see the main [Deployment Guide](./DeploymentGuide.md). --- This document provides guidance on post-deployment steps after deploying the Customer Chatbot Solution Accelerator from the [AVM (Azure Verified Modules) repository](https://github.com/Azure/bicep-registry-modules.git). ## Overview After deploying the infrastructure using AVM, you'll need to complete the application layer setup, which includes: - Configuring team agent configurations - Processing and uploading sample datasets - Setting up Azure AI Search indexes - Configuring blob storage containers - Setting up application authentication ## Prerequisites Before starting the post-deployment process, ensure you have the following: ### Required Software 1. **[PowerShell](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.4)** (v7.0+ recommended) - Available for Windows, macOS, and Linux 2. **[Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli)** (v2.50+) - Command-line tool for managing Azure resources 3. **[Python](https://www.python.org/downloads/)** (v3.9+ recommended) - Required for data processing scripts 4. **[Git](https://git-scm.com/downloads/)** - Version control system for cloning the repository 5. **[Bicep CLI](https://learn.microsoft.com/azure/azure-resource-manager/bicep/install)** (v0.33.0+) - Required for compiling infrastructure templates ### Azure Requirements 5. **Azure Access** - One of the following roles on the subscription or resource group: - `Contributor` - `Owner` 6. **Deployed Infrastructure** - A successful Customer Chatbot deployment from the [AVM repository](https://github.com/Azure/bicep-registry-modules/tree/main/avm/ptn/sa/customer-chatbot) #### **Important Note for PowerShell Users** If you encounter issues running PowerShell scripts due to execution policy restrictions, you can temporarily adjust the `ExecutionPolicy` by running the following command in an elevated PowerShell session: ```powershell Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass ``` This will allow the scripts to run for the current session without permanently changing your system's policy. ## Post-Deployment Steps ### Step 1: Clone the Repository First, clone this repository to access the post-deployment scripts: ```powershell git clone https://github.com/microsoft/customer-chatbot-solution-accelerator.git ``` ```powershell cd customer-chatbot-solution-accelerator ``` ### Step 2: Run the Post-Deployment Script The post-deployment process is automated through a PowerShell or Bash script that completes the following tasks in approximately 5-10 minutes: ### Initialize Data and Agents **Step 1: Populate Product Catalogs and Search Indexes** Run the data setup script to load sample product data - **For PowerShell (Windows/Linux/macOS):** ```shell infra\scripts\data_scripts\run_upload_data_scripts.ps1 -resource_group "" ``` - **For Bash (Linux/macOS/WSL):** ```bash bash ./infra/scripts/data_scripts/run_upload_data_scripts.sh --resource-group "" ``` **If you deployed using `azd up` command:** - **For PowerShell (Windows/Linux/macOS):** ```shell infra\scripts\data_scripts\run_upload_data_scripts.ps1 ``` - **For Bash (Linux/macOS/WSL):** ```bash bash ./infra/scripts/data_scripts/run_upload_data_scripts.sh ``` This script will: - Upload sample product catalog data to Azure Cosmos DB - Create and configure Azure AI Search indexes - Populate search indexes with product and policy documents **Step 2: Create AI Foundry Agents** Run the data setup script to load sample product data and create search indexes in Azure AI Search: - **For PowerShell (Windows/Linux/macOS):** ```shell infra\scripts\agent_scripts\run_create_agents_scripts.ps1 -resourceGroup "" ``` - **For Bash (Linux/macOS/WSL):** ```bash bash ./infra/scripts/agent_scripts/run_create_agents_scripts.sh --resource-group "" ``` **If you deployed using `azd up` command:** - **For PowerShell (Windows/Linux/macOS):** ```shell infra\scripts\agent_scripts\run_create_agents_scripts.ps1 ``` - **For Bash (Linux/macOS/WSL):** ``` bash ./infra/scripts/agent_scripts/run_create_agents_scripts.sh ``` This script creates: - Chat Agent - Product Agent - Policy Agent > **Note**: Replace `` with the actual name of the resource group containing your deployed Azure resources. ### Step 3: Provide Required Information During script execution, you'll be prompted for: - You'll be prompted to authenticate with Azure if not already logged in - Select the appropriate Azure subscription #### Resource Validation - The script will automatically detect and validate your deployed Azure resources - Confirmation prompts will appear before making configuration changes ### Step 4: Post Deployment Script Completion Upon successful completion, you'll see a success message. **­ƒÄë Congratulations!** Your post-deployment configuration is complete. ### Step 5: Set Up App Authentication (Optional) Follow the steps in [Set Up Authentication in Azure App Service](AppAuthentication.md) to add app authentication to your web app running on Azure App Service. \ No newline at end of file +# AVM Post Deployment Guide + +> **📋 Note**: This guide is specifically for post-deployment steps after using the AVM template. For complete deployment from scratch, see the main [Deployment Guide](./DeploymentGuide.md). + +--- + +This document provides guidance on post-deployment steps after deploying the Customer Chatbot Solution Accelerator from the [AVM (Azure Verified Modules) repository](https://github.com/Azure/bicep-registry-modules.git). + +## Overview + +After deploying the infrastructure using AVM, you'll need to complete the application layer setup, which includes: + +- Configuring team agent configurations +- Processing and uploading sample datasets +- Setting up Azure AI Search indexes +- Configuring blob storage containers +- Setting up application authentication + +## Prerequisites + +Before starting the post-deployment process, ensure you have the following: + +### Required Software + +1. **[PowerShell](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.4)** (v7.0+ recommended) - Available for Windows, macOS, and Linux + +2. **[Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli)** (v2.50+) - Command-line tool for managing Azure resources + +3. **[Python](https://www.python.org/downloads/)** (v3.9+ recommended) - Required for data processing scripts + +4. **[Git](https://git-scm.com/downloads/)** - Version control system for cloning the repository +5. **[Bicep CLI](https://learn.microsoft.com/azure/azure-resource-manager/bicep/install)** (v0.33.0+) - Required for compiling infrastructure templates + +### Azure Requirements + +5. **Azure Access** - One of the following roles on the subscription or resource group: + + - `Contributor` + - `Owner` + +6. **Deployed Infrastructure** - A successful Customer Chatbot deployment from the [AVM repository](https://github.com/Azure/bicep-registry-modules/tree/main/avm/ptn/sa/customer-chatbot) + +#### **Important Note for PowerShell Users** + +If you encounter issues running PowerShell scripts due to execution policy restrictions, you can temporarily adjust the `ExecutionPolicy` by running the following command in an elevated PowerShell session: + +```powershell +Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass +``` + +This will allow the scripts to run for the current session without permanently changing your system's policy. + +## Post-Deployment Steps + +### Step 1: Clone the Repository + +First, clone this repository to access the post-deployment scripts: + +```powershell +git clone https://github.com/microsoft/customer-chatbot-solution-accelerator.git +``` + +```powershell +cd customer-chatbot-solution-accelerator +``` + +### Step 2: Run the Post-Deployment Script + +The post-deployment process is automated through a PowerShell or Bash script that completes the following tasks in approximately 5-10 minutes: + +### Initialize Data and Agents + +**Step 1: Populate Product Catalogs and Search Indexes** + +Run the data setup script to load sample product data +- **For PowerShell (Windows/Linux/macOS):** + ```shell + infra\scripts\data_scripts\run_upload_data_scripts.ps1 -resource_group "" + ``` +- **For Bash (Linux/macOS/WSL):** + ```bash + bash ./infra/scripts/data_scripts/run_upload_data_scripts.sh --resource-group "" + ``` +**If you deployed using `azd up` command:** + +- **For PowerShell (Windows/Linux/macOS):** + ```shell + infra\scripts\data_scripts\run_upload_data_scripts.ps1 + ``` +- **For Bash (Linux/macOS/WSL):** + ```bash + bash ./infra/scripts/data_scripts/run_upload_data_scripts.sh + ``` + + +This script will: +- Upload sample product catalog data to Azure Cosmos DB +- Create and configure Azure AI Search indexes +- Populate search indexes with product and policy documents + +**Step 2: Create AI Foundry Agents** +Run the data setup script to load sample product data and create search indexes in Azure AI Search: + +- **For PowerShell (Windows/Linux/macOS):** + ```shell + infra\scripts\agent_scripts\run_create_agents_scripts.ps1 -resourceGroup "" + ``` +- **For Bash (Linux/macOS/WSL):** + ```bash + bash ./infra/scripts/agent_scripts/run_create_agents_scripts.sh --resource-group "" + ``` +**If you deployed using `azd up` command:** + +- **For PowerShell (Windows/Linux/macOS):** + ```shell + infra\scripts\agent_scripts\run_create_agents_scripts.ps1 + ``` +- **For Bash (Linux/macOS/WSL):** + ``` + bash ./infra/scripts/agent_scripts/run_create_agents_scripts.sh + ``` + + +This script creates: + +- Chat Agent +- Product Agent +- Policy Agent + + > **Note**: Replace `` with the actual name of the resource group containing your deployed Azure resources. + + +### Step 3: Provide Required Information + +During script execution, you'll be prompted for: + +- You'll be prompted to authenticate with Azure if not already logged in +- Select the appropriate Azure subscription + +#### Resource Validation + +- The script will automatically detect and validate your deployed Azure resources +- Confirmation prompts will appear before making configuration changes + +### Step 4: Post Deployment Script Completion + +Upon successful completion, you'll see a success message. + +**🎉 Congratulations!** Your post-deployment configuration is complete. + +### Step 5: Set Up App Authentication (Optional) + +Follow the steps in [Set Up Authentication in Azure App Service](AppAuthentication.md) to add app authentication to your web app running on Azure App Service. From 729c38c871b464d919e7a6f014717646e1878df0 Mon Sep 17 00:00:00 2001 From: "Prekshith D J (Persistent Systems Inc)" Date: Tue, 12 May 2026 18:16:14 +0530 Subject: [PATCH 08/10] updated the md file --- documents/QuotaCheck.md | 4 ++-- infra/scripts/quota_check_params.sh | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/documents/QuotaCheck.md b/documents/QuotaCheck.md index 939a1dca..1f4bdbbe 100644 --- a/documents/QuotaCheck.md +++ b/documents/QuotaCheck.md @@ -10,7 +10,7 @@ azd auth login ### 📌 Default Models & Capacities: ``` -gpt-4o:150, gpt-4o-mini:150, gpt-4:150 +gpt-4o-mini:150, text-embedding-3-small:150, gpt-realtime-mini:150 ``` ### 📌 Default Regions: ``` @@ -66,7 +66,7 @@ The final table lists regions with available quota. You can select any of these **To check quota for the deployment** ```sh - curl -L -o quota_check_params.sh "https://raw.githubusercontent.com/microsoft/Conversation-Knowledge-Mining-Solution-Accelerator/main/infra/scripts/quota_check_params.sh" + curl -L -o quota_check_params.sh "https://raw.githubusercontent.com/microsoft/customer-chatbot-solution-accelerator/main/infra/scripts/quota_check_params.sh" chmod +x quota_check_params.sh ./quota_check_params.sh ``` diff --git a/infra/scripts/quota_check_params.sh b/infra/scripts/quota_check_params.sh index c483eafd..389b6cad 100644 --- a/infra/scripts/quota_check_params.sh +++ b/infra/scripts/quota_check_params.sh @@ -47,7 +47,7 @@ log_verbose() { } # Default Models and Capacities (Comma-separated in "model:capacity" format) -DEFAULT_MODEL_CAPACITY="gpt-4o:150,gpt-4o-mini:150,gpt-4:150" +DEFAULT_MODEL_CAPACITY="gpt-4o-mini:150,text-embedding-3-small:150,gpt-realtime-mini:150" # Convert the comma-separated string into an array IFS=',' read -r -a MODEL_CAPACITY_PAIRS <<< "$DEFAULT_MODEL_CAPACITY" From e3ffcb8df89d57726d198e2b23e694f43d630453 Mon Sep 17 00:00:00 2001 From: "Prekshith D J (Persistent Systems Inc)" Date: Wed, 13 May 2026 14:59:16 +0530 Subject: [PATCH 09/10] Fixed the copilot review comments --- documents/QuotaCheck.md | 2 +- infra/scripts/quota_check_params.sh | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/documents/QuotaCheck.md b/documents/QuotaCheck.md index 1f4bdbbe..6a990676 100644 --- a/documents/QuotaCheck.md +++ b/documents/QuotaCheck.md @@ -10,7 +10,7 @@ azd auth login ### 📌 Default Models & Capacities: ``` -gpt-4o-mini:150, text-embedding-3-small:150, gpt-realtime-mini:150 +gpt-4o-mini:50,text-embedding-3-small:10,gpt-realtime-mini:1 ``` ### 📌 Default Regions: ``` diff --git a/infra/scripts/quota_check_params.sh b/infra/scripts/quota_check_params.sh index 389b6cad..ab47de7a 100644 --- a/infra/scripts/quota_check_params.sh +++ b/infra/scripts/quota_check_params.sh @@ -47,7 +47,8 @@ log_verbose() { } # Default Models and Capacities (Comma-separated in "model:capacity" format) -DEFAULT_MODEL_CAPACITY="gpt-4o-mini:150,text-embedding-3-small:150,gpt-realtime-mini:150" +# Keep these defaults aligned with infra/main.bicep deployment capacities. +DEFAULT_MODEL_CAPACITY="gpt-4o-mini:50,text-embedding-3-small:10,gpt-realtime-mini:1" # Convert the comma-separated string into an array IFS=',' read -r -a MODEL_CAPACITY_PAIRS <<< "$DEFAULT_MODEL_CAPACITY" From 7d7f7fc960c5a6f22bcd6084be3df24f0e84d41c Mon Sep 17 00:00:00 2001 From: Yamini-Microsoft Date: Thu, 14 May 2026 17:37:27 +0530 Subject: [PATCH 10/10] fix: restrict deploy workflow to manual trigger only Remove push and pull_request triggers to prevent automatic resource provisioning. The workflow now only runs via workflow_dispatch. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .github/workflows/azure-dev.yml | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/.github/workflows/azure-dev.yml b/.github/workflows/azure-dev.yml index 77dd0627..43bea052 100644 --- a/.github/workflows/azure-dev.yml +++ b/.github/workflows/azure-dev.yml @@ -1,13 +1,6 @@ name: Azure Dev Deploy on: workflow_dispatch: - push: - branches: - - main - paths: - - 'infra/**' - - 'azure*.yaml' - - '.github/workflows/azure-dev.yml' permissions: contents: read @@ -78,4 +71,4 @@ jobs: azd env set AZURE_EXISTING_AI_PROJECT_RESOURCE_ID "$AZURE_EXISTING_AI_PROJECT_RESOURCE_ID" fi - azd up --no-prompt + azd up --no-prompt \ No newline at end of file