# 機能設計書 23-Set-DbaAgListener

## 概要

本ドキュメントは、SQL Server可用性グループリスナーのポート番号を変更するSet-DbaAgListener機能の設計仕様を記述する。

### 本機能の処理概要

Set-DbaAgListenerは、可用性グループリスナーのネットワークポート番号を変更するPowerShellコマンドレットである。

**業務上の目的・背景**：可用性グループ環境において、クライアントが可用性グループに接続するためのリスナーポートを変更する必要が生じる場合がある。例えば、環境間でのポート標準化、他サービスとのポート競合解消、またはセキュリティポリシーで非デフォルトポートが要求される場合などである。本機能は、これらの要件に対応するためのポート変更操作を簡素化する。

**機能の利用シーン**：
- 環境間でのリスナーポート標準化
- 他サービスとのポート競合解消
- セキュリティポリシーに基づく非デフォルトポートへの変更
- ネットワーク構成変更に伴うポート再割り当て

**主要な処理内容**：
1. SqlInstanceまたはInputObjectパラメータから対象リスナーを特定
2. Get-DbaAgListenerを使用してリスナーオブジェクトを取得
3. リスナーオブジェクトのPortNumberプロパティを更新
4. Alter()メソッドを呼び出して変更を適用
5. 更新されたリスナーオブジェクトを返却

**関連システム・外部連携**：SQL Server Management Objects (SMO) のAvailabilityGroupListenerクラスを使用してSQL Serverと連携する。

**権限による制御**：可用性グループに対するALTER権限が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 3 | AGリスナー管理 | 補助機能 | 可用性グループリスナーのポート番号変更 |

## 機能種別

構成変更（可用性グループリスナーのプロパティ変更）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No | 対象SQL Serverインスタンス | - |
| SqlCredential | PSCredential | No | 代替認証情報 | 有効なPSCredential |
| AvailabilityGroup | string[] | No | 対象可用性グループ名 | SqlInstance使用時は必須 |
| Listener | string[] | No | 対象リスナー名（省略時は全リスナー） | - |
| Port | int | Yes | 新しいポート番号 | 有効なTCPポート範囲 |
| InputObject | AvailabilityGroupListener[] | No | パイプラインからのリスナーオブジェクト | SqlInstanceまたはInputObjectいずれか必須 |
| EnableException | switch | No | 例外を有効化 | - |

### 入力データソース

- SqlInstanceパラメータ：SQL Serverインスタンス名の直接指定
- InputObjectパラメータ：Get-DbaAgListenerからのパイプライン入力

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| Name | string | リスナー名 |
| AvailabilityGroup | string | 親可用性グループ名 |
| PortNumber | int | 変更後のポート番号 |
| IPAddress | string | リスナーIPアドレス |
| SubnetMask | string | サブネットマスク |
| Parent | object | 親AvailabilityGroupオブジェクトへの参照 |

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. パラメータ検証
   └─ SqlInstanceまたはInputObjectのいずれかが指定されていることを確認
2. 追加パラメータ検証（SqlInstance指定時）
   └─ AvailabilityGroupが指定されていることを確認
3. リスナーオブジェクト取得
   └─ Get-DbaAgListenerを使用してリスナーオブジェクトを取得
4. 各リスナーに対する処理
   └─ ShouldProcess確認後、PortNumberを設定してAlter()を実行
5. 結果出力
   └─ 更新されたリスナーオブジェクトを返却
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{SqlInstance or InputObject?}
    B -->|Neither| C[Stop-Function: パラメータエラー]
    B -->|OK| D{SqlInstance指定?}
    D -->|Yes| E{AvailabilityGroup指定?}
    E -->|No| F[Stop-Function: パラメータエラー]
    E -->|Yes| G{Listener指定?}
    G -->|Yes| H[Get-DbaAgListener -Listener]
    G -->|No| I[Get-DbaAgListener]
    D -->|No| J[InputObjectを使用]
    H --> K[foreach aglistener in InputObject]
    I --> K
    J --> K
    K --> L{ShouldProcess?}
    L -->|No| M[スキップ]
    L -->|Yes| N[PortNumber設定]
    N --> O[Alter実行]
    O --> P{成功?}
    P -->|Yes| Q[オブジェクト出力]
    P -->|No| R[Stop-Function: エラー]
    M --> S{次のリスナー?}
    Q --> S
    R --> S
    S -->|Yes| K
    S -->|No| T[終了]
    C --> T
    F --> T
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | パラメータ相互排他 | SqlInstanceまたはInputObjectのいずれかが必須 | 常時 |
| BR-02 | AG指定必須 | SqlInstance指定時はAvailabilityGroupが必須 | SqlInstance指定時 |
| BR-03 | 確認プロンプト | ConfirmImpactがHighのため、デフォルトで確認プロンプトを表示 | WhatIfまたはConfirmが指定されていない場合 |

### 計算ロジック

特になし（プロパティ設定操作のため）

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

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

| 操作 | 対象オブジェクト | 操作種別 | 概要 |
|-----|-------------|---------|------|
| Alter | AvailabilityGroupListener | UPDATE | リスナーポート番号の変更 |

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

#### sys.availability_group_listeners

SMOのAlter()メソッドにより内部的にALTER AVAILABILITY GROUP ... MODIFY LISTENER文が実行され、ポート番号が更新される。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | パラメータエラー | SqlInstanceとInputObjectの両方が未指定 | Stop-Functionでエラーメッセージ出力 |
| - | パラメータエラー | SqlInstance指定時にAGが未指定 | Stop-Functionでエラーメッセージ出力 |
| - | 接続エラー | SQL Serverへの接続失敗 | Stop-Functionで継続可能エラー |
| - | 操作エラー | Alter失敗 | Stop-Functionでエラー出力 |

### リトライ仕様

リトライ機能は実装されていない。

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

SMOのAlter()メソッドは内部的にSQL Serverトランザクションを使用する。変更は即座にコミットされる。

## パフォーマンス要件

特に定義なし。操作自体は軽量で、通常は数秒以内に完了する。

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

- Windows認証、SQL Server認証、Active Directory認証をサポート
- MFA認証にはConnect-DbaInstanceの事前使用が必要
- 可用性グループに対するALTER権限が必要
- ShouldProcess実装によりWhatIfおよびConfirmをサポート

## 備考

- SQL Server 2012以上が必要
- ポート変更後、クライアント接続設定の更新が必要
- ポート変更は即座に反映されるため、接続中のクライアントに影響する可能性がある

---

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

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

### 推奨読解順序

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

SMOのAvailabilityGroupListenerクラスが中心的なデータ構造である。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Set-DbaAgListener.ps1 | `public/Set-DbaAgListener.ps1` | パラメータ定義と型（83-93行目）を確認 |

**読解のコツ**: Portパラメータが必須（Mandatory）として定義されている点に注目。

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

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

**主要処理フロー**:
1. **95-98行目**: パラメータ検証（SqlInstanceまたはInputObjectの存在確認）
2. **99-102行目**: SqlInstance指定時のAG必須チェック
3. **104-110行目**: Get-DbaAgListenerを使用したリスナーオブジェクト取得
4. **112-122行目**: 各リスナーに対するポート変更とAlter()実行

#### Step 3: SMO操作を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Set-DbaAgListener.ps1 | `public/Set-DbaAgListener.ps1` | PortNumberプロパティ設定とAlter()（115-117行目） |

**主要処理フロー**:
- **115行目**: `$aglistener.PortNumber = $Port`でポート番号設定
- **116行目**: `$aglistener.Alter()`で変更をSQL Serverに適用
- **117行目**: 更新されたオブジェクトを出力

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

```
Set-DbaAgListener
    │
    ├─ Test-Bound (パラメータ検証)
    │
    ├─ Stop-Function (エラー処理)
    │
    ├─ Get-DbaAgListener (リスナー取得)
    │      └─ Connect-DbaInstance (接続)
    │
    └─ AvailabilityGroupListener.Alter() (SMOメソッド)
```

### データフロー図

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

SqlInstance ───────────┐
                       │
SqlCredential ─────────┼──▶ Get-DbaAgListener ──▶ AvailabilityGroupListener[]
                       │            │
AvailabilityGroup ─────┤            │
                       │            ▼
Listener ──────────────┤     PortNumber設定
                       │            │
Port ──────────────────┘            ▼
                              Alter()
                                    │
                                    ▼
InputObject ──────────────────────────────────────▶ AvailabilityGroupListener[]
  (パイプライン)                                        (更新済みオブジェクト)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Set-DbaAgListener.ps1 | `public/Set-DbaAgListener.ps1` | ソース | メイン機能実装 |
| Get-DbaAgListener.ps1 | `public/Get-DbaAgListener.ps1` | ソース | リスナー取得 |
| Add-DbaAgListener.ps1 | `public/Add-DbaAgListener.ps1` | ソース | リスナー作成 |
| Remove-DbaAgListener.ps1 | `public/Remove-DbaAgListener.ps1` | ソース | リスナー削除 |
