> 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/ja/zi-dong-hua/runbooks/runbook-references/device/avd/toggle-drain-mode.md).

# Drain モードの切り替え

### 説明

この Runbooks は、ある Tenant のすべての AVD ホストプールを調べ、特定の Session Host の DrainMode を設定します。SubscriptionId の値は runbooks のカスタマイズで定義する必要があります。

### 場所

デバイス → AVD → Drain Mode を切り替え

**Runbook の完全名**

rjgit-device\_AVD\_toggle-drain-mode

### 詳細

| プロパティ    | 値                                                                                                          |
| -------- | ---------------------------------------------------------------------------------------------------------- |
| バージョン    | 1.0.1                                                                                                      |
| 必要なモジュール | <p>RealmJoin.RunbookHelper (>= 0.8.9)<br>Az.DesktopVirtualization (>= 6.0.0)<br>Az.Accounts (>= 5.5.2)</p> |
| スケジュール可能 | いいえ                                                                                                        |

### アクセス許可

#### 権限に関する注意

Azure: Hostpool を含むサブスクリプションにおける Desktop Virtualization Host Pool Contributor

### パラメーター

#### デバイス名

Drain mode を切り替える対象の AVD Session Host デバイスの名前。UI では非表示。

| プロパティ    | 値                        |
| -------- | ------------------------ |
| 必須       | はい                       |
| 既定値      |                          |
| 種類       | 文字列                      |
| ポータルで非表示 | はい（Runbook のカスタマイズで事前設定） |

#### DrainMode

Drain Mode を有効または無効にするブール値。true にすると Drain Mode を有効化し（新しいセッションを受け付けない）、false にすると無効化します（新しいセッションを許可する）。既定値は false です。

| プロパティ   | 値        |
| ------- | -------- |
| 必須      | はい       |
| 既定値     | False    |
| 種類      | ブール値     |
| ポータル表示名 | ドレイン モード |

#### SubscriptionIds

AVD Session Host リソースが配置されている Azure サブスクリプション ID の配列。AVD.SubscriptionIds 設定（Customization）から取得されます。UI では非表示。

| プロパティ    | 値                        |
| -------- | ------------------------ |
| 必須       | はい                       |
| 既定値      |                          |
| 種類       | String\[]                |
| ポータルで非表示 | はい（Runbook のカスタマイズで事前設定） |

[Runbook Reference の概要に戻る](/ja/zi-dong-hua/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/ja/zi-dong-hua/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.