# 機能設計書 470-Remove-DbaRgWorkloadGroup

## 概要

本ドキュメントは、SQL Server Resource Governorからワークロードグループを削除するRemove-DbaRgWorkloadGroup機能の設計を記述する。

### 本機能の処理概要

Remove-DbaRgWorkloadGroupは、SQL Server Resource Governorから指定されたワークロードグループを削除し、変更を即座に有効にするためにResource Governorを自動的に再構成する機能である。

**業務上の目的・背景**：ワークロードグループは、受信リクエストに対するリソース割り当てポリシーを定義する。テスト環境のクリーンアップ、非推奨リソースポリシーの削除、またはパフォーマンスチューニング時のResource Governor構成の簡素化などの場面で、ワークロードグループを削除する必要がある。この機能により、内部および外部リソースプールの両方で動作し、Get-DbaRgWorkloadGroupからのパイプライン入力を通じて複数のワークロードグループを効率的に処理できる。

**機能の利用シーン**：
- 不要になったワークロードグループのクリーンアップ
- ワークロード管理ポリシーの再編成
- テスト環境のワークロードグループ削除
- Resource Governor構成の簡素化

**主要な処理内容**：
1. 削除対象のワークロードグループを特定（SqlInstanceとWorkloadGroupまたはInputObject）
2. リソースプールタイプ（Internal/External）に基づいてグループを取得
3. SMOのDrop()メソッドでグループを削除
4. Resource Governorを再構成して変更を適用
5. 削除結果をPSCustomObjectで返却

**関連システム・外部連携**：Get-DbaRgWorkloadGroupからパイプライン入力を受け取ることができる。SMOを使用してResource Governorを操作する。

**権限による制御**：CONTROL SERVER権限またはsysadminロールが必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 114 | ワークロードグループ | 主機能 | ワークロードグループの削除 |

## 機能種別

DELETE / 削除

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No | 対象のSQL Serverインスタンス | ValueFromPipeline |
| SqlCredential | PSCredential | No | 代替認証情報 | - |
| WorkloadGroup | String[] | No | 削除するワークロードグループ名 | InputObject未指定時は必須 |
| ResourcePool | String | No | 所属リソースプール名 | デフォルト: default |
| ResourcePoolType | String | No | プールタイプ | ValidateSet: Internal, External。デフォルト: Internal |
| SkipReconfigure | switch | No | 再構成をスキップ | - |
| InputObject | Microsoft.SqlServer.Management.Smo.WorkloadGroup[] | No | 削除するWorkloadGroupオブジェクト | ValueFromPipeline |
| EnableException | switch | No | 例外を直接スローするかどうか | - |

### 入力データソース

- パラメータ入力（SqlInstance、WorkloadGroup、ResourcePool）
- パイプライン入力（SqlInstance、WorkloadGroupオブジェクト）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | String | SQL Serverインスタンスのコンピュータ名 |
| InstanceName | String | SQL Serverインスタンス名 |
| SqlInstance | String | 完全なSQL Serverインスタンス名 |
| Name | String | 削除されたワークロードグループ名 |
| Status | String | 削除結果（"Dropped"または失敗時のエラーメッセージ） |
| IsRemoved | Boolean | 削除成功かどうか |

### 出力先

- PowerShellパイプライン（標準出力）
- PSCustomObject

## 処理フロー

### 処理シーケンス

```
1. パラメータ検証
   ├─ InputObjectとWorkloadGroupの両方が未指定: エラー
   └─ InputObjectとSqlInstanceの両方が未指定: エラー
2. SqlInstance指定時、リソースプールを取得
   └─ WorkloadGroupでグループをフィルタしてInputObjectに追加
3. end ブロックで各WorkloadGroupオブジェクトに対して処理
4. ShouldProcessで確認
5. 出力オブジェクトを初期化
6. Drop()メソッドでグループを削除
7. 削除成功時、StatusとIsRemovedを更新
8. Resource Governorの再構成
   ├─ SkipReconfigure: 警告を出力してスキップ
   └─ 通常: $server.ResourceGovernor.Alter()
9. 結果を出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{パラメータ検証}
    B -->|InputObject/WorkloadGroup未指定| C[Stop-Function: エラー]
    B -->|InputObject/SqlInstance未指定| C
    B -->|OK| D[SqlInstanceループ開始: process]
    D --> E[Connect-DbaInstance]
    E --> F{ResourcePoolType?}
    F -->|Internal| G[ResourcePools取得]
    F -->|External| H[ExternalResourcePools取得]
    G --> I[ResourcePoolフィルタ]
    H --> I
    I --> J[WorkloadGroupsフィルタ]
    J --> K[InputObjectに追加]
    K --> D
    D --> L[endブロック: WorkloadGroupループ開始]
    L --> M{ShouldProcess確認}
    M -->|Yes| N[出力オブジェクト初期化]
    M -->|No| L
    N --> O[Drop実行]
    O --> P{成功?}
    P -->|Yes| Q[Status=Dropped, IsRemoved=true]
    P -->|No| R[Status=エラー, IsRemoved=false]
    Q --> S{SkipReconfigure?}
    R --> S
    S -->|Yes| T[警告出力]
    S -->|No| U[ResourceGovernor.Alter]
    T --> V[結果出力]
    U --> V
    V --> L
    L --> W[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | パラメータ必須 | InputObjectまたはWorkloadGroupのいずれかが必要 | 常に適用 |
| BR-002 | インスタンス必須 | InputObjectまたはSqlInstanceのいずれかが必要 | 常に適用 |
| BR-003 | デフォルトプール | ResourcePoolパラメータのデフォルトは'default' | ResourcePool未指定時 |
| BR-004 | SkipReconfigure警告 | 再構成をスキップすると変更は即座に有効にならない | SkipReconfigure指定時 |
| BR-005 | パイプラインサポート | Get-DbaRgWorkloadGroupからの出力をパイプラインで受け取り可能 | パイプライン使用時 |
| BR-006 | process/end分離 | processでInputObject収集、endで削除実行 | 常に適用 |

### 計算ロジック

該当なし（削除機能のため）

## データベース操作仕様

### 操作別データベース影響一覧

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| グループ削除 | sys.resource_governor_workload_groups | DELETE | ワークロードグループの削除 |
| 再構成 | - | ALTER | Resource Governor再構成 |

### テーブル別操作詳細

SMOのDrop()、Alter()メソッドが内部的にT-SQLを生成・実行する。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | パラメータエラー | InputObject/WorkloadGroup未指定 | いずれかを指定 |
| - | パラメータエラー | InputObject/SqlInstance未指定 | いずれかを指定 |
| ConnectionError | 接続エラー | SQL Serverへの接続失敗 | 資格情報とネットワーク接続を確認 |
| - | 削除失敗 | Drop()実行時のエラー | エラーメッセージを確認 |
| - | 再構成失敗 | Alter()実行時のエラー | エラーメッセージを確認 |

### リトライ仕様

リトライ処理は実装されていない。

## トランザクション仕様

SMOのDrop()による単一操作。明示的なトランザクション管理は実装されていない。

## パフォーマンス要件

- メタデータ操作のため、軽量な処理
- Resource Governor再構成に数秒かかる場合がある

## セキュリティ考慮事項

- CONTROL SERVER権限またはsysadminロールが必要
- ShouldProcessによる確認機能を提供
- SqlCredentialパラメータによる安全な認証情報の受け渡し

## 備考

- システムワークロードグループ（internal/default）は削除できない
- 削除結果はPSCustomObjectで返却され、成功/失敗をIsRemovedプロパティで確認可能
- processブロックでInputObjectを収集し、endブロックで実際の削除を実行する設計

---

## コードリーディングガイド

本機能を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Remove-DbaRgWorkloadGroup.ps1 | `public/Remove-DbaRgWorkloadGroup.ps1` | .OUTPUTSセクション（60-70行目）で出力オブジェクトの構造を確認 |

**読解のコツ**: 出力はPSCustomObjectで、Name、Status、IsRemovedプロパティを含む。

#### Step 2: パラメータ構造を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Remove-DbaRgWorkloadGroup.ps1 | `public/Remove-DbaRgWorkloadGroup.ps1` | paramブロック（82-96行目）でパラメータ定義を確認 |

**読解のコツ**: ResourcePoolのデフォルトは'default'。ResourcePoolTypeはInternal/Externalを選択。

#### Step 3: メイン処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Remove-DbaRgWorkloadGroup.ps1 | `public/Remove-DbaRgWorkloadGroup.ps1` | processブロック（97-122行目）でInputObject収集 |
| 3-2 | Remove-DbaRgWorkloadGroup.ps1 | `public/Remove-DbaRgWorkloadGroup.ps1` | endブロック（123-158行目）で削除処理 |

**主要処理フロー**:
1. **98-105行目**: パラメータ検証（InputObject/WorkloadGroup、InputObject/SqlInstance）
2. **107-121行目**: SqlInstanceループ、ResourcePoolTypeでプール取得、WorkloadGroupフィルタ
3. **124行目**: endブロック、WorkloadGroupループ開始
4. **125行目**: $wklGroup.Parent.Parent.Parentでサーバー取得
5. **127-134行目**: PSCustomObject初期化
6. **135-143行目**: Drop()実行、成功/失敗でStatus更新
7. **146-154行目**: Resource Governor再構成（SkipReconfigureチェック）
8. **156行目**: 結果出力

#### Step 4: 依存関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Get-DbaRgWorkloadGroup.ps1 | `public/Get-DbaRgWorkloadGroup.ps1` | ワークロードグループ取得処理 |
| 4-2 | Get-DbaRgResourcePool.ps1 | `public/Get-DbaRgResourcePool.ps1` | リソースプール取得処理 |

### プログラム呼び出し階層図

```
Remove-DbaRgWorkloadGroup
    │
    ├─ Stop-Function (パラメータエラー時)
    │
    ├─ Connect-DbaInstance (SqlInstance指定時)
    │
    ├─ $server.ResourceGovernor.ResourcePools/ExternalResourcePools
    │
    ├─ $resPool.WorkloadGroups (フィルタリング)
    │
    ├─ $wklGroup.Drop()
    │
    ├─ Get-ErrorMessage (エラー時)
    │
    └─ $server.ResourceGovernor.Alter() (再構成)
```

### データフロー図

```
[入力]                          [処理]                              [出力]

SqlInstance + ──────────▶ Connect-DbaInstance
WorkloadGroup                   │
       or                       ▼
InputObject (pipeline) ──▶ ResourcePools/ExternalResourcePools
                                │
                                ▼
                         WorkloadGroupsフィルタ
                                │
                                ▼
                        InputObjectに収集 (process)
                                │
                                ▼
                           Drop() (end)
                                │
                                ▼
                      ResourceGovernor.Alter()
                                │
                                ▼
                       PSCustomObject ────▶ 削除結果
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Remove-DbaRgWorkloadGroup.ps1 | `public/Remove-DbaRgWorkloadGroup.ps1` | ソース | 本機能のメイン実装 |
| Get-DbaRgWorkloadGroup.ps1 | `public/Get-DbaRgWorkloadGroup.ps1` | ソース | ワークロードグループ取得 |
| Get-DbaRgResourcePool.ps1 | `public/Get-DbaRgResourcePool.ps1` | ソース | リソースプール取得 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続 |
| Stop-Function.ps1 | `private/functions/Stop-Function.ps1` | ソース | エラーハンドリング |
| Write-Message.ps1 | `private/functions/Write-Message.ps1` | ソース | メッセージ出力 |
| Get-ErrorMessage.ps1 | `private/functions/Get-ErrorMessage.ps1` | ソース | エラーメッセージ取得 |
