diff --git a/README.md b/README.md index a9e9b6c2..57587315 100644 --- a/README.md +++ b/README.md @@ -53,15 +53,17 @@ The sample data used in this repository is synthetic and generated using Azure O QUICK DEPLOY -Follow the [quick deploy steps on the deployment guide](./docs/DeploymentGuide.md) to deploy this solution to your own Azure subscription. +Follow the quick deploy steps on the deployment guide to deploy this solution to your own Azure subscription. -### ⚠️ Important: Check Azure OpenAI Quota Availability +[Click here to launch the deployment guide](./docs/DeploymentGuide.md) -➡️ 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/content-processing-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/content-processing-solution-accelerator) | |---|---| +
+ +> ⚠️ **Important: Check Azure OpenAI Quota Availability**
To ensure sufficient quota is available in your subscription, please follow [quota check instructions guide](./docs/Quota_Check.md) before you deploy the solution.
diff --git a/docs/AzureGPTQuotaSettings.md b/docs/AzureGPTQuotaSettings.md index 34e925af..7a6f3f7a 100644 --- a/docs/AzureGPTQuotaSettings.md +++ b/docs/AzureGPTQuotaSettings.md @@ -1,4 +1,6 @@ ## How to Check & Update Quota + +Please follow [quota check instructions guide](./Quota_Check.md) to check quota availability by region. 1. **Navigate** to the [Azure AI Foundry portal](https://ai.azure.com/). 2. **Select** the AI Project associated with this accelerator. diff --git a/docs/DeploymentGuide.md b/docs/DeploymentGuide.md index f1c631e0..7e704fa4 100644 --- a/docs/DeploymentGuide.md +++ b/docs/DeploymentGuide.md @@ -18,7 +18,7 @@ Check the [Azure Products by Region](https://azure.microsoft.com/en-us/explore/g Here are some example regions where the services are available: East US, East US2, Australia East, UK South, France Central. -### **Important Note for PowerShell Users** +### **Important: Note for PowerShell Users** If you encounter issues running PowerShell scripts due to the policy of not being digitally signed, you can temporarily adjust the `ExecutionPolicy` by running the following command in an elevated PowerShell session: @@ -28,6 +28,14 @@ Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass This will allow the scripts to run for the current session without permanently changing your system's policy. +
+ +### **Important: Check Azure OpenAI Quota Availability** + +⚠️ To ensure sufficient quota is available in your subscription, please follow [quota check instructions guide](./Quota_Check.md) before you deploy the solution. + +
+ ## Deployment Options & Steps Pick from the options below to see step-by-step instructions for GitHub Codespaces, VS Code Dev Containers, Local Environments, and Bicep deployments. @@ -40,7 +48,7 @@ Pick from the options below to see step-by-step instructions for GitHub Codespac ### GitHub Codespaces -You can run this solution using GitHub Codespaces. The button will open a web-based VS Code instance in your browser: +You can run this solution using [GitHub Codespaces](https://docs.github.com/en/codespaces). The button will open a web-based VS Code instance in your browser: 1. Open the solution accelerator (this may take several minutes): @@ -57,7 +65,7 @@ You can run this solution using GitHub Codespaces. The button will open a web-ba ### VS Code Dev Containers -You can run this solution in VS Code Dev Containers, which will open the project in your local VS Code using the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers): +You can run this solution in [VS Code Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers), which will open the project in your local VS Code using the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers): 1. Start Docker Desktop (install it if not already installed). 2. Open the project: diff --git a/docs/Images/manual_register_app_web_6.png b/docs/Images/manual_register_app_web_6.png new file mode 100644 index 00000000..2fca2c87 Binary files /dev/null and b/docs/Images/manual_register_app_web_6.png differ diff --git a/docs/ManualAppRegistrationConfiguration.md b/docs/ManualAppRegistrationConfiguration.md index db3d3a21..e8fb6bf4 100644 --- a/docs/ManualAppRegistrationConfiguration.md +++ b/docs/ManualAppRegistrationConfiguration.md @@ -51,6 +51,12 @@ This guide provides detailed steps to manually register both front-end and backe - Click **Add** and remember to copy and store the secret value securely as it will not be shown again ![manual_register_app_web_3](./Images/manual_register_app_web_3.png) +### 3. Get Tenant ID +- Go to **Tenant Properties** in [Azure Portal](https://portal.azure.com) +- Copy the Tenant ID (will be used in next step) + +![manual_register_app_web_6](./Images/manual_register_app_web_6.png) + ### 4. Set Up Authentication in Web Container App - Go to your Web Container App @@ -58,17 +64,15 @@ This guide provides detailed steps to manually register both front-end and backe - Click **Add Identity Provider** - Choose **Microsoft** - Input: -- **Client ID**: The Application (client) ID from the app registration -- **Client Secret**: The secret value you generated in Certificates & Secrets from the app registration -- **Issuer URL**: `https://sts.windows.net//v2.0` -- **Allowed Token Audiences**: Usually the Application ID URI or Client ID + - **Client ID**: The Application (client) ID from the app registration + - **Client Secret**: The secret value you generated in Certificates & Secrets from the app registration + - **Issuer URL**: `https://sts.windows.net//v2.0` + - **Allowed Token Audiences**: Usually the Application ID URI or Client ID - Click **Add** ![manual_register_app_web_4](./Images/manual_register_app_web_4.png) - - ## Step 2: Register API Application ### 1. Create App Registration