> For the complete documentation index, see [llms.txt](https://docs.realmjoin.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.realmjoin.com/automation/runbooks/runbook-references/device/avd/toggle-drain-mode.md).

# Toggle Drain Mode

Enable or disable drain mode on this AVD session host

### Description

Switches drain mode for this Azure Virtual Desktop session host, whichever host pool of the tenant it belongs to. With drain mode on, the host accepts no new sessions, for example before maintenance; existing sessions stay connected. With drain mode off, the host takes new sessions again.

### Location

Device → AVD → Toggle Drain Mode

**Full Runbook name**

rjgit-device\_AVD\_toggle-drain-mode

### Details

| Property         | Value                                                                                                       |
| ---------------- | ----------------------------------------------------------------------------------------------------------- |
| Version          | 1.0.1                                                                                                       |
| Required modules | <p>RealmJoin.RunbookHelper (>= 0.8.10)<br>Az.DesktopVirtualization (>= 6.0.0)<br>Az.Accounts (>= 5.5.2)</p> |
| Schedulable      | no                                                                                                          |

### Permissions

#### Permission notes

Azure: Desktop Virtualization Host Pool Contributor on Subscription which contains the Hostpool

### Parameters

#### DeviceName

Name of the AVD session host. Set by the portal from the selected device.

| Property         | Value                                  |
| ---------------- | -------------------------------------- |
| Required         | true                                   |
| Default Value    |                                        |
| Type             | String                                 |
| Hidden in portal | yes (preset via runbook customization) |

#### DrainMode

Whether the host should stop accepting new sessions (drain mode on) or take new sessions again (drain mode off).

| Property            | Value      |
| ------------------- | ---------- |
| Required            | true       |
| Default Value       | False      |
| Type                | Boolean    |
| Portal display name | Drain mode |

**Portal options**

| Portal option                    | Value |
| -------------------------------- | ----- |
| On - stop accepting new sessions | true  |
| Off - accept new sessions again  | false |

#### SubscriptionIds

Azure subscriptions that hold the AVD host pools. Taken from the tenant setting AVD.SubscriptionIds.

| Property         | Value                                  |
| ---------------- | -------------------------------------- |
| Required         | true                                   |
| Default Value    |                                        |
| Type             | String\[]                              |
| Hidden in portal | yes (preset via runbook customization) |

[Back to Runbook Reference overview](/automation/runbooks/runbook-references.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.realmjoin.com/automation/runbooks/runbook-references/device/avd/toggle-drain-mode.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.