# 機能設計書 420-Get-DbaPbmCategorySubscription

## 概要

本ドキュメントは、自動ポリシー評価を制御するポリシーベース管理（PBM）カテゴリへのデータベースサブスクリプションを取得する`Get-DbaPbmCategorySubscription`機能の設計を定義する。

### 本機能の処理概要

本機能は、SQL Serverのポリシーベース管理機能からポリシーカテゴリへのすべてのデータベースサブスクリプションを取得する。これらのサブスクリプションは、特定のポリシーカテゴリに対する自動ポリシー評価の対象となるデータベースを決定する。

**業務上の目的・背景**：データベースがカテゴリにサブスクライブすると（自発的または必須サブスクリプションによって）、そのカテゴリ内のすべてのポリシーがデータベースに対して自動的に評価される。これはポリシーコンプライアンスの監査、評価失敗のトラブルシューティング、どのデータベースがどのポリシーセットによって管理されているかを理解するために不可欠である。

**機能の利用シーン**：
- ポリシーカテゴリへのサブスクリプション状況の監査
- コンプライアンス評価失敗のトラブルシューティング
- ポリシー適用範囲の確認
- カテゴリサブスクリプションの一覧化

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスへの接続
2. Get-DbaPbmStoreでPolicyStoreオブジェクトを取得
3. PolicyCategorySubscriptionsコレクションを取得
4. 結果をパイプラインに出力

**関連システム・外部連携**：
- 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認証対応 |
| InputObject | psobject[] | No | Get-DbaPbmStoreからのパイプライン入力 | ValueFromPipeline |
| EnableException | switch | No | 例外の詳細表示有効化 | - |

### 入力データソース

- SQL Server: PolicyStore.PolicyCategorySubscriptions

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 | デフォルト表示 |
|--------|-----|------|---------------|
| ComputerName | string | SQL Serverホストのコンピュータ名 | Yes |
| InstanceName | string | SQL Serverインスタンス名 | Yes |
| SqlInstance | string | 完全なSQL Serverインスタンス名 | Yes |
| PolicyCategory | string | サブスクリプション対象のポリシーカテゴリ名 | Yes |
| Target | string | サブスクライブしているターゲットオブジェクト（データベース等） | Yes |
| TargetType | string | ターゲットオブジェクトのタイプ | Yes |
| ID | int | サブスクリプションの一意識別子 | Yes |
| State | string | サブスクリプションオブジェクトの現在の状態 | Yes |
| IdentityKey | string | サブスクリプションオブジェクトの識別キー | Yes |
| Metadata | object | サブスクリプションのメタデータ情報 | Yes |
| KeyChain | string | サブスクリプションオブジェクトの識別パス | Yes |
| Properties | collection | プロパティコレクション | No |
| Urn | string | サブスクリプションのURN | No |
| Parent | object | 親PolicyStoreオブジェクトへの参照 | No |

### 出力先

PowerShellパイプライン(Microsoft.SqlServer.Management.Dmf.PolicyCategorySubscription)

## 処理フロー

### 処理シーケンス

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

2. processブロック: 処理
   └─ 2.1 SqlInstance指定時はGet-DbaPbmStoreを呼び出してInputObjectに追加
   └─ 2.2 各PolicyStoreをループ
   └─ 2.3 PolicyCategorySubscriptionsを取得
   └─ 2.4 各サブスクリプションにComputerName/InstanceName/SqlInstanceを追加
   └─ 2.5 Select-DefaultViewで出力（Properties, Urn, Parent除外）
```

### フローチャート

```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[PolicyCategorySubscriptions取得]
    I --> J{各サブスクリプションをループ}
    J --> K[Write-Message Verbose]
    K --> L[ComputerName/InstanceName/SqlInstance追加]
    L --> M[Select-DefaultView出力]
    M --> J
    J -->|完了| H
    H -->|完了| N[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 全サブスクリプション取得 | フィルタリングなしで全サブスクリプションを取得 | 常時 |
| BR-002 | パイプライン入力 | SqlInstanceとInputObjectの両方をサポート | 常時 |
| BR-003 | 非表示プロパティ | Properties, Urn, Parentはデフォルト非表示 | 常時 |

### 計算ロジック

特になし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| サブスクリプション取得 | msdb.dbo.syspolicy_policy_category_subscriptions | SELECT | サブスクリプション情報の読み取り |

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

#### PolicyStore.PolicyCategorySubscriptions

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| 読み取り | PolicyCategory, Target, TargetType, ID, State, etc. | - | SMO経由で取得 |

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

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

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

## パフォーマンス要件

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

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

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

## 備考

- Chrissy LeMaire氏(@cl)による開発
- Get-DbaPbmStoreと連携して動作
- Get-DbaPbmCategoryと組み合わせて使用することでカテゴリとサブスクリプションの関係を把握できる

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaPbmCategorySubscription.ps1 | `public/Get-DbaPbmCategorySubscription.ps1` | 出力オブジェクトの構造（97行目） |

**読解のコツ**: 出力はPolicyCategorySubscriptionオブジェクトにComputerName/InstanceName/SqlInstanceを追加したもの。Properties, Urn, Parentは非表示。

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

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

**主要処理フロー**:
1. **74行目**: SqlInstanceパラメータ（オプション）
2. **75行目**: SqlCredentialパラメータ
3. **76-78行目**: InputObjectパラメータ（パイプライン入力）
4. **79行目**: EnableExceptionパラメータ

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

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

**主要処理フロー**:
- **82行目**: Add-PbmLibrary
- **85行目**: Test-FunctionInterrupt
- **86-88行目**: SqlInstance指定時はGet-DbaPbmStore呼び出し
- **90行目**: PolicyCategorySubscriptions取得（注: PolicycategorySubscriptions - 大文字小文字の違い）
- **92-97行目**: 各サブスクリプションにプロパティ追加と出力

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

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

### データフロー図

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

SqlInstance ──────▶ Get-DbaPbmStore ──────────┐
                                              │
InputObject ─────────────────────────────────┤
(パイプライン)                               │
                                              ▼
                   PolicyStore.PolicyCategorySubscriptions
                                              │
                          ┌───────────────────┘
                          │
                          ▼
                   foreach ($current in $all)
                          │
                          ▼
                   Add-Member (ComputerName,
                   InstanceName, SqlInstance)
                          │
                          ▼
               Select-DefaultView ──────▶ パイプライン出力
               (Properties, Urn, Parent除外)
```

### 関連ファイル一覧

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