# 通知設計書 20-New-DbaAgentAlertCategory

## 概要

本ドキュメントは、SQL Serverエージェントのアラートカテゴリを作成するdbatools PowerShellコマンド「New-DbaAgentAlertCategory」の設計仕様を記載します。

### 本通知の処理概要

New-DbaAgentAlertCategoryは、SQL Server Agentに新しいアラートカテゴリを作成するコマンドです。カテゴリを使用することで、関連するアラートをグループ化し、管理を効率化できます。

**業務上の目的・背景**：アラートカテゴリは、アラートを機能別、責任チーム別、重大度別などに論理的にグループ化するための仕組みです。大量のアラートが存在する環境では、カテゴリによる整理がSQL Server Management Studioでの閲覧性向上やレポート作成に役立ちます。本コマンドにより、複数のSQL Serverインスタンスに対して一貫したカテゴリ構成を迅速に展開できます。

**通知の送信タイミング**：本コマンドは「カテゴリを作成する」コマンドであり、通知を送信しません。作成されたカテゴリにアラートを割り当て、そのアラートがトリガーされた際に初めて通知が発生します。

**通知の受信者**：本コマンドの実行結果はコマンド実行者（DBA、システム管理者）に返されます。作成されたカテゴリ情報がSMO AlertCategoryオブジェクトとして出力されます。

**通知内容の概要**：作成されたカテゴリの名前、ID、カテゴリタイプなどの情報が返されます。

**期待されるアクション**：管理者はカテゴリ作成後、New-DbaAgentAlertやSet-DbaAgentAlertで既存のアラートに新しいカテゴリを割り当てます。

## 通知種別

PowerShellコンソール出力 / パイプライン出力（Microsoft.SqlServer.Management.Smo.Agent.AlertCategory）

## 送信仕様

### 基本情報

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

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

- SqlInstanceパラメータ：作成対象のSQL Serverインスタンスを指定
- Categoryパラメータ：作成するカテゴリ名を指定（複数指定可能）

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 出力形式 | Microsoft.SqlServer.Management.Smo.Agent.AlertCategory |
| 確認プロンプト | ShouldProcess による確認（ConfirmImpact = 'Low'） |

### 本文テンプレート

```
カテゴリ作成成功時の出力:
ComputerName : {ComputerName}
InstanceName : {InstanceName}
SqlInstance  : {SqlInstance}
ID           : {CategoryID}
Name         : {CategoryName}
CategoryType : {Alert}
```

### 添付ファイル

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

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| SqlInstance | SQL Serverインスタンス | パラメータ指定 | Yes |
| Category | カテゴリ名 | パラメータ指定 | Yes |
| Force | 確認プロンプト抑制 | パラメータ指定 | No |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コマンド実行 | New-DbaAgentAlertCategory実行 | 同名カテゴリ未存在 | 新規カテゴリを作成 |
| パイプライン入力 | SqlInstanceのパイプ入力 | 複数インスタンス対応 | 複数サーバーに一括作成 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 同名カテゴリ存在 | 既存カテゴリがある場合はStop-Functionでスキップ |
| -WhatIf指定時 | 実際の作成は行わず、処理内容のみ表示 |
| AG Listener経由 | 可用性グループリスナー経由では作成不可 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[コマンド実行開始] --> B{Force指定?}
    B -->|Yes| C[ConfirmPreference = none]
    B -->|No| D[通常確認モード]
    C --> E[foreach instance in SqlInstance]
    D --> E
    E --> F[Connect-DbaInstance]
    F --> G{接続成功?}
    G -->|No| H[Stop-Function: 接続エラー]
    H --> E
    G -->|Yes| I[foreach cat in Category]
    I --> J{同名カテゴリ存在?}
    J -->|Yes| K[Stop-Function: 既存カテゴリ]
    K --> I
    J -->|No| L{ShouldProcess確認}
    L -->|No| M[スキップ]
    M --> I
    L -->|Yes| N[New-Object AlertCategory]
    N --> O{AG Listener?}
    O -->|Yes| P[Stop-Function: AG Listenerエラー]
    P --> I
    O -->|No| Q[Create実行]
    Q --> R[JobServer.Refresh]
    R --> S[Get-DbaAgentAlertCategory出力]
    S --> T{次のカテゴリ?}
    T -->|Yes| I
    T -->|No| U{次のインスタンス?}
    U -->|Yes| E
    U -->|No| V[終了]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| msdb.dbo.syscategories | 既存カテゴリの重複チェック | SMO経由で参照 |

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

#### msdb.dbo.syscategories

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| name | 重複チェック | 作成前に同名存在確認 |
| category_class | カテゴリ種別確認 | AlertCategory（class=2） |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| msdb.dbo.syscategories | INSERT | 新規カテゴリの作成 |

#### syscategoriesテーブル

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| INSERT | name | Category パラメータ | カテゴリ名 |
| INSERT | category_class | 2 | アラートカテゴリを示す |
| INSERT | category_type | 3 | カテゴリタイプ |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 接続失敗 | SqlInstanceに接続不可 | Stop-Function -Continue |
| 既存カテゴリ | 同名カテゴリが存在 | Stop-Function -Continue |
| AG Listener | リスナー経由でのアクセス | Stop-Function -Continue（プライマリレプリカへの接続を推奨） |
| Create失敗 | SMO Create()失敗 | Stop-Function -Continue |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- sysadmin権限が必要
- SqlCredentialパラメータによりSQL Server認証、Windows認証、AD認証をサポート
- 可用性グループリスナー経由では実行不可（プライマリレプリカに直接接続が必要）
- SQL Server 2000以上が対象

## 備考

- Forceパラメータで確認プロンプトを抑制可能
- 複数カテゴリ名を配列で指定して一括作成可能
- 作成後、Get-DbaAgentAlertCategoryを呼び出して結果を出力
- AG Listener経由の場合は明示的なエラーメッセージを表示

---

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

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

### 推奨読解順序

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

まず、作成されるAlertCategoryオブジェクトの構造を理解することが重要です。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | New-DbaAgentAlertCategory.ps1 | `public/New-DbaAgentAlertCategory.ps1` | 53-66行目: .OUTPUTSセクションで出力プロパティを確認 |

**読解のコツ**: `Microsoft.SqlServer.Management.Smo.Agent.AlertCategory`型がSMOのカテゴリオブジェクトであることを理解する。

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

処理の起点となるパラメータ設定を確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | New-DbaAgentAlertCategory.ps1 | `public/New-DbaAgentAlertCategory.ps1` | 79-89行目: パラメータ定義 |
| 2-2 | New-DbaAgentAlertCategory.ps1 | `public/New-DbaAgentAlertCategory.ps1` | 91-93行目: beginブロック（Force処理） |

**主要処理フロー**:
1. **81行目**: `[parameter(Mandatory, ValueFromPipeline)]` - SqlInstanceは必須でパイプライン入力対応
2. **84-85行目**: Category は必須パラメータで配列対応
3. **92行目**: Force指定時に `$ConfirmPreference = 'none'`

#### Step 3: 接続と重複チェックを理解する

SQL Server接続と既存カテゴリの重複チェックを確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | New-DbaAgentAlertCategory.ps1 | `public/New-DbaAgentAlertCategory.ps1` | 96-101行目: 接続処理 |
| 3-2 | New-DbaAgentAlertCategory.ps1 | `public/New-DbaAgentAlertCategory.ps1` | 103-106行目: 重複チェック |

**主要処理フロー**:
- **97-100行目**: Connect-DbaInstance による接続とエラーハンドリング
- **104行目**: `$server.JobServer.AlertCategories.Name` で既存カテゴリ名を確認

#### Step 4: カテゴリ作成処理を理解する

SMOを使用したカテゴリ作成処理を確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | New-DbaAgentAlertCategory.ps1 | `public/New-DbaAgentAlertCategory.ps1` | 108-127行目: カテゴリ作成処理 |

**主要処理フロー**:
- **110行目**: `New-Object Microsoft.SqlServer.Management.Smo.Agent.AlertCategory` でSMOオブジェクト作成
- **111-117行目**: AG Listener経由の場合のエラーハンドリング
- **120行目**: `$alertCategory.Create()` でデータベースに永続化
- **122行目**: `$server.JobServer.Refresh()` で更新反映
- **128行目**: `Get-DbaAgentAlertCategory` で結果出力

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

```
New-DbaAgentAlertCategory (エントリーポイント)
    |
    +-- [beginブロック]
    |       └── Force → ConfirmPreference = 'none'
    |
    └── [processブロック]
            |
            └── foreach ($instance in $SqlInstance)
                    |
                    ├── Connect-DbaInstance
                    |
                    └── foreach ($cat in $Category)
                            |
                            ├── 重複チェック (AlertCategories.Name)
                            |
                            ├── ShouldProcess確認
                            |
                            ├── New-Object AlertCategory
                            |       └── AG Listener チェック
                            |
                            ├── Create()
                            |
                            ├── JobServer.Refresh()
                            |
                            └── Get-DbaAgentAlertCategory 出力
```

### データフロー図

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

SqlInstance ────────┐
SqlCredential ──────┼──▶ Connect-DbaInstance ──▶ $server
Category ───────────┤                               │
Force ──────────────┘                               ▼
                                        既存カテゴリ重複チェック
                                                    │
                                                    ▼
                                        New-Object AlertCategory
                                                    │
                                    ┌───────────────┼───────────────┐
                                    ▼               ▼               ▼
                              AG Listener     Create()       JobServer.Refresh
                                チェック
                                    │               │               │
                                    └───────────────┼───────────────┘
                                                    ▼
                                     Get-DbaAgentAlertCategory
                                                    │
                                                    ▼
                             Microsoft.SqlServer.Management.Smo.Agent.AlertCategory
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| New-DbaAgentAlertCategory.ps1 | `public/New-DbaAgentAlertCategory.ps1` | ソース | メインコマンド実装 |
| Get-DbaAgentAlertCategory.ps1 | `public/Get-DbaAgentAlertCategory.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` | ソース | ログ出力ユーティリティ |
