# 通知設計書 16-Remove-DbaAgentAlert

## 概要

本ドキュメントは、SQL Serverエージェントアラートを削除するdbatools PowerShellコマンド「Remove-DbaAgentAlert」の設計仕様を記載します。

### 本通知の処理概要

Remove-DbaAgentAlertは、SQL Server Agentに設定されたアラートを永続的に削除するコマンドです。不要になったアラートのクリーンアップや、テスト設定の除去に使用されます。

**業務上の目的・背景**：運用環境では、廃止されたシステムに対応するアラート、テスト目的で作成されたアラート、重複するアラートなどを整理する必要があります。本コマンドは、特定のアラートを指名削除したり、除外条件を設定して一括削除したりすることで、アラート設定のメンテナンスを効率化します。

**通知の送信タイミング**：本コマンドは「アラート設定を削除する」コマンドです。削除されたアラートは以降トリガーされなくなり、通知も発生しなくなります。

**通知の受信者**：本コマンドの実行結果はコマンド実行者に返されます。削除されたアラートの情報がPSCustomObjectとして出力されます。

**通知内容の概要**：削除処理の結果として、ComputerName、InstanceName、SqlInstance、Name（アラート名）、Status（処理結果）、IsRemoved（削除成功フラグ）が返されます。

**期待されるアクション**：管理者は出力結果を確認し、意図したアラートが正常に削除されたことを検証します。重要なアラートを誤って削除しないよう、事前にGet-DbaAgentAlertで対象を確認することを推奨します。

## 通知種別

PowerShellコンソール出力 / パイプライン出力（PSCustomObject）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（コマンド実行と同時に結果出力） |
| 優先度 | 高（ConfirmImpact = 'High'） |
| リトライ | 無（失敗時はエラーメッセージ出力） |

### 送信先決定ロジック

- SqlInstanceパラメータ：削除対象のSQL Serverインスタンスを指定
- Alertパラメータ：削除対象のアラート名を指定
- ExcludeAlertパラメータ：削除から除外するアラート名を指定
- InputObjectパラメータ：Get-DbaAgentAlertからパイプラインで受け取ったAlertオブジェクトを処理

## 通知テンプレート

### コンソール出力の場合

| 項目 | 内容 |
|-----|------|
| 出力形式 | PSCustomObject |
| 確認プロンプト | ShouldProcess による確認（-Confirm:$false で抑制可能） |

### 本文テンプレート

```
確認プロンプト:
"Removing the SQL Agent alert {AlertName} on {SqlInstanceName}"

成功時出力:
ComputerName : {ComputerName}
InstanceName : {InstanceName}
SqlInstance  : {SqlInstance}
Name         : {AlertName}
Status       : Dropped
IsRemoved    : True

失敗時出力:
ComputerName : {ComputerName}
InstanceName : {InstanceName}
SqlInstance  : {SqlInstance}
Name         : {AlertName}
Status       : {ErrorMessage}
IsRemoved    : False
```

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| なし | - | - | 本コマンドは添付ファイルを出力しない |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| ComputerName | SQL Serverのコンピュータ名 | $dbAlert.Parent.Parent.ComputerName | Yes |
| InstanceName | SQL Serverのインスタンス名 | $dbAlert.Parent.Parent.ServiceName | Yes |
| SqlInstance | 完全修飾インスタンス名 | $dbAlert.Parent.Parent.DomainInstanceName | Yes |
| Name | 削除対象のアラート名 | $dbAlert.Name | Yes |
| Status | 処理結果ステータス | "Dropped" または エラーメッセージ | Yes |
| IsRemoved | 削除成功フラグ | $true / $false | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コマンド実行 | Remove-DbaAgentAlert実行 | 削除対象アラートが存在 | 指定されたアラートの削除処理を実行 |
| パイプライン入力 | Get-DbaAgentAlertからのパイプ | InputObjectに有効なオブジェクト | パイプラインから受け取ったアラートを削除 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| -WhatIf指定時 | 実際の削除は行わず、処理内容のみ表示 |
| ShouldProcess拒否 | ユーザーが確認プロンプトで拒否した場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[コマンド実行開始] --> B{SqlInstance指定?}
    B -->|Yes| C[Get-DbaAgentAlert呼び出し]
    B -->|No| D[InputObjectを配列に追加]
    C --> E[dbAlerts配列に格納]
    D --> E
    E --> F[endブロック: アラート削除ループ]
    F --> G{ShouldProcess確認}
    G -->|承認| H[出力オブジェクト初期化]
    G -->|拒否| I[次のアラートへ]
    H --> J[Drop実行]
    J --> K{成功?}
    K -->|Yes| L[Status=Dropped, IsRemoved=True]
    K -->|No| M[Stop-Function呼び出し]
    M --> N[Status=ErrorMessage, IsRemoved=False]
    L --> O[結果出力]
    N --> O
    O --> P{次のアラート?}
    P -->|Yes| F
    P -->|No| Q[終了]
    I --> P
```

## データベース参照・更新仕様

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| msdb.dbo.sysalerts | アラート情報の取得 | Get-DbaAgentAlert経由 |

### テーブル別参照項目詳細

#### msdb.dbo.sysalerts

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| id | アラート識別 | SMOオブジェクト経由 |
| name | アラート名表示 | 削除対象の特定 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| msdb.dbo.sysalerts | DELETE | アラートの削除 |
| msdb.dbo.sysnotifications | DELETE | 関連する通知設定の削除（カスケード） |

#### 送信ログテーブル

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| なし | - | - | 本コマンドは送信ログを記録しない |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 接続失敗 | SqlInstanceに接続不可 | Get-DbaAgentAlert内でエラー処理 |
| アラート不存在 | 指定アラートが見つからない | Get-DbaAgentAlertが空を返す |
| Drop失敗 | SMO Drop()メソッド失敗 | Stop-Functionでエラーメッセージ出力 |
| 権限不足 | sysadmin権限なし | SMOからエラー返却 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（リトライなし） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | なし |
| 1日あたり上限 | なし |

### 配信時間帯

制限なし（任意のタイミングで実行可能）

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

- sysadmin権限またはmsdbデータベースへの適切な権限が必要
- SqlCredentialパラメータによりSQL Server認証、Windows認証、AD認証をサポート
- 削除操作は永続的であり、復元不可能（事前のバックアップを推奨）
- ConfirmImpact = 'High'により、デフォルトで確認プロンプトを表示

## 備考

- Get-DbaAgentAlertからパイプラインで直接削除する場合、endブロックで処理することで「Collection was modified」エラーを回避
- EnableExceptionスイッチにより、スクリプト内でのtry/catchエラーハンドリングが可能
- Out-GridViewを使用したインタラクティブ選択との組み合わせが可能

---

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

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

### 推奨読解順序

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

まず、処理対象となるAlertオブジェクトの構造を理解することが重要です。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Remove-DbaAgentAlert.ps1 | `public/Remove-DbaAgentAlert.ps1` | 47-59行目: .OUTPUTSセクションで出力プロパティを確認 |
| 1-2 | Remove-DbaAgentAlert.ps1 | `public/Remove-DbaAgentAlert.ps1` | 96-97行目: InputObjectパラメータの型定義 |

**読解のコツ**: `[Microsoft.SqlServer.Management.Smo.Agent.Alert[]]`型がSMOのアラートオブジェクトであることを理解する。

#### Step 2: エントリーポイントを理解する

処理の起点となるパラメータセットと初期化処理を確認します。

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

**主要処理フロー**:
1. **86行目**: `[CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')]` - 高影響度の確認処理を有効化
2. **88-89行目**: NonPipelineパラメータセット - SqlInstance指定時の処理
3. **96-97行目**: Pipelineパラメータセット - パイプライン入力時の処理

#### Step 3: 処理ブロック（begin/process/end）を理解する

PowerShellの高度な関数構造に沿った処理フローを追跡します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Remove-DbaAgentAlert.ps1 | `public/Remove-DbaAgentAlert.ps1` | 102-104行目: beginブロック - 配列初期化 |
| 3-2 | Remove-DbaAgentAlert.ps1 | `public/Remove-DbaAgentAlert.ps1` | 106-115行目: processブロック - アラート収集 |
| 3-3 | Remove-DbaAgentAlert.ps1 | `public/Remove-DbaAgentAlert.ps1` | 117-141行目: endブロック - 削除実行 |

**主要処理フロー**:
- **103行目**: `$dbAlerts = @( )` - 削除対象を格納する配列を初期化
- **107-111行目**: SqlInstance指定時、Get-DbaAgentAlertを呼び出して対象取得
- **112-114行目**: パイプライン入力時、InputObjectを配列に追加
- **119-140行目**: foreachループで各アラートを削除

#### Step 4: SMOを使用した削除処理を理解する

実際の削除処理とエラーハンドリングを確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Remove-DbaAgentAlert.ps1 | `public/Remove-DbaAgentAlert.ps1` | 129-137行目: try/catchによる削除処理 |

**主要処理フロー**:
- **120行目**: `$PSCmdlet.ShouldProcess()` - 確認プロンプト処理
- **130行目**: `$dbAlert.Drop()` - SMOメソッドによる削除実行
- **134行目**: `Stop-Function` - dbatools標準のエラー処理

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

```
Remove-DbaAgentAlert (エントリーポイント)
    |
    +-- [beginブロック]
    |       └── 配列初期化
    |
    +-- [processブロック]
    |       ├── Get-DbaAgentAlert (SqlInstance指定時)
    |       └── InputObject追加 (パイプライン時)
    |
    └── [endブロック]
            └── foreach ($dbAlert)
                    ├── ShouldProcess確認
                    ├── PSCustomObject作成
                    ├── $dbAlert.Drop()
                    ├── Stop-Function (エラー時)
                    └── Get-ErrorMessage (エラーメッセージ取得)
```

### データフロー図

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

SqlInstance ────────┐
SqlCredential ──────┼──▶ Get-DbaAgentAlert ──┐
Alert ──────────────┤                        │
ExcludeAlert ───────┘                        ▼
                                        dbAlerts配列
InputObject ─────────────────────────────────┘
                                             │
                                             ▼
                                 foreach ループ (endブロック)
                                             │
                                             ▼
                                 ShouldProcess確認
                                             │
                                             ▼
                                 Alert.Drop()
                                             │
                                             ▼
                                     PSCustomObject
                                 (ComputerName, InstanceName,
                                  SqlInstance, Name,
                                  Status, IsRemoved)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Remove-DbaAgentAlert.ps1 | `public/Remove-DbaAgentAlert.ps1` | ソース | メインコマンド実装 |
| Get-DbaAgentAlert.ps1 | `public/Get-DbaAgentAlert.ps1` | ソース | アラート取得（内部呼び出し） |
| Stop-Function.ps1 | `private/functions/Stop-Function.ps1` | ソース | エラー処理ユーティリティ |
| Get-ErrorMessage.ps1 | `private/functions/Get-ErrorMessage.ps1` | ソース | エラーメッセージ抽出 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続（Get-DbaAgentAlert内で使用） |
