Toggle Drain Mode

Sets Drainmode on true or false for a specific AVD Session Host.

Description

This Runbooks looks through all AVD Hostpools of a tenant and sets the DrainMode for a specific Session Host. The SubscriptionId value must be defined in the runbooks customization.

Location

Device → AVD → Toggle Drain Mode

Full Runbook name

rjgit-device_AVD_toggle-drain-mode

Details

Property	Value
Version	1.0.1
Required modules	RealmJoin.RunbookHelper (>= 0.8.9) Az.DesktopVirtualization (>= 6.0.0) Az.Accounts (>= 5.5.2)
Schedulable	no

Permissions

Permission notes

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

Parameters

DeviceName

The name of the AVD Session Host device for which to toggle drain mode. Hidden in UI.

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

DrainMode

Boolean value to enable or disable Drain Mode. Set to true to enable Drain Mode (prevent new sessions), false to disable it (allow new sessions). Default is false.

Property	Value
Required	true
Default Value	False
Type	Boolean
Portal display name	Drain Mode

SubscriptionIds

Array of Azure subscription IDs where the AVD Session Host resources are located. Retrieved from AVD.SubscriptionIds setting (Customization). Hidden in UI.

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

Back to Runbook Reference overview