Merge branch 'main' of https://github.com/microsoft/Modernize-your-code-solution-accelerator into updateContinerName

Author: marktayl1

.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md

@@ -0,0 +1,36 @@
+<!--
+IF SUFFICIENT INFORMATION IS NOT PROVIDED VIA THE FOLLOWING TEMPLATE THE ISSUE MIGHT BE CLOSED WITHOUT FURTHER CONSIDERATION OR INVESTIGATION
+-->
+> Please provide us with the following information:
+> ---------------------------------------------------------------
+
+### This issue is for a: (mark with an `x`)
+```
+- [ ] bug report -> please search issues before submitting
+- [ ] feature request
+- [ ] documentation issue or request
+- [ ] regression (a behavior that used to work and stopped in a new release)
+```
+
+### Minimal steps to reproduce
+>
+
+### Any log messages given by the failure
+>
+
+### Expected/desired behavior
+>
+
+### OS and Version?
+> Windows 7, 8 or 10. Linux (which distribution). macOS (Yosemite? El Capitan? Sierra?)
+
+### azd version?
+> run `azd version` and copy paste here.
+
+### Versions
+>
+
+### Mention any other details that might be useful
+
+> ---------------------------------------------------------------
+> Thanks! We'll be in touch soon.

README.md

@@ -61,7 +61,7 @@ The sample data used in this repository is synthetic and generated using Azure O
 
 This diagram double-clicks into the agentic framework for the code conversion process. The conversion uses an agentic approach with each agent playing a specialized role in the process. The system gets a list of SQL files which are targeted for conversion. 
 
-**Step 1:** The system loops through the list of SQL files, converting each file, starting by passing the SQL to the Migrator agent. This agent will create several candidate SQL files that should be equivalent. It does this to ensure that the system acknowledges that most of these queries could be converted in a number of different ways. *Note that the processing time can vary depending on OpenAI and cloud services.*
+**Step 1:** The system loops through the list of SQL files, converting each file, starting by passing the SQL to the Migrator agent. This agent will create several candidate SQL files that should be equivalent. It does this to ensure that the system acknowledges that most of these queries could be converted in a number of different ways. *Note that the processing time can vary depending on Azure OpenAI service and cloud services.*
 
 **Step 2:** The Picker agent then examines these various possibilities and picks the one it believes is best using criteria such as simplicity, clarity of syntax, etc.
 
@@ -75,28 +75,24 @@ This diagram double-clicks into the agentic framework for the code conversion pr
 QUICK DEPLOY
 </h2>
 
-
-| [![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) | [![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fmicrosoft%2FModernize-your-code-solution-accelerator%2Frefs%2Fheads%2Fmain%2Finfra%2Fmain.json) |
-|---|---|---|
-
 ### **Prerequisites**
 
 To deploy this solution accelerator, ensure you have access to an [Azure subscription](https://azure.microsoft.com/free/) with the necessary permissions to create **resource groups and resources**. Follow the steps in  [Azure Account Set Up](./docs/AzureAccountSetUp.md) 
 
 Check the [Azure Products by Region](https://azure.microsoft.com/en-us/explore/global-infrastructure/products-by-region/?products=all&regions=all) page and select a **region** where the following services are available:  
 
 - Azure AI Foundry 
-- Azure OpenAI Service 
-- Embedding Deployment Capacity  
+- Azure OpenAI Service  
 - GPT Model Capacity
 
 Here are some example regions where the services are available: East US, East US2, Japan East, UK South, Sweden Central.
 
-This accelerator can be deployed with or without authentication. 
+### ⚠️ Important: Check Azure OpenAI Quota Availability  
 
-* To install with authentication requires that the installer 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 install with authentication, all processing history and current processing will be performed for your specific user. If you deploy without authentication, all batch history from the tool will be visible to all users.
+➡️ 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**  
 
@@ -106,16 +102,20 @@ When you start the deployment, most parameters will have **default values**, but
 |------------|----------------|  ------------|
 | **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. | None |
-| **Ai Location** | Location for all Ai services resources. This location can be different from the resource group location | None |
-| **Capacity** | Configure capacity for **GPT models**. |  5k |
+| **AI Location** | Location for all AI services resources. This location can be different from the resource group location | None |
+| **Capacity** | Configure capacity for **gpt-4o**. |  5k |
+
+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 30k tokens for optimal performance.** 
-
-To adjust quota settings, follow these [steps](./docs/AzureGPTQuotaSettings.md)  
+> **We recommend increasing the capacity to 200k tokens for optimal performance.** 
 
-**⚠️ Warning:**  **Insufficient quota can cause application errors.** Please ensure you have the recommended capacity or request for additional capacity before deploying this solution. 
+To adjust quota settings, follow these [steps](./docs/AzureGPTQuotaSettings.md)
 
 ### Deployment Options
 Pick from the options below to see step-by-step instructions for: GitHub Codespaces, VS Code Dev Containers, Local Environments, and Bicep deployments.
@@ -178,16 +178,6 @@ If you're not using one of the above options for opening the project, then you'l
 
 4. Continue with the [deploying steps](#deploying).
 
-</details>
-<details>
-  <summary><b>Deploy with Bicep/ARM template</b></summary>
-
-### Bicep
-
-   Click the following deployment button to create the required resources for this accelerator directly in your Azure Subscription.
-
-   [![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fmarktayl1%2Ftestdeploy%2Frefs%2Fheads%2Fmain%2FCodeGenDeploy.json)
-
 </details>
 
 ### Deploying
@@ -246,8 +236,7 @@ Responsible AI Transparency FAQ
 
 Please refer to [Transparency FAQ](./TRANSPARENCY_FAQ.md) for responsible AI transparency details of this solution accelerator.
 
-<h2><img src="./docs/images/read_me/supportingDocuments.png" width="64" style="max-width: 100%;">
-</br>
+<h2>
 Supporting Documentation
 </h2>
 
@@ -262,7 +251,7 @@ You can try the [Azure pricing calculator](https://azure.microsoft.com/en-us/pri
 * Azure AI Foundry: Free tier. [Pricing](https://azure.microsoft.com/pricing/details/ai-studio/)
 * Azure Storage Account: Standard tier, LRS. Pricing is based on storage and operations. [Pricing](https://azure.microsoft.com/pricing/details/storage/blobs/)
 * Azure Key Vault: Standard tier. Pricing is based on the number of operations. [Pricing](https://azure.microsoft.com/pricing/details/key-vault/)
-* Azure AI Services: S0 tier, defaults to gpt-4o-mini and text-embedding-ada-002 models. Pricing is based on token count. [Pricing](https://azure.microsoft.com/pricing/details/cognitive-services/)
+* Azure AI Services: S0 tier, defaults to gpt-4o-mini. Pricing is based on token count. [Pricing](https://azure.microsoft.com/pricing/details/cognitive-services/)
 * Azure Container App: Consumption tier with 0.5 CPU, 1GiB memory/storage. Pricing is based on resource allocation, and each month allows for a certain amount of free usage. [Pricing](https://azure.microsoft.com/pricing/details/container-apps/)
 * Azure Container Registry: Basic tier. [Pricing](https://azure.microsoft.com/pricing/details/container-registry/)
 * Log analytics: Pay-as-you-go tier. Costs based on data ingested. [Pricing](https://azure.microsoft.com/pricing/details/monitor/)

docs/AzureAccountSetUp.md

@@ -0,0 +1,14 @@
+## Azure account setup
+
+1. Sign up for a [free Azure account](https://azure.microsoft.com/free/) and create an Azure Subscription.
+2. Check that you have the necessary permissions:
+    * Your Azure account must have `Microsoft.Authorization/roleAssignments/write` permissions, such as [Role Based Access Control Administrator](https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#role-based-access-control-administrator-preview), [User Access Administrator](https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#user-access-administrator), or [Owner](https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#owner).
+    * Your Azure account also needs `Microsoft.Resources/deployments/write` permissions on the subscription level.
+
+You can view the permissions for your account and subscription by following the steps below: 
+- Navigate to the [Azure Portal](https://portal.azure.com/) and click on `Subscriptions` under 'Navigation' 
+- Select the subscription you are using for this accelerator from the list. 
+    - If you try to search for your subscription and it does not come up, make sure no filters are selected.
+- Select `Access control (IAM)` and you can see the roles that are assigned to your account for this subscription. 
+    - If you want to see more information about the roles, you can go to the `Role assignments`
+     tab and search by your account name and then click the role you want to view more information about.

docs/AzureGPTQuotaSettings.md

@@ -0,0 +1,10 @@
+## How to Check & Update Quota
+
+1. **Navigate** to the [Azure AI Foundry portal](https://ai.azure.com/).  
+2. **Select** the AI Project associated with this accelerator.  
+3. **Go to** the `Management Center` from the bottom-left navigation menu.  
+4. Select `Quota`  
+   - Click on the `GlobalStandard` dropdown.  
+   - Select the required **GPT model** (`GPT-4, GPT-4o`).  
+   - Choose the **region** where the deployment is hosted.  
+5. Request More Quota or delete any unused model deployments as needed.  

docs/CustomizingAzdParameters.md

@@ -0,0 +1,23 @@
+By default this template will use the environment name as the prefix to prevent naming collisions within Azure. The parameters below show the default values. You only need to run the statements below if you need to change the values. 
+
+
+> To override any of the parameters, run `azd env set <key> <value>` before running `azd up`. On the first azd command, it will prompt you for the environment name. Be sure to choose 3-20 charaters alphanumeric unique name. 
+
+Change the Model Deployment Type (allowed values: Standard, GlobalStandard)
+
+```shell
+azd env set AZURE_ENV_MODEL_DEPLOYMENT_TYPE Standard
+```
+
+Set the Model Name (allowed values: gpt-4)
+
+```shell
+azd env set AZURE_ENV_MODEL_NAME gpt-4
+```
+
+Change the Model Capacity (choose a number based on available GPT model capacity in your subscription)
+
+```shell
+azd env set AZURE_ENV_MODEL_CAPACITY 30
+```
+

docs/DeleteResourceGroup.md

@@ -0,0 +1,51 @@
+# Deleting Resources After a Failed Deployment in Azure Portal
+
+If your deployment fails and you need to clean up the resources manually, follow these steps in the Azure Portal.
+
+---
+
+## **1. Navigate to the Azure Portal**
+1. Open [Azure Portal](https://portal.azure.com/).
+2. Sign in with your Azure account.
+
+---
+
+## **2. Find the Resource Group**
+1. In the search bar at the top, type **"Resource groups"** and select it.
+2. Locate the **resource group** associated with the failed deployment.
+
+![Resource Groups](images/delete_resource/resourcegroup.png)
+
+![Resource Groups](images/delete_resource/resource-groups.png)
+
+---
+
+## **3. Delete the Resource Group**
+1. Click on the **resource group name** to open it.
+2. Click the **Delete resource group** button at the top.
+
+![Delete Resource Group](images/delete_resource/DeleteRG.png)
+
+3. Type the resource group name in the confirmation box and click **Delete**.
+
+📌 **Note:** Deleting a resource group will remove all resources inside it.
+
+---
+
+## **4. Delete Individual Resources (If Needed)**
+If you don’t want to delete the entire resource group, follow these steps:
+
+1. Open **Azure Portal** and go to the **Resource groups** section.
+2. Click on the specific **resource group**.
+3. Select the **resource** you want to delete (e.g., App Service, Storage Account).
+4. Click **Delete** at the top.
+
+![Delete Individual Resource](images/delete_resource/deleteservices.png)
+
+---
+
+## **5. Verify Deletion**
+- After a few minutes, refresh the **Resource groups** page.
+- Ensure the deleted resource or group no longer appears.
+
+📌 **Tip:** If a resource fails to delete, check if it's **locked** under the **Locks** section and remove the lock.

docs/EXAMPLE-CustomizingAzdParameters.md

@@ -11,12 +11,6 @@ Change the Content Understanding Location (allowed values: Sweden Central, Austr
 azd env set AZURE_ENV_CU_LOCATION 'swedencentral'
 ```
 
-Change the Secondary Location (example: eastus2, westus2, etc.)
-
-```shell
-azd env set AZURE_ENV_SECONDARY_LOCATION eastus2
-```
-
 Change the Model Deployment Type (allowed values: Standard, GlobalStandard)
 
 ```shell
@@ -34,15 +28,3 @@ Change the Model Capacity (choose a number based on available GPT model capacity
 ```shell
 azd env set AZURE_ENV_MODEL_CAPACITY 30
 ```
-
-Change the Embedding Model 
-
-```shell
-azd env set AZURE_ENV_EMBEDDING_MODEL_NAME text-embedding-ada-002
-```
-
-Change the Embedding Deployment Capacity (choose a number based on available embedding model capacity in your subscription)
-
-```shell
-azd env set AZURE_ENV_EMBEDDING_MODEL_CAPACITY 80
-```