Skip to content

Commit 05a127d

Browse files
Merge pull request #750 from microsoft/psl-fixdpeployment-doc
docs: fix some inconsistency in DeploymentGuide.md
2 parents bc3f20e + 41e120b commit 05a127d

1 file changed

Lines changed: 39 additions & 16 deletions

File tree

docs/DeploymentGuide.md

Lines changed: 39 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Overview
44

5-
This guide walks you through deploying the Multi Agent Custom Automation Engine Solution Accelerator to Azure. The deployment process takes approximately 10-15 minutes for the default Development/Testing configuration and includes both infrastructure provisioning and application setup.
5+
This guide walks you through deploying the Multi Agent Custom Automation Engine Solution Accelerator to Azure. The deployment process takes approximately 9-10 minutes for the default Development/Testing configuration and includes both infrastructure provisioning and application setup.
66

77
🆘 **Need Help?** If you encounter any issues during deployment, check our [Troubleshooting Guide](./TroubleShootingSteps.md) for solutions to common problems.
88

@@ -52,6 +52,7 @@ Ensure you have access to an [Azure subscription](https://azure.microsoft.com/fr
5252
- [Azure Cosmos DB](https://learn.microsoft.com/en-us/azure/cosmos-db/)
5353
- [Azure Key Vault](https://learn.microsoft.com/en-us/azure/key-vault/)
5454
- [Azure Blob Storage](https://learn.microsoft.com/en-us/azure/storage/blobs/)
55+
- [Azure Queue Storage](https://learn.microsoft.com/en-us/azure/storage/queues/)
5556
- [GPT Model Capacity](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models)
5657

5758
**Recommended Regions:** East US, East US2, Australia East, Japan East, UK South, France Central
@@ -64,9 +65,10 @@ Ensure you have access to an [Azure subscription](https://azure.microsoft.com/fr
6465

6566
📖 **Follow:** [Quota Check Instructions](./quota_check.md) to ensure sufficient capacity.
6667

67-
<!-- **Recommended Configuration:**
68-
- **Default:** 200k tokens (minimum)
69-
- **Optimal:** 500k tokens (recommended for best performance) -->
68+
**Default Quota Configuration:**
69+
- **GPT-4.1:** 150k tokens
70+
- **4o-mini:** 50k tokens
71+
- **GPT-4.1-mini:** 50k tokens
7072

7173
> **Note:** When you run `azd up`, the deployment will automatically show you regions with available quota, so this pre-check is optional but helpful for planning purposes. You can customize these settings later in [Step 3.3: Advanced Configuration](#33-advanced-configuration-optional).
7274
@@ -130,7 +132,14 @@ Select one of the following options to deploy the Multi Agent Custom Automation
130132
5. When prompted in the VS Code Web terminal, choose one of the available options shown below:
131133

132134
![VS Code Initial Prompt](./images/vscodeweb_intialize.png)
133-
6. Proceed to [Step 3: Configure Deployment Settings](#step-3-configure-deployment-settings)
135+
136+
6. **Authenticate with Azure** (VS Code Web requires device code authentication):
137+
```shell
138+
az login --use-device-code
139+
```
140+
> **Note:** In VS Code Web environment, the regular `az login` command may fail. Use the `--use-device-code` flag to authenticate via device code flow. Follow the prompts in the terminal to complete authentication.
141+
142+
7. Proceed to [Step 3: Configure Deployment Settings](#step-3-configure-deployment-settings)
134143

135144
</details>
136145

@@ -225,7 +234,7 @@ azd env set AZURE_ENV_VM_ADMIN_PASSWORD <your-password>
225234

226235
You can customize various deployment settings before running `azd up`, including Azure regions, AI model configurations (deployment type, version, capacity), container registry settings, and resource names.
227236

228-
📖 **Complete Guide:** See [Parameter Customization Guide](../docs/CustomizingAzdParameters.md) for the full list of available parameters and their usage.
237+
📖 **Complete Guide:** See [Parameter Customization Guide](./CustomizingAzdParameters.md) for the full list of available parameters and their usage.
229238

230239
</details>
231240

@@ -268,21 +277,25 @@ To optimize costs and integrate with your existing Azure infrastructure, you can
268277

269278
💡 **Before You Start:** If you encounter any issues during deployment, check our [Troubleshooting Guide](./TroubleShootingSteps.md) for common solutions.
270279

280+
⚠️ **Critical: Redeployment Warning** - If you have previously run `azd up` in this folder (i.e., a `.azure` folder exists), you must [create a fresh environment](#creating-a-new-environment) to avoid conflicts and deployment failures.
281+
271282
### 4.1 Authenticate with Azure
272283

273284
```shell
274285
azd auth login
275286
```
276287

288+
> **Note for VS Code Web Users:** If you're using VS Code Web and have already authenticated using `az login --use-device-code` in Option C, you may skip this step or proceed with `azd auth login` if prompted.
289+
277290
**For specific tenants:**
278291
```shell
279292
azd auth login --tenant-id <tenant-id>
280293
```
281294

282-
> **Finding Tenant ID:**
283-
> 1. Open the [Azure Portal](https://portal.azure.com/).
284-
> 2. Navigate to **Microsoft Entra ID** from the left-hand menu.
285-
> 3. Under the **Overview** section, locate the **Tenant ID** field. Copy the value displayed.
295+
**Finding Tenant ID:**
296+
1. Open the [Azure Portal](https://portal.azure.com/)
297+
2. Navigate to **Microsoft Entra ID** from the left-hand menu
298+
3. Under the **Overview** section, locate the **Tenant ID** field. Copy the value displayed
286299

287300
### 4.2 Start Deployment
288301

@@ -291,7 +304,7 @@ azd up
291304
```
292305

293306
**During deployment, you'll be prompted for:**
294-
1. **Environment name** (e.g., "macae1") - Must be 3-16 characters long, alphanumeric only
307+
1. **Environment name** (e.g., "macaedev") - Must be 3-16 characters long, alphanumeric only
295308
2. **Azure subscription** selection
296309
3. **Azure AI Foundry deployment region** - Select a region with available model quota for AI operations
297310
4. **Primary location** - Select the region where your infrastructure resources will be deployed
@@ -350,14 +363,24 @@ After successful deployment:
350363

351364
### 5.4 Test the Application
352365

353-
Follow the detailed workflow to test the Multi Agent functionality:
366+
**Quick Test Steps:**
367+
368+
1. **Access the application** using the URL from Step 4.3
369+
2. **Sign in** with your authenticated account
370+
3. **Select a use case** from the available scenarios you uploaded in Step 5.1
371+
4. **Ask a sample question** relevant to the selected use case
372+
5. **Verify the response** includes appropriate multi-agent collaboration
373+
6. **Check the logs** in Azure Portal to confirm backend processing
354374

355-
📖 **Detailed Instructions:** See the complete [Sample Workflow](./SampleQuestions.md) guide for step-by-step testing procedures.
375+
📖 **Detailed Instructions:** See the complete [Sample Workflow](./SampleQuestions.md) guide for step-by-step testing procedures and sample questions for each use case.
356376

357377

358378
## Step 6: Clean Up (Optional)
359379

360380
### Remove All Resources
381+
382+
To purge resources and clean up after deployment, use the `azd down` command or follow the Delete Resource Group Guide for manual cleanup through Azure Portal.
383+
361384
```shell
362385
azd down
363386
```
@@ -470,16 +493,16 @@ Now that your deployment is complete and tested, explore these resources to enha
470493
📚 **Learn More:**
471494
- [Local Development Setup](./LocalDevelopmentSetup.md) - Set up your local development environment
472495
- [Sample Questions](./SampleQuestions.md) - Explore sample questions and workflows
496+
- [MCP Server Documentation](./mcp_server.md) - Learn about Model Context Protocol server integration
497+
- [Customizing Parameters](./CustomizingAzdParameters.md) - Advanced configuration options
498+
- [Azure Account Setup](./AzureAccountSetUp.md) - Detailed Azure subscription configuration
473499
474500
## Need Help?
475501
476502
- 🐛 **Issues:** Check [Troubleshooting Guide](./TroubleShootingSteps.md)
477503
- 💬 **Support:** Review [Support Guidelines](../SUPPORT.md)
478504
- 🔧 **Development:** See [Contributing Guide](../CONTRIBUTING.md)
479505
480-
---
481-
482-
483506
## Advanced: Deploy Local Changes
484507
485508
If you've made local modifications to the code and want to deploy them to Azure, follow these steps to swap the configuration files:

0 commit comments

Comments
 (0)