Runbook レポート設定

レポート用 runbook の中央集約されたメールとストレージ配信設定を構成します。

概要

いくつかの RealmJoin runbook には、レポート、通知、およびアラートを管理者に直接配信する自動レポート機能が含まれています。構成によって、レポートは次の方法で配信できます:

• メールで送信 — 構成された送信者アドレスを代表して Microsoft Graph API を使用して
• Azure Storage Account にアップロード — そして期限付きの SAS ダウンロードリンクとして利用可能に

両方の配信チャネルをサポートすることが、今後のすべてのレポート runbook における想定標準です。まだ両方のチャネルをサポートしていないレポート runbook もありますが、サポート対象の runbook は継続的に増えています。両方のチャネルは、個別にも組み合わせでも有効化できます。

すべての共有設定は RealmJoin Runbook Customization で一度だけ構成され、それぞれの機能を使用するすべての runbook に自動的に適用されます。runbook ごとに異なる設定（対象コンテナー名など）は、この中央設定の対象ではなく、各 runbook で直接設定されます。

これらの設定を利用する関数 — Send-RjRbReportEmail と Publish-RjRbFilesToStorageContainer — は RealmJoin.RunbookHelper PowerShell モジュールによって提供されます。詳細な使用方法については Report Functions を参照してください。

メール配信

前提条件

次のような専用の共有メールボックスの使用を推奨します。 [e-mail]。このメールボックスは、すべてのレポートの送信者アドレスとして使用されます。受信者が自動レポートに返信することは想定されないため、no-reply アドレスを使用できます。

注: 送信者アドレスはユーザーまたは共有メールボックスでなければなりません — Microsoft 365 グループは Graph API を介してメールを送信できません。レポート受信者としてのグループ アドレスは技術的には動作しますが、推奨されません。実際にメンバーがメールを受信するかどうかはグループのフォロー/サブスクリプション設定に依存し、配信失敗は送信者メールボックス内の未配信レポートとしてのみ表示されます。 受信者 。

構成

詳細は JSON Based Customizing のドキュメントで説明されているとおり、 RealmJoin Runbook Customization RealmJoin Portal（Settings > Runbook Customizations）内へ移動します。

〜の Settings ブロックで、次の RJReport セクションを追加または変更して、次を含めます: EmailSender プロパティに希望の送信者メールアドレスを指定します:

{
    "Settings": {
        "RJReport": {
            "EmailSender": "[e-mail]"
        }
    }
}

置き換えてください [e-mail] を実際の共有メールボックスのアドレスに。

Service Desk の連絡先情報（オプション）

この中央設定は、すべての runbook に対して共通の Service Desk 値のみを提供します。連絡先情報が実際に通知メールに含まれるかどうかは、それぞれの runbook 自身によって決まります — 対応する Service Desk パラメーター（例: ServiceDeskDisplayName, ServiceDeskPortalUrl）を実装している runbook のみがこれらの値を読み取り、メールに表示します。

これらの runbook に Service Desk の連絡先情報を提供するには、次のプロパティを RJReport セクションに追加します:

{
    "Settings": {
        "RJReport": {
            "EmailSender": "[e-mail]",
            "ServiceDesk_DisplayName": "IT Service Desk",
            "ServiceDesk_EMail": "[e-mail]",
            "ServiceDesk_Phone": "[phone]",
            "ServiceDesk_PortalUrl": "https://servicedesk.domain.com"
        }
    }
}

パラメーター:

• ServiceDesk_DisplayName — Service Desk の表示名（例: "IT Support", "Help Desk"）
• ServiceDesk_EMail — Service Desk のメールアドレス（クリック可能な mailto: リンクとして表示されます）
• ServiceDesk_Phone — 国際形式の Service Desk 電話番号（クリック可能な tel: リンクとして表示されます）
• ServiceDesk_PortalUrl — Service Desk ポータルまたは Web サイトの URL（クリック可能なリンクとして表示されます）

すべてのパラメーターは任意です。構成されている場合は、メールのフッターにクリック可能なリンクとして表示されます。

注: 一部の runbook では、要求のトリガーとなった特定のチケットを参照するための run ごとのチケットリンク（例: ServiceDeskTicketUrl）も受け付けます。これは runbook パラメーターであり、この中央設定の一部ではありません。

メールのブランド設定（オプション）

レポートメールには Tenant 固有のブランド設定を適用できます。既定の RealmJoin のヘッダーおよびフッターの画像を独自の画像に置き換えたり、フッター画像を社内イントラネットや IT ポータルなどのカスタム先にリンクさせたり、テンプレートの色を企業デザインに合わせて調整したりできます。

ブランド設定を構成するには、 Branding のサブセクションを RJReport ブロックに追加します（ StorageAccount):

{
    "Settings": {
        "RJReport": {
            "Branding": {
                "HeaderImageUrl": "https://cdn.contoso.com/branding/email-header.png",
                "FooterImageUrl": "https://cdn.contoso.com/branding/email-footer.png",
                "FooterLink": "https://intranet.contoso.com",
                "AccentColor": "#0052cc",
                "TextColor": "#1a1a2e"
            }
        }
    }
}

パラメーター:

設定項目	必須	既定値	説明
HeaderImageUrl	いいえ	RealmJoin のヘッダー画像	既定の RealmJoin ヘッダー画像を置き換えるカスタム ヘッダー画像の公開 HTTPS URL
FooterImageUrl	いいえ	RealmJoin のフッター画像	既定の RealmJoin フッター画像を置き換えるカスタム フッター画像の公開 HTTPS URL
FooterLink	いいえ	https://www.realmjoin.com	フッター画像がリンクする URL
AccentColor	いいえ	#f8842c (RealmJoin オレンジ)	メールテンプレートのアクセントカラー: 表のヘッダー行、アクションボタン、情報ボックスのアクセント枠
TextColor	いいえ	#011e33 (RealmJoin ネイビー)	メールテンプレートの主要テキスト色: 本文、見出し、リスト項目、コード

画像要件:

• 画像は次の方法で到達可能である必要があります: 公開 HTTPS URL — 例えば、匿名読み取りアクセスが有効な Azure Blob Storage コンテナー、CDN、または会社の Web サイトです。SAS Token を含む URL でも動作し、コンテナーを非公開に保てます。
• 対応形式: PNG、JPEG または GIF。形式はファイル拡張子ではなく、ファイルシグネチャから判定されます。
• 画像は 幅 750 pxでレンダリングされます。推奨サイズは 750×200 px （既定のバナーに一致するサイズ）または 1500×400 px を高 DPI ディスプレイ向けに使用します。
• 最大 200 KB 画像 1 枚あたり; 100 KB 以下 が推奨されます。ブランド画像は、レポート添付ファイルと約 4 MB のメール全体サイズ上限を共有します（参考までに、既定の RealmJoin グラフィックは 52 KB と 15 KB です）。

色の要件:

• 値は、先頭の # — たとえば #0052cc。短縮形（#05c）および色名（赤）はサポートされません。
• メールとその添付ファイルの両方はライト/ダークモードで表示されるため、 と 白いコンテンツ カード上でも読みやすいテキスト色と、白いボタン文字に対して十分なコントラストを持つアクセントカラーを選んでください。
• ステータスカラー（成功、エラー、警告状態の緑/赤/アンバー）および中立のグレーは、意図的に構成できません — それらは Tenant ごとに変わるべきではない意味を持っています。

画像は各実行ごとに runbook によってダウンロードおよび検証されます。設定が空のままの場合は、既定の RealmJoin グラフィック、色、およびフッターリンクが使用されます。ダウンロードに失敗した場合、画像が無効な場合、または色が有効な hex 値でない場合は警告がログに記録され、代わりに対応する既定値が使用されます — 壊れたブランド設定が原因でレポートメールの送信が妨げられることはありません。

すべての設定は任意であり、レポートメールを送信するすべての runbook に適用されます。

注: 色の設定には RealmJoin.RunbookHelper 0.8.9 以降が Automation Account に必要です。古いモジュール バージョンでは画像設定は引き続き適用され、色は無視されます。

Storage Account への配信

この配信チャネルをサポートするレポート runbook は、出力を Azure Blob Storage コンテナーにアップロードできます。アップロードが成功すると、runbook はファイルを直接ダウンロードするために使用できる期限付きの SAS リンクを返します。このチャネルは、メール配信とは独立して使用することも、併用することもできます。

前提条件

既存の Azure Storage Account が必要です。Automation Account のマネージド ID（または runbook で使用される Service Principal）には、Storage Account またはそのリソース グループに対して少なくとも Storage Blob Data Contributor 権限が必要です。

構成

〜に移動し RealmJoin Runbook Customization 、次の StorageAccount のサブセクションを RJReport ブロックを追加します:

{
    "Settings": {
        "RJReport": {
            "StorageAccount": {
                "ResourceGroup": "rg-reports",
                "StorageAccountName": "stcontosoreports",
                "LinkExpiryDays": 6
            }
        }
    }
}

パラメーター:

設定項目	必須	既定値	説明
ResourceGroup	はい	—	Storage Account を含むリソース グループ
StorageAccountName	はい	—	Azure Storage Account の名前
LinkExpiryDays	いいえ	6	生成された SAS ダウンロードリンクの有効期限が切れるまでの日数

注: 個別の runbook に固有の設定—たとえば対象コンテナー名やカスタム blob 名—は、その runbook で直接構成され、この中央設定の一部ではないように意図されています。blob 名のプレフィックス付与も同様です。上書きを防ぐためにタイムスタンプのプレフィックス（yyyyMMdd-HHmmss）を blob 名の先頭に付けるかどうかは、 AddBlobNamePrefix パラメーターで Publish-RjRbFilesToStorageContainer （既定値 $false）制御され、各 runbook が明示的に渡します。

組み合わせ例

次のスニペットは、完全な RJReport すべての機能を有効にした構成を示します:

{
    "Settings": {
        "RJReport": {
            "EmailSender": "[e-mail]",
            "ServiceDesk_DisplayName": "IT Service Desk",
            "ServiceDesk_EMail": "[e-mail]",
            "ServiceDesk_Phone": "[phone]",
            "ServiceDesk_PortalUrl": "https://servicedesk.domain.com",
            "Branding": {
                "HeaderImageUrl": "https://cdn.contoso.com/branding/email-header.png",
                "FooterImageUrl": "https://cdn.contoso.com/branding/email-footer.png",
                "FooterLink": "https://intranet.contoso.com",
                "AccentColor": "#0052cc",
                "TextColor": "#1a1a2e"
            },
            "StorageAccount": {
                "ResourceGroup": "rg-reports",
                "StorageAccountName": "stcontosoreports",
                "LinkExpiryDays": 6
            }
        }
    }
}