Drain session hosts for maintenance in Azure Virtual Desktop

Drain mode enables you to isolate a session host when you want to perform maintenance without disruption to service. When a session host is set to drain, it won't accept new user sessions. Any new connections will be redirected to the next available session host. Existing connections to the session host will remain active until the user signs out or an administrator ends the session. Once there aren't any sessions remaining on the session host, you can perform the maintenance you need. Administrators can still remotely connect to the server directly without going through the Azure Virtual Desktop service.

This article shows you how to drain session hosts using the Azure portal or Azure PowerShell.

Prerequisites

To drain session hosts, you need:

• A host pool with at least one session host.

• An Azure account assigned the Desktop Virtualization Session Host Operator role.

• If you want to use Azure PowerShell locally, see Use Azure CLI and Azure PowerShell with Azure Virtual Desktop to make sure you have the Az.DesktopVirtualization PowerShell module installed. Alternatively, use the Azure Cloud Shell.

Enable and disable drain mode for a session host

Here's how to enable and disable drain mode for a session host using the Azure portal and PowerShell.

Azure portal

To enable drain mode for a session host and block new sessions in the Azure portal:

1. Sign in to the Azure portal.

2. In the search bar, type Azure Virtual Desktop and select the matching service entry.

3. From the Azure Virtual Desktop overview page, select Host pools.

4. Select the host pool that contains the session host you want to drain, then select Session hosts.

5. Check the box next to the session host you want to enable drain mode, then select Turn drain mode on.

6. When you're ready to allow new connections to the session host, check the box next to the session host you want to disable drain mode, then select Turn drain mode off.

Azure PowerShell

You can set drain mode in PowerShell with the AllowNewSessions parameter, which is part of the Update-AzWvdSessionhost command. You'll need to run these commands for every session host for which you want to enable and disable drain.

Important

In the following examples, you'll need to change the <placeholder> values for your own.

1. Launch the Azure Cloud Shell in the Azure portal with the PowerShell terminal type, or run PowerShell on your local device.

   1. If you're using Cloud Shell, make sure your Azure context is set to the subscription you want to use.

   2. If you're using PowerShell locally, first Sign in with Azure PowerShell, then make sure your Azure context is set to the subscription you want to use.

2. To enable drain for a session host and block new sessions, run the following command:

   $params = @{
       ResourceGroupName = '<ResourceGroupName>'
       HostPoolName = '<HostPoolName>'
       Name = '<SessionHostName>'
       AllowNewSession = $False
   }
   
   Update-AzWvdSessionHost @params
   

3. To disable drain for a session host and allow new sessions, run the following command:

   $params = @{
       ResourceGroupName = '<ResourceGroupName>'
       HostPoolName = '<HostPoolName>'
       Name = '<SessionHostName>'
       AllowNewSession = $True
   }
   
   Update-AzWvdSessionHost @params