# 機能設計書 288-Stop-DbaEndpoint

## 概要

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

### 本機能の処理概要

Stop-DbaEndpoint は、稼働中の SQL Server エンドポイントを停止して、新規ネットワーク接続を受け付けない状態にする PowerShell コマンドです。

**業務上の目的・背景**：メンテナンスウィンドウ中やトラブルシューティング時に、Service Broker、Database Mirroring、カスタム TCP エンドポイントを一時的に停止する必要があることがあります。本機能は、エンドポイントを削除せずに安全に停止し、後で Start-DbaEndpoint で再開できる状態を維持します。これにより、計画的なメンテナンスや問題切り分けが可能になります。

**機能の利用シーン**：
- 計画的メンテナンスウィンドウでのエンドポイント停止
- 接続性問題のトラブルシューティング
- セキュリティインシデント対応での即時停止
- リソース競合解消のための一時停止
- 構成変更前の安全停止

**主要な処理内容**：
1. 停止対象エンドポイントの特定（名前指定、全件指定、パイプライン入力）
2. 確認プロンプトの表示（ShouldProcess、ConfirmImpact=High）
3. Stop() メソッドの実行
4. 更新されたエンドポイントオブジェクトの出力

**関連システム・外部連携**：SQL Server Management Objects (SMO) を介してエンドポイントを停止します。Get-DbaEndpoint と組み合わせて使用されることが多いです。

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

## 関連画面

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

## 機能種別

状態変更操作（ALTER ENDPOINT ... STATE = STOPPED）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| 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 インスタンスのエンドポイントメタデータ

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| Microsoft.SqlServer.Management.Smo.Endpoint | SMO オブジェクト | 停止されたエンドポイントオブジェクト |

出力には以下のプロパティが含まれます：

| 項目名 | 型 | 説明 |
|--------|-----|------|
| Name | string | エンドポイント名 |
| EndpointState | EndpointState | エンドポイント状態（Stopped） |
| EndpointType | EndpointType | エンドポイントタイプ |
| ProtocolType | ProtocolType | プロトコルタイプ |
| Owner | string | 所有者 |
| IsAdminEndpoint | bool | 管理エンドポイントフラグ |
| IsSystemObject | bool | システムオブジェクトフラグ |

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. パラメータ検証
   └─ SqlInstance 使用時は Endpoint または AllEndpoints が必要
2. SqlInstance からエンドポイントを取得
   └─ Get-DbaEndpoint で対象を特定し InputObject に追加
3. 各エンドポイントに対して停止処理
   ├─ ShouldProcess で確認（ConfirmImpact=High）
   ├─ Stop() メソッド実行
   └─ エンドポイントオブジェクト出力
```

### フローチャート

```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?<br/>ConfirmImpact=High}
    G -->|No| F
    G -->|Yes| H[$ep.Stop]
    H --> I{成功?}
    I -->|Yes| J[$ep 出力]
    I -->|No| K[Stop-Function]
    J --> F
    K --> F
    F -->|完了| L[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | パラメータ必須チェック | SqlInstance 使用時は Endpoint または AllEndpoints が必要 | SqlInstance 指定時 |
| BR-002 | 高影響確認 | ConfirmImpact=High により停止前に確認プロンプトを表示 | 常時 |
| BR-003 | 状態変更 | Stop() メソッドでエンドポイントを Stopped 状態に変更 | 常時 |

### 計算ロジック

特になし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| エンドポイント停止 | sys.endpoints | UPDATE | ALTER ENDPOINT ... STATE = STOPPED 相当 |

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

#### sys.endpoints

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| UPDATE | state | STOPPED | Stop() メソッド実行時 |

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

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

各エンドポイントの Stop() は独立した操作として実行されます。

## パフォーマンス要件

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

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

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

## 備考

- SupportsShouldProcess を実装（-WhatIf, -Confirm 対応）
- ConfirmImpact は High に設定（停止は重大な操作のため）
- SMO Endpoint オブジェクトをそのまま出力

---

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

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

### 推奨読解順序

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

SMO Endpoint オブジェクトの状態プロパティを理解します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Stop-DbaEndpoint.ps1 | `public/Stop-DbaEndpoint.ps1` | 106-107行目: Stop() メソッド実行と出力 |

**読解のコツ**: SMO Endpoint オブジェクトの EndpointState プロパティが Stop() メソッドで Stopped に変わることを確認します。

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

パラメータ定義と ConfirmImpact=High を確認します。

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

**主要処理フロー**:
1. **84行目**: CmdletBinding で ConfirmImpact = 'High' を設定
2. **84-93行目**: パラメータ定義（SqlInstance, Endpoint, AllEndpoints, InputObject 等）

#### Step 3: 停止処理の実装を理解する

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

**主要処理フロー**:
- **95-98行目**: パラメータ検証
- **99-101行目**: Get-DbaEndpoint でエンドポイント取得
- **103-112行目**: 各エンドポイントに対する停止処理

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

```
Stop-DbaEndpoint
    │
    ├─ パラメータ検証
    │      └─ SqlInstance 使用時は Endpoint/AllEndpoints 必須
    │
    ├─ [SqlInstance] Get-DbaEndpoint
    │      └─ 対象エンドポイント取得
    │
    └─ foreach Endpoint
           │
           ├─ ShouldProcess 確認 (ConfirmImpact=High)
           │
           ├─ $ep.Stop()
           │
           └─ $ep 出力
```

### データフロー図

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

SqlInstance ────────┐
                    │
SqlCredential ──────┼──▶ Get-DbaEndpoint ──▶ InputObject
                    │           │
Endpoint ───────────┤           │
                    │           │
AllEndpoints ───────┤           │
                    │           ▼
InputObject ────────┴──▶ foreach Endpoint
                                │
                                ├──▶ ShouldProcess? (High)
                                │
                                └──▶ $ep.Stop()
                                          │
                                          ▼
                                   SMO Endpoint ──▶ パイプライン出力
                                   (EndpointState = Stopped)
```

### 関連ファイル一覧

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