# 機能設計書 419-Get-DbaPbmCategory

## 概要

本ドキュメントは、ガバナンスとコンプライアンス管理のためにSQL Serverインスタンスからポリシーベース管理（PBM）カテゴリを取得する`Get-DbaPbmCategory`機能の設計を定義する。

### 本機能の処理概要

本機能は、SQL Serverのポリシーベース管理（PBM）機能で構成されているすべてのポリシーカテゴリを取得する。ポリシーカテゴリは、関連するポリシーを整理・グループ化し、データベース環境全体での管理と選択的な適用を容易にする。

**業務上の目的・背景**：ポリシーベース管理は、SQL Server環境全体でガバナンスとコンプライアンスを実現するための重要な機能である。ポリシーカテゴリを使用することで、セキュリティ、パフォーマンス、標準化などの目的別にポリシーを分類できる。本機能を使用することで、DBAは既存のカテゴリをインベントリ化し、カテゴリ割り当てを監査し、どのカテゴリが自動ポリシー評価のためにデータベースサブスクリプションを必須としているかを理解できる。

**機能の利用シーン**：
- ポリシーカテゴリのインベントリ取得
- カテゴリ設定の監査
- カスタムカテゴリと組み込みカテゴリの区別
- ポリシー管理計画の策定

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスへの接続
2. Get-DbaPbmStoreでPolicyStoreオブジェクトを取得
3. PolicyCategoriesコレクションを取得
4. システムオブジェクトと名前によるフィルタリング
5. 結果をパイプラインに出力

**関連システム・外部連携**：
- Get-DbaPbmStore（PolicyStore取得）
- Microsoft.SqlServer.Management.DMF（Policy Management Framework）

**権限による制御**：VIEW ANY DEFINITION権限またはsysadmin権限が必要

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | コマンドライン | 主画面 | PowerShellコンソールからの実行 |

## 機能種別

データ取得処理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No | 対象SQL Serverインスタンス | - |
| SqlCredential | PSCredential | No | 代替認証資格情報 | Windows/SQL認証対応 |
| Category | string[] | No | 取得するカテゴリ名でフィルタ | - |
| InputObject | psobject[] | No | Get-DbaPbmStoreからのパイプライン入力 | ValueFromPipeline |
| ExcludeSystemObject | switch | No | システムカテゴリを除外 | - |
| EnableException | switch | No | 例外の詳細表示有効化 | - |

### 入力データソース

- SQL Server: PolicyStore.PolicyCategories

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverホストのコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名 |
| Id | int | ポリシーカテゴリの一意識別子 |
| Name | string | ポリシーカテゴリ名 |
| MandateDatabaseSubscriptions | bool | データベースが自動ポリシー評価のためにこのカテゴリにサブスクライブする必要があるか |

### 出力先

PowerShellパイプライン(Microsoft.SqlServer.Management.Sdk.Sfc.ISfcInstance)

## 処理フロー

### 処理シーケンス

```
1. beginブロック: 初期化
   └─ Add-PbmLibraryでPBMライブラリロード

2. processブロック: 処理
   └─ 2.1 SqlInstance指定時はGet-DbaPbmStoreを呼び出してInputObjectに追加
   └─ 2.2 各PolicyStoreをループ
   └─ 2.3 PolicyCategoriesを取得
   └─ 2.4 ExcludeSystemObjectでフィルタ（デフォルトはシステム除外）
   └─ 2.5 Categoryでフィルタ
   └─ 2.6 各カテゴリにComputerName/InstanceName/SqlInstanceを追加
   └─ 2.7 Select-DefaultViewで出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[Add-PbmLibrary]
    B --> C{Test-FunctionInterrupt}
    C -->|中断| D[return]
    C -->|継続| E{SqlInstance指定?}
    E -->|Yes| F[Get-DbaPbmStore]
    F --> G[InputObjectに追加]
    E -->|No| G
    G --> H{各storeをループ}
    H --> I[PolicyCategories取得]
    I --> J{ExcludeSystemObject?}
    J -->|No| K[IsSystemObject != trueでフィルタ]
    J -->|Yes| L[フィルタなし]
    K --> M{Category指定?}
    L --> M
    M -->|Yes| N[Name in Categoryでフィルタ]
    M -->|No| O{各カテゴリをループ}
    N --> O
    O --> P[Write-Message Verbose]
    P --> Q[ComputerName/InstanceName/SqlInstance追加]
    Q --> R[Select-DefaultView出力]
    R --> O
    O -->|完了| H
    H -->|完了| S[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | システム除外デフォルト | ExcludeSystemObject未指定でもIsSystemObject != trueでフィルタ | デフォルト |
| BR-002 | カテゴリフィルタ | Categoryパラメータ指定時は名前で絞り込み | Category指定時 |
| BR-003 | パイプライン入力 | SqlInstanceとInputObjectの両方をサポート | 常時 |

### 計算ロジック

特になし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| カテゴリ取得 | msdb.dbo.syspolicy_policy_categories | SELECT | カテゴリ情報の読み取り |

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

#### PolicyStore.PolicyCategories

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| 読み取り | Id, Name, MandateDatabaseSubscriptions, IsSystemObject | - | SMO経由で取得 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| FunctionInterrupt | 中断 | Test-FunctionInterrupt true | return |

### リトライ仕様

リトライ処理なし（単一試行）

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

読み取り専用処理のためトランザクション管理不要

## パフォーマンス要件

- PolicyCategoriesコレクションの取得は軽量
- 複数インスタンスへの一括クエリ時は順次処理

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

- VIEW ANY DEFINITION権限またはsysadmin権限が必要
- SQL認証/Windows認証/Azure AD認証に対応
- 資格情報はPSCredentialで安全に渡される

## 備考

- Chrissy LeMaire氏(@cl)による開発
- Get-DbaPbmStoreと連携して動作

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaPbmCategory.ps1 | `public/Get-DbaPbmCategory.ps1` | 出力プロパティの構造（102-105行目） |

**読解のコツ**: 出力はSMOオブジェクト(ISfcInstance)にComputerName/InstanceName/SqlInstanceを追加したもの

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaPbmCategory.ps1 | `public/Get-DbaPbmCategory.ps1` | パラメータ定義（72-80行目） |

**主要処理フロー**:
1. **73行目**: SqlInstanceパラメータ（オプション）
2. **75行目**: Categoryパラメータ（フィルタ用）
3. **76-77行目**: InputObjectパラメータ（パイプライン入力）
4. **78行目**: ExcludeSystemObjectパラメータ

#### Step 3: メイン処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaPbmCategory.ps1 | `public/Get-DbaPbmCategory.ps1` | beginブロック（81-83行目） |
| 3-2 | Get-DbaPbmCategory.ps1 | `public/Get-DbaPbmCategory.ps1` | processブロック（84-107行目） |

**主要処理フロー**:
- **82行目**: Add-PbmLibrary
- **85行目**: Test-FunctionInterrupt
- **86-88行目**: SqlInstance指定時はGet-DbaPbmStore呼び出し
- **90行目**: PolicyCategories取得
- **92-94行目**: ExcludeSystemObjectフィルタ（デフォルトはIsSystemObject除外）
- **96-98行目**: Categoryフィルタ
- **100-105行目**: 各カテゴリにプロパティ追加と出力

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

```
Get-DbaPbmCategory
    │
    ├─ Add-PbmLibrary
    │      └─ PBMライブラリロード
    │
    ├─ Test-FunctionInterrupt
    │      └─ 中断チェック
    │
    ├─ Get-DbaPbmStore（SqlInstance指定時）
    │      ├─ Connect-DbaInstance
    │      └─ PolicyStore作成
    │
    └─ Select-DefaultView
           └─ 出力プロパティの選択
```

### データフロー図

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

SqlInstance ──────▶ Get-DbaPbmStore ──────────┐
                                              │
InputObject ─────────────────────────────────┤
(パイプライン)                               │
                                              ▼
                         PolicyStore.PolicyCategories
                                              │
ExcludeSystemObject ──▶ IsSystemObjectフィルタ
                                              │
Category ─────────────▶ Nameフィルタ
                                              │
                          ┌───────────────────┘
                          │
                          ▼
                   foreach ($current in $all)
                          │
                          ▼
                   Add-Member (ComputerName,
                   InstanceName, SqlInstance)
                          │
                          ▼
               Select-DefaultView ──────▶ パイプライン出力
               (Id, Name, MandateDatabaseSubscriptions)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaPbmCategory.ps1 | `public/Get-DbaPbmCategory.ps1` | ソース | メイン関数実装 |
| Get-DbaPbmStore.ps1 | `public/Get-DbaPbmStore.ps1` | ソース | PolicyStore取得 |
| Add-PbmLibrary.ps1 | `internal/functions/Add-PbmLibrary.ps1` | ソース | PBMライブラリロード |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続処理 |
