# 機能設計書 551-Get-DbaCredential

## 概要

本ドキュメントは、SQL Server資格情報（Credential）の取得機能について、その処理内容、入出力仕様、および実装詳細を記述した機能設計書である。

### 本機能の処理概要

Get-DbaCredentialは、SQL Serverインスタンスに構成されている資格情報（Credential）を取得するPowerShellコマンドレットである。資格情報は外部リソース（ファイル共有、Webサービス、他のSQL Serverインスタンスなど）へのアクセス時にSQL Serverサービスが使用する認証情報として保存されており、本機能によりその詳細情報を確認できる。

**業務上の目的・背景**：SQL Server環境では、バックアップのネットワーク保存先へのアクセス、外部データソースへの接続、SQL Agentジョブによる外部システム連携など、様々な場面で資格情報が必要となる。セキュリティ監査やコンプライアンス対応において、どのような資格情報が設定されているか、どのIDでアクセスしているかを把握することは重要である。本機能はこれらの要件に対応するため、資格情報の一覧取得と詳細確認を提供する。

**機能の利用シーン**：
- セキュリティ監査時の資格情報棚卸し
- バックアップジョブで使用するサービスアカウントの確認
- 外部データソース接続に使用している認証情報の確認
- 暗号化キー管理（EKM）用資格情報の管理

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスへの接続確立
2. サーバーに登録されている資格情報（Credentials）コレクションの取得
3. 名前、ID、除外条件によるフィルタリング
4. 各資格情報へのインスタンス情報（ComputerName、InstanceName、SqlInstance）の付与
5. 既定のビュープロパティを適用した結果の出力

**関連システム・外部連携**：
- SMO（SQL Server Management Objects）を使用してSQL Serverに接続
- Connect-DbaInstanceコマンドレットによる接続管理
- Windows認証、SQL認証、Active Directory認証に対応

**権限による制御**：資格情報の参照には、SQL Serverでの適切な権限（VIEW ANY DEFINITION等）が必要である。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 74 | 資格情報管理 | 主画面 | 資格情報の取得 |

## 機能種別

データ取得（SELECT）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 対象のSQL Serverインスタンス。パイプライン入力対応 | 有効なSQL Serverインスタンス名 |
| SqlCredential | PSCredential | No | 接続に使用する代替資格情報 | Get-Credentialで取得した資格情報 |
| Credential | string[] | No | 取得する資格情報名（Name）でフィルタ。ワイルドカード対応。エイリアス: Name | - |
| ExcludeCredential | string[] | No | 除外する資格情報名。エイリアス: ExcludeName | - |
| Identity | string[] | No | 指定したIDでフィルタ。エイリアス: CredentialIdentity | - |
| ExcludeIdentity | string[] | No | 除外するID。エイリアス: ExcludeCredentialIdentity | - |
| EnableException | switch | No | 例外処理の有効化。trueの場合は例外をスロー | - |

### 入力データソース

- SQL Serverインスタンス（$server.Credentials）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverが稼働するコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名（computer\instance） |
| ID | int | 資格情報の一意識別子 |
| Name | string | 資格情報の名前 |
| Identity | string | 使用するWindows ID、ログイン、または外部ID |
| MappedClassType | string | 資格情報クラスタイプ（None/CryptographicProvider） |
| ProviderName | string | 暗号化プロバイダー名（EKM使用時） |

### 出力先

- PowerShellパイプライン（Microsoft.SqlServer.Management.Smo.Credential型）

## 処理フロー

### 処理シーケンス

```
1. パラメータバインディング
   └─ SqlInstance、フィルタ条件の受け取り

2. foreach ($instance in $SqlInstance) ループ開始
   └─ 各インスタンスに対して処理実行

3. SQL Serverへの接続
   └─ Connect-DbaInstanceによる接続確立
   └─ 接続失敗時はStop-Functionで継続処理

4. 資格情報コレクションの取得
   └─ $server.Credentialsの参照

5. フィルタリング処理
   └─ Credential（Name）による絞り込み
   └─ ExcludeCredentialによる除外
   └─ Identityによる絞り込み
   └─ ExcludeIdentityによる除外

6. 結果の出力
   └─ Add-Memberでインスタンス情報を追加
   └─ Select-DefaultViewで既定プロパティを選択
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[パラメータ受け取り]
    B --> C{各インスタンスをループ}
    C --> D[Connect-DbaInstance]
    D --> E{接続成功?}
    E -->|No| F[Stop-Function / Continue]
    F --> C
    E -->|Yes| G[$server.Credentials取得]
    G --> H{Credentialフィルタ?}
    H -->|Yes| I[Name絞り込み]
    H -->|No| J{ExcludeCredential?}
    I --> J
    J -->|Yes| K[Name除外]
    J -->|No| L{Identityフィルタ?}
    K --> L
    L -->|Yes| M[Identity絞り込み]
    L -->|No| N{ExcludeIdentity?}
    M --> N
    N -->|Yes| O[Identity除外]
    N -->|No| P[結果ループ]
    O --> P
    P --> Q[Add-Member: インスタンス情報追加]
    Q --> R[Select-DefaultView]
    R --> S[パイプライン出力]
    S --> C
    C -->|完了| T[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | パイプライン入力 | SqlInstanceパラメータはパイプラインからの入力を受け付ける | 常時 |
| BR-002 | 包含フィルタ | Credentialパラメータ指定時は名前が一致するもののみ返却 | Credential指定時 |
| BR-003 | 除外フィルタ | ExcludeCredentialパラメータ指定時は名前が一致するものを除外 | ExcludeCredential指定時 |
| BR-004 | ID包含フィルタ | Identityパラメータ指定時はIDが一致するもののみ返却 | Identity指定時 |
| BR-005 | ID除外フィルタ | ExcludeIdentityパラメータ指定時はIDが一致するものを除外 | ExcludeIdentity指定時 |

### 計算ロジック

特になし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 資格情報取得 | sys.credentials | SELECT | SMO経由で資格情報を取得 |

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

#### sys.credentials（SMO経由アクセス）

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | credential_id, name, credential_identity, mapped_class_type, provider_name等 | 全資格情報 | SMOのCredentialsコレクション経由 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ConnectionError | 接続エラー | SQL Serverへの接続失敗 | Stop-Functionで警告メッセージを出力し、次のインスタンスへ継続 |

### リトライ仕様

リトライは実装されていない。接続エラー時は次のインスタンスへスキップする。

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

読み取り専用操作のため、トランザクション制御は不要。

## パフォーマンス要件

- SMO経由でのメタデータ取得のため、通常は高速に完了
- 大量のインスタンスを処理する場合はパイプライン処理による逐次出力

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

- 資格情報のパスワードは取得できない（SQL Serverの制限）
- VIEW ANY DEFINITIONまたは同等の権限が必要
- SqlCredentialパラメータにより代替認証情報での接続が可能

## 備考

- Credentialパラメータのエイリアスとして「Name」が使用可能
- ワイルドカードを含む名前でスペースがある場合はクォートで囲む必要あり

---

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

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

### 推奨読解順序

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

SMOのCredentialオブジェクトは、SQL Serverの資格情報を表現するオブジェクトである。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaCredential.ps1 | `public/Get-DbaCredential.ps1` | 出力型（.OUTPUTS）セクションでMicrosoft.SqlServer.Management.Smo.Credentialを確認 |

**読解のコツ**: SMO Credentialオブジェクトのプロパティは、SQL Server Management Studioで資格情報を表示した際に見えるものと対応している。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaCredential.ps1 | `public/Get-DbaCredential.ps1` | function宣言とparamブロック（95-110行目） |

**主要処理フロー**:
1. **95-110行目**: パラメータ定義（CmdletBinding、パラメータ属性）
2. **112行目**: processブロック開始
3. **113行目**: foreachループでインスタンス処理開始

#### Step 3: 接続処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaCredential.ps1 | `public/Get-DbaCredential.ps1` | Connect-DbaInstance呼び出し（114-118行目） |

**主要処理フロー**:
- **114-118行目**: try-catchブロックでの接続処理、失敗時はStop-FunctionでContinue

#### Step 4: フィルタリング処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Get-DbaCredential.ps1 | `public/Get-DbaCredential.ps1` | フィルタリングロジック（120-136行目） |

**主要処理フロー**:
- **120行目**: $server.Credentialsで全資格情報取得
- **122-124行目**: Credentialパラメータによるフィルタ
- **126-128行目**: ExcludeCredentialによる除外
- **130-132行目**: Identityパラメータによるフィルタ
- **134-136行目**: ExcludeIdentityによる除外

#### Step 5: 出力処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 5-1 | Get-DbaCredential.ps1 | `public/Get-DbaCredential.ps1` | 出力オブジェクト生成（138-144行目） |

**主要処理フロー**:
- **139-141行目**: Add-MemberでComputerName、InstanceName、SqlInstanceを追加
- **143行目**: Select-DefaultViewで既定プロパティを選択して出力

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

```
Get-DbaCredential
    │
    ├─ Connect-DbaInstance
    │      └─ SQL Server SMO接続
    │
    ├─ $server.Credentials（SMO Credentialsコレクション）
    │
    ├─ Where-Object（フィルタリング）
    │
    ├─ Add-Member（プロパティ追加）
    │
    └─ Select-DefaultView（出力整形）
```

### データフロー図

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

SqlInstance ───▶ Connect-DbaInstance ───▶ SMO Server
                        │
                        ▼
              $server.Credentials ───▶ フィルタリング
                        │
                        ▼
              Add-Member ───▶ インスタンス情報付与
                        │
                        ▼
              Select-DefaultView ───▶ パイプライン出力
                                             │
                                             ▼
                                    Credential Objects
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaCredential.ps1 | `public/Get-DbaCredential.ps1` | ソース | メイン実装 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続機能 |
| Select-DefaultView.ps1 | `private/functions/flowcontrol/Select-DefaultView.ps1` | ソース | 既定プロパティ選択 |
| Stop-Function.ps1 | `private/functions/flowcontrol/Stop-Function.ps1` | ソース | エラー処理 |
