# 機能設計書 501-New-DbaAgentOperator

## 概要

本ドキュメントは、SQL Server Agent オペレーターを新規作成する `New-DbaAgentOperator` コマンドの機能設計書である。

### 本機能の処理概要

**業務上の目的・背景**：SQL Server Agent のオペレーターは、アラート発火時やジョブ失敗時に通知を受け取る連絡先として重要な役割を果たす。手動で SQL Server Management Studio から作成する場合、複数インスタンスへの展開が煩雑になる。本コマンドは、オペレーターの作成を自動化し、複数インスタンスへの一括展開を可能にすることで、運用管理の効率化と設定の一貫性を確保する。

**機能の利用シーン**：新規 SQL Server 環境のセットアップ時、監視体制の構築時、担当者変更に伴うオペレーター追加時、災害復旧環境での迅速なオペレーター設定再構築時などに利用される。特に、複数のSQL Server インスタンスを管理する環境で、統一された通知設定を展開する場合に有効である。

**主要な処理内容**：
1. 対象インスタンスへの接続確立（Connect-DbaInstance使用）
2. 通知方法（Email/NetSend/Pager）の少なくとも1つが指定されているか検証
3. ページャー日程に応じた時刻パラメータの妥当性検証（正規表現による時刻形式チェック）
4. 既存オペレーターの存在確認と Force パラメータによる再作成処理
5. SMO（Operator クラス）を使用したオペレーターオブジェクトの作成
6. 通知設定（Email、NetSend、Pager、ページャースケジュール）の構成
7. フェイルセーフオペレーターとしての設定（IsFailsafeOperator指定時）
8. 作成されたオペレーターの取得と出力（Get-DbaAgentOperator経由）

**関連システム・外部連携**：SQL Server Agent サービス、Database Mail（Email通知用）、SMTPサーバー（通知送信用）、ページャーゲートウェイ（SMS通知用）

**権限による制御**：対象インスタンスで sysadmin 権限が必要。フェイルセーフオペレーターの設定変更には JobServer.AlertSystem への書き込み権限が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 13 | Agentオペレーター管理 | 主画面 | SQLエージェントオペレーターの新規作成 |

## 機能種別

CRUD操作（Create）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No | 対象SQL Serverインスタンス | 接続可能なインスタンス名 |
| SqlCredential | PSCredential | No | 代替認証情報 | - |
| Operator | string | Yes | 作成するオペレーター名 | 必須、一意である必要あり |
| EmailAddress | string | No | メール通知用アドレス | Email/NetSend/Pagerのいずれか1つ以上必須 |
| NetSendAddress | string | No | NetSend通知用アドレス | Email/NetSend/Pagerのいずれか1つ以上必須 |
| PagerAddress | string | No | ページャー通知用アドレス | Email/NetSend/Pagerのいずれか1つ以上必須 |
| PagerDay | string | No | ページャー通知日設定 | EveryDay/Weekdays/Weekend/Sunday〜Saturday |
| SaturdayStartTime | string | No | 土曜日ページャー開始時刻 | HHMMSS形式（000000〜235959） |
| SaturdayEndTime | string | No | 土曜日ページャー終了時刻 | HHMMSS形式（000000〜235959） |
| SundayStartTime | string | No | 日曜日ページャー開始時刻 | HHMMSS形式（000000〜235959） |
| SundayEndTime | string | No | 日曜日ページャー終了時刻 | HHMMSS形式（000000〜235959） |
| WeekdayStartTime | string | No | 平日ページャー開始時刻 | HHMMSS形式（000000〜235959） |
| WeekdayEndTime | string | No | 平日ページャー終了時刻 | HHMMSS形式（000000〜235959） |
| IsFailsafeOperator | switch | No | フェイルセーフオペレーター指定 | - |
| FailsafeNotificationMethod | string | No | フェイルセーフ通知方法 | NotifyEmail/NotifyPager |
| Force | switch | No | 既存オペレーターの再作成 | - |
| InputObject | Server[] | No | パイプライン入力用サーバーオブジェクト | SMO Serverオブジェクト |
| EnableException | switch | No | 例外を有効化 | - |

### 入力データソース

PowerShell コマンドラインからのパラメータ入力、またはパイプラインからの SMO Server オブジェクト入力

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverインスタンスのコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名 |
| Name | string | オペレーター名 |
| EmailAddress | string | メールアドレス |
| NetSendAddress | string | NetSendアドレス |
| PagerAddress | string | ページャーアドレス |
| Enabled | bool | オペレーターの有効状態 |
| LastEmailDate | DateTime | 最後にメール送信した日時 |
| LastNetSendDate | DateTime | 最後にNetSend送信した日時 |
| LastPagerDate | DateTime | 最後にページャー送信した日時 |

### 出力先

PowerShell パイプライン（Microsoft.SqlServer.Management.Smo.Agent.Operator オブジェクト）

## 処理フロー

### 処理シーケンス

```
1. beginブロック
   └─ Forceパラメータ指定時、ConfirmPreferenceを'none'に設定
2. processブロック
   ├─ 通知方法の検証（Email/NetSend/Pagerのいずれか必須）
   ├─ PagerDay値をInterval（ビットマスク）に変換
   │   └─ Sunday=1, Monday=2, Tuesday=4, Wednesday=8, Thursday=16, Friday=32, Saturday=64
   ├─ 時刻パラメータの検証（正規表現: ^(?:(?:([01]?\d|2[0-3]))?([0-5]?\d))?([0-5]?\d)$）
   │   ├─ PagerDayに応じた土曜時刻検証
   │   ├─ PagerDayに応じた日曜時刻検証
   │   └─ PagerDayに応じた平日時刻検証
   ├─ フェイルセーフオペレーター設定の検証
   ├─ 時刻フォーマット変換（HHMMSS → HH:MM:SS）
   ├─ SqlInstanceからサーバー接続
   └─ 各サーバーに対する処理ループ
       ├─ 既存オペレーターの確認
       │   ├─ 存在しForceなし → スキップ
       │   ├─ 存在しForceあり → 削除後再作成
       │   └─ フェイルセーフオペレーターの場合は削除スキップ
       ├─ 新規Operatorオブジェクト作成
       ├─ 通知設定の適用
       ├─ ページャースケジュールの設定
       ├─ Operator.Create()実行
       ├─ フェイルセーフオペレーター設定（指定時）
       └─ Get-DbaAgentOperatorで結果取得・出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{通知方法が1つ以上指定?}
    B -->|No| C[エラー終了]
    B -->|Yes| D[PagerDay値をIntervalに変換]
    D --> E{PagerDayに応じた時刻検証}
    E -->|検証失敗| C
    E -->|検証成功| F[時刻フォーマット変換]
    F --> G[サーバー接続]
    G --> H{既存オペレーター存在?}
    H -->|Yes| I{Force指定?}
    I -->|No| J[スキップして次へ]
    I -->|Yes| K{フェイルセーフOP?}
    K -->|Yes| J
    K -->|No| L[既存オペレーター削除]
    L --> M[新規Operatorオブジェクト作成]
    H -->|No| M
    M --> N[通知設定・スケジュール適用]
    N --> O[Operator.Create実行]
    O --> P{IsFailsafeOperator?}
    P -->|Yes| Q[フェイルセーフ設定適用]
    P -->|No| R[結果出力]
    Q --> R
    R --> S[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-501-01 | 通知方法必須 | Email、NetSend、Pagerのいずれか1つ以上を指定する必要がある | 常時 |
| BR-501-02 | ページャー時刻必須 | PagerDayを指定した場合、対応する曜日の開始・終了時刻が必要（Forceで既定値適用可） | PagerDay指定時 |
| BR-501-03 | フェイルセーフ唯一性 | フェイルセーフオペレーターはインスタンスごとに1つのみ | IsFailsafeOperator指定時 |
| BR-501-04 | 既存オペレーター保護 | 同名オペレーターが存在する場合、Forceなしではスキップ | 常時 |
| BR-501-05 | フェイルセーフOP削除禁止 | フェイルセーフオペレーターとして設定されている既存オペレーターは、Forceでも削除しない | IsFailsafeOperator指定時 |

### 計算ロジック

**PagerDayのInterval変換**：
- Sunday = 1, Monday = 2, Tuesday = 4, Wednesday = 8
- Thursday = 16, Friday = 32, Saturday = 64
- Weekdays = 62 (2+4+8+16+32)
- Weekend = 65 (1+64)
- EveryDay = 127 (全ビット)

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| オペレーター作成 | msdb.dbo.sysoperators | INSERT | SMO経由でオペレーターレコード作成 |
| フェイルセーフ設定 | msdb.dbo.sysalerts (AlertSystem) | UPDATE | フェイルセーフオペレーター設定更新 |

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

#### msdb.dbo.sysoperators

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| INSERT | name | Operatorパラメータ値 | オペレーター名 |
| INSERT | email_address | EmailAddressパラメータ値 | メールアドレス |
| INSERT | netsend_address | NetSendAddressパラメータ値 | NetSendアドレス |
| INSERT | pager_address | PagerAddressパラメータ値 | ページャーアドレス |
| INSERT | pager_days | Interval計算値 | ページャー通知日ビットマスク |
| INSERT | weekday_pager_start_time | WeekdayStartTime（HH:MM:SS形式） | 平日ページャー開始時刻 |
| INSERT | weekday_pager_end_time | WeekdayEndTime（HH:MM:SS形式） | 平日ページャー終了時刻 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 接続エラー | インスタンスへの接続失敗 | Stop-Functionで処理継続、エラーログ出力 |
| - | パラメータエラー | 通知方法が1つも指定されていない | Stop-Functionで即座に終了 |
| - | パラメータエラー | 時刻形式が不正 | Stop-Functionで即座に終了 |
| - | パラメータエラー | フェイルセーフ通知方法が不正 | Stop-Functionで即座に終了 |
| - | 作成エラー | オペレーター作成失敗 | Stop-Functionで処理継続、エラーログ出力 |
| - | AG関連エラー | AGリスナー経由での作成試行 | 専用エラーメッセージで終了 |

### リトライ仕様

リトライ処理は実装されていない。エラー発生時は Stop-Function でエラーを記録し、次のインスタンスの処理に進む。

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

SMO の Operator.Create() メソッドによる暗黙的トランザクション。作成処理は単一操作として実行される。

## パフォーマンス要件

特に定義されていない。通常のSMO操作のレスポンス時間に依存。

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

- 対象インスタンスへの sysadmin 権限が必要
- SqlCredential パラメータで代替認証情報をサポート（PSCredential）
- MFA が必要な環境では Connect-DbaInstance の事前使用を推奨
- Windows認証、SQL Server認証、Active Directory認証をサポート

## 備考

- SQL Server 2000 以降をサポート
- 可用性グループリスナー経由での作成はサポートされない（インスタンスレベルのオブジェクトのため）
- NetSend は現代の環境ではほとんど使用されないレガシー機能

---

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

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

### 推奨読解順序

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

SMO の Operator クラスの構造と、PagerDay のビットマスク変換ロジックを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | New-DbaAgentOperator.ps1 | `public/New-DbaAgentOperator.ps1` | 182-209行目: PagerDayからIntervalへの変換ロジック |

**読解のコツ**: PagerDay はビットマスクで管理される。各曜日に対応するビット値を加算して Interval を計算する。

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

コマンドの開始点と主要なパラメータ検証ロジック。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | New-DbaAgentOperator.ps1 | `public/New-DbaAgentOperator.ps1` | 147-170行目: パラメータ定義、172-174行目: beginブロック |

**主要処理フロー**:
1. **147-170行目**: CmdletBinding と param ブロックでパラメータ定義
2. **172-174行目**: Force 指定時の ConfirmPreference 設定
3. **177-180行目**: 通知方法の必須チェック

#### Step 3: バリデーションロジックを理解する

時刻パラメータの検証と変換処理。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | New-DbaAgentOperator.ps1 | `public/New-DbaAgentOperator.ps1` | 211-294行目: 時刻バリデーション、297-316行目: 時刻フォーマット変換 |

**主要処理フロー**:
- **211行目**: 時刻検証用正規表現パターン
- **213-237行目**: 土曜日時刻検証
- **239-263行目**: 日曜日時刻検証
- **265-289行目**: 平日時刻検証
- **297-316行目**: HHMMSS → HH:MM:SS 変換

#### Step 4: オペレーター作成処理を理解する

SMO を使用した実際のオペレーター作成ロジック。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | New-DbaAgentOperator.ps1 | `public/New-DbaAgentOperator.ps1` | 326-421行目: メインの作成処理ループ |

**主要処理フロー**:
- **329-350行目**: 既存オペレーターの確認と Force 処理
- **352-365行目**: 新規 Operator オブジェクト作成（AG リスナーエラー処理含む）
- **367-406行目**: 通知設定とスケジュール設定
- **407行目**: Operator.Create() 実行
- **409-413行目**: フェイルセーフオペレーター設定
- **416行目**: Get-DbaAgentOperator で結果取得

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

```
New-DbaAgentOperator
    │
    ├─ Connect-DbaInstance (318-323行目)
    │      └─ SQL Server インスタンスへの接続確立
    │
    ├─ Get-DbaAgentOperator (329行目)
    │      └─ 既存オペレーターの存在確認
    │
    ├─ $server.JobServer.Operators[$operator].Drop() (344行目)
    │      └─ 既存オペレーターの削除（Force時）
    │
    ├─ New-Object Microsoft.SqlServer.Management.Smo.Agent.Operator (357行目)
    │      └─ SMO Operator オブジェクト作成
    │
    ├─ $operators.Create() (407行目)
    │      └─ オペレーターの永続化
    │
    └─ Get-DbaAgentOperator (416行目)
           └─ 作成結果の取得と出力
```

### データフロー図

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

SqlInstance     ─────▶ Connect-DbaInstance ─────▶ Server オブジェクト
                              │
Operator        ─────────────▶│
EmailAddress    ─────────────▶│
PagerAddress    ─────────────▶├─▶ パラメータ検証
PagerDay        ─────────────▶│        │
時刻パラメータ  ─────────────▶│        │
                              ▼        ▼
                      Operator オブジェクト作成
                              │
                              ▼
                      Create() 実行
                              │
                              ▼
                      Get-DbaAgentOperator ─────▶ Operator オブジェクト
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| New-DbaAgentOperator.ps1 | `public/New-DbaAgentOperator.ps1` | ソース | メインコマンド実装 |
| Get-DbaAgentOperator.ps1 | `public/Get-DbaAgentOperator.ps1` | ソース | 既存オペレーター取得、結果出力 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | インスタンス接続 |
