# 機能設計書 19-Remove-DbaAgListener

## 概要

本ドキュメントは、SQL Server可用性グループからリスナーを削除するRemove-DbaAgListenerコマンドの機能設計書です。

### 本機能の処理概要

Remove-DbaAgListenerは、SQL Serverインスタンスから可用性グループリスナーを削除するPowerShellコマンドレットです。クライアントがAGデータベースに接続するために使用する仮想ネットワーク名とIPアドレス構成を永続的に削除します。

**業務上の目的・背景**：デコミッショニング、再構成、またはリスナー統合時に、可用性グループリスナーを削除する必要があります。リスナーが削除されると、アプリケーションは個別のレプリカに直接接続するか、別のリスナーを使用する必要があります。このコマンドは、特定のリスナーを名前で削除したり、指定されたAGからすべてのリスナーを削除したりする機能を提供します。

**機能の利用シーン**：
- AGリスナーのデコミッショニング
- リスナー再構成（削除後再作成）
- 不要なリスナーのクリーンアップ
- AG移行時の古いリスナー削除
- テスト環境のクリーンアップ

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスに接続
2. 対象リスナーを取得（Get-DbaAgListener使用）
3. リスナーを削除（Drop()メソッド）
4. 削除結果をPSCustomObjectで出力

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

**権限による制御**：対象可用性グループに対するALTER AVAILABILITY GROUP権限、またはsysadmin固定サーバーロールのメンバーシップが必要です。

## 関連画面

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

## 機能種別

DELETE（削除）/ 可用性グループ管理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No | 対象SQL Serverインスタンス（SQL Server 2012以上） | インスタンス接続可能性検証 |
| SqlCredential | PSCredential | No | 代替認証資格情報 | 有効なPSCredentialオブジェクト |
| Listener | string[] | No | 削除対象のリスナー名 | SqlInstance指定時は必須 |
| AvailabilityGroup | string[] | No | 対象可用性グループ名 | なし |
| InputObject | AvailabilityGroupListener[] | No | パイプライン入力用リスナーオブジェクト | Microsoft.SqlServer.Management.Smo.AvailabilityGroupListener型 |
| EnableException | switch | No | 例外を有効化 | なし |
| WhatIf | switch | No | 実行シミュレーション | なし |
| Confirm | switch | No | 実行前確認 | なし |

### 入力データソース

- PowerShellパラメータ入力
- パイプラインからのAvailabilityGroupListenerオブジェクト（Get-DbaAgListener出力）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverインスタンスのコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名 |
| AvailabilityGroup | string | リスナーが削除された可用性グループ名 |
| Listener | string | 削除されたリスナー名 |
| Status | string | 操作結果（"Removed"） |

### 出力先

- PowerShellパイプライン（標準出力）
- オブジェクト型：PSCustomObject

## 処理フロー

### 処理シーケンス

```
1. パラメータ検証
   └─ SqlInstanceまたはInputObjectの必須チェック
2. Listener検証（SqlInstance指定時）
   └─ Listener必須チェック
3. リスナー取得
   └─ Get-DbaAgListenerでリスナーオブジェクト取得
4. リスナー削除
   └─ Drop()メソッドでAGから削除
5. 結果出力
   └─ PSCustomObjectでステータス出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{SqlInstance or InputObject?}
    B -->|Neither| C[Stop-Function: エラー]
    B -->|OK| D{SqlInstance指定?}
    D -->|Yes| E{Listener指定?}
    E -->|No| F[Stop-Function: Listener必須エラー]
    E -->|Yes| G[Get-DbaAgListener]
    D -->|No| H[InputObject使用]
    G --> I[InputObjectにListener追加]
    H --> I
    I --> J[各Listenerをforeach]
    J --> K{ShouldProcess確認}
    K -->|Yes| L[Drop呼び出し]
    K -->|No| J
    L --> M[PSCustomObject出力]
    M --> J
    J -->|完了| N[終了]
    C --> N
    F --> N
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | パラメータ排他 | SqlInstanceとInputObjectの少なくとも一方が必須 | 常時 |
| BR-02 | Listener必須 | SqlInstance使用時はListener必須 | SqlInstance指定時 |
| BR-03 | 高影響確認 | ConfirmImpact = High（確認ダイアログ表示） | 常時 |
| BR-04 | クライアント影響 | リスナー削除後はクライアント接続に影響 | 常時 |

### 計算ロジック

特になし（削除操作のため）

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| リスナー削除 | sys.availability_group_listeners | DELETE | AGリスナーレコード削除 |
| IP削除 | sys.availability_group_listener_ip_addresses | DELETE | リスナーIP設定削除 |

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

本コマンドはSMOのDrop()メソッドを使用し、可用性グループからリスナーを削除します。WSFCリソースも同時に削除されます。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ConnectionError | インスタンス接続失敗 | 接続情報・ネットワーク確認 |
| - | ParameterValidation | 必須パラメータ未指定 | パラメータ指定を確認 |
| - | DropFailed | 削除操作失敗 | AG状態・権限確認 |

### リトライ仕様

リトライ機能なし。失敗時はStop-Function -Continueでエラー出力後継続。

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

SMOのDrop()メソッドによる暗黙的トランザクション管理。

## パフォーマンス要件

- 単一リスナー削除：数秒以内

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

- ALTER AVAILABILITY GROUP権限またはsysadmin権限が必要
- Windows認証/SQL認証/AD認証対応
- SqlCredentialによる資格情報の安全な受け渡し
- ConfirmImpact = Highによる実行前確認

## 備考

- リスナー削除後は、クライアントアプリケーションの接続文字列を更新する必要がある
- WSFCリソースも同時に削除される
- DNSレコードは手動でクリーンアップが必要な場合がある

---

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

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

### 推奨読解順序

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

入力はAvailabilityGroupListenerオブジェクト、出力はPSCustomObjectです。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Remove-DbaAgListener.ps1 | `public/Remove-DbaAgListener.ps1` | 出力PSCustomObject構造（108-115行目） |

**読解のコツ**: リスナーオブジェクトはParent.AvailabilityGroupListeners経由でアクセスされています（107行目）。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Remove-DbaAgListener.ps1 | `public/Remove-DbaAgListener.ps1` | processブロック（86-121行目） |

**主要処理フロー**:
1. **87-90行目**: パラメータ検証（SqlInstanceまたはInputObjectの必須チェック）
2. **92-97行目**: SqlInstance時のListener必須チェック
3. **99-101行目**: Get-DbaAgListenerでリスナー取得
4. **103-120行目**: foreachでリスナー削除処理

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaAgListener.ps1 | `public/Get-DbaAgListener.ps1` | リスナー情報取得 |

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

```
Remove-DbaAgListener
    │
    ├─ Test-Bound (パラメータ検証)
    │
    ├─ Get-DbaAgListener (SqlInstance指定時)
    │      └─ Get-DbaAvailabilityGroup
    │
    ├─ ShouldProcess (確認ダイアログ)
    │
    └─ AvailabilityGroupListeners[name].Drop()
```

### データフロー図

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

SqlInstance ───▶ Get-DbaAgListener ────┐
                                       │
InputObject ───────────────────────────┼─▶ Listenerオブジェクト
                                       │
Listener (filter) ─────────────────────┘
                                       │
                                       ▼
                                Drop()呼び出し
                                       │
                                       ▼
                            PSCustomObject出力 ───▶ パイプライン
                            ├─ ComputerName
                            ├─ InstanceName
                            ├─ SqlInstance
                            ├─ AvailabilityGroup
                            ├─ Listener
                            └─ Status: "Removed"
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Remove-DbaAgListener.ps1 | `public/Remove-DbaAgListener.ps1` | ソース | メインコマンド実装 |
| Get-DbaAgListener.ps1 | `public/Get-DbaAgListener.ps1` | ソース | リスナー取得 |
| Add-DbaAgListener.ps1 | `public/Add-DbaAgListener.ps1` | ソース | リスナー追加コマンド（関連） |
| Set-DbaAgListener.ps1 | `public/Set-DbaAgListener.ps1` | ソース | リスナー設定変更コマンド（関連） |
