# 機能設計書 14-Get-DbaAgListener

## 概要

本ドキュメントは、SQL Server可用性グループリスナーの構成情報（IPアドレスとポート番号を含む）を取得するGet-DbaAgListenerコマンドの機能設計書です。

### 本機能の処理概要

Get-DbaAgListenerは、SQL Serverインスタンスから可用性グループリスナーの構成情報を取得するPowerShellコマンドレットです。クライアント接続やトラブルシューティングに必要なネットワーク詳細情報（リスナー名、ポート番号、IP構成、関連する可用性グループ）を返します。

**業務上の目的・背景**：可用性グループリスナーは、クライアントアプリケーションがAGに接続するための重要なエンドポイントです。リスナー構成の確認は、接続問題のトラブルシューティング、インフラストラクチャドキュメンテーション、セットアップ後の検証に不可欠です。このコマンドにより、複数のAGにまたがるリスナー情報を効率的に収集できます。

**機能の利用シーン**：
- リスナーセットアップ後の構成検証
- クライアント接続問題のトラブルシューティング
- AGインフラストラクチャのドキュメンテーション
- マルチサブネット環境でのIP構成確認
- 監査・コンプライアンスレポートの生成

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

**関連システム・外部連携**：
- SQL Server SMO (Server Management Objects)
- SQL Server可用性グループインフラストラクチャ
- Windows Server Failover Clustering (WSFC)
- DNS（リスナー名解決）

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | PowerShellコンソール/ISE | 主画面 | コマンド実行とパイプライン処理 |
| - | SSMS可用性グループプロパティ | 参照画面 | リスナー構成の視覚的確認 |

## 機能種別

SELECT（データ取得）/ 構成情報取得

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No | 対象SQL Serverインスタンス（SQL Server 2012以上） | インスタンス接続可能性検証 |
| SqlCredential | PSCredential | No | 代替認証資格情報 | 有効なPSCredentialオブジェクト |
| AvailabilityGroup | string[] | No | 取得対象の可用性グループ名（ワイルドカード対応） | なし |
| Listener | 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 | クライアント接続用リスナーネットワーク名 |
| PortNumber | int | TCPポート番号（デフォルト1433） |
| ClusterIPConfiguration | string | WSFCクラスターIPリソース構成詳細 |
| AvailabilityGroupListenerIPAddresses | Collection | リスナーのIP構成コレクション |

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. パラメータ検証
   └─ SqlInstanceまたはInputObjectの少なくとも一方が必須
2. インスタンス接続（SqlInstance指定時）
   └─ Get-DbaAvailabilityGroupを呼び出してAGオブジェクト取得
3. リスナーコレクション取得
   └─ InputObject.AvailabilityGroupListenersを取得
4. フィルタリング
   └─ -Listenerパラメータ指定時、名前マッチング
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[InputObjectにAG追加]
    E --> F
    F --> G[AvailabilityGroupListeners取得]
    G --> H{Listenerフィルタ指定?}
    H -->|Yes| I[名前でフィルタ]
    H -->|No| J[全リスナー対象]
    I --> J
    J --> K[各リスナーをforeach]
    K --> L[Add-Member: プロパティ追加]
    L --> M[Select-DefaultView出力]
    M --> K
    K -->|完了| N[終了]
    C --> N
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | パラメータ排他 | SqlInstanceとInputObjectの少なくとも一方が必須 | 常時 |
| BR-02 | バージョン制限 | SQL Server 2012以上が必要 | 接続時 |
| BR-03 | フィルタ動作 | Listener指定時、一致しないリスナーはスキップ | -Listener指定時 |

### 計算ロジック

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

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| リスナー情報取得 | sys.availability_group_listeners | SELECT | SMO経由でのリスナー構成取得 |
| IPアドレス取得 | sys.availability_group_listener_ip_addresses | SELECT | リスナーIP情報取得 |

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ConnectionError | インスタンス接続失敗 | 接続情報・ネットワーク確認 |
| - | ParameterValidation | SqlInstance/InputObject両方未指定 | パラメータ指定を確認 |

### リトライ仕様

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

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

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

## パフォーマンス要件

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

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

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

## 備考

- SQL Server 2012以上が必須
- マルチサブネット環境では複数のIPアドレスが設定可能
- リスナー名はDNSに登録される仮想ネットワーク名

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: PowerShellのAdd-Memberを使用して、SMOオブジェクトに追加プロパティを動的に付与している点に注目してください。

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

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

**主要処理フロー**:
1. **95-98行目**: パラメータ検証（SqlInstanceまたはInputObjectの必須チェック）
2. **100-102行目**: SqlInstance指定時のGet-DbaAvailabilityGroup呼び出し
3. **104行目**: AvailabilityGroupListenersの取得
4. **105-107行目**: Listenerフィルタの適用
5. **111-117行目**: リスナー走査とプロパティ追加処理

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

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

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

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

### データフロー図

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

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

### 関連ファイル一覧

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