# 機能設計書 504-Remove-DbaAgentAlert

## 概要

本ドキュメントは、SQL Server Agent アラートを削除する `Remove-DbaAgentAlert` コマンドの機能設計書である。

### 本機能の処理概要

**業務上の目的・背景**：SQL Server Agent のアラートは、特定のエラー、パフォーマンス条件、またはシステムイベントを監視し、発生時に通知やジョブ実行をトリガーする。本コマンドは、不要になったアラートの削除を自動化し、テスト環境のクリーンアップや廃止されたアラートポリシーの整理を効率的に行う。複数インスタンスに対する一括削除やパイプラインを通じた選択的削除をサポートする。

**機能の利用シーン**：不要なテストアラートの削除、廃止された監視ポリシーのクリーンアップ、環境移行時のアラート整理、Out-GridView を使用した対話的なアラート選択削除などに利用される。

**主要な処理内容**：
1. 対象インスタンスへの接続とアラート取得（Get-DbaAgentAlert 使用）
2. 除外アラートのフィルタリング（ExcludeAlert パラメータ）
3. パイプライン入力またはパラメータ指定によるアラートオブジェクト収集
4. ShouldProcess による削除確認
5. SMO（Alert.Drop() メソッド）を使用したアラート削除
6. 削除結果のステータスオブジェクト出力

**関連システム・外部連携**：SQL Server Agent サービス、msdb データベース

**権限による制御**：対象インスタンスで sysadmin 権限または SQLAgentOperatorRole が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 12 | Agentアラート管理 | 主画面 | SQLエージェントアラートの削除 |

## 機能種別

CRUD操作（Delete）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes* | 対象SQL Serverインスタンス | *NonPipelineパラメータセット時必須 |
| SqlCredential | PSCredential | No | 代替認証情報 | - |
| Alert | string[] | No | 削除するアラート名 | - |
| ExcludeAlert | string[] | No | 削除対象から除外するアラート名 | - |
| InputObject | Alert[] | Yes* | パイプライン入力用アラートオブジェクト | *Pipelineパラメータセット時必須 |
| EnableException | switch | No | 例外を有効化 | - |

### 入力データソース

PowerShell コマンドラインからのパラメータ入力、または Get-DbaAgentAlert からのパイプライン入力

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverインスタンスのコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名 |
| Name | string | 削除されたアラート名 |
| Status | string | 削除結果（"Dropped" または エラーメッセージ） |
| IsRemoved | bool | 削除成功の真偽値 |

### 出力先

PowerShell パイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. beginブロック
   └─ 空の配列 $dbAlerts を初期化
2. processブロック
   ├─ SqlInstance 指定時
   │   └─ Get-DbaAgentAlert でアラートオブジェクト取得
   └─ パイプライン入力時
       └─ InputObject を $dbAlerts に追加
3. endブロック（削除実行）
   └─ 各アラートに対するループ
       ├─ ShouldProcess による確認
       ├─ 出力オブジェクト初期化
       ├─ Alert.Drop() 実行
       │   ├─ 成功時: Status="Dropped", IsRemoved=true
       │   └─ 失敗時: Status=エラーメッセージ, IsRemoved=false
       └─ 出力オブジェクトをパイプラインに出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{SqlInstance指定?}
    B -->|Yes| C[Get-DbaAgentAlert実行]
    B -->|No| D[InputObjectを配列に追加]
    C --> E[processブロック終了]
    D --> E
    E --> F[endブロック開始]
    F --> G{次のアラート存在?}
    G -->|No| H[終了]
    G -->|Yes| I{ShouldProcess確認}
    I -->|No| G
    I -->|Yes| J[出力オブジェクト初期化]
    J --> K[Alert.Drop実行]
    K --> L{成功?}
    L -->|Yes| M[Status=Dropped, IsRemoved=true]
    L -->|No| N[Status=エラー, IsRemoved=false]
    M --> O[出力オブジェクト出力]
    N --> O
    O --> G
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-504-01 | endブロック削除 | パイプラインからの直接削除時の "Collection was modified" エラーを防ぐため、endブロックで削除を実行 | 常時 |
| BR-504-02 | 確認プロンプト | ConfirmImpact が High のため、削除前に確認プロンプトを表示（-Confirm:$false で抑制可能） | 常時 |
| BR-504-03 | 除外処理 | ExcludeAlert で指定されたアラートは Get-DbaAgentAlert で除外される | ExcludeAlert指定時 |

### 計算ロジック

特になし。

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| アラート削除 | msdb.dbo.sysalerts | DELETE | SMO経由でアラートレコード削除 |
| 関連通知削除 | msdb.dbo.sysnotifications | DELETE | アラートに関連付けられた通知も削除 |

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

#### msdb.dbo.sysalerts

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | id | 削除対象アラートのID | SMO Drop()で実行 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 削除エラー | Alert.Drop() 失敗 | Stop-Function でエラー記録、Status にエラーメッセージ設定 |

### リトライ仕様

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

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

SMO の Alert.Drop() メソッドによる暗黙的トランザクション。

## パフォーマンス要件

特に定義されていない。

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

- 対象インスタンスへの sysadmin 権限または SQLAgentOperatorRole が必要
- ConfirmImpact が High のため、誤削除を防ぐための確認プロンプトがデフォルトで表示される

## 備考

- Get-DbaAgentAlert からのパイプライン入力をサポート
- Out-GridView を使用した対話的選択削除が可能
- 削除結果は常にオブジェクトとして出力される（成功/失敗に関わらず）

---

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

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

### 推奨読解順序

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

出力オブジェクトの構造とパラメータセットを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Remove-DbaAgentAlert.ps1 | `public/Remove-DbaAgentAlert.ps1` | 86-100行目: パラメータ定義、2つのパラメータセット |

**読解のコツ**: NonPipeline と Pipeline の2つのパラメータセットがあり、入力方法によって使い分けられる。

#### Step 2: アラート収集処理を理解する

process ブロックでのアラートオブジェクト収集。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Remove-DbaAgentAlert.ps1 | `public/Remove-DbaAgentAlert.ps1` | 102-115行目: begin/processブロック |

**主要処理フロー**:
1. **103行目**: 空の配列 $dbAlerts を初期化
2. **107-111行目**: SqlInstance 指定時は Get-DbaAgentAlert で取得
3. **112-114行目**: パイプライン入力時は InputObject を追加

#### Step 3: 削除処理を理解する

end ブロックでの実際の削除実行。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Remove-DbaAgentAlert.ps1 | `public/Remove-DbaAgentAlert.ps1` | 117-141行目: endブロック |

**主要処理フロー**:
- **118行目**: コメントで "Collection was modified" エラー防止の説明
- **119-128行目**: 出力オブジェクトの初期化
- **129-132行目**: Drop() 成功時の処理
- **133-137行目**: Drop() 失敗時のエラー処理
- **138行目**: 出力オブジェクトの出力

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

```
Remove-DbaAgentAlert
    │
    ├─ Get-DbaAgentAlert (111行目)
    │      └─ アラートオブジェクト取得（SqlInstance指定時）
    │
    └─ $dbAlert.Drop() (130行目)
           └─ SMO経由でアラート削除
```

### データフロー図

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

SqlInstance ──┬──▶ Get-DbaAgentAlert ──▶ Alert オブジェクト配列
Alert ────────┘                                │
ExcludeAlert ──▶ (フィルタリング)              │
                                               ▼
InputObject ─────────────────────────▶ Alert オブジェクト配列
                                               │
                                               ▼
                                       endブロックで削除
                                               │
                                               ▼
                                       PSCustomObject出力
                                       (ComputerName, InstanceName,
                                        SqlInstance, Name, Status, IsRemoved)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Remove-DbaAgentAlert.ps1 | `public/Remove-DbaAgentAlert.ps1` | ソース | メインコマンド実装 |
| Get-DbaAgentAlert.ps1 | `public/Get-DbaAgentAlert.ps1` | ソース | アラート取得（SqlInstance指定時） |
