# 機能設計書 577-Remove-DbaLinkedServerLogin

## 概要

本ドキュメントは、リンクサーバーのログインマッピングを削除する `Remove-DbaLinkedServerLogin` 機能の設計仕様を定義するものです。

### 本機能の処理概要

`Remove-DbaLinkedServerLogin` は、SQL Serverのリンクサーバーに設定されたログインマッピング（ローカルログインとリモートサーバーの資格情報の関連付け）を削除するdbatools PowerShellコマンドレットです。リンクサーバーを通じたリモートサーバーへのアクセス制御を管理します。

**業務上の目的・背景**：リンクサーバーは、SQL Serverから他のSQL Serverや外部データソースへのアクセスを提供します。ログインマッピングは、ローカルログインがリンクサーバーを通じてリモートサーバーに接続する際に使用する資格情報を定義します。ユーザーアクセスの廃止やセキュリティ設定の変更時に、これらのマッピングを削除する必要があります。

**機能の利用シーン**：
- ユーザーのリンクサーバーアクセス権限の取り消し
- リンクサーバー廃止前のログインマッピングクリーンアップ
- セキュリティ監査後の不要マッピングの削除
- 環境移行時のセキュリティ設定整理

**主要な処理内容**：
1. 対象SQL Serverインスタンスへの接続またはパイプライン入力の受け取り
2. Get-DbaLinkedServerLoginによるログインマッピングの取得
3. 収集したログインマッピングをendブロックで一括削除
4. SMOのDrop()メソッドによるログインマッピング削除

**関連システム・外部連携**：SQL Server SMOライブラリ、Get-DbaLinkedServer、Get-DbaLinkedServerLoginとの連携。

**権限による制御**：ALTER ANY LINKED SERVER権限または対象リンクサーバーに対するALTER権限が必要です。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| N/A | SSMSリンクサーバーセキュリティ画面 | 参照画面 | GUIでのログインマッピング削除に相当する操作 |

## 機能種別

CRUD操作（Delete）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No* | 対象のSQL Serverインスタンス | 有効なインスタンス名 |
| SqlCredential | PSCredential | No | 代替認証情報 | 有効なPSCredentialオブジェクト |
| LinkedServer | String[] | Yes* | 対象のリンクサーバー名（SqlInstance指定時必須） | - |
| LocalLogin | String[] | No | 削除対象のローカルログイン名 | - |
| InputObject | Object[] | No | パイプライン入力 | Server/LinkedServer/LinkedServerLoginオブジェクト |
| EnableException | Switch | No | 例外を有効化するスイッチ | - |

*SqlInstance指定時はLinkedServerが必須

### 入力データソース

- PowerShellコマンドライン入力
- パイプライン入力（Connect-DbaInstance、Get-DbaLinkedServer、Get-DbaLinkedServerLoginからの出力）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | String | SQL Serverが動作するコンピュータ名 |
| InstanceName | String | SQL Serverインスタンス名 |
| SqlInstance | String | 完全なインスタンス名 |
| LinkedServer | String | リンクサーバー名 |
| Login | String | 削除されたログインマッピング名 |
| Status | String | 操作結果（"Removed" または "Failure"） |

### 出力先

- PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. begin ブロック
   └─ 削除対象ログインマッピングコレクションを初期化
2. process ブロック
   ├─ SqlInstance指定時
   │   ├─ LinkedServer必須チェック
   │   └─ Get-DbaLinkedServerLoginで取得・コレクション追加
   └─ InputObject処理
       ├─ Server → Get-DbaLinkedServerLogin
       ├─ LinkedServer → Get-DbaLinkedServerLogin
       └─ LinkedServerLogin → 直接コレクション追加
3. end ブロック
   └─ 収集したログインマッピングを一括削除
       ├─ ShouldProcess確認
       ├─ Drop()実行
       └─ 結果出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[begin: コレクション初期化]
    B --> C{SqlInstance指定?}
    C -->|Yes| D{LinkedServer指定?}
    D -->|No| E[エラー: LinkedServer必須]
    D -->|Yes| F[Get-DbaLinkedServerLogin]
    F --> G[コレクション追加]
    C -->|No| H{InputObject?}
    H -->|Yes| I{オブジェクトタイプ?}
    I -->|Server| J{LinkedServer指定?}
    J -->|No| K[エラー: LinkedServer必須]
    J -->|Yes| L[Get-DbaLinkedServerLogin]
    I -->|LinkedServer| M[パイプ経由Get-DbaLinkedServerLogin]
    I -->|LinkedServerLogin| N[直接コレクション追加]
    L --> G
    M --> G
    N --> G
    H -->|No| O[end ブロック]
    G --> O
    O --> P[ログインマッピングループ]
    P --> Q{ShouldProcess確認}
    Q -->|No| R[スキップ]
    Q -->|Yes| S[Drop実行]
    S --> T{成功?}
    T -->|Yes| U[Status=Removed]
    T -->|No| V[Status=Failure]
    U --> W[結果出力]
    V --> W
    R --> X{次のマッピング?}
    W --> X
    X -->|Yes| P
    X -->|No| Y[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | LinkedServer必須 | SqlInstance指定時はLinkedServerも必須 | SqlInstance指定時 |
| BR-002 | end ブロック処理 | 一括削除によるパイプライン処理の安定化 | 常時 |
| BR-003 | 複数入力タイプ対応 | Server、LinkedServer、LinkedServerLoginオブジェクトをサポート | InputObject使用時 |

### 計算ロジック

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

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| ログインマッピング削除 | sys.linked_logins | DELETE | リンクサーバーログインマッピングの削除 |

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

#### sys.linked_logins

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | server_id, local_principal_id | 対象のリンクサーバーとローカルログインID | SMO Drop()で実行 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| LinkedServerRequired | パラメータエラー | SqlInstance指定時にLinkedServer未指定 | LinkedServerを指定 |
| DropFailed | 削除エラー | Drop()の失敗 | エラー内容を確認 |

### リトライ仕様

エラー発生時はStop-Functionで処理を中断し、次のログインマッピングへ継続します。結果オブジェクトにStatus="Failure"を設定します。

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

SMOのDrop()メソッドによる暗黙的トランザクションで処理されます。

## パフォーマンス要件

通常のログインマッピング削除は1秒以内で完了します。

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

- ALTER ANY LINKED SERVER権限が必要
- ConfirmImpact=Highによるデフォルト確認プロンプト
- 監査ログによる操作追跡を推奨

## 備考

- end ブロックでの一括削除により、パイプライン処理の安定性を確保
- Get-DbaLinkedServerLoginとの連携が推奨

---

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

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

### 推奨読解順序

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

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

**読解のコツ**: LinkedServerLoginはLinkedServer.LinkedServerLoginsコレクションのメンバーです。Parentプロパティで親LinkedServerにアクセスできます。

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

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

**主要処理フロー**:
1. **90-99行目**: パラメータ定義
2. **100-102行目**: begin ブロック - コレクション初期化
3. **103-127行目**: process ブロック - ログインマッピング収集
4. **129-162行目**: end ブロック - 削除実行

#### Step 3: 入力タイプ別処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Remove-DbaLinkedServerLogin.ps1 | `public/Remove-DbaLinkedServerLogin.ps1` | InputObjectタイプ判定 |

**主要処理フロー**:
- **104-107行目**: SqlInstance指定時のLinkedServer必須チェック
- **109-111行目**: SqlInstance指定時のログインマッピング取得
- **113-126行目**: InputObjectタイプ別処理（Server、LinkedServer、LinkedServerLogin）

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

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

**主要処理フロー**:
- **131-137行目**: 出力用情報の取得
- **139-149行目**: ShouldProcess確認後のDrop実行
- **150-159行目**: エラー時の処理

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

```
Remove-DbaLinkedServerLogin
    │
    ├─ begin ブロック
    │      └─ コレクション初期化
    │
    ├─ process ブロック
    │      ├─ Connect-DbaInstance (SqlInstance指定時)
    │      │
    │      └─ Get-DbaLinkedServerLogin
    │             └─ ログインマッピング取得
    │
    └─ end ブロック
           └─ LinkedServerLogin.Drop()
                  └─ ログインマッピング削除
```

### データフロー図

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

SqlInstance ─────────▶ Connect-DbaInstance
        +                      │
LinkedServer ────────▶ Get-DbaLinkedServerLogin ──▶ コレクション
        +                                                  │
LocalLogin ──────────────────────────────────────────────▶ フィルタ
                                                           │
        or                                                 │
                                                           ▼
InputObject ────────────────────────────────────▶ end ブロック
(Server/LinkedServer/                                      │
 LinkedServerLogin)                              Drop()実行
                                                           │
                                                           ▼
                                               PSCustomObject ──▶ パイプライン
                                               (Status: Removed/Failure)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Remove-DbaLinkedServerLogin.ps1 | `public/Remove-DbaLinkedServerLogin.ps1` | ソース | メイン関数定義 |
| Get-DbaLinkedServerLogin.ps1 | `public/Get-DbaLinkedServerLogin.ps1` | ソース | ログインマッピング取得 |
| Get-DbaLinkedServer.ps1 | `public/Get-DbaLinkedServer.ps1` | ソース | リンクサーバー取得 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | インスタンス接続 |
| Stop-Function.ps1 | `private/functions/Stop-Function.ps1` | ソース | エラー処理 |
