# 機能設計書 697-Stop-DbaService

## 概要

本ドキュメントは、SQL Server関連のWindowsサービスを停止するdbatools PowerShellコマンド `Stop-DbaService` の機能設計書です。

### 本機能の処理概要

`Stop-DbaService` は、1台以上のコンピューターにまたがるSQL Server関連サービスを、サービス依存関係を適切に処理しながら停止する機能です。Database Engine、SQL Agent、Reporting Services、Analysis Services、Integration Services、PolyBase、Launchpadなど、SQL Serverの各種サービスを対象とします。

**業務上の目的・背景**：計画的なメンテナンスウィンドウ、トラブルシューティング、パッチ適用前の準備などにおいて、SQL Server関連サービスを安全に停止する必要があります。Database Engineを停止する際には、SQL Agentなどの依存サービスを先に停止しないと依存関係エラーが発生します。Forceパラメータを使用することで、これらの依存サービスを自動的に停止できます。

**機能の利用シーン**：
- 計画的なメンテナンスウィンドウでのサービス停止
- サーバー再起動前の安全なサービス停止
- トラブルシューティング時のサービス停止
- パッチ適用準備

**主要な処理内容**：
1. 対象サービスの取得（Get-DbaService呼び出しまたはパイプライン入力）
2. Force指定時は依存サービス（Agent, PolyBase）を自動追加
3. サービスの停止処理（Update-ServiceStatus -Action stop）
4. 処理結果の出力

**関連システム・外部連携**：Windows Service Control Manager、SQL Server関連Windowsサービス

**権限による制御**：対象コンピューターでのローカル管理者権限が必要

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| N/A | コマンドライン | 主画面 | PowerShellコンソールからの直接実行 |

## 機能種別

サービス管理 / 操作実行

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| ComputerName | DbaInstanceParameter[] | No | サービス停止対象のコンピューター名 | Serverパラメータセット、デフォルト$env:COMPUTERNAME |
| InstanceName | string[] | No | 特定のSQL Serverインスタンス名でフィルタリング | なし |
| SqlInstance | DbaInstanceParameter[] | No | コンピューター名とインスタンス名の組み合わせで指定 | Serverパラメータセット |
| Credential | PSCredential | No | 代替資格情報でコンピューターに接続 | なし |
| Type | string[] | No | サービスタイプでフィルタリング（Agent, Browser, Engine, FullText, SSAS, SSIS, SSRS, PolyBase, Launchpad） | ValidateSet |
| InputObject | object[] | Yes (Service) | Get-DbaServiceからのサービスオブジェクト | パイプライン入力、Serviceパラメータセット |
| Timeout | int | No | 各サービス操作のタイムアウト秒数 | デフォルト60秒、0で無限待機 |
| Force | switch | No | Engineサービス停止時に依存サービスを自動的に停止 | なし |
| EnableException | switch | No | 例外を有効にし、try/catchでのキャッチを可能にする | なし |
| WhatIf | switch | No | 実行せずに処理内容を表示 | なし |
| Confirm | switch | No | 実行前に確認プロンプトを表示 | なし |

### 入力データソース

- Get-DbaServiceから取得したサービスオブジェクト
- パイプライン入力

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | サービスが実行されているコンピューター名 |
| ServiceName | string | Windowsサービス名 |
| InstanceName | string | SQL Serverインスタンス名 |
| ServiceType | string | サービスタイプ（Engine, Agent, Browser等） |
| State | string | サービスの状態 |
| Status | string | 停止操作の結果（Successful, Failed） |
| Message | string | 詳細なステータスメッセージ |

### 出力先

PowerShellパイプライン (Microsoft.SqlServer.Management.Smo.Wmi.Service)

## 処理フロー

### 処理シーケンス

```
1. begin ブロック
   ├─ Force指定時はConfirmPreferenceを'none'に設定
   ├─ processArray初期化
   └─ Serverパラメータセットの場合、Get-DbaServiceでサービス取得

2. process ブロック
   └─ InputObjectをprocessArrayに追加

3. end ブロック
   ├─ InstanceName/Typeでフィルタリング
   ├─ Force指定時
   │   └─ 各Engineサービスに対して依存サービス（Agent, PolyBase）を追加
   ├─ ShouldProcess確認
   ├─ Update-ServiceStatus -Action stop でサービス停止
   └─ 結果を出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{Force指定?}
    B -->|Yes| C[ConfirmPreference=none]
    B -->|No| D{Serverパラメータセット?}
    C --> D
    D -->|Yes| E[Get-DbaServiceでサービス取得]
    D -->|No| F[パイプラインからInputObject受信]
    E --> F
    F --> G[processArrayにサービス追加]
    G --> H[InstanceName/Typeでフィルタリング]
    H --> I{Force指定?}
    I -->|Yes| J{Engineサービスあり?}
    J -->|Yes| K[依存サービス追加]
    J -->|No| L{ShouldProcess?}
    I -->|No| L
    K --> L
    L -->|No| M[終了]
    L -->|Yes| N{サービスあり?}
    N -->|No| O[警告メッセージ出力]
    N -->|Yes| P[Update-ServiceStatus stop]
    O --> M
    P --> Q[結果出力]
    Q --> M
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 権限要件 | ローカル管理者権限が必要 | 常時 |
| BR-002 | 依存サービス自動追加 | Force指定時、EngineサービスにAgent, PolyBaseを追加 | Force指定時 |
| BR-003 | タイムアウト | デフォルト60秒、0で無限待機 | 常時 |
| BR-004 | 確認スキップ | Force指定時はConfirmPreferenceをnoneに設定 | Force指定時 |
| BR-005 | ConfirmImpact | Mediumに設定 | 常時 |

### 計算ロジック

依存サービス追加ロジック（Force指定時）:
```powershell
$dependentTypes = @('Agent', 'PolyBase')
foreach ($depType in $dependentTypes) {
    if (!($processArray | Where-Object { $_.ServiceType -eq $depType -and $_.InstanceName -eq $service.InstanceName -and $_.ComputerName -eq $service.ComputerName })) {
        # 依存サービスを追加
    }
}
```

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

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

本機能はデータベースを直接操作しませんが、SQL Serverサービスの停止によりデータベース接続が中断されます。

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| N/A | N/A | サービス操作 | SQL Serverサービスの停止 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| N/A | 依存関係エラー | 依存サービスが実行中の状態でEngineを停止 | Forceスイッチを使用して依存サービスも停止 |
| N/A | サービス停止失敗 | サービス停止がタイムアウトまたはエラー | サービスのイベントログを確認 |
| ObjectNotFound | サービス未検出 | 指定条件に一致するサービスがない | パラメータ条件を確認 |
| N/A | 権限エラー | ローカル管理者権限がない場合 | 適切な資格情報でCredentialパラメータを使用 |

### リトライ仕様

明示的なリトライ機能は実装されていません。

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

サービス操作はトランザクション的ではありません。

## パフォーマンス要件

- デフォルトタイムアウト: 60秒
- 複数サービスの停止は順次処理

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

- 対象コンピューターでのローカル管理者権限が必要
- Credentialパラメータによる代替資格情報のサポート
- ShouldProcess/Confirmによる実行前確認
- ConfirmImpactはMediumに設定

## 備考

- サービスが既に停止している場合、操作はスキップされます
- 依存関係エラーを避けるため、Forceスイッチの使用を推奨
- Restart-DbaServiceとは異なり、Launchpadは依存サービスに含まれていない

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaService出力 | (Get-DbaService参照) | ServiceName, ServiceType, InstanceName, ComputerName などのプロパティ構造 |

**読解のコツ**: Stop-DbaServiceは Get-DbaService から取得したサービスオブジェクトを処理します。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Stop-DbaService.ps1 | `public/Stop-DbaService.ps1` | メイン関数の構造、パラメータ定義 |

**主要処理フロー**:
1. **119-137行目**: パラメータ定義（2つのパラメータセット: Server, Service）
2. **138-150行目**: begin ブロック - Force時のConfirmPreference設定、Serverパラメータセットの場合にGet-DbaService呼び出し
3. **151-154行目**: process ブロック - InputObjectをprocessArrayに追加
4. **155-190行目**: end ブロック - メイン処理
5. **156行目**: フィルタリング処理
6. **157-175行目**: Force指定時の依存サービス追加
7. **176-189行目**: サービス停止処理

#### Step 3: 依存関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaService.ps1 | `public/Get-DbaService.ps1` | サービス情報取得 |
| 3-2 | Update-ServiceStatus.ps1 | `private/functions/Update-ServiceStatus.ps1` | 実際のサービス操作 |

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

```
Stop-DbaService
    │
    ├─ Get-DbaService (148行目, Serverパラメータセット)
    │      └─ サービス情報を取得
    │
    ├─ Get-DbaService (171行目, Force時の依存サービス取得)
    │      └─ 依存サービス情報を取得
    │
    └─ Update-ServiceStatus (178-185行目)
           └─ -Action stop: サービス停止
```

### データフロー図

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

ComputerName ───▶ Get-DbaService ───▶ サービスオブジェクト
                         │
InstanceName ───▶ フィルタリング
                         │
Type ───────────▶        │
                         ▼
InputObject ─────────▶ processArray
                         │
                         ▼
Force ───────────▶ 依存サービス追加 (Agent, PolyBase)
                         │
                         ▼
                  Update-ServiceStatus (stop) ───▶ 停止結果
                         │
                         ▼
                  Service オブジェクト
                  (ComputerName, ServiceName, InstanceName,
                   ServiceType, State, Status, Message)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Stop-DbaService.ps1 | `public/Stop-DbaService.ps1` | ソース | メイン機能実装 |
| Get-DbaService.ps1 | `public/Get-DbaService.ps1` | ソース | サービス情報取得 |
| Update-ServiceStatus.ps1 | `private/functions/Update-ServiceStatus.ps1` | ソース | サービス操作実行 |
| Stop-DbaService.Tests.ps1 | `tests/Stop-DbaService.Tests.ps1` | テスト | テストコード |
