# 通知設計書 27-Compare-DbaAgReplicaOperator

## 概要

本ドキュメントは、可用性グループレプリカ間でSQL Server Agentオペレーター設定を比較するPowerShellコマンド `Compare-DbaAgReplicaOperator` の通知設計書です。

### 本通知の処理概要

`Compare-DbaAgReplicaOperator` は、可用性グループ（AG）の各レプリカ間でSQL Server Agentオペレーターの構成を比較し、差異を検出するコマンドです。オペレーターの存在有無やメールアドレスの違いを識別し、レプリカ間での構成ドリフトを発見します。

**業務上の目的・背景**：可用性グループ環境では、フェイルオーバー時に通知システムが正しく機能するためには、すべてのレプリカで一貫したオペレーター構成が必要です。ジュニアDBAがアラート通知変更をすべてのレプリカに適用したかの確認や、レプリカ間で構成がドリフトしている問題のトラブルシューティングに特に有用です。このコマンドにより、手動での確認作業を自動化し、構成の一貫性を効率的に監査できます。

**通知の送信タイミング**：このコマンドは比較操作を実行する機能であり、通知を送信するものではありません。差異が検出された場合にのみ、各オペレーターの構成状態を示すPSCustomObjectがパイプラインに出力されます。すべてのレプリカで一致している場合は出力されません。

**通知の受信者**：コマンド実行者がPowerShellコンソールまたはスクリプトの出力を通じて結果を受信します。

**通知内容の概要**：出力には以下の情報が含まれます：可用性グループ名、レプリカ名、オペレーター名、ステータス（"Present" または "Missing"）、メールアドレス（存在する場合）。差異がある場合のみ出力されます。

**期待されるアクション**：コマンド実行者は出力結果を確認し、不足しているオペレーターを作成（New-DbaAgentOperator）するか、メールアドレスの相違を修正（Set-DbaAgentOperator）することが期待されます。Copy-DbaAgentOperatorを使用してオペレーター構成を同期することも可能です。

## 通知種別

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

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（差異検出時にパイプライン出力） |
| 優先度 | 中 |
| リトライ | 無（コマンド再実行により対応） |

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

コマンド実行者のPowerShellセッションに直接出力されます。オペレーター構成に差異がある場合のみ出力され、すべてのレプリカで一致している場合は何も出力されません。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 出力形式 | PSCustomObject |
| 表示プロパティ | AvailabilityGroup, Replica, OperatorName, Status, EmailAddress |

### 出力オブジェクト構造

```powershell
[PSCustomObject]@{
    AvailabilityGroup = "可用性グループ名"
    Replica           = "レプリカインスタンス名"
    OperatorName      = "オペレーター名"
    Status            = "Present" または "Missing"
    EmailAddress      = "メールアドレス" または $null
}
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| AvailabilityGroup | 可用性グループ名 | $ag.Name | Yes |
| Replica | レプリカインスタンス名 | $replica.Name | Yes |
| OperatorName | オペレーター名 | $operator.Name | Yes |
| Status | 構成状態 | 比較結果から動的に設定 | Yes |
| EmailAddress | メールアドレス | $operator.EmailAddress | No |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コマンド実行 | Compare-DbaAgReplicaOperator実行 | 差異検出時 | 構成差異がある場合のみ出力 |
| パイプライン入力 | SqlInstanceの値受信 | ValueFromPipeline | パイプラインからインスタンス名を受け取り処理 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 差異なし | すべてのレプリカでオペレーター構成が一致している場合 |
| HADR未構成 | 可用性グループ（HADR）が構成されていないインスタンス |
| AG未発見 | 指定されたAvailabilityGroupが見つからない場合 |
| レプリカ不足 | 可用性グループのレプリカが2未満の場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[コマンド実行] --> B[インスタンスループ開始]
    B --> C[Connect-DbaInstance MinimumVersion 11]
    C --> D{接続成功?}
    D -->|No| E[Stop-Function + Continue]
    D -->|Yes| F{IsHadrEnabled?}
    F -->|No| G[Stop-Function + Continue]
    F -->|Yes| H[AvailabilityGroups取得]
    H --> I{AGフィルタ適用}
    I --> J{AG存在?}
    J -->|No| K[Stop-Function + Continue]
    J -->|Yes| L[AGループ開始]
    L --> M[レプリカ取得]
    M --> N{レプリカ数 >= 2?}
    N -->|No| O[Stop-Function + Continue]
    N -->|Yes| P[レプリカインスタンス収集]
    P --> Q[各レプリカからオペレーター取得]
    Q --> R[全オペレーター名リスト作成]
    R --> S[各オペレーター比較]
    S --> T{差異あり?}
    T -->|No| S
    T -->|Yes| U[PSCustomObject出力]
    U --> S
    S -->|完了| L
    L -->|完了| V[次のインスタンス]
    V --> B
    B -->|完了| W[終了]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| sys.availability_groups | 可用性グループ情報 | SMO経由でアクセス |
| sys.availability_replicas | レプリカ情報 | SMO経由でアクセス |
| msdb.dbo.sysoperators（各レプリカ） | オペレーター情報 | Get-DbaAgentOperator経由 |

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

#### msdb.dbo.sysoperators

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| name | オペレーター名（比較キー） | 全オペレーター |
| email_address | メールアドレス（比較対象） | 全オペレーター |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | 参照のみ（更新なし） |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 接続エラー | SQL Serverインスタンスに接続できない | 接続情報を確認し再試行 |
| バージョン不足 | SQL Server 2011（11）未満 | SQL Server 2012以上を使用 |
| HADR未構成 | 可用性グループが構成されていない | AG環境で実行 |
| AG未発見 | 指定されたAGが存在しない | AG名を確認 |
| レプリカ不足 | レプリカが1つしかない | 比較対象がないため対処不要 |
| レプリカ接続失敗 | 一部レプリカに接続できない | 接続情報を確認（他のレプリカは継続処理） |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（自動リトライなし） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A（手動で再実行が必要） |

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- 可用性グループの各レプリカへの接続権限が必要
- SqlCredentialパラメータを使用して安全に認証情報を渡すことが可能
- SQL Server 2012（バージョン11）以上が必要（MinimumVersion指定）
- オペレーターのメールアドレス情報を含むため、出力の取り扱いに注意

## 備考

- 差異がある場合のみ出力される（全レプリカで一致している場合は出力なし）
- 比較対象：オペレーターの存在有無（Present/Missing）とメールアドレスの一致
- Get-DbaAvailabilityGroupからのパイプライン入力に対応
- MinimumVersion 11（SQL Server 2012）以上が必要（AG機能のため）
- 各レプリカへの接続は個別に行われ、一部失敗しても他のレプリカは処理継続

---

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

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

### 推奨読解順序

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

まず、出力されるPSCustomObjectの構造を理解することが重要です。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Compare-DbaAgReplicaOperator.ps1 | `public/Compare-DbaAgReplicaOperator.ps1` | 42-53行目の.OUTPUTSセクションで出力構造を確認 |
| 1-2 | Compare-DbaAgReplicaOperator.ps1 | `public/Compare-DbaAgReplicaOperator.ps1` | 139-145行目と147-153行目でPSCustomObject構造を確認 |

**読解のコツ**: 出力はオペレーター構成に差異がある場合のみ行われます。$hasMissing（存在しないレプリカがある）または$uniqueEmails.Count > 1（メールアドレスが異なる）の条件で出力が決定されます。

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Compare-DbaAgReplicaOperator.ps1 | `public/Compare-DbaAgReplicaOperator.ps1` | 64-71行目でパラメータ定義を確認 |

**主要処理フロー**:
1. **66-67行目**: SqlInstanceパラメータ（ValueFromPipeline）
2. **69行目**: AvailabilityGroupパラメータ（フィルタ用）
3. **73行目**: processブロック開始

#### Step 3: 接続とAG検証を理解する

SQL Server接続、HADR確認、AG検証のロジックを確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Compare-DbaAgReplicaOperator.ps1 | `public/Compare-DbaAgReplicaOperator.ps1` | 74-93行目で接続とAG検証を確認 |

**主要処理フロー**:
- **75-79行目**: Connect-DbaInstance（MinimumVersion 11）
- **81-83行目**: IsHadrEnabled確認
- **85-89行目**: AvailabilityGroupフィルタリング
- **91-93行目**: AG存在確認

#### Step 4: レプリカからのオペレーター収集を理解する

各レプリカへの接続とオペレーター情報収集のロジックを確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Compare-DbaAgReplicaOperator.ps1 | `public/Compare-DbaAgReplicaOperator.ps1` | 95-130行目でレプリカ処理を確認 |

**主要処理フロー**:
- **96行目**: $ag.AvailabilityReplicasでレプリカ取得
- **98-100行目**: レプリカ数チェック（2未満はスキップ）
- **102-106行目**: レプリカインスタンス名を収集
- **110-129行目**: 各レプリカに接続してオペレーター取得

#### Step 5: 比較と差異検出ロジックを理解する

オペレーター比較と差異出力のロジックを確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 5-1 | Compare-DbaAgReplicaOperator.ps1 | `public/Compare-DbaAgReplicaOperator.ps1` | 132-168行目で比較処理を確認 |

**主要処理フロー**:
- **132行目**: 全オペレーター名でループ
- **135-155行目**: 各レプリカでの存在確認とPSCustomObject作成
- **157-166行目**: 差異判定（Missing有り or メールアドレス不一致）と出力

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

```
Compare-DbaAgReplicaOperator
    |
    +-- [processブロック]
            +-- foreach ($instance in $SqlInstance)
                    |
                    +-- Connect-DbaInstance (MinimumVersion 11)
                    |
                    +-- IsHadrEnabled チェック
                    |
                    +-- $server.AvailabilityGroups
                    |       +-- AvailabilityGroup フィルタ
                    |
                    +-- foreach ($ag in $availabilityGroups)
                            |
                            +-- $ag.AvailabilityReplicas
                            |       +-- レプリカ数チェック (>= 2)
                            |
                            +-- foreach ($replicaInstance in $replicaInstances)
                            |       +-- Connect-DbaInstance
                            |       +-- Get-DbaAgentOperator
                            |       +-- $operatorsByReplica に格納
                            |       +-- $allOperatorNames に追加
                            |
                            +-- foreach ($operatorName in $allOperatorNames)
                                    |
                                    +-- 各レプリカでの存在確認
                                    +-- PSCustomObject作成（Present/Missing）
                                    +-- 差異判定
                                    +-- 差異あり時のみ出力
```

### データフロー図

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

SqlInstance[] ────────────────> Connect-DbaInstance
        |                              |
        v                              v
AvailabilityGroup[] ──────────> フィルタリング
        |                              |
        v                              v
        |                       各AG処理ループ
        |                              |
        |                       ┌──────┴──────┐
        |                       |             |
        |                       v             v
        |               レプリカ収集    レプリカ接続
        |                       |             |
        |                       v             v
        |               replicaInstances  Get-DbaAgentOperator
        |                       |             |
        |                       └──────┬──────┘
        |                              |
        |                              v
        |                       operatorsByReplica
        |                       allOperatorNames
        |                              |
        |                              v
        |                       比較処理
        |                       ┌─────────────────┐
        |                       │ 各オペレーター   │
        |                       │ × 各レプリカ    │
        |                       └─────────────────┘
        |                              |
        |                              v
        |                       差異判定
        |                       - Missing あり?
        |                       - Email 不一致?
        |                              |
        └──────────────────────────────v
                                       |
                         差異あり時のみ出力
                                       |
                                       v
                               PSCustomObject ────> パイプライン出力
                               - AvailabilityGroup
                               - Replica
                               - OperatorName
                               - Status
                               - EmailAddress
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Compare-DbaAgReplicaOperator.ps1 | `public/Compare-DbaAgReplicaOperator.ps1` | ソース | レプリカ間オペレーター比較の本体 |
| Get-DbaAgentOperator.ps1 | `public/Get-DbaAgentOperator.ps1` | ソース | オペレーター取得 |
| Get-DbaAvailabilityGroup.ps1 | `public/Get-DbaAvailabilityGroup.ps1` | ソース | AG取得（パイプライン入力元） |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続 |
| Stop-Function.ps1 | `internal/functions/Stop-Function.ps1` | ソース | エラーハンドリング共通関数 |
| New-DbaAgentOperator.ps1 | `public/New-DbaAgentOperator.ps1` | ソース | 不足オペレーター作成（対処用） |
| Set-DbaAgentOperator.ps1 | `public/Set-DbaAgentOperator.ps1` | ソース | オペレーター更新（対処用） |
| Copy-DbaAgentOperator.ps1 | `public/Copy-DbaAgentOperator.ps1` | ソース | オペレーターコピー（対処用） |
