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

Author: Abdul-Microsoft

.github/workflows/azure-dev-validation.yml

@@ -19,7 +19,7 @@ jobs:
         uses: actions/checkout@v4 
       # Step 2: Validate the Azure template using microsoft/template-validation-action 
       - name: Validate Azure Template 
-        uses: microsoft/template-validation-action@v0.3.5 
+        uses: microsoft/template-validation-action@Latest 
         id: validation 
         env: 
           AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID }} 

docs/CustomizingAzdParameters.md

@@ -14,7 +14,7 @@ By default this template will use the environment name as the prefix to prevent
 | `AZURE_ENV_MODEL_NAME`                 | string  | `gpt-4o`         | Set the Model Name (allowed values: gpt-4o).                                                         |
 | `AZURE_ENV_MODEL_VERSION`              | string  | `2024-08-06`     | Set the Azure model version (allowed values: 2024-08-06)    |
 | `AZURE_ENV_MODEL_CAPACITY`             | integer | `200`            | Set the Model Capacity (choose a number based on available GPT model capacity in your subscription). |
-| `AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID` | string  | `<Existing Workspace Id>`     | Set this if you want to reuse an existing Log Analytics Workspace instead of creating a new one.     |
+| `AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID` | string  | Guide to get your [Existing Workspace ID](/docs/re-use-log-analytics.md)     | Set this if you want to reuse an existing Log Analytics Workspace instead of creating a new one.     |
 | `AZURE_ENV_IMAGETAG`                   | string  | `latest`         | Set the Image tag Like (allowed values: latest, dev, hotfix)    |
 | `AZURE_ENV_JUMPBOX_SIZE`                   | string  | `Standard_DS2_v2`         | Specifies the size of the Jumpbox Virtual Machine. Set a custom value if `enablePrivateNetworking` is `true`.    |
 | `AZURE_ENV_JUMPBOX_ADMIN_USERNAME`     | string  | `JumpboxAdminUser`          | Specifies the administrator username for the Jumpbox Virtual Machine.      |
@@ -39,4 +39,4 @@ azd env set AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID '/subscriptions/<subscription-i
 
 ```bash
 azd env set AZURE_LOCATION westus2
-```
+```

docs/DeploymentGuide.md

@@ -29,41 +29,8 @@ Check the [Azure Products by Region](https://azure.microsoft.com/en-us/explore/g
 
 ➡️ To ensure sufficient quota is available in your subscription, please follow **[Quota check instructions guide](../docs/quota_check.md)** before you deploy the solution.
 
-| [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/microsoft/Modernize-your-Code-Solution-Accelerator) | [![Open in Dev Containers](https://img.shields.io/static/v1?style=for-the-badge&label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/Modernize-your-Code-Solution-Accelerator) |
-|---|---|
-
-### **Configurable Deployment Settings**  
-
-When you start the deployment, most parameters will have **default values**, but you can update the following settings by following the steps [here](../docs/CustomizingAzdParameters.md):  
-
-| **Setting**                       | **Description**                                                                                      | **Default value**         |
-|----------------------------------|------------------------------------------------------------------------------------------------------|----------------------------|
-| **Azure Region**                 | The region where resources will be created.                                                         | East US                   |
-| **Resource Prefix**              | Prefix for all resources created by this template. This prefix will be used to create unique names for all resources. The prefix must be unique within the resource group. | azdtemp                   |
-| **Capacity**                     | Configure capacity for **gpt-4o**.                                                                   | 200                        |
-| **Model Deployment Type**        | Change the Model Deployment Type (allowed values: Standard, GlobalStandard).                        | GlobalStandard             |
-| **Model Name**                   | Set the Model Name (allowed values: gpt-4o).                                                        | gpt-4o                     |
-| **Model Version**                | Set the Azure model version (allowed values: 2024-08-06).                                           | 2024-08-06                 |
-| **Image Tag**                    | Set the Image tag (allowed values: latest, dev, hotfix).                                            | latest                     |
-| **Existing Log analytics workspace** | To reuse the existing Log analytics workspace Id.                                                | `<Existing Workspace Id>` |
-| **Jumpbox Admin Username**         | Specifies the administrator username for the Jumpbox Virtual Machine.                             | `JumpboxAdminUser`         |
-| **Jumpbox Admin Password**         | Specifies the administrator password for the Jumpbox Virtual Machine.                             | `JumpboxAdminP@ssw0rd1234!` |
-| **Cosmos DB Secondary Location**   | Specifies the secondary region for Cosmos DB. Set this if redundancy (`enableRedundancy`) is enabled. | `<Secondary Region>`        |
-
+## Deployment Options & Steps
 
-This accelerator can be configured to  use authentication. 
-
-* To use authentication the installer must have the rights to create and register an application identity in their Azure environment.
-After installation is complete, follow the directions in the [App Authentication](../docs/AddAuthentication.md) document to enable authentication.
-* Note: If you enable authentication, all processing history and current processing will be performed for your specific user. Without authentication, all batch history from the tool will be visible to all users.
-
-### [Optional] Quota Recommendations  
-By default, the **GPT model capacity** in deployment is set to **5k tokens**.  
-> **We recommend increasing the capacity to 200k tokens for optimal performance.** 
-
-To adjust quota settings, follow these [steps](../docs/AzureGPTQuotaSettings.md)
-
-### Deployment Options & Steps 
 ### Sandbox or WAF Aligned Deployment Options
 
 The [`infra`](../infra) folder contains the [`main.bicep`](../infra/main.bicep) Bicep script, which defines all Azure infrastructure components for this solution.
@@ -86,12 +53,17 @@ When prompted during `azd up`:
 
 - Select **`true`** to deploy a **WAF-aligned, production-ready environment**  
 - Select **`false`** to deploy a **lightweight sandbox/dev environment**
-- 
+  
 > [!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.
 
+### Deployment Steps 
+
 Pick from the options below to see step-by-step instructions for: GitHub Codespaces, VS Code Dev Containers, Local Environments, and Bicep deployments.
 
+| [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/microsoft/Modernize-your-Code-Solution-Accelerator) | [![Open in Dev Containers](https://img.shields.io/static/v1?style=for-the-badge&label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/Modernize-your-Code-Solution-Accelerator) |
+|---|---|
+
 <details>
   <summary><b>Deploy in GitHub Codespaces</b></summary>
 
@@ -104,7 +76,7 @@ You can run this solution using GitHub Codespaces. The button will open a web-ba
     [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/microsoft/Modernize-your-Code-Solution-Accelerator)
 2. Accept the default values on the create Codespaces page
 3. Open a terminal window if it is not already open
-4. Continue with the [deploying steps](#deploying)
+4. Continue with the [deploying steps](#deploying-with-azd)
 
 </details>
 
@@ -122,7 +94,7 @@ You can run this solution in VS Code Dev Containers, which will open the project
 
 
 3. In the VS Code window that opens, once the project files show up (this may take several minutes), open a terminal window.
-4. Continue with the [deploying steps](#deploying)
+4. Continue with the [deploying steps](#deploying-with-azd)
 
 </details>
 
@@ -148,11 +120,61 @@ If you're not using one of the above options for opening the project, then you'l
 
 3. Open the project folder in your terminal or editor.
 
-4. Continue with the [deploying steps](#deploying).
+4. Continue with the [deploying steps](#deploying-with-azd).
 
 </details>
 
-### Deploying
+<br/>
+
+Consider the following settings during your deployment to modify specific settings:
+
+ <details>
+<Summary><b>Configurable Deployment Settings</b></Summary>
+
+When you start the deployment, most parameters will have **default values**, but you can update the following settings by following the steps [here](../docs/CustomizingAzdParameters.md):  
+
+| **Setting**                       | **Description**                                                                                      | **Default value**         |
+|----------------------------------|------------------------------------------------------------------------------------------------------|----------------------------|
+| **Azure Region**                 | The region where resources will be created.                                                         | East US                   |
+| **Resource Prefix**              | Prefix for all resources created by this template. This prefix will be used to create unique names for all resources. The prefix must be unique within the resource group. | azdtemp                   |
+| **Capacity**                     | Configure capacity for **gpt-4o**.                                                                   | 200                        |
+| **Model Deployment Type**        | Change the Model Deployment Type (allowed values: Standard, GlobalStandard).                        | GlobalStandard             |
+| **Model Name**                   | Set the Model Name (allowed values: gpt-4o).                                                        | gpt-4o                     |
+| **Model Version**                | Set the Azure model version (allowed values: 2024-08-06).                                           | 2024-08-06                 |
+| **Image Tag**                    | Set the Image tag (allowed values: latest, dev, hotfix).                                            | latest                     |
+| **Existing Log analytics workspace** | To reuse the existing Log analytics workspace Id.                                                | `<Existing Workspace Id>` |
+| **Jumpbox Admin Username**         | Specifies the administrator username for the Jumpbox Virtual Machine.                             | `JumpboxAdminUser`         |
+| **Jumpbox Admin Password**         | Specifies the administrator password for the Jumpbox Virtual Machine.                             | `JumpboxAdminP@ssw0rd1234!` |
+| **Cosmos DB Secondary Location**   | Specifies the secondary region for Cosmos DB. Set this if redundancy (`enableRedundancy`) is enabled. | `<Secondary Region>`        |
+
+
+This accelerator can be configured to  use authentication. 
+
+* To use authentication the installer must have the rights to create and register an application identity in their Azure environment.
+After installation is complete, follow the directions in the [App Authentication](../docs/AddAuthentication.md) document to enable authentication.
+* Note: If you enable authentication, all processing history and current processing will be performed for your specific user. Without authentication, all batch history from the tool will be visible to all users.
+
+ </details>
+
+<details>
+<Summary><b> Quota Recommendations </b></Summary> 
+  
+By default, the **GPT model capacity** in deployment is set to **5k tokens**.  
+> **We recommend increasing the capacity to 200k tokens for optimal performance.** 
+
+To adjust quota settings, follow these [steps](../docs/AzureGPTQuotaSettings.md)
+
+</details>
+
+<details>
+
+  <summary><b>Reusing an Existing Log Analytics Workspace</b></summary>
+
+  Guide to get your [Existing Workspace ID](/docs/re-use-log-analytics.md)
+
+</details>
+
+### Deploying with AZD
 
 Once you've opened the project in [Codespaces](#github-codespaces) or in [Dev Containers](#vs-code-dev-containers) or [locally](#local-environment), you can deploy it to Azure following the following steps. 
 
@@ -182,7 +204,7 @@ To change the azd parameters from the default values, follow the steps [here](..
     ```shell
     azd up
     ```
-
+  
 4. Select a subscription from your Azure account, and select a location which has quota for all the resources. 
     * This deployment will take *6-9 minutes* to provision the resources in your account and set up the solution with sample data. 
     * If you get an error or timeout with deployment, changing the location can help, as there may be availability constraints for the resources.

docs/images/re_use_log/logAnalytics.png

@@ -0,0 +1,31 @@
+[← Back to *DEPLOYMENT* guide](/docs/DeploymentGuide.md#deployment-options--steps)
+
+# Reusing an Existing Log Analytics Workspace
+To configure your environment to use an existing Log Analytics Workspace, follow these steps:
+---
+### 1. Go to Azure Portal
+Go to https://portal.azure.com
+
+### 2. Search for Log Analytics
+In the search bar at the top, type "Log Analytics workspaces" and click on it and click on the workspace you want to use.
+
+![alt text](../docs/images/re_use_log/logAnalyticsList.png)
+
+### 3. Copy Resource ID
+In the Overview pane, Click on JSON View
+
+![alt text](../docs/images/re_use_log/logAnalytics.png)
+
+Copy Resource ID that is your Workspace ID
+
+![alt text](../docs/images/re_use_log/logAnalyticsJson.png)
+
+### 4. Set the Workspace ID in Your Environment
+Run the following command in your terminal
+```bash
+azd env set AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID '<Existing Log Analytics Workspace Id>'
+```
+Replace `<Existing Log Analytics Workspace Id>` with the value obtained from Step 3.
+
+### 5. Continue Deployment
+Proceed with the next steps in the [deployment guide](/docs/DeploymentGuide.md#deployment-options--steps).

docs/images/re_use_log/logAnalyticsJson.png

@@ -26,7 +26,7 @@ echo "✅ Azure subscription set successfully."
 # Define models and their minimum required capacities
 declare -A MIN_CAPACITY=(
 
-    ["OpenAI.GlobalStandard.gpt4.1"]=$GPT_MIN_CAPACITY
+    ["OpenAI.GlobalStandard.gpt-4o"]=$GPT_MIN_CAPACITY
 )
 
 VALID_REGION=""