# 画面設計書 193-PBMカテゴリ

## 概要

本ドキュメントは、dbatools PowerShellモジュールにおけるPolicy-Based Management (PBM) カテゴリ取得機能の設計を記述する。Get-DbaPbmCategory コマンドを中心に、SQL ServerのPBMカテゴリ情報を取得・表示するための機能仕様を定義する。

### 本画面の処理概要

**業務上の目的・背景**：Policy-Based Management（ポリシーベース管理）のカテゴリは、関連するポリシーをグループ化し、管理と選択的なポリシー適用を容易にする。カテゴリには「MandateDatabaseSubscriptions」属性があり、これによりデータベースがカテゴリへの自動サブスクリプションを強制されるかどうかが決定される。本機能により、既存のポリシーカテゴリを確認し、カテゴリの割り当てを監査し、ポリシーセットごとにどのデータベースが管理対象となっているかを理解できる。ガバナンスとコンプライアンス管理の基盤として重要な機能である。

**画面へのアクセス方法**：PowerShellコマンドラインから `Get-DbaPbmCategory` コマンドを実行することでアクセスする。パイプライン経由で `Get-DbaPbmStore` からの入力を受け取ることも可能である。

**主要な操作・処理内容**：
1. SQL Serverインスタンスへ接続し、PBMストアを取得
2. ポリシーカテゴリコレクションをフィルタリング（システムオブジェクト除外/カテゴリ名フィルタ）
3. 各カテゴリにインスタンス情報を付加して出力
4. パイプライン経由での複数インスタンス処理

**画面遷移**：本機能から `Get-DbaPbmStore` を内部的に呼び出す。また、`Get-DbaPbmCategorySubscription` と組み合わせて、カテゴリへのデータベースサブスクリプションを確認できる。

**権限による表示制御**：SQL Server上でPBM情報にアクセスするための適切な権限（通常はsysadminまたはServerAdmin）が必要。権限不足の場合は接続エラーとなる。

## 関連機能

| 機能No | 機能名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 419 | Get-DbaPbmCategory | 主機能 | PBMカテゴリの取得 |
| 420 | Get-DbaPbmCategorySubscription | 補助機能 | カテゴリサブスクリプションの取得 |
| 424 | Get-DbaPbmStore | 補助機能 | PBMストアへの接続・取得 |
| 423 | Get-DbaPbmPolicy | 遷移先機能 | カテゴリに属するポリシーの取得 |

## 画面種別

一覧（コマンドライン出力）

## URL/ルーティング

PowerShellコマンド: `Get-DbaPbmCategory`

## 入出力項目

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 |
|-------------|-----|------|------|
| SqlInstance | DbaInstanceParameter[] | No | 対象SQL Serverインスタンス |
| SqlCredential | PSCredential | No | 代替認証情報 |
| Category | string[] | No | 取得対象のカテゴリ名フィルタ |
| ExcludeSystemObject | switch | No | システムカテゴリを除外するかどうか |
| InputObject | psobject[] | No | パイプライン入力（Get-DbaPbmStoreからの入力） |
| EnableException | switch | No | 例外処理を有効化 |

### 出力プロパティ（デフォルト表示）

| プロパティ名 | 型 | 説明 |
|-------------|-----|------|
| ComputerName | string | コンピュータ名 |
| InstanceName | string | インスタンス名 |
| SqlInstance | string | 完全なインスタンス名 |
| Id | int | カテゴリのID |
| Name | string | カテゴリ名 |
| MandateDatabaseSubscriptions | bool | データベースサブスクリプションが強制かどうか |

## 表示項目

デフォルトビューでは以下のプロパティが表示される:
- ComputerName, InstanceName, SqlInstance
- Id, Name, MandateDatabaseSubscriptions

## イベント仕様

### 1-カテゴリ一覧取得

コマンド実行時に以下の処理フローが実行される:

1. **beginブロック**: `Add-PbmLibrary` を呼び出してPBMライブラリを読み込む
2. **processブロック**:
   - SqlInstance指定時は内部で `Get-DbaPbmStore` を呼び出し
   - 取得したストアからポリシーカテゴリコレクションを取得
   - ExcludeSystemObject指定がない場合、システムカテゴリを除外（デフォルト動作）
   - Category指定時は名前でフィルタリング
   - 各カテゴリにインスタンス情報を付加して出力

## データベース更新仕様

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

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

### テーブル別更新項目詳細

本機能は参照のみであり、データベースの更新は行わない。

## メッセージ仕様

| メッセージID | 種別 | メッセージ内容 | 発生条件 |
|-------------|------|---------------|---------|
| MSG001 | Verbose | Processing {categoryname} | 各カテゴリ処理時 |

## 例外処理

| 例外種別 | 発生条件 | 処理内容 |
|---------|---------|---------|
| 接続エラー | SQL Serverへ接続できない場合 | Stop-Functionでエラー出力 |
| 権限エラー | PBM情報へアクセス権限がない場合 | 接続時にエラーとなる |

## 備考

- SQL Server 2008以降（バージョン10以上）が必要
- ExcludeSystemObjectパラメータが指定されていない場合でも、IsSystemObject != trueのカテゴリのみが返される（コードのロジックに注意）
- 出力オブジェクトは Microsoft.SqlServer.Management.Sdk.Sfc.ISfcInstance 型
- MandateDatabaseSubscriptionsがTrueの場合、そのカテゴリに属するポリシーは全データベースで自動評価される

---

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

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

### 推奨読解順序

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

PBMカテゴリオブジェクトの構造とプロパティを理解することが重要である。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaPbmCategory.ps1 | `public/Get-DbaPbmCategory.ps1` | .OUTPUTS セクションで出力オブジェクトの構造を確認（L47-58） |

**読解のコツ**: MandateDatabaseSubscriptions属性がポリシー適用の自動化に重要な役割を果たす。

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

Get-DbaPbmCategory関数のパラメータとbeginブロックを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaPbmCategory.ps1 | `public/Get-DbaPbmCategory.ps1` | param()ブロックでパラメータ定義を確認（L71-80） |

**主要処理フロー**:
1. **L81-83**: beginブロックで `Add-PbmLibrary` を呼び出し、PBMライブラリをロード
2. **L84-85**: Test-FunctionInterruptで処理中断チェック
3. **L86-88**: SqlInstance指定時にGet-DbaPbmStoreを内部呼び出し

#### Step 3: メイン処理ロジックを理解する

カテゴリの取得・フィルタリング・出力処理を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaPbmCategory.ps1 | `public/Get-DbaPbmCategory.ps1` | processブロックのメイン処理（L89-108） |

**主要処理フロー**:
- **L89-90**: ストアからポリシーカテゴリコレクションを取得
- **L92-94**: ExcludeSystemObjectが指定されていない場合にシステムカテゴリを除外（注意：ロジックが逆に見える）
- **L96-98**: カテゴリ名フィルタリング
- **L100-106**: 各カテゴリにインスタンス情報を付加してパイプラインに出力

#### Step 4: 関連機能を理解する

Get-DbaPbmCategorySubscriptionの処理を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Get-DbaPbmCategorySubscription.ps1 | `public/Get-DbaPbmCategorySubscription.ps1` | カテゴリサブスクリプションの取得処理（L84-99） |

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

```
Get-DbaPbmCategory
    |
    +-- Add-PbmLibrary (beginブロック)
    |       └-- PBMライブラリの読み込み
    |
    +-- Test-FunctionInterrupt
    |       └-- 処理中断チェック
    |
    +-- Get-DbaPbmStore (SqlInstance指定時)
    |       |
    |       +-- Connect-DbaInstance
    |       |       └-- SQL Server接続確立
    |       |
    |       +-- New-Object SqlStoreConnection
    |       |       └-- SFC接続オブジェクト作成
    |       |
    |       └-- New-Object PolicyStore
    |               └-- PBMストアオブジェクト作成
    |
    +-- Where-Object IsSystemObject
    |       └-- システムカテゴリフィルタリング
    |
    +-- Where-Object Name
    |       └-- カテゴリ名フィルタリング
    |
    +-- Add-Member (ComputerName, InstanceName, SqlInstance)
    |       └-- インスタンス情報の付加
    |
    └-- Select-DefaultView
            └-- デフォルト表示プロパティの設定
```

### データフロー図

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

SqlInstance ─────────┐
                     │
SqlCredential ───────┤
                     │    ┌─────────────────────┐
Category ────────────┼───►│ Get-DbaPbmStore     │
                     │    │ (内部呼び出し)       │
ExcludeSystemObject ─┤    └──────────┬──────────┘
                     │               │
InputObject ─────────┘               ▼
                          ┌─────────────────────┐
                          │ PolicyStore.        │
                          │ PolicyCategories    │
                          │ (カテゴリコレクション)│
                          └──────────┬──────────┘
                                     │
                                     ▼
                          ┌─────────────────────┐
                          │ フィルタリング処理   │
                          │ - システム除外      │
                          │ - 名前フィルタ      │
                          └──────────┬──────────┘
                                     │
                                     ▼
                          ┌─────────────────────┐
                          │ メタデータ付加       │──►  PolicyCategory[]
                          │ - ComputerName      │     (出力オブジェクト)
                          │ - InstanceName      │
                          │ - SqlInstance       │
                          └─────────────────────┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaPbmCategory.ps1 | `public/Get-DbaPbmCategory.ps1` | ソース | メイン関数定義 |
| Get-DbaPbmCategorySubscription.ps1 | `public/Get-DbaPbmCategorySubscription.ps1` | ソース | カテゴリサブスクリプション取得関数 |
| Get-DbaPbmStore.ps1 | `public/Get-DbaPbmStore.ps1` | ソース | PBMストア取得関数 |
| Get-DbaPbmPolicy.ps1 | `public/Get-DbaPbmPolicy.ps1` | ソース | PBMポリシー取得関数 |
