# 機能設計書 93-Get-DbaCmConnection

## 概要

本ドキュメントは、dbatoolsがキャッシュしているWindows管理およびCIM接続情報を取得するGet-DbaCmConnectionコマンドの機能設計書である。

### 本機能の処理概要

Get-DbaCmConnectionは、dbatoolsがリモートコンピュータへのアクセスに使用するキャッシュされた接続情報を表示する機能である。これにより、どの認証コンテキストがアクティブであるかを把握し、接続問題のトラブルシューティングに役立てることができる。

**業務上の目的・背景**：dbatoolsのコマンドがリモートSQL Serverホストに対してWindowsサービス、レジストリ、ファイルシステムにアクセスする際、自動的にキャッシュ接続が作成される。本機能はこれらのキャッシュされた接続情報を可視化し、接続問題の診断や認証状態の確認を可能にする。

**機能の利用シーン**：リモートSQL Serverホストへの接続問題のトラブルシューティング、使用されている認証コンテキストの確認、特定のサービスアカウントを使用している接続の検索、および接続キャッシュの状態確認時に利用される。

**主要な処理内容**：
1. 内部接続キャッシュ（ConnectionHost.Connections）からフィルタ条件に一致する接続を取得
2. ComputerNameパターンでのフィルタリング
3. UserNameパターンでのフィルタリング
4. マッチした接続オブジェクトを出力

**関連システム・外部連携**：dbatoolsの内部接続管理システム（Dataplat.Dbatools.Connection.ConnectionHost）を参照する。

**権限による制御**：特別な権限は不要。キャッシュ情報の読み取りのみ。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | コマンドラインインターフェース | 主画面 | PowerShellコンソールまたはスクリプトから実行 |

## 機能種別

データ取得（内部キャッシュからの読み取り操作）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| ComputerName | String[] | No | コンピュータ名でフィルタ（ワイルドカード対応、デフォルト: "*"） | パイプライン入力可能 |
| UserName | String | No | ユーザー名でフィルタ（ワイルドカード対応、デフォルト: "*"） | - |
| EnableException | Switch | No | 例外処理を有効化 | - |

### 入力データソース

dbatoolsの内部接続キャッシュ（`[Dataplat.Dbatools.Connection.ConnectionHost]::Connections.Values`）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | String | リモートコンピュータ名 |
| Available | Boolean | 接続プロトコルが利用可能かどうか |
| User | String | 接続に使用されているユーザー名 |
| OverrideExplicitCredential | Boolean | キャッシュ認証情報を優先使用するか |
| DisabledConnectionTypes | Enum | 無効化された接続プロトコル |
| Credentials | PSCredential | 格納されている認証情報 |
| UseWindowsCredentials | Boolean | Windows認証を使用するか |
| CimRM | Status | CIM over WinRMの接続テスト結果 |
| CimDCOM | Status | CIM over DCOMの接続テスト結果 |
| Wmi | Status | WMIプロトコルの接続テスト結果 |
| PowerShellRemoting | Status | PowerShellリモーティングの接続テスト結果 |

### 出力先

PowerShellパイプラインに直接出力される

## 処理フロー

### 処理シーケンス

```
1. Begin処理：ログ出力開始
   └─ Write-Messageでパラメータバインド情報を記録
2. Process処理：各ComputerNameパターンに対してフィルタ
   └─ ConnectionHost.Connectionsから条件に一致する接続を抽出
3. End処理：ログ出力終了
   └─ Write-Messageで処理終了を記録
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[パラメータバインド記録]
    B --> C{各ComputerNameパターンをループ}
    C --> D[ConnectionHost.Connections.Values取得]
    D --> E[ComputerNameでフィルタ]
    E --> F[UserNameでフィルタ]
    F --> G[結果出力]
    G --> C
    C -->|完了| H[終了ログ]
    H --> I[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-93-1 | ワイルドカードフィルタ | ComputerNameとUserNameは-likeでワイルドカード検索 | パターン指定時 |
| BR-93-2 | デフォルトパターン | パラメータ未指定時は"*"（全件マッチ） | パラメータ省略時 |

### 計算ロジック

該当なし

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

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

本機能はデータベースにアクセスしない。dbatoolsの内部メモリキャッシュのみを参照する。

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | - | 本機能は読み取りのみのため、エラーが発生する可能性は低い | - |

### リトライ仕様

リトライ機構は不要（メモリキャッシュの参照のみ）

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

該当なし（メモリキャッシュの参照のみ）

## パフォーマンス要件

メモリキャッシュの参照のみのため、パフォーマンスへの影響は極めて小さい。

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

- キャッシュされた認証情報（Credentialsプロパティ）が公開される可能性がある
- 出力内容には機密性のある認証情報が含まれる場合がある

## 備考

- 接続キャッシュはdbatoolsコマンドの実行時に自動的に作成される
- Test-DbaCmConnectionでプリテストと最適な接続方法の構成が可能

---

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

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

### 推奨読解順序

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

出力されるオブジェクトはDataplat.Dbatools.Connection.ManagementConnectionである。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaCmConnection.ps1 | `public/Get-DbaCmConnection.ps1` | 行22-47の.OUTPUTSセクションで返却オブジェクトのプロパティを確認 |

**読解のコツ**: ManagementConnectionオブジェクトはdbatools内部で定義されている.NETクラス。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaCmConnection.ps1 | `public/Get-DbaCmConnection.ps1` | 関数全体の構造（begin/process/end） |

**主要処理フロー**:
1. **83-86行目**: begin ブロック - ログ記録
2. **87-91行目**: process ブロック - フィルタ処理
3. **90行目**: ConnectionHost.Connections.Valuesからのフィルタ（Where-Object）
4. **93-95行目**: end ブロック - 終了ログ

#### Step 3: フィルタ処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaCmConnection.ps1 | `public/Get-DbaCmConnection.ps1` | 90行目のWhere-Object条件 |

**主要処理フロー**:
- **90行目**: `($_.ComputerName -like $name) -and ($_.Credentials.UserName -like $UserName)`でフィルタ

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

```
Get-DbaCmConnection
    │
    ├─ begin
    │      └─ Write-Message (ログ)
    │
    ├─ process
    │      └─ ConnectionHost.Connections.Values
    │             └─ Where-Object (フィルタ)
    │
    └─ end
           └─ Write-Message (ログ)
```

### データフロー図

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

ComputerName   ───▶ パターンマッチング   ───▶ フィルタ済み接続
UserName       ───▶ (Where-Object)       ───▶ ManagementConnection
                           │                    オブジェクト
                           ▼
              ConnectionHost.Connections
              (内部キャッシュ)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaCmConnection.ps1 | `public/Get-DbaCmConnection.ps1` | ソース | メイン機能実装 |
| ConnectionHost.cs | `library/Dataplat.Dbatools/Connection/ConnectionHost.cs` | ソース | 接続キャッシュ管理クラス |
| ManagementConnection.cs | `library/Dataplat.Dbatools/Connection/ManagementConnection.cs` | ソース | 接続オブジェクト定義 |
