Merge remote-tracking branch 'origin/dev' into dependabotchanges

Author: Saswato-Microsoft

.devcontainer/setupEnv.sh

@@ -23,10 +23,10 @@ yarn install
 cd ../../
 
 echo "Setting up executable permission for shell scripts"
-sed -i 's/\r$//' ./infra/scripts/post_deployment.sh
-sudo chmod +x ./infra/scripts/docker-build.sh
-sudo chmod +x ./infra/scripts/post_deployment.sh
-sudo chmod +x ./src/ContentProcessorAPI/samples/upload_files.sh
-sudo chmod +x ./src/ContentProcessorAPI/samples/schemas/register_schema.sh
+sed -i 's/\r$//' infra/scripts/post_deployment.sh
+sudo chmod +x infra/scripts/docker-build.sh
+sudo chmod +x infra/scripts/post_deployment.sh
+sudo chmod +x src/ContentProcessorAPI/samples/upload_files.sh
+sudo chmod +x src/ContentProcessorAPI/samples/schemas/register_schema.sh
 
 echo "Setup complete! 🎉"

.github/workflows/deploy.yml

@@ -16,7 +16,6 @@ jobs:
       propertydamageclaimform_schema_id: ${{ steps.register.outputs.propertylossdamageclaimform_schema_id }}
       RESOURCE_GROUP_NAME: ${{ steps.generate_rg_name.outputs.RESOURCE_GROUP_NAME }}
       CONTAINER_WEB_APPURL: ${{ steps.get_output.outputs.CONTAINER_WEB_APPURL }}
-      SOLUTION_NAME: ${{ steps.get_output.outputs.SOLUTION_NAME }}
       DEPLOYMENT_SUCCESS: ${{ steps.deployment_status.outputs.SUCCESS }}
       AI_SERVICES_NAME: ${{ steps.get_ai_services_name.outputs.AI_SERVICES_NAME }}
       KEYVAULTS: ${{ steps.list_keyvaults.outputs.KEYVAULTS }}
@@ -137,25 +136,24 @@ jobs:
           # Install azd (Azure Developer CLI)
           curl -fsSL https://aka.ms/install-azd.sh | bash
 
+          # Generate current timestamp in desired format: YYYY-MM-DDTHH:MM:SS.SSSSSSSZ
+            current_date=$(date -u +"%Y-%m-%dT%H:%M:%S.%7NZ")
+
           echo "Running az deployment group create..."
           if ! DEPLOY_OUTPUT=$(az deployment group create \
             --resource-group ${{ env.RESOURCE_GROUP_NAME }} \
             --template-file infra/main.json \
             --parameters \
               environmentName="${{ env.ENVIRONMENT_NAME }}" \
-              secondaryLocation="EastUs2" \
+              enablePrivateNetworking="false" \
+              secondaryLocation="eastus2" \
               contentUnderstandingLocation="WestUS" \
               deploymentType="GlobalStandard" \
               gptModelName="gpt-4o" \
               gptModelVersion="2024-08-06" \
               gptDeploymentCapacity="30" \
-              minReplicaContainerApp="1" \
-              maxReplicaContainerApp="1" \
-              minReplicaContainerApi="1" \
-              maxReplicaContainerApi="1" \
-              minReplicaContainerWeb="1" \
-              maxReplicaContainerWeb="1" \
               aiDeploymentsLocation="${{ env.AZURE_LOCATION }}" \
+              tags="{'CreatedBy':'Pipeline', 'SecurityControl':'Ignore','Purpose':'Deploying and Cleaning Up Resources for Validation','CreatedDate':'$current_date'}" \
             --query "properties.outputs" -o json); then
               echo "❌ Deployment failed. See logs above."
               exit 1
@@ -171,18 +169,13 @@ jobs:
           export CONTAINER_API_APPNAME=$(echo "$DEPLOY_OUTPUT" | jq -r '.containeR_API_APP_NAME.value')
           echo "CONTAINER_API_APPNAME=$CONTAINER_API_APPNAME" >> $GITHUB_ENV
 
-          export CONTAINER_WEB_APPURL=$(echo "$DEPLOY_OUTPUT" | jq -r '.containeR_WEB_APP_FQDN.value')
+          export CONTAINER_WEB_APPURL="https://$(echo "$DEPLOY_OUTPUT" | jq -r '.containeR_WEB_APP_FQDN.value')"
           echo "CONTAINER_WEB_APPURL=$CONTAINER_WEB_APPURL" >> $GITHUB_ENV
           echo "CONTAINER_WEB_APPURL=$CONTAINER_WEB_APPURL" >> $GITHUB_OUTPUT
 
           export CONTAINER_WEB_APPNAME=$(echo "$DEPLOY_OUTPUT" | jq -r '.containeR_WEB_APP_NAME.value')
           echo "CONTAINER_WEB_APPNAME=$CONTAINER_WEB_APPNAME" >> $GITHUB_ENV
 
-          export SOLUTION_NAME=$(echo "$DEPLOY_OUTPUT" | jq -r '.solutioN_NAME.value')
-          echo "SOLUTION_NAME=$SOLUTION_NAME" >> $GITHUB_ENV
-          echo "SOLUTION_NAME=$SOLUTION_NAME" >> $GITHUB_OUTPUT
-
-
       - name: Register schemas
         id: register
         run: |
@@ -290,7 +283,6 @@ jobs:
     with:
       CP_WEB_URL: ${{ needs.deploy.outputs.CONTAINER_WEB_APPURL }}
       CP_RG: ${{ needs.deploy.outputs.RESOURCE_GROUP_NAME }}
-      CP_CONTAINERAPP_PREFIX: ${{ format('ca-{0}', needs.deploy.outputs.SOLUTION_NAME ) }}
     secrets: inherit
 
   cleanup:

.github/workflows/test-automation.yml

@@ -9,14 +9,10 @@ on:
       CP_RG:
         required: true
         type: string
-      CP_CONTAINERAPP_PREFIX:
-        required: true
-        type: string
 
 env:
     url: ${{ inputs.CP_WEB_URL }}
     CP_RG: ${{ inputs.CP_RG }}
-    CP_CONTAINERAPP_PREFIX: ${{ inputs.CP_CONTAINERAPP_PREFIX }}
     accelerator_name: "Content Processing"
 
 
@@ -38,16 +34,6 @@ jobs:
           az login --service-principal -u ${{ secrets.AZURE_MAINTENANCE_CLIENT_ID }} -p ${{ secrets.AZURE_MAINTENANCE_CLIENT_SECRET }} --tenant ${{ secrets.AZURE_TENANT_ID }}
           az account set --subscription ${{ secrets.AZURE_MAINTENANCE_SUBSCRIPTION_ID }}
 
-      - name: Start Container App
-        id: start-container-app
-        uses: azure/cli@v2
-        with:
-          azcliversion: 'latest'
-          inlineScript: |
-            az rest -m post -u "/subscriptions/${{ secrets.AZURE_MAINTENANCE_SUBSCRIPTION_ID }}/resourceGroups/${{ env.CP_RG }}/providers/Microsoft.App/containerApps/${{ env.CP_CONTAINERAPP_PREFIX }}-app/start?api-version=2025-01-01"
-            az rest -m post -u "/subscriptions/${{ secrets.AZURE_MAINTENANCE_SUBSCRIPTION_ID }}/resourceGroups/${{ env.CP_RG }}/providers/Microsoft.App/containerApps/${{ env.CP_CONTAINERAPP_PREFIX }}-api/start?api-version=2025-01-01"
-            az rest -m post -u "/subscriptions/${{ secrets.AZURE_MAINTENANCE_SUBSCRIPTION_ID }}/resourceGroups/${{ env.CP_RG }}/providers/Microsoft.App/containerApps/${{ env.CP_CONTAINERAPP_PREFIX }}-web/start?api-version=2025-01-01"
-
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
@@ -159,15 +145,4 @@ jobs:
           # Send the notification
           curl -X POST "${{ secrets.EMAILNOTIFICATION_LOGICAPP_URL_TA }}" \
             -H "Content-Type: application/json" \
-            -d "$EMAIL_BODY" || echo "Failed to send notification"
-
-      - name: Stop Container App
-        if: always()
-        uses: azure/cli@v2
-        with:
-          azcliversion: 'latest'
-          inlineScript: |
-            az rest -m post -u "/subscriptions/${{ secrets.AZURE_MAINTENANCE_SUBSCRIPTION_ID }}/resourceGroups/${{ env.CP_RG }}/providers/Microsoft.App/containerApps/${{ env.CP_CONTAINERAPP_PREFIX }}-app/stop?api-version=2025-01-01"
-            az rest -m post -u "/subscriptions/${{ secrets.AZURE_MAINTENANCE_SUBSCRIPTION_ID }}/resourceGroups/${{ env.CP_RG }}/providers/Microsoft.App/containerApps/${{ env.CP_CONTAINERAPP_PREFIX }}-api/stop?api-version=2025-01-01"
-            az rest -m post -u "/subscriptions/${{ secrets.AZURE_MAINTENANCE_SUBSCRIPTION_ID }}/resourceGroups/${{ env.CP_RG }}/providers/Microsoft.App/containerApps/${{ env.CP_CONTAINERAPP_PREFIX }}-web/stop?api-version=2025-01-01"
-            az logout
+            -d "$EMAIL_BODY" || echo "Failed to send notification"

README.md

@@ -71,6 +71,8 @@ Quick deploy
 ### How to install or deploy
 Follow the quick deploy steps on the deployment guide to deploy this solution to your own Azure subscription.
 
+> **Note:** This solution accelerator requires **Azure Developer CLI (azd) version 1.18.0 or higher**. Please ensure you have the latest version installed before proceeding with deployment. [Download azd here](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/install-azd).
+
 [Click here to launch the deployment guide](./docs/DeploymentGuide.md)
 <br/><br/>
 

azure.yaml

@@ -4,7 +4,7 @@
 name: content-processing
 
 requiredVersions:
-  azd: ">=1.15.0 !=1.17.1"
+  azd: '>= 1.18.0'
 
 metadata:
   template: content-processing@1.0

docs/ACRBuildAndPushGuide.md

@@ -0,0 +1,94 @@
+# Azure Container Registry (ACR) – Build & Push Guide
+
+This guide provides step-by-step instructions to build and push Docker images for **WebApp** and **Backend** services into Azure Container Registry (ACR).
+
+## 📋 Prerequisites
+Before starting, ensure you have:
+- An active [Azure Subscription](https://portal.azure.com/)
+- [Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli) installed and logged in
+- [Docker Desktop](https://docs.docker.com/get-docker/) installed and running
+- Access to your Azure Container Registry (ACR)
+- To create an Azure Container Registry (ACR), you can refer to the following guides:
+
+    - [Create Container Registry using Azure CLI](https://learn.microsoft.com/en-us/azure/container-registry/container-registry-get-started-azure-cli)
+
+    - [Create Container Registry using Azure Portal](https://learn.microsoft.com/en-us/azure/container-registry/container-registry-get-started-portal?tabs=azure-cli)
+
+    - [Create Container Registry using PowerShell](https://learn.microsoft.com/en-us/azure/container-registry/container-registry-get-started-powershell)
+
+    - [Create Container Registry using ARM Template](https://learn.microsoft.com/en-us/azure/container-registry/container-registry-get-started-geo-replication-template)
+
+    - [Create Container Registry using Bicep](https://learn.microsoft.com/en-us/azure/container-registry/container-registry-get-started-bicep?tabs=CLI)
+
+---
+
+Login to ACR :
+``` bash
+az acr login --name $ACR_NAME
+```
+
+## 🚀 Build and Push Images
+
+**Backend :** 
+ 
+ ```bash 
+az acr login --name <containerregname>
+docker build --no-cache -f docker/Backend.Dockerfile -t <acrloginserver>/<repo>:<tagname> .
+docker push <acrloginserver>/<repo>:<tagname>
+ ```
+
+ If you want to update image tag and image manually you can follow below steps:
+- Go to your **Container App** in the [Azure Portal](https://portal.azure.com/#home).
+- In the left menu, select **Containers**.
+- Under your container, update:
+
+    - Image source → Azure Container Registry / Docker Hub.
+
+    - Image name → myapp/backend.
+
+    - Tag → change to the new one you pushed (e.g., v2).
+
+- Click **Save** → this will create a new revision automatically with the updated image.
+
+![alt text](./images/ContainerApp.png)
+
+**WebApp :**
+
+```bash
+az acr login --name <containerregname>
+docker build --no-cache -f docker/Frontend.Dockerfile -t <acrloginserver>/<repo>:<tagname> .
+docker push <acrloginserver>/<repo>:<tagname>
+```
+
+If you want to update image tag and image manually you can follow below steps:
+- Go to your App Service in the [Azure Portal](https://portal.azure.com/#home).
+- In the left menu, select Deployment → Deployment Center
+- Under Container settings, you can configure:
+
+    - Image Source → (e.g., Azure Container Registry / Docker Hub / Other).
+
+    - Image Name → e.g., myapp/backend.
+
+    - Tag → e.g., v1.2.3.
+
+![alt text](./images/AppServiceContainer.png)
+
+
+## ✅ Verification
+
+Run the following command to verify that images were pushed successfully:
+```bash
+az acr repository list --name $ACR_NAME --output table
+```
+
+You should see repositories in the output.
+
+## 📝 Notes
+
+- Always use meaningful tags (v1.0.0, staging, prod) instead of just latest.
+
+- If you are pushing from a CI/CD pipeline, make sure the pipeline agent has access to Docker and ACR.
+
+- For private images, ensure your services (e.g., Azure Container Apps, AKS, App Service) are configured with appropriate ACR pull permissions.
+
+

docs/AVMPostDeploymentGuide.md

@@ -0,0 +1,59 @@
+# 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 Content processing solution accelerator from the [AVM (Azure Verified Modules) repository](https://github.com/Azure/bicep-registry-modules/tree/main/avm/ptn/sa/content-processing).
+
+## Overview
+
+After successfully deploying the Content Processing Solution Accelerator using the AVM template, you'll need to complete some configuration steps to make the solution fully operational.
+
+## 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)** <small>(v7.0+ recommended)</small> - Available for Windows, macOS, and Linux
+
+2. **[Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli)** <small>(v2.50+)</small> - Command-line tool for managing Azure resources
+
+3. **[Git](https://git-scm.com/downloads/)** - Version control system for cloning the repository
+
+4. **Deployed Infrastructure** - A successful Content processing solution accelerator deployment from the [AVM repository](https://github.com/Azure/bicep-registry-modules/tree/main/avm/ptn/sa/content-processing)
+
+#### 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/content-processing-solution-accelerator.git
+cd content-processing-solution-accelerator
+```
+
+### Step 2: Complete Post-Deployment Configuration
+
+Follow the **[Post Deployment Steps](./DeploymentGuide.md#post-deployment-steps)** section in the main Deployment Guide, which includes:
+
+1. **[Optional: Publishing Local Build Container to Azure Container Registry](./DeploymentGuide.md#post-deployment-steps)**
+2. **[Register Schema Files](./DeploymentGuide.md#post-deployment-steps)**
+3. **[Import Sample Data](./DeploymentGuide.md#post-deployment-steps)**
+4. **[Add Authentication Provider](./DeploymentGuide.md#post-deployment-steps)**
+
+## Next Steps
+
+Once configuration is complete, see the **[Next Steps](./DeploymentGuide.md#next-steps)** section in the main Deployment Guide to start using the solution.

docs/CustomizingAzdParameters.md

@@ -18,7 +18,7 @@ By default this template will use the environment name as the prefix to prevent
 | `AZURE_ENV_MODEL_CAPACITY`             | integer | `30`                        | Sets the model capacity (choose based on your subscription's available GPT capacity). |
 | `AZURE_ENV_IMAGETAG`                      | boolean | `latest`                     | Set the Image tag Like (allowed values: latest, dev, hotfix)                       |
 | `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 Project resource Id>`            | Reuses an existing AIFoundry and AIFoundryProject instead of creating a new one.  |
 
 ## How to Set a Parameter
 

docs/DeploymentGuide.md

@@ -87,7 +87,7 @@ If you're not using one of the above options for opening the project, then you'l
 
 1. Make sure the following tools are installed:
     - [PowerShell](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.5) <small>(v7.0+)</small> - available for Windows, macOS, and Linux.
-    - [Azure Developer CLI (azd)](https://aka.ms/install-azd) <small>(v1.15.0+)</small> - version
+    - [Azure Developer CLI (azd)](https://aka.ms/install-azd) <small>(v1.18.0+)</small> - version
     - [Python 3.9+](https://www.python.org/downloads/)
     - [Docker Desktop](https://www.docker.com/products/docker-desktop/)
     - [Git](https://git-scm.com/downloads)
@@ -124,6 +124,7 @@ When you start the deployment, most parameters will have **default values**, but
 | **Use Local Build**                         | Boolean flag to determine if local container builds should be used.                         | false             |
 | **Image Tag**                               | Image version for deployment (allowed values: `latest`, `dev`, `hotfix`).                   | latest            |
 | **Existing Log Analytics Workspace**        | To reuse an existing Log Analytics Workspace ID instead of creating a new one.              | *(none)*          |
+| **Existing Azure AI Foundry Project**        | To reuse an existing Azure AI Foundry Project ID instead of creating a new one.              | *(none)*          |
 
 
 </details>
@@ -148,6 +149,14 @@ To adjust quota settings, follow these [steps](./AzureGPTQuotaSettings.md).
 
 </details>
 
+<details>
+
+  <summary><b>Reusing an Existing Azure AI Foundry Project</b></summary>
+
+  Guide to get your [Existing Project ID](/docs/re-use-foundry-project.md)
+
+</details>
+
 ### Deploying with AZD
 
 Once you've opened the project in [Codespaces](#github-codespaces), [Dev Containers](#vs-code-dev-containers), or [locally](#local-environment), you can deploy it to Azure by following these steps:
@@ -175,6 +184,7 @@ Once you've opened the project in [Codespaces](#github-codespaces), [Dev Contain
     ```shell
     azd up
     ```
+    > **Note:** This solution accelerator requires **Azure Developer CLI (azd) version 1.18.0 or higher**. Please ensure you have the latest version installed before proceeding with deployment. [Download azd here](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/install-azd).
 
 3. Provide an `azd` environment name (e.g., "cpsapp").
 4. Select a subscription from your Azure account and choose a location that has quota for all the resources. 
@@ -192,6 +202,9 @@ Once you've opened the project in [Codespaces](#github-codespaces), [Dev Contain
 
 7. If you are done trying out the application, you can delete the resources by running `azd down`.
 
+### 🛠️ Troubleshooting
+ If you encounter any issues during the deployment process, please refer  [troubleshooting](../docs/TroubleShootingSteps.md) document for detailed steps and solutions
+
 ## Post Deployment Steps
 1. Optional: Publishing Local Build Container to Azure Container Registry 
 
@@ -273,6 +286,21 @@ Once you've opened the project in [Codespaces](#github-codespaces), [Dev Contain
 
      - Follow steps in [Delete Resource Group](./DeleteResourceGroup.md) if your deployment fails and/or you need to clean up the resources.
 
+## Environment configuration for local development & debugging
+**Creatign env file**
+
+> Navigate to the `src` folder of the project.
+
+1. Locate the `.env` file inside the `src` directory.
+2. To fill in the required values, follow these steps
+- Go to the Azure Portal.
+- Navigate to your **Resource Group**.
+- Open the **Web Container** resource.
+- In the left-hand menu, select **Containers**.
+- Go to the **Environment Variables** tab.
+- Copy the necessary environment variable values and paste them into your local `.env` file.
+  
+
 ## Next Steps
 
 Now that you've completed your deployment, you can start using the solution. Try out these things to start getting familiar with the capabilities: