# 画面設計書 192-PBMオブジェクトセット

## 概要

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

### 本画面の処理概要

**業務上の目的・背景**：Policy-Based Management（ポリシーベース管理）のオブジェクトセットは、ポリシーが対象とするSQL Serverオブジェクトのコレクションを定義する。テーブル、ストアドプロシージャ、ビューなどの関連オブジェクトを特定の基準でグループ化し、一貫したポリシー適用を可能にする。本機能により、既存のオブジェクトセットを確認し、どのオブジェクトがポリシー評価の対象となっているかを把握できる。複数のデータベースやインスタンスにわたる標準化された構成管理とコンプライアンスルールの実装に不可欠な機能である。

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

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

**画面遷移**：本機能から `Get-DbaPbmStore` を内部的に呼び出す。オブジェクトセットは `Get-DbaPbmPolicy` で取得されるポリシーと関連付けられる。

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

## 関連機能

| 機能No | 機能名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 422 | Get-DbaPbmObjectSet | 主機能 | PBMオブジェクトセットの取得 |
| 424 | Get-DbaPbmStore | 補助機能 | PBMストアへの接続・取得 |
| 423 | Get-DbaPbmPolicy | 遷移先機能 | オブジェクトセットを使用するポリシーの取得 |

## 画面種別

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

## URL/ルーティング

PowerShellコマンド: `Get-DbaPbmObjectSet`

## 入出力項目

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 |
|-------------|-----|------|------|
| SqlInstance | DbaInstanceParameter[] | No | 対象SQL Serverインスタンス |
| SqlCredential | PSCredential | No | 代替認証情報 |
| ObjectSet | string[] | No | 取得対象のオブジェクトセット名フィルタ |
| IncludeSystemObject | switch | No | システムオブジェクトセットを含めるかどうか |
| InputObject | psobject[] | No | パイプライン入力（Get-DbaPbmStoreからの入力） |
| EnableException | switch | No | 例外処理を有効化 |

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

| プロパティ名 | 型 | 説明 |
|-------------|-----|------|
| ComputerName | string | コンピュータ名 |
| InstanceName | string | インスタンス名 |
| SqlInstance | string | 完全なインスタンス名 |
| ID | int | オブジェクトセットのID |
| Name | string | オブジェクトセット名 |
| Facet | string | 対象ファセット（Server、Database、Tableなど） |
| TargetSets | object | ターゲットセットのコレクション |
| IsSystemObject | bool | システムオブジェクトセットかどうか |

## 表示項目

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

## イベント仕様

### 1-オブジェクトセット一覧取得

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

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

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

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

| 操作（イベント） | 対象テーブル | 操作種別 | 概要 |
|----------------|-------------|---------|------|
| オブジェクトセット取得 | msdb.dbo.syspolicy_object_sets | SELECT | PBMオブジェクトセット情報の読み取り |

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

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

## メッセージ仕様

| メッセージID | 種別 | メッセージ内容 | 発生条件 |
|-------------|------|---------------|---------|
| MSG001 | Verbose | Processing {objectsetname} | 各オブジェクトセット処理時 |

## 例外処理

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

## 備考

- SQL Server 2008以降（バージョン10以上）が必要
- PowerShell Coreでも動作可能（Get-DbaPbmConditionとは異なる）
- システムオブジェクトセットはデフォルトで除外され、IncludeSystemObjectスイッチで表示可能
- 出力オブジェクトは Microsoft.SqlServer.Management.Dmf.ObjectSet 型
- ファセットはServer、Database、Table等のオブジェクト種別を示す

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: ObjectSetオブジェクトはファセットとターゲットセットを持ち、どのタイプのオブジェクトが対象かを定義する。

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

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

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

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

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

オブジェクトセットの取得・フィルタリング・出力処理を理解する。

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

**主要処理フロー**:
- **L100-101**: ストアからオブジェクトセットコレクションを取得
- **L103-105**: システムオブジェクト除外フィルタリング
- **L107-109**: オブジェクトセット名フィルタリング
- **L111-117**: 各オブジェクトセットにインスタンス情報を付加してパイプラインに出力

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

```
Get-DbaPbmObjectSet
    |
    +-- 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 ───────┤
                     │    ┌─────────────────────┐
ObjectSet ───────────┼───►│ Get-DbaPbmStore     │
                     │    │ (内部呼び出し)       │
IncludeSystemObject ─┤    └──────────┬──────────┘
                     │               │
InputObject ─────────┘               ▼
                          ┌─────────────────────┐
                          │ PolicyStore.        │
                          │ ObjectSets          │
                          │ (オブジェクトセット) │
                          └──────────┬──────────┘
                                     │
                                     ▼
                          ┌─────────────────────┐
                          │ フィルタリング処理   │
                          │ - システム除外      │
                          │ - 名前フィルタ      │
                          └──────────┬──────────┘
                                     │
                                     ▼
                          ┌─────────────────────┐
                          │ メタデータ付加       │──►  ObjectSet[]
                          │ - ComputerName      │     (出力オブジェクト)
                          │ - InstanceName      │
                          │ - SqlInstance       │
                          └─────────────────────┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaPbmObjectSet.ps1 | `public/Get-DbaPbmObjectSet.ps1` | ソース | メイン関数定義 |
| Get-DbaPbmStore.ps1 | `public/Get-DbaPbmStore.ps1` | ソース | PBMストア取得関数 |
| Get-DbaPbmPolicy.ps1 | `public/Get-DbaPbmPolicy.ps1` | ソース | PBMポリシー取得関数 |
