|
| 1 | +--- |
| 2 | +title: Azure Virtual Desktop Tools |
| 3 | +description: Learn how to use the Azure MCP Server with Azure Virtual Desktop. |
| 4 | +keywords: azure mcp server, azmcp, azure virtual desktop, avd, host pools, session hosts |
| 5 | +author: diberry |
| 6 | +ms.author: diberry |
| 7 | +ms.date: 08/06/2025 |
| 8 | +content_well_notification: |
| 9 | + - AI-contribution |
| 10 | +ai-usage: ai-assisted |
| 11 | +ms.topic: reference |
| 12 | +ms.custom: build-2025 |
| 13 | +--- |
| 14 | + |
| 15 | +# Azure Virtual Desktop tools for the Azure MCP Server |
| 16 | + |
| 17 | +The Azure MCP Server enables you to manage Azure Virtual Desktop resources by using natural language prompts. You can list host pools, view session hosts, monitor user sessions, and manage your virtual desktop infrastructure without needing to remember complex command syntax. |
| 18 | + |
| 19 | +[Azure Virtual Desktop](/azure/virtual-desktop/overview) is a desktop and app virtualization service that runs on the cloud. It provides a full Windows experience with optimized Office 365 ProPlus, and supports Remote Desktop Services environments. |
| 20 | + |
| 21 | +[!INCLUDE [tip-about-params](../includes/tools/parameter-consideration.md)] |
| 22 | + |
| 23 | +## Conditional parameters |
| 24 | + |
| 25 | +Some of the Azure Virtual Desktop tools require **one** of the following parameter options within the conversation context: |
| 26 | + |
| 27 | +- **Option 1**: Host pool name |
| 28 | +- **Option 2**: Host pool resource ID |
| 29 | + |
| 30 | +Don't provide both parameters (host pool name and host pool resource ID) together, because this combination creates conflicting inputs. When you provide a host pool resource ID, the tool uses it instead of searching by name. |
| 31 | + |
| 32 | +## Host pools: list host pools |
| 33 | + |
| 34 | +The Azure MCP Server can list all host pools in a subscription or resource group. This feature provides an overview of your virtual desktop infrastructure and helps you manage your desktop deployment. |
| 35 | + |
| 36 | +Example prompts include: |
| 37 | + |
| 38 | +- **List all host pools**: "Show me all host pools in my subscription." |
| 39 | +- **View host pools**: "What host pools do I have available?" |
| 40 | +- **Find host pools**: "List all virtual desktop host pools." |
| 41 | +- **Query host pools**: "Show available host pools in my environment." |
| 42 | +- **Check infrastructure**: "Get all Azure Virtual Desktop host pools." |
| 43 | + |
| 44 | +## Host pools: list session hosts in a host pool |
| 45 | + |
| 46 | +The Azure MCP Server can list all session hosts in a host pool. This functionality helps you monitor your virtual machines and understand the capacity and status of your virtual desktop environment. |
| 47 | + |
| 48 | +Example prompts include: |
| 49 | + |
| 50 | +- **List session hosts**: "Show me all session hosts in the 'production-hostpool' host pool." |
| 51 | +- **View VMs**: "What session hosts are in my host pool?" |
| 52 | +- **Find hosts**: "List all virtual machines in hostpool 'dev-environment'." |
| 53 | +- **Query capacity**: "Show session hosts in my virtual desktop pool." |
| 54 | +- **Check hosts**: "Get all session hosts for host pool ID '/subscriptions/abc123/resourceGroups/rg/providers/Microsoft.DesktopVirtualization/hostPools/pool1'." |
| 55 | + |
| 56 | +| Parameter | Required or optional | Description | |
| 57 | +|-----------|-------------|-------------| |
| 58 | +| **Host pool** | [Conditionally](#conditional-parameters) required | The name of the Azure Virtual Desktop host pool. This is the unique name you choose for your host pool. | |
| 59 | +| **Host pool resource ID** | [Conditionally](#conditional-parameters) required | The Azure resource ID of the host pool. When you provide this ID, the server uses it instead of searching by name. | |
| 60 | + |
| 61 | +## Host pools: list user sessions |
| 62 | + |
| 63 | +The Azure MCP Server can list all user sessions on a specific session host in a host pool. This capability helps you monitor active users, troubleshoot connection issues, and manage user workloads. |
| 64 | + |
| 65 | +Example prompts include: |
| 66 | + |
| 67 | +- **List user sessions**: "Show me all user sessions on session host 'vm-prod-001' in host pool 'production-pool'." |
| 68 | +- **View active users**: "What users are connected to session host 'desktop-vm-02'?" |
| 69 | +- **Find sessions**: "List all active sessions on host 'avd-host-001'." |
| 70 | +- **Monitor users**: "Show user sessions for session host in my host pool." |
| 71 | +- **Check connections**: "Get all user sessions on virtual machine 'session-host-03'." |
| 72 | + |
| 73 | +| Parameter | Required or optional | Description | |
| 74 | +|-----------|-------------|-------------| |
| 75 | +| **Host pool** | [Conditionally](#conditional-parameters) required | The name of the Azure Virtual Desktop host pool. This is the unique name you choose for your host pool. | |
| 76 | +| **Host pool resource ID** | [Conditionally](#conditional-parameters) required | The Azure resource ID of the host pool. When you provide this ID, the server uses it instead of searching by name. | |
| 77 | +| **Session host** | Required | The name of the session host. This name is the computer name of the virtual machine in the host pool. | |
| 78 | + |
| 79 | +## Related content |
| 80 | + |
| 81 | +- [What are the Azure MCP Server tools?](index.md) |
| 82 | +- [Get started using Azure MCP Server](../get-started.md) |
| 83 | +- [Azure Virtual Desktop documentation](/azure/virtual-desktop/) |
0 commit comments