# 機能設計書 336-Get-DbaInstanceAuditSpecification

## 概要

本ドキュメントは、SQL Serverインスタンスからサーバーレベルの監査仕様を取得する機能「Get-DbaInstanceAuditSpecification」の設計仕様を記載する。

### 本機能の処理概要

Get-DbaInstanceAuditSpecificationは、SQL Serverインスタンスで構成されたすべてのサーバーレベル監査仕様を取得する機能である。監査仕様の有効状態、関連付けられた監査名、構成の詳細情報を提供し、コンプライアンスレポートやセキュリティ評価を支援する。

**業務上の目的・背景**：サーバー監査仕様は、SQL Server Auditがインスタンスレベルでキャプチャするイベントを定義する。ログイン試行、権限変更、データベースアクセスパターンなどのイベントが含まれる。DBはこれらの監査仕様構成をインベントリして、コンプライアンスレポートやセキュリティ評価を行い、適切なイベント監視が実施されていることを確認する必要がある。

**機能の利用シーン**：
- コンプライアンスレポートのために監査仕様構成をインベントリする際
- セキュリティ評価で監査仕様設定を確認する際
- 適切なイベント監視が行われていることを確認する際
- 環境間で監査仕様設定を比較する際

**主要な処理内容**：
1. SQL Serverインスタンスへの接続
2. SMO ServerAuditSpecifications コレクションの取得
3. 追加プロパティ（ComputerName、InstanceName、SqlInstance）の付与
4. 結果をパイプラインに出力

**関連システム・外部連携**：
- SQL Server SMO (Server Management Objects)
- SQL Server Audit 機能

**権限による制御**：
- サーバー監査仕様を表示するには VIEW SERVER STATE 権限が必要
- sysadmin ロールのメンバーは完全なアクセス権を持つ

## 関連画面

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

## 機能種別

情報取得 / セキュリティ監査

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 対象SQL Serverインスタンス | パイプライン入力可能 |
| SqlCredential | PSCredential | No | SQL Server接続用の資格情報 | - |
| EnableException | switch | No | 例外を直接スローする | - |

### 入力データソース

- SQL Server SMO Server.ServerAuditSpecifications コレクション

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverをホストするコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名 |
| ID | int | サーバー監査仕様の一意識別子 |
| Name | string | サーバー監査仕様の名前 |
| AuditName | string | 関連付けられたSQL Server監査の名前 |
| Enabled | bool | 監査仕様が現在有効かどうか |
| CreateDate | DateTime | 監査仕様が作成された日時 |
| DateLastModified | DateTime | 監査仕様が最後に変更された日時 |
| Guid | Guid | 監査仕様のグローバル一意識別子 |

### 出力先

パイプライン出力（Microsoft.SqlServer.Management.Smo.ServerAuditSpecification オブジェクト、追加プロパティ付き）

## 処理フロー

### 処理シーケンス

```
1. インスタンス接続
   └─ Connect-DbaInstance で接続（最小バージョン: SQL Server 2008）

2. 監査仕様コレクション取得
   └─ $server.ServerAuditSpecifications を取得

3. 各監査仕様オブジェクトの処理
   └─ 追加プロパティの付与

4. 結果出力
   └─ Select-DefaultView で表示プロパティを設定しパイプライン出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[Connect-DbaInstance]
    B --> C{接続成功?}
    C -->|No| D[Stop-Function]
    C -->|Yes| E[$server.ServerAuditSpecifications取得]
    E --> F[各監査仕様をループ]
    F --> G[Add-Member ComputerName]
    G --> H[Add-Member InstanceName]
    H --> I[Add-Member SqlInstance]
    I --> J[Select-DefaultView]
    J --> K[パイプライン出力]
    K --> L{次の監査仕様?}
    L -->|Yes| F
    L -->|No| M[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 最小バージョン | SQL Server 2008 (バージョン10)以上が必要 | 常に |
| BR-002 | コレクション全取得 | ServerAuditSpecificationsコレクション全体を取得 | 常に |

### 計算ロジック

特になし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 監査仕様取得 | sys.server_audit_specifications | SELECT | SMO経由で監査仕様情報を取得 |

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

本機能は読み取り専用操作のみを行う。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ConnectionError | 接続エラー | SQL Serverへの接続失敗 | Stop-Function で処理継続 |

### リトライ仕様

リトライは行わない。

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

本機能はデータ変更を行わないため、トランザクション管理は不要。

## パフォーマンス要件

監査仕様オブジェクト数に依存するが、通常は即座に完了する。

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

- VIEW SERVER STATE 権限が必要
- 監査仕様の構成情報が表示されるため、セキュリティ監査の目的で使用

## 備考

- SQL Server 2008 (バージョン10)以上で動作
- Get-DbaInstanceAudit と組み合わせて使用することで、監査と監査仕様の完全な情報を取得可能

---

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

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

### 推奨読解順序

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

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

**読解のコツ**: Microsoft.SqlServer.Management.Smo.ServerAuditSpecification オブジェクトの標準プロパティに加えて、カスタムプロパティ（ComputerName、InstanceName、SqlInstance）が追加されている。

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

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

**主要処理フロー**:
1. **74-80行目**: インスタンス接続（MinimumVersion 10）
2. **82-88行目**: 各監査仕様オブジェクトの処理と出力

#### Step 3: 出力処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaInstanceAuditSpecification.ps1 | `public/Get-DbaInstanceAuditSpecification.ps1` | Add-Member と Select-DefaultView（83-87行目） |

**主要処理フロー**:
- **83行目**: ComputerNameプロパティ追加
- **84行目**: InstanceNameプロパティ追加
- **85行目**: SqlInstanceプロパティ追加
- **87行目**: デフォルト表示プロパティの設定

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

```
Get-DbaInstanceAuditSpecification
    │
    ├─ Connect-DbaInstance
    │      └─ SQL Serverへの接続（MinimumVersion 10）
    │
    ├─ $server.ServerAuditSpecifications
    │      └─ SMO ServerAuditSpecifications コレクション取得
    │
    ├─ Add-Member
    │      └─ カスタムプロパティの追加
    │
    └─ Select-DefaultView
           └─ 表示プロパティの設定
```

### データフロー図

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

SqlInstance ──▶ Connect-DbaInstance
                    │
                    ▼
               $server.ServerAuditSpecifications
                    │
                    ▼
               foreach ($auditSpecification)
                    │
                    ├─ Add-Member ComputerName
                    ├─ Add-Member InstanceName
                    ├─ Add-Member SqlInstance
                    │
                    ▼
               Select-DefaultView ──▶ パイプライン出力
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaInstanceAuditSpecification.ps1 | `public/Get-DbaInstanceAuditSpecification.ps1` | ソース | メイン関数 |
| Get-DbaInstanceAudit.ps1 | `public/Get-DbaInstanceAudit.ps1` | ソース | インスタンス監査の取得 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続 |
| Select-DefaultView.ps1 | `private/functions/Select-DefaultView.ps1` | ソース | デフォルト表示設定 |
