# 機能設計書 510-Remove-DbaAgentProxy

## 概要

本ドキュメントは、SQL Server Agent プロキシアカウントを削除する `Remove-DbaAgentProxy` コマンドの機能設計書である。

### 本機能の処理概要

**業務上の目的・背景**：SQL Server Agent のプロキシアカウントは、ジョブステップが異なるセキュリティコンテキストで実行できるようにする。本コマンドは、不要になったプロキシアカウントの削除を自動化し、セキュリティ監査に伴うクリーンアップ、廃止されたサービスアカウントの整理、環境統合などを効率的に行う。パイプライン入力と詳細なステータス出力をサポートし、対話的なクリーンアップと自動化スクリプトの両方に適している。

**機能の利用シーン**：不要になったプロキシアカウントの削除、セキュリティ監査後のクリーンアップ、廃止されたサービスアカウントに関連するプロキシの整理、テスト環境のプロキシクリーンアップ、Out-GridView を使用した対話的なプロキシ選択削除などに利用される。

**主要な処理内容**：
1. 対象インスタンスへの接続とプロキシ取得（Get-DbaAgentProxy 使用）
2. 除外プロキシのフィルタリング（ExcludeProxy パラメータ）
3. パイプライン入力またはパラメータ指定によるプロキシオブジェクト収集
4. ShouldProcess による削除確認
5. SMO（ProxyAccount.Drop() メソッド）を使用したプロキシ削除
6. 削除結果のステータスオブジェクト出力

**関連システム・外部連携**：SQL Server Agent サービス、msdb データベース、SQL Server 資格情報

**権限による制御**：対象インスタンスで sysadmin 権限が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 15 | Agentプロキシ管理 | 主画面 | SQLエージェントプロキシの削除 |

## 機能種別

CRUD操作（Delete）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No | 対象SQL Serverインスタンス | 接続可能なインスタンス名 |
| SqlCredential | PSCredential | No | 代替認証情報 | - |
| Proxy | string[] | No | 削除するプロキシ名 | ワイルドカード対応 |
| ExcludeProxy | string[] | No | 削除対象から除外するプロキシ名 | ワイルドカード対応 |
| InputObject | ProxyAccount[] | Yes* | パイプライン入力用プロキシオブジェクト | *Pipelineパラメータセット時必須 |
| EnableException | switch | No | 例外を有効化 | - |

### 入力データソース

PowerShell コマンドラインからのパラメータ入力、または Get-DbaAgentProxy からのパイプライン入力

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverインスタンスのコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名 |
| Name | string | 削除されたプロキシ名 |
| Status | string | 削除結果（"Dropped" または エラーメッセージ） |
| IsRemoved | bool | 削除成功の真偽値 |

### 出力先

PowerShell パイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. beginブロック
   └─ 空の配列 $dbProxies を初期化
2. processブロック
   ├─ SqlInstance 指定時
   │   └─ Get-DbaAgentProxy でプロキシオブジェクト取得
   └─ パイプライン入力時
       └─ InputObject を $dbProxies に追加
3. endブロック（削除実行）
   └─ 各プロキシに対するループ
       ├─ ShouldProcess による確認
       ├─ 出力オブジェクト初期化
       ├─ ProxyAccount.Drop() 実行
       │   ├─ 成功時: Status="Dropped", IsRemoved=true
       │   └─ 失敗時: Status=エラーメッセージ, IsRemoved=false
       └─ 出力オブジェクトをパイプラインに出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{SqlInstance指定?}
    B -->|Yes| C[Get-DbaAgentProxy実行]
    B -->|No| D[InputObjectを配列に追加]
    C --> E[processブロック終了]
    D --> E
    E --> F[endブロック開始]
    F --> G{次のプロキシ存在?}
    G -->|No| H[終了]
    G -->|Yes| I{ShouldProcess確認}
    I -->|No| G
    I -->|Yes| J[出力オブジェクト初期化]
    J --> K[ProxyAccount.Drop実行]
    K --> L{成功?}
    L -->|Yes| M[Status=Dropped, IsRemoved=true]
    L -->|No| N[Status=エラー, IsRemoved=false]
    M --> O[出力オブジェクト出力]
    N --> O
    O --> G
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-510-01 | endブロック削除 | パイプラインからの直接削除時の "Collection was modified" エラーを防ぐため、endブロックで削除を実行 | 常時 |
| BR-510-02 | 確認プロンプト | ConfirmImpact が High のため、削除前に確認プロンプトを表示 | 常時 |
| BR-510-03 | 除外処理 | ExcludeProxy で指定されたプロキシは Get-DbaAgentProxy で除外される | ExcludeProxy指定時 |
| BR-510-04 | ジョブステップ依存注意 | プロキシが使用中のジョブステップがある場合、削除に失敗する可能性がある | ジョブステップ使用時 |

### 計算ロジック

特になし。

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| プロキシ削除 | msdb.dbo.sysproxies | DELETE | SMO経由でプロキシレコード削除 |
| ログイン権限削除 | msdb.dbo.sysproxylogin | DELETE | プロキシに関連付けられたログイン権限も削除 |
| サブシステム割り当て削除 | msdb.dbo.sysproxysubsystem | DELETE | サブシステムへの割り当ても削除 |

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

#### msdb.dbo.sysproxies

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | proxy_id | 削除対象プロキシのID | SMO Drop()で実行 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 削除エラー | ProxyAccount.Drop() 失敗 | Stop-Function でエラー記録、Status にエラーメッセージ設定 |
| - | 使用中エラー | プロキシが使用中 | ジョブステップからの参照を解除後に再試行 |

### リトライ仕様

リトライ処理は実装されていない。

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

SMO の ProxyAccount.Drop() メソッドによる暗黙的トランザクション。

## パフォーマンス要件

特に定義されていない。

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

- 対象インスタンスへの sysadmin 権限が必要
- プロキシ削除により、そのプロキシを使用するジョブステップは実行できなくなる
- ConfirmImpact が High のため、誤削除を防ぐための確認プロンプトがデフォルトで表示される

## 備考

- Get-DbaAgentProxy からのパイプライン入力をサポート
- Out-GridView を使用した対話的選択削除が可能
- ワイルドカードによるパターンマッチングをサポート

---

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

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

### 推奨読解順序

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

出力オブジェクトの構造とパラメータセットを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Remove-DbaAgentProxy.ps1 | `public/Remove-DbaAgentProxy.ps1` | 85-95行目: パラメータ定義、Default/Pipelineパラメータセット |

**読解のコツ**: DefaultParameterSetName="Default" で、SqlInstance 指定と InputObject 指定の両方をサポート。

#### Step 2: プロキシ収集処理を理解する

process ブロックでのプロキシオブジェクト収集。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Remove-DbaAgentProxy.ps1 | `public/Remove-DbaAgentProxy.ps1` | 97-110行目: begin/processブロック |

**主要処理フロー**:
1. **98行目**: 空の配列 $dbProxies を初期化
2. **102-106行目**: SqlInstance 指定時は Get-DbaAgentProxy で取得
3. **107-109行目**: パイプライン入力時は InputObject を追加

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

end ブロックでの実際の削除実行。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Remove-DbaAgentProxy.ps1 | `public/Remove-DbaAgentProxy.ps1` | 112-136行目: endブロック |

**主要処理フロー**:
- **113行目**: コメントで "Collection was modified" エラー防止の説明
- **116-123行目**: 出力オブジェクトの初期化
- **125行目**: Drop() 実行

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

```
Remove-DbaAgentProxy
    │
    ├─ Get-DbaAgentProxy (106行目)
    │      └─ プロキシオブジェクト取得（SqlInstance指定時）
    │
    └─ $dbProxy.Drop() (125行目)
           └─ SMO経由でプロキシ削除
```

### データフロー図

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

SqlInstance ──┬──▶ Get-DbaAgentProxy ──▶ ProxyAccount オブジェクト配列
Proxy ────────┤                                │
ExcludeProxy ─▶ (フィルタリング)               │
                                               ▼
InputObject ─────────────────────────▶ ProxyAccount オブジェクト配列
                                               │
                                               ▼
                                       endブロックで削除
                                               │
                                               ▼
                                       PSCustomObject出力
                                       (ComputerName, InstanceName,
                                        SqlInstance, Name, Status, IsRemoved)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Remove-DbaAgentProxy.ps1 | `public/Remove-DbaAgentProxy.ps1` | ソース | メインコマンド実装 |
| Get-DbaAgentProxy.ps1 | `public/Get-DbaAgentProxy.ps1` | ソース | プロキシ取得（SqlInstance指定時） |
