# 機能設計書 572-Remove-DbaCredential

## 概要

本ドキュメントは、SQL Server資格情報（Credential）を削除する `Remove-DbaCredential` 機能の設計仕様を定義するものです。

### 本機能の処理概要

`Remove-DbaCredential` は、SQL Serverインスタンスから資格情報（Credential）を削除するdbatools PowerShellコマンドレットです。資格情報は、プロキシアカウント、バックアップ暗号化、外部リソースアクセスなどに使用されるセキュリティオブジェクトであり、本コマンドにより不要になった資格情報を安全に削除できます。

**業務上の目的・背景**：SQL Serverの資格情報は、Windows認証や外部サービスへのアクセスに使用されます。ユーザーアカウントの無効化、サービスアカウントの変更、セキュリティポリシーの更新時に、不要な資格情報を適切に削除する必要があります。放置された資格情報はセキュリティリスクとなる可能性があります。

**機能の利用シーン**：
- サービスアカウントの廃止に伴う資格情報クリーンアップ
- セキュリティ監査後の不要資格情報の削除
- 環境移行時の資格情報整理
- 開発/テスト環境のリセット

**主要な処理内容**：
1. 対象SQL Serverインスタンスへの接続またはパイプライン入力の受け取り
2. Get-DbaCredentialによる対象資格情報の取得（SqlInstance指定時）
3. フィルタ条件（Credential、Identity、除外条件）の適用
4. ShouldProcessによる削除確認
5. SMOのDrop()メソッドによる資格情報の削除
6. 削除結果の出力

**関連システム・外部連携**：SQL Server SMOライブラリを使用。削除対象の資格情報がSQL Agent Proxyやその他機能で使用されている場合、依存関係エラーが発生する可能性があります。

**権限による制御**：ALTER ANY CREDENTIAL権限または同等の権限（sysadminメンバーシップ）が必要です。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| N/A | SSMS資格情報管理画面 | 参照画面 | GUIでの資格情報削除に相当する操作 |

## 機能種別

CRUD操作（Delete）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No* | 対象のSQL Serverインスタンス | 有効なインスタンス名 |
| SqlCredential | PSCredential | No | 代替認証情報 | 有効なPSCredentialオブジェクト |
| Credential | String[] | No | 削除対象の資格情報名（ワイルドカード対応） | - |
| ExcludeCredential | String[] | No | 除外する資格情報名（ワイルドカード対応） | - |
| Identity | String[] | No | フィルタ対象のID | - |
| ExcludeIdentity | String[] | No | 除外するID | - |
| InputObject | Credential[] | Yes* | パイプライン入力（Pipelineパラメータセット） | SMO Credentialオブジェクト |
| EnableException | Switch | No | 例外を有効化するスイッチ | - |

*SqlInstanceまたはInputObjectのいずれかが必須

### 入力データソース

- PowerShellコマンドライン入力
- パイプライン入力（Get-DbaCredentialからの出力）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | String | SQL Serverが動作するコンピュータ名 |
| InstanceName | String | SQL Serverインスタンス名 |
| SqlInstance | String | 完全なインスタンス名 |
| Name | String | 削除対象の資格情報名 |
| Status | String | 操作結果（"Dropped"または エラーメッセージ） |
| IsRemoved | Boolean | 削除成功フラグ |

### 出力先

- PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. begin ブロック
   └─ 空の資格情報コレクションを初期化
2. process ブロック
   ├─ SqlInstance指定時
   │   └─ Get-DbaCredentialでフィルタリングして取得
   └─ InputObject指定時
       └─ パイプライン入力を収集
3. end ブロック（削除実行）
   └─ 各資格情報に対して
       ├─ ShouldProcess確認
       ├─ Drop()メソッド実行
       └─ 結果オブジェクト出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[begin: コレクション初期化]
    B --> C{SqlInstance指定?}
    C -->|Yes| D[Get-DbaCredential呼び出し]
    D --> E[フィルタ適用・コレクション追加]
    C -->|No| F{InputObject?}
    F -->|Yes| G[コレクションに追加]
    F -->|No| H[処理終了]
    E --> I[end ブロック]
    G --> I
    I --> J[資格情報ループ開始]
    J --> K{ShouldProcess確認}
    K -->|No| L[スキップ]
    K -->|Yes| M[出力オブジェクト作成]
    M --> N[Drop()実行]
    N --> O{成功?}
    O -->|Yes| P[Status=Dropped, IsRemoved=True]
    O -->|No| Q[Status=エラー, IsRemoved=False]
    P --> R[結果出力]
    Q --> R
    L --> S{次の資格情報?}
    R --> S
    S -->|Yes| J
    S -->|No| T[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 依存関係チェック | 資格情報がProxy等で使用中の場合、削除失敗 | 常時 |
| BR-002 | 確認プロンプト | ConfirmImpact=Highにより、デフォルトで確認を要求 | Confirm:$false以外 |
| BR-003 | end ブロック処理 | パイプライン処理の"Collection was modified"エラー回避のためendブロックで削除 | 常時 |

### 計算ロジック

特に計算ロジックはありません。

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 資格情報削除 | sys.credentials | DELETE | 資格情報の削除 |

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

#### sys.credentials

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | credential_id | 対象資格情報のID | 完全削除 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ConnectionError | 接続エラー | インスタンスへの接続失敗 | 接続情報・ネットワーク確認 |
| DependencyError | 依存関係エラー | 資格情報がProxy等で使用中 | 依存オブジェクトを先に削除 |
| PermissionDenied | 権限エラー | ALTER ANY CREDENTIAL権限なし | 権限付与を依頼 |

### リトライ仕様

エラー発生時はStop-Functionで処理を中断し、エラーメッセージを含む結果オブジェクトを出力します。

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

SMOのDrop()メソッドによる暗黙的トランザクションで処理されます。失敗時は自動ロールバックされます。

## パフォーマンス要件

単一資格情報の削除は通常1秒以内で完了します。大量の資格情報を削除する場合は、Out-GridViewで選択するパターンが推奨されます。

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

- 認証情報はPSCredentialオブジェクトで安全に受け渡し
- ConfirmImpact=Highによるデフォルト確認プロンプト
- 削除操作は監査ログに記録される可能性あり

## 備考

- Get-DbaCredentialとの組み合わせによるパイプライン処理が推奨
- Out-GridViewを使用した対話的な削除選択が可能

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Credential (SMO) | Microsoft.SqlServer.Management.Smo | SMOのCredentialクラスの構造 |

**読解のコツ**: Credentialオブジェクトは、Name、Identity、Parentプロパティを持ち、Drop()メソッドで削除されます。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Remove-DbaCredential.ps1 | `public/Remove-DbaCredential.ps1` | 関数定義とパラメータバインディング |

**主要処理フロー**:
1. **88-100行目**: パラメータ定義（2つのパラメータセット）
2. **102-104行目**: begin ブロック - コレクション初期化
3. **106-114行目**: process ブロック - 資格情報収集
4. **117-140行目**: end ブロック - 削除実行

#### Step 3: 資格情報取得処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Remove-DbaCredential.ps1 | `public/Remove-DbaCredential.ps1` | Get-DbaCredentialとの連携 |

**主要処理フロー**:
- **107-114行目**: SqlInstance指定時はGet-DbaCredentialで取得、InputObjectはコレクションに追加

#### Step 4: 削除処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Remove-DbaCredential.ps1 | `public/Remove-DbaCredential.ps1` | end ブロックでの削除実行 |

**主要処理フロー**:
- **119-139行目**: 各資格情報に対してShouldProcess確認後、Drop()実行
- **121-128行目**: 出力オブジェクトの初期化
- **129-132行目**: Drop()成功時の処理
- **133-137行目**: Drop()失敗時のエラー処理

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

```
Remove-DbaCredential
    │
    ├─ Get-DbaCredential (SqlInstance指定時)
    │      └─ Connect-DbaInstance
    │
    ├─ $dbCredential.Drop() (SMO)
    │
    ├─ Stop-Function (エラー時)
    │
    └─ Get-ErrorMessage (エラーメッセージ取得)
```

### データフロー図

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

SqlInstance ───────▶ Get-DbaCredential ─────▶ Credentialコレクション
        or                                           │
InputObject ───────────────────────────────▶ ────────┘
                                                      │
                                                      ▼
                                              endブロック
                                                      │
                                              ShouldProcess確認
                                                      │
                                              Drop()実行
                                                      │
                                                      ▼
                                              PSCustomObject ──▶ パイプライン
                                              (Status, IsRemoved)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Remove-DbaCredential.ps1 | `public/Remove-DbaCredential.ps1` | ソース | メイン関数定義 |
| Get-DbaCredential.ps1 | `public/Get-DbaCredential.ps1` | ソース | 資格情報取得 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | インスタンス接続 |
| Stop-Function.ps1 | `private/functions/Stop-Function.ps1` | ソース | エラー処理 |
| Get-ErrorMessage.ps1 | `private/functions/Get-ErrorMessage.ps1` | ソース | エラーメッセージ取得 |
