監査の設定

Microsoft Dataverse の監査では、Organization テーブル の設定を使用し、個々のテーブルと列の定義を使用して、キャプチャする監査履歴データの種類を決定します。 構成データは誰でも表示できますが、設定を変更するには、システム管理者またはシステム カスタマイザーの役割が必要です。 監査構成に加えられた変更 は、監査履歴に含まれます。

組織の設定を構成する

Organization テーブルの 5 つのプロパティが、環境の監査を有効にする方法を制御します。 組織テーブルには、1 行のみ含まれています。 organizationid 列は主キーです。 行を直接クエリしてキー値を取得するか、WhoAmI メッセージを実行して WhoAmIResponse.OrganizationId プロパティの値を取得します。

次の表で、監査動作を制御する organization テーブル列について説明します。

スキーマ名
論理名
表示名
タイプ 説明
IsAuditEnabled
isauditenabled
監査が有効
ブール値 環境に対して監査が有効になっているかどうか
AuditRetentionPeriodV2
auditretentionperiodv2
監査の保持期間の設定
整数 監査ログ レコードを保持する日数
既定値は 30 です。 有効な値は 1 日から 365,000 日 (約 1,000 年) です。 値が "-1" に設定されている場合、レコードは永久に保持されます。
管理者ガイド: 監査の開始/停止とアイテム保持ポリシーの設定
IsUserAccessAuditEnabled
isuseraccessauditenabled
ユーザー アクセス監査は有効ですか
ブール値 ユーザー アクセス ログが有効かどうか
ユーザー アクセス ログを有効にするには、環境の監査も有効にする必要があります。
UserAccessAuditingInterval
useraccessauditinginterval
ユーザー認証の監査の間隔
整数 ユーザー アクセスが何時間ごとにログに記録されるか
既定値は 4 です。
AuditSettings
auditsettings
監査設定
String JSON 形式の文字列。 監査機能に関連する設定が含まれています。

組織の設定を取得

次のクエリを使用して、組織の設定を取得します。

リクエスト:

GET [Organization URI]/api/data/v9.2/organizations?$select=
auditsettings,
isauditenabled,
auditretentionperiodv2,
isuseraccessauditenabled,
useraccessauditinginterval HTTP/1.1

Accept: application/json  
OData-MaxVersion: 4.0  
OData-Version: 4.0
If-None-Match: null

応答:

HTTP/1.1 200 OK

{
    "@odata.context": "[Organization URI]/api/data/v9.2/$metadata#organizations(auditsettings,isauditenabled,auditretentionperiodv2,isuseraccessauditenabled,useraccessauditinginterval)",
    "value": [
        {
            "@odata.etag": "W/\"67404512\"",
            "auditsettings": "{\"IsSqlAuditWriteDisabled\":true}",
            "isauditenabled": true,
            "auditretentionperiodv2": 30,
            "isuseraccessauditenabled": true,
            "useraccessauditinginterval": 4,
            "organizationid": "<organizationid value>"
        }
    ]
}

詳細情報

組織設定の変更

Organization テーブルの列の値を変更して、環境に対する監査の動作を変更します。 設定を変更するには、システム管理者またはシステム カスタマイザーのロールが必要です。 環境設定の読み取りと更新についての詳細

監査設定の変更

Organization.AuditSettings には、 さまざまな機能を有効にするための設定を格納する JSON 文字列が含まれています。 組織レコードの auditsettings 列を更新することで、一部の機能を有効にすることができます。 次の表に、どのような監査設定があるか、その使用目的、および変更できるかどうかを示します。

設定 説明 更新可能
StoreLabelNameforPicklistAudits 選択リスト値の監査では、オプション値とオプション名の両方を監査します。 それ以外の場合は、オプション値のみ。 元のユーザーが選択したラベルの選択は、監査レコードに保持されます。 はい
IsSqlAuditWriteDisabled SQL 以外の監査ストレージが有効になっている場合に、SQL 監査テーブルへの書き込みを無効にするかどうかを示します。 いいえ、エラーになります。
ApplyRetentionToExistingLogs 既存の監査レコードに新しい保持ポリシーを適用します。 いいえ、無視されます。

次の例を使用して、組織の設定を行います。 あなたにはorganizationid値が必要です。 取得方法については、組織の設定を取得するを参照してください。

リクエスト:

PATCH [Organization URI]/api/data/v9.2/organizations([Organization ID]) HTTP/1.1
Content-Type: application/json  
OData-MaxVersion: 4.0  
OData-Version: 4.0
If-Match: *

{
   "auditsettings": "{\"StoreLabelNameforPicklistAudits\":true}"
}

応答:

HTTP/1.1 204 No content

詳細情報

テーブルと列を設定

組織の監査を有効にすると、監査が有効になっているテーブルは、監査が有効になっているすべての列の監査データを記録します。 主な制御は組織レベルであり、次にテーブル レベルです。

テーブルと列には、IsAuditEnabled という名の 管理プロパティ がそれぞれあり、監査が有効かどうかを制御します。

Item Web API .NET 用 SDK
テーブル EntityMetadata.IsAuditEnabled EntityMetadata.IsAuditEnabled プロパティ
列 AttributeMetadata.IsAuditEnabled AttributeMetadata.IsAuditEnabled プロパティ

IsAuditEnabled プロパティは、次のタイプで定義される管理プロパティです。

Web API .NET 用 SDK
BooleanManagedProperty ComplexType BooleanManagedProperty クラス

BooleanManagedProperty には 2 つの重要な特性があります:

プロパティ 説明
Value 設定が有効かどうかを決定します。
CanBeChanged テーブルか列が管理ソリューションに含まれ後、Value 設定が変更可能かどうか決定します。

テーブルを追加するマネージド ソリューションの発行元は、ソリューションをインストールするユーザーが監査を有効にできないようにすることができます。 一部の Dataverse システム テーブルでは、CanBeChanged プロパティが false に設定されているので、監査用に有効または無効にすることはできません。 マネージド プロパティに関する詳細。

注

IsAuditEnabled プロパティでは、テーブル用のデータの変更を監査するまたは列用の監査を有効にするのラベルを使用し、単純なブール値プロパティとしてデザイナーに公開されます。 CanBeChanged プロパティは、プログラムでのみ読み取りまたは設定できます。

監査が有効になっているテーブルを検出

テーブル定義を照会し、IsAuditEnabled プロパティを確認して、監査をサポートするテーブルと変更可能なテーブルを確認します。

このクエリは、監査が有効になっているすべてのパブリック テーブルの Logicalname を返します。

リクエスト:

GET [Organization URI]/api/data/v9.2/EntityDefinitions?$select=
LogicalName,
IsAuditEnabled
&$filter=IsAuditEnabled/Value eq true 
and IsPrivate eq false

Accept: application/json  
OData-MaxVersion: 4.0  
OData-Version: 4.0
If-None-Match: null

応答:

{
    "@odata.context": "[Organization URI]/api/data/v9.2/$metadata#EntityDefinitions(LogicalName,IsAuditEnabled)",
    "value": [
        {
            "LogicalName": "account",
            "MetadataId": "70816501-edb9-4740-a16c-6a5efbc05d84",
            "IsAuditEnabled": {
                "Value": true,
                "CanBeChanged": true,
                "ManagedPropertyLogicalName": "canmodifyauditsettings"
            }
        },
    < list truncated for brevity >
    ]
}

詳細情報

監査が有効になっている列を検出

列定義のクエリを実行し、 IsAuditEnabled プロパティを確認して、監査をサポートする列と変更できる列を確認します。

リクエスト:

GET [Organization URI]/api/data/v9.0/EntityDefinitions(LogicalName='account')/Attributes?$select=
LogicalName,
IsAuditEnabled
&$filter=IsAuditEnabled/Value eq true

Accept: application/json  
OData-MaxVersion: 4.0  
OData-Version: 4.0
If-None-Match: null

応答:

{
    "@odata.context": "[Organization URI]/api/data/v9.2/$metadata#EntityDefinitions('account')/Attributes(LogicalName,IsAuditEnabled)",
    "value": [
        {
            "@odata.type": "#Microsoft.Dynamics.CRM.StringAttributeMetadata",
            "LogicalName": "emailaddress3",
            "MetadataId": "97fb4aae-ea5d-427f-9b2b-9a6b9754286e",
            "IsAuditEnabled": {
                "Value": true,
                "CanBeChanged": true,
                "ManagedPropertyLogicalName": "canmodifyauditsettings"
            }
        },
    < list truncated for brevity >
    ]
}

詳細については: Web API を使用してテーブル定義を照会する

テーブルおよび列の監査を有効または無効にする

監査をサポートするテーブルと列を変更する場合は、それぞれの IsAuditEnabled.Value プロパティを更新します。

テーブルの監査を有効または無効にする

API プロパティ さらに詳しい情報
Web API EntityMetadata.IsAuditEnabled.Value テーブルの定義の更新
.NET 用 SDK EntityMetadata.IsAuditEnabled.Value テーブルを取得して更新する

列の監査を有効または無効にする

API プロパティ さらに詳しい情報
Web API AttributeMetadata.IsAuditEnabled.Value 列の更新
.NET 用 SDK AttributeMetadata.IsAuditEnabled。Value 列の更新

重要

変更内容は、テーブルのカスタマイズを公開するまでは有効になりません。

列変更の公開

PublishXml メッセージを使用して、テーブルのカスタマイズを公開します。

リクエスト:

POST [Organization URI]/api/data/v9.2/PublishXml HTTP/1.1

Accept: application/json  
OData-MaxVersion: 4.0  
OData-Version: 4.0
If-None-Match: null

{
    "ParameterXml": "<importexportxml><entities><entity>account</entity></entities></importexportxml>"
}

応答:

HTTP/1.1 204 OK 

詳細情報

詳細情報

関連項目

管理者ガイド: Dataverse 監査を管理する
管理者向けガイド: システム設定の[監査]タブ
監査の概要
監査済みデータの変更履歴を取得する
監査データを削除