> For the complete documentation index, see [llms.txt](https://docs.realmjoin.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.realmjoin.com/ja/dev-reference/report-functions/export-rjrbxlsx.md).

# Export-RjRbXlsx

Azure Automation runbook からオブジェクトを、外部モジュール依存なしでスタイル付きのネイティブ Excel ブック (.xlsx) にエクスポートします。

## 概要

`Export-RjRbXlsx` は、RealmJoin のレポート用 runbook から Excel レポート ファイル（`.xlsx`）を生成するための標準ヘルパーです。PSCustomObject の 1 つ以上のテーブルを `PSCustomObject`として **ネイティブな Excel ブック** として、.NET（`System.IO.Compression`）のみを使って書き出します —  `ImportExcel` も COM 自動化も不要で、Automation 環境で他の外部モジュールも必要ありません。

{% hint style="info" %}
**RealmJoin.RunbookHelper 0.8.8 で利用可能です。** この関数はモジュールからエクスポートされます。以前の runbook バージョンに含まれていたインライン コピーは削除されました。これを使用する runbook では、モジュールのバージョンを次のように宣言します:

```powershell
#Requires -Modules @{ModuleName = "RealmJoin.RunbookHelper"; ModuleVersion = "0.8.8" }
```

{% endhint %}

主な特徴:

* **モジュール依存関係なし** — ブックは `System.IO.Compression.ZipArchive`を介して Open XML パッケージとして直接組み立てられます。これにより、重いモジュールのコールド スタート コストと、複数種のレポート runbook におけるアセンブリ競合の両方を回避できます。
* **スタイル設定済みですぐ共有できる出力** — 各ワークシートには、スタイル付きの Excel テーブル（紺色のヘッダー、並べ替え後も追従するゼブラ行、フィルターのドロップダウン）が付き、ヘッダー行は固定され、列幅は自動計算され、印刷設定も自動で行われます（向きは内容の幅から決定され、ヘッダー行は印刷する各ページで繰り返されます）。最初のワークシート タブは RealmJoin orange で色付けされます。
* **型を忠実に保持するセル** — .NET の数値は Excel の数値になり、 `DateTime` 値と ISO-8601 文字列（例: Graph の日付フィールド）は、実際に並べ替え可能な Excel の日付になり（クライアント側でローカライズされ）、 `http/https` URL はクリック可能なハイパーリンクになります。その他の文字列はすべてテキストのままです — シリアル番号や IMEI などの値が数値に変換されることは決してなく、 **数式インジェクションも不可能です**.
* **単一または複数のワークシート** — 行を単一シートにパイプするか、順序付き辞書を渡して、複数のワークシートと任意の "Info" 表紙シートを持つブックを作成します。
* **レポートを美しく仕上げる機能を内蔵** — ステータス列向けの条件付き書式のハイライト ルール、数値列のセル内データバー、わかりやすいハイパーリンク表示テキスト、桁区切りを任意で指定できます。

典型的な利用者は、CSV と XLSX ファイルを生成し、その後それらを [Send-RjRbReportEmail](https://docs.realmjoin.com/ja/dev-reference/report-functions/send-rjrbreportemail.md) および/または [Publish-RjRbFilesToStorageContainer](https://docs.realmjoin.com/ja/dev-reference/report-functions/publish-rjrbfilestostoragecontainer.md).

## 前提条件

PowerShell 自体以外にはありません。この関数は、すべての Azure Automation ランタイムで利用できる .NET 型のみを使用します（`System.IO.Compression`, `System.Text`, `System.Xml`を使わない文字列構築）。Graph や Az の接続は不要です — この関数はローカル データだけで動作し、ローカル ファイルを書き出します。

## クイック スタート

最小限の呼び出しでは、行を関数にパイプし、出力パスを指定します:

```powershell
$devices | Export-RjRbXlsx -Path (Join-Path $env:TEMP 'devices.xlsx') -WorksheetName 'Devices'
```

これにより、単一の "Devices" ワークシートを持つブックが作成されます。フィルターのドロップダウン付きのスタイル設定されたテーブル、固定されたヘッダー行、自動調整された列幅、印刷設定を備え、レポートメールに添付するか、ストレージ コンテナーにアップロードする準備が整います。

## パラメーター

### パラメーター セット

この関数には 2 つのパラメーター セットがあります:

| パラメーター セット         | 入力                                              | 用途                                   |
| ------------------ | ----------------------------------------------- | ------------------------------------ |
| `SingleSheet` （既定） | `-InputObject` （パイプライン経由でも可） + `-WorksheetName` | 1 つのテーブル、1 つのワークシート。                 |
| `MultiSheet`       | `-Worksheets` （順序付き辞書）                          | 複数のテーブルを 1 つのブック内の別々のワークシートとして保存します。 |

### 必須

| パラメーター | 型        | 説明                                           |
| ------ | -------- | -------------------------------------------- |
| `パス`   | `string` | 作成する `.xlsx` ファイルの完全パス。 **既存のファイルは上書きされます。** |

### データ入力

| パラメーター        | 型             | パラメーター セット    | 説明                                                                                                                                                                       |
| ------------- | ------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `InputObject` | `object[]`    | `SingleSheet` | エクスポートする行（オブジェクトの配列。パイプライン経由でも受け付けます）。列の順序は最初のオブジェクトのプロパティ順に従います。Dictionary/Hashtable はオブジェクトに変換されます。                                                                    |
| `ワークシート名`     | `string`      | `SingleSheet` | 単一ワークシートの名前。最大 31 文字（参照: [ワークシート名](#worksheet-names)）。既定値: `レポート`.                                                                                                       |
| `ワークシート`      | `IDictionary` | `MultiSheet`  | ワークシート名→行 の順序付き辞書。例: `([ordered]@{ 'Summary' = $summary; 'Details' = $details })`。少なくとも 1 件のエントリを含める必要があります。キーはワークシート名で、それぞれ最大 31 文字です（参照: [ワークシート名](#worksheet-names)). |

### 任意 — 内容と書式設定

| パラメーター                  | 型             | 既定値 | 説明                                                                                                                                                                               |
| ----------------------- | ------------- | --- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `CoverSheet`            | `IDictionary` | —   | 順序付き辞書を "Info" 表紙ワークシート（最初のタブ）として表示します: `タイトル` キーは見出しになり、他のすべてのキーはラベル/値の行になります。例: `([ordered]@{ Title = 'デバイス レポート'; Tenant = 'contoso'; Generated = '2026-07-16 08:00 UTC' })`. |
| `HighlightRules`        | `object[]`    | —   | ステータス列の条件付き書式。次のキーを持つハッシュテーブルの配列: `列` （ヘッダー名）、 `値` （セルの正確なテキスト、大文字小文字は区別しない）および `Color` (`Green`, `Red` または `Yellow` — Excel の典型的なハイライト プリセット）。ルールは、指定された列を含むすべてのワークシートに適用されます。  |
| `DataBarColumns`        | `object[]`    | —   | セル内データバー（orange、最小から最大へのグラデーション）が付く数値列名。例: `@('DeviceCount')`。ワークシートに存在しない列はスキップされます。                                                                                            |
| `HyperlinkText`         | `IDictionary` | —   | 列名→ハイパーリンク セルの表示テキスト。例: `@{ Portal = 'Intune で開く' }`。セルには親しみやすいテキストが表示され、リンク先は完全な URL のままです。マッピングのない列は URL をそのまま表示します。                                                           |
| `NoHyperlink`           | `スイッチ`        | オフ  | 変換しない `http/https` URL 文字列をクリック可能なハイパーリンクに。                                                                                                                                      |
| `HideGridLines`         | `スイッチ`        | オフ  | テーブル外のワークシートの罫線を非表示にします（可読性のため、既定では罫線を保持します。表紙シートでは常に非表示です）。                                                                                                                     |
| `UseThousandsSeparator` | `スイッチ`        | オフ  | 数値セルを桁区切り付きで書式設定します（`#,##0` 整数には `#,##0.00` 小数には — Excel によってローカライズされます）。                                                                                                        |

## 使用例

### 複数のワークシート

```powershell
Export-RjRbXlsx `
    -Worksheets ([ordered]@{ 'Summary' = $summaryRows; 'Details' = $detailRows }) `
    -Path (Join-Path $env:TEMP 'report.xlsx')
```

ワークシート タブは辞書の順序で表示され、最初のタブは RealmJoin orange で色付けされ、残りのタブはニュートラルなグレーです。

### 表紙シート、ハイライト ルール、データバー

情報表紙シート、色付きのステータス列、セル内データバーを備えた完全な "report workbook" パターン:

```powershell
$coverSheet = [ordered]@{
    Title             = 'デバイス レポート'
    'Tenant'          = $tenantDisplayName
    'Generated (UTC)' = (Get-Date).ToUniversalTime().ToString('yyyy-MM-dd HH:mm')
    'runbook バージョン' = $Version
    'デバイス合計'   = "$($devices.Count)"
}

Export-RjRbXlsx `
    -Worksheets      ([ordered]@{ 'Devices' = $devices }) `
    -Path            (Join-Path $env:TEMP 'device-report.xlsx') `
    -CoverSheet      $coverSheet `
    -HighlightRules  @(
        @{ Column = 'Compliant'; Value = 'yes'; Color = 'Green' },
        @{ Column = 'Compliant'; Value = 'no';  Color = 'Red' }
    ) `
    -DataBarColumns  @('AppCount')
```

表紙シートは "Info" という名前の最初のタブとして挿入され、 `タイトル` 値はオレンジのアクセント ラインの上にある紺色の見出しとして表示され、その他のキーはすべてラベル/値の行になります。

### 親しみやすいハイパーリンク テキスト

URL 列は既定でクリック可能で、元の URL が表示されます。テーブルを細く保つために、列を親しみやすい表示テキストに割り当てます:

```powershell
$rows = $devices | Select-Object DeviceName, SerialNumber, @{
    n = 'Portal'
    e = { "https://intune.microsoft.com/#view/Microsoft_Intune_Devices/DeviceSettingsMenuBlade/~/overview/mdmDeviceId/$($_.id)" }
}

$rows | Export-RjRbXlsx -Path $xlsxPath -WorksheetName 'Devices' -HyperlinkText @{ Portal = 'Intune で開く' }
```

### 配信ヘルパーと組み合わせる

レポート runbook でよくあるエンドツーエンドのパターン — ブックを書き出し、その後レポートメールに添付するか、ダウンロードリンク用にアップロードします:

```powershell
$xlsxPath = Join-Path $env:TEMP 'report.xlsx'
Export-RjRbXlsx -Worksheets ([ordered]@{ Changes = $changeRows; 'All Users' = $allUserRows }) `
    -Path $xlsxPath -CoverSheet $coverSheet

# メール配信 — コンパクトなブックは、サイズ制限時の代替添付ファイルとして最適です
Send-RjRbReportEmail `
    -EmailFrom       $emailFrom `
    -EmailTo         $EmailTo `
    -Subject         "レポート — $(Get-Date -Format 'yyyy-MM-dd')" `
    -MarkdownContent $reportMd `
    -Attachments     @($xlsxPath)

# ...または、期限付きダウンロードリンクによるストレージ配信
$uploaded = Publish-RjRbFilesToStorageContainer `
    -FilePaths          $xlsxPath `
    -ContainerName      'reports' `
    -ResourceGroupName  $ResourceGroupName `
    -StorageAccountName $StorageAccountName `
    -AddBlobNamePrefix  $true
```

参照 [Send-RjRbReportEmail](https://docs.realmjoin.com/ja/dev-reference/report-functions/send-rjrbreportemail.md) と [Publish-RjRbFilesToStorageContainer](https://docs.realmjoin.com/ja/dev-reference/report-functions/publish-rjrbfilestostoragecontainer.md) このパターンの配信側に使います。

## セル型の処理

| 入力値                                                       | 次のようにレンダリングされます                                                               |
| --------------------------------------------------------- | ----------------------------------------------------------------------------- |
| .NET の整数/浮動小数点/decimal 型                                  | Excel の数値（必要に応じて `-UseThousandsSeparator`). `NaN`/`Infinity` テキストにフォールバックします。 |
| `[datetime]`                                              | 実際の Excel 日付。日付のみの値には日付書式が適用され、時刻を含む値には日時書式が適用されます。表示クライアントによってローカライズされます。    |
| ISO-8601 日付文字列（`2026-07-16T08:00:00Z`、Graph の典型的な日付フィールド） | 実際に並べ替え可能な Excel 日付として解析・表示されます。                                              |
| `[bool]`                                                  | Excel のブール値（`TRUE`/`FALSE`).                                                  |
| `http://` / `https://` URL 文字列                            | クリック可能なハイパーリンク（抑制するには `-NoHyperlink`; 表示テキストは `-HyperlinkText`).              |
| 配列 / コレクション                                               | 項目は `;` で連結され、                                                                |
| `$null` / `DBNull`                                        | 空のセル。                                                                         |
| それ以外                                                      | プレーン テキストです。先頭/末尾の空白は保持され、文字列が数値や数式として再解釈されることはありません。                         |

## 動作とエラー処理

### ワークシート名

ワークシート名は Excel の規則に合わせて正規化されます: 無効な文字（`[ ] : * ? / \`）は置換され、名前は 31 文字に切り詰められ、空の名前は `Sheet<n>`になり、重複には `_2`, `_3`、… サフィックスが付きます。

{% hint style="warning" %}
**ワークシート名は 31 文字以内にしてください。** これは `-WorksheetName` および `-Worksheets`のキーにも適用されます。実行時に挿入される値も含みます。長い名前は黙って切り詰められるため、名前の意味のある部分が切り取られたり、2 つの名前が同一になったりすることがあります（後者には `_2` サフィックスが付きます）。短く意味のある名前を選び、 `\ / ? * [ ] :`を含めず、runbook の対応するテーブル タイトルと同じ名前を使用してください [出力データ](https://docs.realmjoin.com/ja/dev-reference/runbook-output-data.md#naming-a-table) タブでは、31 文字を超えるタイトルは Excel へのエクスポートに失敗します。
{% endhint %}

### 列ヘッダー

ヘッダー名は最初の行オブジェクトのプロパティ順から取得されます。空のプロパティ名は `Column<n>`になり、大文字小文字を区別しない重複名は `_2`, `_3`、… サフィックスで重複排除されます。Excel のテーブル列は一意かつ空でない必要があるためです。

### 空のワークシート

行セットが空のワークシートでも書き出されます — そこには "No data available" の 1 セルのみが含まれ、テーブルはありません。空の `-Worksheets` 辞書は、ただし、 `Export-RjRbXlsx: -Worksheets には少なくとも 1 件のエントリが必要です。`

### 行数制限

Excel ではワークシートは 1,048,576 行に制限されています。この関数は `Export-RjRbXlsx: worksheet '<name>' has <n> rows - xlsx の上限は 1048575 データ行です。` 無効なファイルを書き出す前に。非常に大きなエクスポートは複数のワークシートに分割するか、代わりに CSV として配信してください。

### ハイライト ルール

* ワークシートに存在しない列を参照するルールは、そのワークシートでは黙ってスキップされます（その列がある他のワークシートには引き続き適用されます）。
* 不明な `Color` 値は `Export-RjRbXlsx: unknown highlight color '<color>' - Green、Red、Yellow のいずれかを使用してください。ルールをスキップします。` 警告として出力され、そのルールだけがスキップされます。

### 列幅

幅はヘッダーの長さと最初の 1,000 データ行から計算されます（8〜60 文字に制限）。そのため、非常に大きなエクスポートでも幅計算で遅くなりません。

### 出力ファイル

にある既存ファイルは `パス` 削除して再作成されます。この関数は存在しない親ディレクトリを作成しません — ターゲット フォルダーが存在することを確認してください（例: `New-Item -ItemType Directory`).

## 出力

この関数は何も返しません。ブックを書き出す先は `パス` で、詳細メッセージ（`Export-RjRbXlsx: wrote <n> worksheet(s) to <path>`）を出力します。runbook が `-Verbose` または `$VerbosePreference = 'Continue'`.

## 関連項目

* [Send-RjRbReportEmail](https://docs.realmjoin.com/ja/dev-reference/report-functions/send-rjrbreportemail.md) — 生成されたブックをレポートメールの添付ファイルとして配信します。
* [Publish-RjRbFilesToStorageContainer](https://docs.realmjoin.com/ja/dev-reference/report-functions/publish-rjrbfilestostoragecontainer.md) — ブックを Azure Blob Storage にアップロードし、期限付きダウンロードリンクを返します。
* [Runbook レポート設定](https://docs.realmjoin.com/ja/zi-dong-hua/runbooks/runbook-report-settings.md) — レポート配信チャネルの中央設定です。
* 本番 runbook での使用例: [sync-MFA-secure-users-to-group\_scheduled.ps1](https://github.com/realmjoin/realmjoin-runbooks/blob/master/org/security/sync-MFA-secure-users-to-group_scheduled.ps1) — "Info" 表紙シートを持つ複数ワークシートのブックを作成します。


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.realmjoin.com/ja/dev-reference/report-functions/export-rjrbxlsx.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
