# 機能設計書 335-Get-DbaInstanceAudit

## 概要

本ドキュメントは、SQL Serverインスタンスレベルのセキュリティ監査構成から監査オブジェクトを取得する機能「Get-DbaInstanceAudit」の設計仕様を記載する。

### 本機能の処理概要

Get-DbaInstanceAuditは、SQL Serverのインスタンスレベルで構成されたすべての監査オブジェクトを取得する機能である。セキュリティ監査イベントの保存場所や管理方法の詳細情報を提供する。

**業務上の目的・背景**：SQL Server監査は、ログイン試行、権限変更、その他のセキュリティ関連アクティビティをSQL Serverインスタンス全体でキャプチャする。DBはこれらの監査構成を監視して、コンプライアンス要件を満たしているか、適切なイベント監視が行われているかを確認する必要がある。本機能は、監査ファイルのパス、サイズ制限、ロールオーバー設定、現在の状態などの詳細情報を提供し、手動でシステムビューをクエリすることなく監査構成の確認を可能にする。

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

**主要な処理内容**：
1. SQL Serverインスタンスへの接続
2. SMO Audits コレクションの取得
3. フィルタリング（Audit、ExcludeAuditパラメータ）
4. 追加プロパティ（FullName、RemoteFullName）の計算
5. 結果をパイプラインに出力

**関連システム・外部連携**：
- 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接続用の資格情報 | - |
| Audit | string[] | No | 取得する監査オブジェクトの名前 | - |
| ExcludeAudit | string[] | No | 除外する監査オブジェクトの名前 | - |
| EnableException | switch | No | 例外を直接スローする | - |

### 入力データソース

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

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverをホストするコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名 |
| Name | string | SQL Server監査の名前 |
| IsEnabled | bool | 監査が現在有効かどうか |
| OnFailure | AuditOnFailureAction | 監査イベント書き込み失敗時のアクション |
| MaximumFiles | int | 保持する監査ファイルの最大数 |
| MaximumFileSize | int | 各監査ファイルの最大サイズ |
| MaximumFileSizeUnit | AuditFileSizeUnit | MaximumFileSizeの単位 |
| MaximumRolloverFiles | int | ロールオーバー前に保持するファイル数 |
| QueueDelay | int | 監査レコードをフラッシュする前の遅延（ミリ秒） |
| ReserveDiskSpace | bool | ディスクスペースを事前割り当てするか |
| FullName | string | 監査イベントが保存されるファイルのフルパス |
| RemoteFullName | string | 監査ファイルのリモートUNCパス |
| FilePath | string | 監査ファイルのディレクトリパス |
| FileName | string | 監査ファイルの名前 |

### 出力先

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

## 処理フロー

### 処理シーケンス

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

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

3. フィルタリング
   └─ Audit パラメータで絞り込み
   └─ ExcludeAudit パラメータで除外

4. 各監査オブジェクトの処理
   └─ FullName、RemoteFullName の計算
   └─ 追加プロパティの付与

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

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[Connect-DbaInstance]
    B --> C{接続成功?}
    C -->|No| D[Stop-Function]
    C -->|Yes| E[$server.Audits取得]
    E --> F{Audit指定あり?}
    F -->|Yes| G[名前でフィルタ]
    F -->|No| H{ExcludeAudit指定あり?}
    G --> H
    H -->|Yes| I[除外フィルタ]
    H -->|No| J[各監査をループ]
    I --> J
    J --> K[FullName計算]
    K --> L[RemoteFullName計算]
    L --> M[Add-Member で追加プロパティ]
    M --> N[Select-DefaultView]
    N --> O[パイプライン出力]
    O --> P{次の監査?}
    P -->|Yes| J
    P -->|No| Q[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 最小バージョン | SQL Server 2008 (バージョン10)以上が必要 | 常に |
| BR-002 | FullName計算 | FilePath + FileName で完全パスを構築 | 常に |
| BR-003 | RemoteFullName計算 | ドライブレターを$に置換し、UNC形式に変換 | 常に |

### 計算ロジック

- FullName = "$directory\$filename" （$directory = FilePath.TrimEnd("\")）
- RemoteFullName = "\\ComputerName\{FullNameのドライブレターを$に置換}"

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

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

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

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

リトライは行わない。

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

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

## パフォーマンス要件

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

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

- VIEW SERVER STATE 権限が必要
- 監査ファイルのパス情報が表示されるため、機密情報として扱う

## 備考

- SQL Server 2008 (バージョン10)以上で動作
- SQL Server Audit 機能はEnterprise Editionでのみ完全にサポート（一部機能はStandard Editionでも利用可能）

---

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

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

### 推奨読解順序

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

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

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

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

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

**主要処理フロー**:
1. **93-99行目**: インスタンス接続（MinimumVersion 10）
2. **101-108行目**: 監査コレクション取得とフィルタリング
3. **110-124行目**: 各監査オブジェクトの処理と出力

#### Step 3: プロパティ計算を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaInstanceAudit.ps1 | `public/Get-DbaInstanceAudit.ps1` | FullName/RemoteFullName計算（111-115行目） |

**主要処理フロー**:
- **111行目**: ディレクトリパスの末尾のバックスラッシュを削除
- **113行目**: フルパスを構築
- **114-115行目**: リモートUNCパスを構築

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

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

### データフロー図

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

SqlInstance ──▶ Connect-DbaInstance
                    │
                    ▼
               $server.Audits
                    │
                    ├─ Audit フィルタ
                    ├─ ExcludeAudit フィルタ
                    │
                    ▼
               foreach ($currentaudit)
                    │
                    ├─ FullName計算
                    ├─ RemoteFullName計算
                    ├─ Add-Member
                    │
                    ▼
               Select-DefaultView ──▶ パイプライン出力
```

### 関連ファイル一覧

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