# 機能設計書 285-Remove-DbaEndpoint

## 概要

本ドキュメントは、SQL Server エンドポイントを削除する Remove-DbaEndpoint コマンドの機能設計書です。

### 本機能の処理概要

Remove-DbaEndpoint は、SQL Server インスタンス上の DatabaseMirroring、ServiceBroker、Soap、TSql タイプのエンドポイントを削除する PowerShell コマンドです。

**業務上の目的・背景**：サーバーの廃止、高可用性構成の解除、セキュリティ強化のための不要エンドポイント削除など、様々な場面でエンドポイントの削除が必要になります。本機能は、特定のエンドポイントを選択的に削除したり、全エンドポイントを一括削除したりすることで、管理作業を効率化します。確認プロンプトにより誤削除を防止し、パイプライン入力により柔軟なワークフローを実現します。

**機能の利用シーン**：
- サーバー廃止・移行時のクリーンアップ
- 高可用性構成（AG、ミラーリング）の解除
- 未使用エンドポイントの削除によるセキュリティ強化
- 構成変更に伴うエンドポイントの再作成準備
- テスト環境のクリーンアップ

**主要な処理内容**：
1. 削除対象エンドポイントの特定（名前指定、全件指定、パイプライン入力）
2. 確認プロンプトの表示（ShouldProcess）
3. DROP ENDPOINT ステートメントの実行
4. 処理結果のパイプライン出力

**関連システム・外部連携**：SQL Server に対して直接 DROP ENDPOINT クエリを実行します。Get-DbaEndpoint と組み合わせて使用されることが多いです。

**権限による制御**：エンドポイントの削除には sysadmin 権限または ALTER ANY ENDPOINT 権限が必要です。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | SSMS Server Objects > Endpoints | 参照画面 | エンドポイント確認 |
| - | PowerShell Console | 主画面 | コマンド実行 |

## 機能種別

削除操作（DROP ENDPOINT）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No | 対象 SQL Server インスタンス | 有効なインスタンス名 |
| SqlCredential | PSCredential | No | 代替認証情報 | - |
| Endpoint | string[] | No | 削除するエンドポイント名 | SqlInstance 使用時は必須（AllEndpoints と排他） |
| AllEndpoints | switch | No | 全エンドポイント削除フラグ | SqlInstance 使用時は必須（Endpoint と排他） |
| InputObject | Microsoft.SqlServer.Management.Smo.Endpoint[] | No | パイプライン入力されたエンドポイントオブジェクト | - |
| EnableException | switch | No | 例外スロー有効化 | - |

### 入力データソース

- PowerShell コマンドライン引数
- Get-DbaEndpoint からのパイプライン入力
- SQL Server インスタンスのエンドポイントメタデータ

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Server ホスト名 |
| InstanceName | string | インスタンス名 |
| SqlInstance | string | 完全修飾インスタンス名 |
| Endpoint | string | 削除されたエンドポイント名 |
| Status | string | 処理結果（常に "Removed"） |

### 出力先

PowerShell パイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. パラメータ検証
   └─ SqlInstance 使用時は Endpoint または AllEndpoints が必要
2. SqlInstance からエンドポイントを取得
   └─ Get-DbaEndpoint で対象を特定し InputObject に追加
3. 各エンドポイントに対して削除処理
   ├─ ShouldProcess で確認
   ├─ DROP ENDPOINT クエリ実行
   └─ 結果オブジェクト出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{SqlInstance 指定?}
    B -->|Yes| C{Endpoint or AllEndpoints<br/>指定あり?}
    C -->|No| D[エラー終了]
    C -->|Yes| E[Get-DbaEndpoint で取得]
    B -->|No| F[InputObject ループ開始]
    E --> F
    F --> G{ShouldProcess?}
    G -->|No| F
    G -->|Yes| H[DROP ENDPOINT 実行]
    H --> I{成功?}
    I -->|Yes| J[Status=Removed 出力]
    I -->|No| K[Stop-Function]
    J --> F
    K --> F
    F -->|完了| L[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | パラメータ必須チェック | SqlInstance 使用時は Endpoint または AllEndpoints が必要 | SqlInstance 指定時 |
| BR-002 | 確認プロンプト | ConfirmImpact=High により削除前に確認 | 常時 |
| BR-003 | 直接クエリ実行 | SMO の列挙問題を避けるため直接 DROP ENDPOINT を実行 | 常時 |

### 計算ロジック

特になし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| エンドポイント削除 | sys.endpoints | DELETE | DROP ENDPOINT 実行 |

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

#### sys.endpoints

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | name | 指定されたエンドポイント名 | DROP ENDPOINT |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | パラメータ不足 | SqlInstance 使用時に Endpoint/AllEndpoints 未指定 | Endpoint または AllEndpoints を指定 |
| - | 削除失敗 | エンドポイントが使用中、権限不足等 | エラーメッセージを確認 |

### リトライ仕様

リトライは実装されていません。失敗時は Stop-Function でエラー出力して続行します。

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

DROP ENDPOINT は暗黙的トランザクションで実行されます。各エンドポイントの削除は独立して処理されます。

## パフォーマンス要件

特に定義されていません。

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

- sysadmin 権限または ALTER ANY ENDPOINT 権限が必要
- SQL Server 認証または Windows 認証を使用
- ConfirmImpact=High により誤削除を防止

## 備考

- SupportsShouldProcess を実装（-WhatIf, -Confirm 対応）
- ConfirmImpact は High に設定
- SMO の列挙問題を避けるため、$ep.Parent.Query("DROP ENDPOINT $ep") を使用

---

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

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

### 推奨読解順序

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

出力オブジェクトの構造を理解します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Remove-DbaEndpoint.ps1 | `public/Remove-DbaEndpoint.ps1` | 104-110行目: 出力オブジェクトの構造 |

**読解のコツ**: PSCustomObject で ComputerName, InstanceName, SqlInstance, Endpoint, Status を出力していることを確認します。

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

パラメータ定義とバリデーションを確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Remove-DbaEndpoint.ps1 | `public/Remove-DbaEndpoint.ps1` | パラメータ定義 |

**主要処理フロー**:
1. **80-89行目**: パラメータ定義（SqlInstance, Endpoint, AllEndpoints, InputObject 等）
2. **91-94行目**: パラメータ検証

#### Step 3: 削除処理の実装を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Remove-DbaEndpoint.ps1 | `public/Remove-DbaEndpoint.ps1` | process ブロックのメインロジック |

**主要処理フロー**:
- **95-97行目**: Get-DbaEndpoint でエンドポイント取得
- **99-115行目**: 各エンドポイントに対する削除処理
- **103行目**: DROP ENDPOINT クエリの直接実行

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

```
Remove-DbaEndpoint
    │
    ├─ パラメータ検証
    │      └─ SqlInstance 使用時は Endpoint/AllEndpoints 必須
    │
    ├─ [SqlInstance] Get-DbaEndpoint
    │      └─ 対象エンドポイント取得
    │
    └─ foreach Endpoint
           │
           ├─ ShouldProcess 確認
           │
           └─ $ep.Parent.Query("DROP ENDPOINT $ep")
                  │
                  └─ 結果オブジェクト出力
```

### データフロー図

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

SqlInstance ────────┐
                    │
SqlCredential ──────┼──▶ Get-DbaEndpoint ──▶ InputObject
                    │           │
Endpoint ───────────┤           │
                    │           │
AllEndpoints ───────┤           │
                    │           ▼
InputObject ────────┴──▶ foreach Endpoint
                                │
                                ├──▶ ShouldProcess?
                                │
                                └──▶ DROP ENDPOINT クエリ
                                          │
                                          ▼
                                   PSCustomObject ──▶ パイプライン出力
                                   (ComputerName, InstanceName,
                                    SqlInstance, Endpoint, Status)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Remove-DbaEndpoint.ps1 | `public/Remove-DbaEndpoint.ps1` | ソース | メイン関数実装 |
| Remove-DbaEndpoint.Tests.ps1 | `tests/Remove-DbaEndpoint.Tests.ps1` | テスト | ユニット・統合テスト |
| Get-DbaEndpoint.ps1 | `public/Get-DbaEndpoint.ps1` | ソース | エンドポイント取得（依存） |
| New-DbaEndpoint.ps1 | `public/New-DbaEndpoint.ps1` | ソース | エンドポイント作成（関連） |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server 接続（依存） |
