# 機能設計書 15-Get-DbaAgReplica

## 概要

本ドキュメントは、SQL Server可用性グループのレプリカ構成とステータス情報を取得するGet-DbaAgReplicaコマンドの機能設計書です。

### 本機能の処理概要

Get-DbaAgReplicaは、可用性グループレプリカの詳細情報（現在のロール、接続状態、同期ステータス、フェイルオーバー構成など）を取得するPowerShellコマンドレットです。DBAがシステムビューを手動でクエリすることなく、レプリカのヘルス監視、フェイルオーバー準備状況の検証、可用性グループ問題のトラブルシューティングを行えるようにします。

**業務上の目的・背景**：可用性グループ環境において、各レプリカの状態とフェイルオーバー準備状況を把握することは、高可用性を維持するために重要です。このコマンドは、バックアップ優先度、エンドポイントURL、セッションタイムアウト、読み取り専用ルーティングリストなど、AG管理とコンプライアンスレポートに必要な包括的なレプリカプロパティを返します。

**機能の利用シーン**：
- レプリカヘルスの監視
- フェイルオーバー準備状況の検証
- 可用性グループ問題のトラブルシューティング
- バックアップ優先度設定の確認
- 読み取り専用ルーティング構成の検証
- AGインフラストラクチャのドキュメンテーション

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスに接続
2. 可用性グループ情報を取得（Get-DbaAvailabilityGroupを内部呼び出し）
3. 各可用性グループのAvailabilityReplicasコレクションを走査
4. レプリカフィルタリング（-Replicaパラメータ指定時）
5. 各レプリカオブジェクトにメタデータプロパティを追加
6. カスタムビューでフォーマットされた結果をパイプライン出力

**関連システム・外部連携**：
- SQL Server SMO (Server Management Objects)
- SQL Server可用性グループインフラストラクチャ
- Windows Server Failover Clustering (WSFC)
- データベースミラーリングエンドポイント

**権限による制御**：VIEW SERVER STATE権限またはsysadmin固定サーバーロールのメンバーシップが必要です。VIEW ANY DEFINITION権限も推奨されます。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | PowerShellコンソール/ISE | 主画面 | コマンド実行とパイプライン処理 |
| - | SSMS AG Dashboard | 参照画面 | レプリカ情報の視覚的確認 |

## 機能種別

SELECT（データ取得）/ 監視・レポート出力

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No | 対象SQL Serverインスタンス（SQL Server 2012以上） | インスタンス接続可能性検証 |
| SqlCredential | PSCredential | No | 代替認証資格情報 | 有効なPSCredentialオブジェクト |
| AvailabilityGroup | string[] | No | 取得対象の可用性グループ名（ワイルドカード対応） | なし |
| Replica | string[] | No | 取得対象のレプリカ名 | なし |
| InputObject | AvailabilityGroup[] | No | パイプライン入力用AGオブジェクト | Microsoft.SqlServer.Management.Smo.AvailabilityGroup型 |
| EnableException | switch | No | 例外を有効化（詳細エラー表示） | なし |

### 入力データソース

- PowerShellパラメータ入力
- パイプラインからのAvailabilityGroupオブジェクト（Get-DbaAvailabilityGroup出力）
- SQL Server SMO経由のレプリカメタデータ

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverインスタンスのコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名 |
| AvailabilityGroup | string | 可用性グループ名 |
| Name | string | レプリカの名前/表示名 |
| Role | enum | 現在のロール（Primary/Secondary） |
| ConnectionState | enum | 接続状態（Connected/Disconnected等） |
| RollupSynchronizationState | enum | 全体的なデータベース同期状態 |
| AvailabilityMode | enum | コミットモード（SynchronousCommit/AsynchronousCommit） |
| BackupPriority | int | バックアップ優先度（0-100） |
| EndpointUrl | string | データベースミラーリングエンドポイントURL |
| SessionTimeout | int | セッションタイムアウト（秒） |
| FailoverMode | enum | フェイルオーバーモード（Automatic/Manual） |
| ReadonlyRoutingList | string[] | 読み取り専用ルーティングリスト |

### 出力先

- PowerShellパイプライン（標準出力）
- オブジェクト型：Microsoft.SqlServer.Management.Smo.AvailabilityReplica（拡張プロパティ付き）

## 処理フロー

### 処理シーケンス

```
1. パラメータ検証
   └─ SqlInstanceまたはInputObjectの少なくとも一方が必須
2. インスタンス接続（SqlInstance指定時）
   └─ Get-DbaAvailabilityGroupを呼び出してAGオブジェクト取得
3. レプリカコレクション取得
   └─ InputObject.AvailabilityReplicasを取得
4. フィルタリング
   └─ -Replicaパラメータ指定時、名前マッチング
5. プロパティ追加
   └─ Add-Memberで追加プロパティを付与
6. 出力
   └─ Select-DefaultViewでフォーマットしてパイプライン出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{SqlInstance or InputObject?}
    B -->|Neither| C[Stop-Function: エラー]
    B -->|SqlInstance| D[Get-DbaAvailabilityGroup呼び出し]
    B -->|InputObject| E[パイプライン入力使用]
    D --> F{取得成功?}
    F -->|No| G[Stop-Function: AG取得失敗]
    F -->|Yes| H[InputObjectにAG追加]
    E --> H
    H --> I[AvailabilityReplicas取得]
    I --> J{Replicaフィルタ指定?}
    J -->|Yes| K[名前でフィルタ]
    J -->|No| L[全レプリカ対象]
    K --> L
    L --> M[各レプリカをforeach]
    M --> N[Add-Member: プロパティ追加]
    N --> O[Select-DefaultView出力]
    O --> M
    M -->|完了| P[終了]
    C --> P
    G --> P
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | パラメータ排他 | SqlInstanceとInputObjectの少なくとも一方が必須 | 常時 |
| BR-02 | バージョン制限 | SQL Server 2012以上が必要 | 接続時 |
| BR-03 | フィルタ動作 | Replica指定時、一致しないレプリカはスキップ | -Replica指定時 |
| BR-04 | 後方互換 | Replicaプロパティも追加（Name同様） | 常時 |

### 計算ロジック

特になし（データ取得機能のため）

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| レプリカ情報取得 | sys.availability_replicas | SELECT | SMO経由でのレプリカ構成取得 |
| 同期状態取得 | sys.dm_hadr_availability_replica_states | SELECT | レプリカ状態情報取得 |

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

本コマンドはSMOを使用するため、直接T-SQLを発行しません。SMOが内部的にシステムビューやDMVにアクセスします。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ConnectionError | インスタンス接続失敗 | 接続情報・ネットワーク確認 |
| - | ParameterValidation | SqlInstance/InputObject両方未指定 | パラメータ指定を確認 |
| - | AGNotFound | 指定されたAGが見つからない | AG名を確認 |

### リトライ仕様

リトライ機能なし（呼び出し元での制御が必要）

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

読み取り専用操作のため、トランザクション管理なし

## パフォーマンス要件

- 単一インスタンス・単一AGの場合：1秒以内
- 複数AGの場合：AG数とレプリカ数に比例

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

- Windows認証/SQL認証/AD認証対応
- SqlCredentialによる資格情報の安全な受け渡し
- VIEW SERVER STATE権限要求

## 備考

- SQL Server 2012以上が必須
- SeedingModeプロパティはSQL Server 2016以上でのみ利用可能
- Select-Object *で全SMOプロパティにアクセス可能

---

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

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

### 推奨読解順序

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

SMOのAvailabilityReplicaオブジェクトが主要なデータ構造です。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaAgReplica.ps1 | `public/Get-DbaAgReplica.ps1` | 出力プロパティ定義（124行目のdefaults配列） |

**読解のコツ**: SMOのAvailabilityReplicaオブジェクトに追加プロパティを付与しています。後方互換性のためにReplicaプロパティも追加されています（131行目）。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaAgReplica.ps1 | `public/Get-DbaAgReplica.ps1` | processブロック（104-135行目）がメイン処理 |

**主要処理フロー**:
1. **105-108行目**: パラメータ検証（SqlInstanceまたはInputObjectの必須チェック）
2. **110-117行目**: SqlInstance指定時のGet-DbaAvailabilityGroup呼び出し（try-catch付き）
3. **119-122行目**: AvailabilityReplicasの取得とReplicaフィルタの適用
4. **126-133行目**: レプリカ走査とプロパティ追加処理

#### Step 3: 依存コマンドを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaAvailabilityGroup.ps1 | `public/Get-DbaAvailabilityGroup.ps1` | AG情報取得の内部呼び出し |

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

```
Get-DbaAgReplica
    │
    ├─ Test-Bound (パラメータ検証)
    │
    ├─ Get-DbaAvailabilityGroup (SqlInstance指定時)
    │      └─ Connect-DbaInstance
    │
    ├─ Where-Object (Replicaフィルタ)
    │
    ├─ Add-Member (プロパティ追加)
    │      ├─ ComputerName
    │      ├─ InstanceName
    │      ├─ SqlInstance
    │      ├─ AvailabilityGroup
    │      └─ Replica (後方互換)
    │
    └─ Select-DefaultView (出力フォーマット)
```

### データフロー図

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

SqlInstance ───▶ Get-DbaAvailabilityGroup ─┐
                                           │
InputObject ───────────────────────────────┼─▶ AvailabilityReplicas取得
                                           │
Replica (filter) ──────────────────────────▶ Where-Objectフィルタ
                                                     │
                                               Add-Member
                                                     │
                                           Select-DefaultView ───▶ パイプライン出力
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaAgReplica.ps1 | `public/Get-DbaAgReplica.ps1` | ソース | メインコマンド実装 |
| Get-DbaAvailabilityGroup.ps1 | `public/Get-DbaAvailabilityGroup.ps1` | ソース | AG情報取得依存コマンド |
| Get-DbaAgReplica.Tests.ps1 | `tests/Get-DbaAgReplica.Tests.ps1` | テスト | 単体・統合テスト |
| Add-DbaAgReplica.ps1 | `public/Add-DbaAgReplica.ps1` | ソース | レプリカ追加コマンド（関連） |
| Remove-DbaAgReplica.ps1 | `public/Remove-DbaAgReplica.ps1` | ソース | レプリカ削除コマンド（関連） |
| Set-DbaAgReplica.ps1 | `public/Set-DbaAgReplica.ps1` | ソース | レプリカ設定変更コマンド（関連） |
