Skip to content

Commit d6a0ee5

Browse files
authored
Merge pull request #80 from microsoft/auth-config-doc
docs: Update auth config, deployment and quota documentation
2 parents ba57e98 + 14cb638 commit d6a0ee5

File tree

5 files changed

+28
-12
lines changed

5 files changed

+28
-12
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,15 +53,17 @@ The sample data used in this repository is synthetic and generated using Azure O
5353
QUICK DEPLOY
5454
</h2>
5555

56-
Follow the [quick deploy steps on the deployment guide](./docs/DeploymentGuide.md) to deploy this solution to your own Azure subscription.
56+
Follow the quick deploy steps on the deployment guide to deploy this solution to your own Azure subscription.
5757

58-
### ⚠️ Important: Check Azure OpenAI Quota Availability
58+
[Click here to launch the deployment guide](./docs/DeploymentGuide.md)
5959

60-
➡️ To ensure sufficient quota is available in your subscription, please follow **[Quota check instructions guide](./docs/quota_check.md)** before you deploy the solution.
6160

6261
| [![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) |
6362
|---|---|
6463

64+
<br>
65+
66+
> ⚠️ **Important: Check Azure OpenAI Quota Availability** <br/>To ensure sufficient quota is available in your subscription, please follow [quota check instructions guide](./docs/Quota_Check.md) before you deploy the solution.
6567
6668
<br/>
6769

docs/AzureGPTQuotaSettings.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
## How to Check & Update Quota
2+
3+
Please follow [quota check instructions guide](./Quota_Check.md) to check quota availability by region.
24

35
1. **Navigate** to the [Azure AI Foundry portal](https://ai.azure.com/).
46
2. **Select** the AI Project associated with this accelerator.

docs/DeploymentGuide.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Check the [Azure Products by Region](https://azure.microsoft.com/en-us/explore/g
1818

1919
Here are some example regions where the services are available: East US, East US2, Australia East, UK South, France Central.
2020

21-
### **Important Note for PowerShell Users**
21+
### **Important: Note for PowerShell Users**
2222

2323
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:
2424

@@ -28,6 +28,14 @@ Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
2828

2929
This will allow the scripts to run for the current session without permanently changing your system's policy.
3030

31+
<br>
32+
33+
### **Important: Check Azure OpenAI Quota Availability**
34+
35+
⚠️ To ensure sufficient quota is available in your subscription, please follow [quota check instructions guide](./Quota_Check.md) before you deploy the solution.
36+
37+
<br/>
38+
3139
## Deployment Options & Steps
3240

3341
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
4048

4149
### GitHub Codespaces
4250

43-
You can run this solution using GitHub Codespaces. The button will open a web-based VS Code instance in your browser:
51+
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:
4452

4553
1. Open the solution accelerator (this may take several minutes):
4654

@@ -57,7 +65,7 @@ You can run this solution using GitHub Codespaces. The button will open a web-ba
5765

5866
### VS Code Dev Containers
5967

60-
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):
68+
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):
6169

6270
1. Start Docker Desktop (install it if not already installed).
6371
2. Open the project:
26.2 KB
Loading

docs/ManualAppRegistrationConfiguration.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,24 +51,28 @@ This guide provides detailed steps to manually register both front-end and backe
5151
- Click **Add** and remember to copy and store the secret value securely as it will not be shown again
5252
![manual_register_app_web_3](./Images/manual_register_app_web_3.png)
5353

54+
### 3. Get Tenant ID
55+
- Go to **Tenant Properties** in [Azure Portal](https://portal.azure.com)
56+
- Copy the Tenant ID (will be used in next step)
57+
58+
![manual_register_app_web_6](./Images/manual_register_app_web_6.png)
59+
5460
### 4. Set Up Authentication in Web Container App
5561

5662
- Go to your Web Container App
5763
- Go to **Authentication**
5864
- Click **Add Identity Provider**
5965
- Choose **Microsoft**
6066
- Input:
61-
- **Client ID**: The Application (client) ID from the app registration
62-
- **Client Secret**: The secret value you generated in Certificates & Secrets from the app registration
63-
- **Issuer URL**: `https://sts.windows.net/<tenant_id>/v2.0`
64-
- **Allowed Token Audiences**: Usually the Application ID URI or Client ID
67+
- **Client ID**: The Application (client) ID from the app registration
68+
- **Client Secret**: The secret value you generated in Certificates & Secrets from the app registration
69+
- **Issuer URL**: `https://sts.windows.net/<tenant_id>/v2.0`
70+
- **Allowed Token Audiences**: Usually the Application ID URI or Client ID
6571
- Click **Add**
6672

6773
![manual_register_app_web_4](./Images/manual_register_app_web_4.png)
6874

6975

70-
71-
7276
## Step 2: Register API Application
7377

7478
### 1. Create App Registration

0 commit comments

Comments
 (0)