> 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/pt/automacao/runbooks/runbook-references/device/avd/toggle-drain-mode.md).

# Alternar modo drain

### Descrição

Este runbook examina todos os Hostpools AVD de um Tenant e define o DrainMode para um Host de Sessão específico. O valor SubscriptionId deve ser definido na personalização do runbook.

### Localização

Dispositivo → AVD → Alternar Modo de Drenagem

**Nome completo do runbook**

rjgit-device\_AVD\_toggle-drain-mode

### Detalhes

| Propriedade         | Valor                                                                                                      |
| ------------------- | ---------------------------------------------------------------------------------------------------------- |
| Versão              | 1.0.1                                                                                                      |
| Módulos necessários | <p>RealmJoin.RunbookHelper (>= 0.8.9)<br>Az.DesktopVirtualization (>= 6.0.0)<br>Az.Accounts (>= 5.5.2)</p> |
| Agendável           | não                                                                                                        |

### Permissões

#### Notas de permissão

Azure: Colaborador do Host Pool de Virtualização de Desktop na assinatura que contém o Hostpool

### Parâmetros

#### Nome do dispositivo

O nome do dispositivo Host de Sessão AVD para o qual alternar o modo de drenagem. Oculto na interface de utilizador.

| Propriedade      | Valor                                           |
| ---------------- | ----------------------------------------------- |
| Obrigatório      | verdadeiro                                      |
| Valor padrão     |                                                 |
| Tipo             | String                                          |
| Oculto no portal | sim (predefinido via personalização do runbook) |

#### Modo de Drenagem

Valor booleano para ativar ou desativar o Modo de Drenagem. Defina como true para ativar o Modo de Drenagem (impede novas sessões), false para desativá-lo (permite novas sessões). O padrão é false.

| Propriedade                | Valor            |
| -------------------------- | ---------------- |
| Obrigatório                | verdadeiro       |
| Valor padrão               | Falso            |
| Tipo                       | Booleano         |
| Nome de exibição no portal | Modo de Drenagem |

#### IDs de assinatura

Array de IDs de assinatura Azure onde os recursos do Host de Sessão AVD estão localizados. Obtido da configuração AVD.SubscriptionIds (Personalização). Oculto na interface de utilizador.

| Propriedade      | Valor                                           |
| ---------------- | ----------------------------------------------- |
| Obrigatório      | verdadeiro                                      |
| Valor padrão     |                                                 |
| Tipo             | String\[]                                       |
| Oculto no portal | sim (predefinido via personalização do runbook) |

[Voltar à visão geral da referência do runbook](/pt/automacao/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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.