監査の構成

[アーティクル]
06/14/2023

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

組織の設定を構成する

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

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

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

組織の設定の取得

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

Web API
.NET 用 SDK

要求:

GET [Organization URI]/api/data/v9.2/organizations?$select=
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(isauditenabled,auditretentionperiodv2,isuseraccessauditenabled,useraccessauditinginterval)",
    "value": [
        {
            "@odata.etag": "W/\"67404512\"",
            "isauditenabled": true,
            "auditretentionperiodv2": 30,
            "isuseraccessauditenabled": true,
            "useraccessauditinginterval": 4,
            "organizationid": "<organizationid value>"
        }
    ]
}

詳細情報

/// <summary>
/// Shows Auditing Configuration properties
/// </summary>
/// <param name="svc">The IOrganizationService instance to use.</param>
static void ShowAuditingConfig(IOrganizationService svc)
{
    WhoAmIResponse whoAmIResponse = 
        (WhoAmIResponse)svc.Execute(new WhoAmIRequest());

    Entity organization = svc.Retrieve(
        entityName: "organization",
        id: whoAmIResponse.OrganizationId,
        columnSet: new ColumnSet(
        "isauditenabled",
        "auditretentionperiodv2",
        "isuseraccessauditenabled",
        "useraccessauditinginterval"
        )
    );

    Console.WriteLine($"isauditenabled: " +
        $"{organization["isauditenabled"]}");
    Console.WriteLine($"auditretentionperiodv2: " +
        $"{organization["auditretentionperiodv2"]}");
    Console.WriteLine($"isuseraccessauditenabled: " +
        $"{organization["isuseraccessauditenabled"]}");
    Console.WriteLine($"useraccessauditinginterval: " +
        $"{organization["useraccessauditinginterval"]}");
}

詳細情報

組織設定の変更

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

Web API または .NET 用の Dataverse SDK を使用して、組織の設定を変更できます。

テーブルと列を構成

組織の監査が有効になっている場合、監査用に有効化されたテーブルはすべて、監査が有効になっている全列の監査データを書き込みます。主な制御は組織レベルであり、次にテーブルレベルです。

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

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

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

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

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

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

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

注意

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

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

テーブル定義をクエリして IsAuditEnabled プロパティを確認し、どのテーブルが監査をサポートするか、どのテーブルを変更できるかを決定します。

Web API
.NET 用 SDK

このクエリは、監査が有効になっているすべてのパブリックテーブルの 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 >
    ]
}

詳細情報

/// <summary>
/// Lists the tables that can be enabled for auditing and 
/// the tables that cannot be enabled for auditing.
/// </summary>
/// <param name="svc">The IOrganizationService instance to use.</param>
static void ShowTableAuditConfigurations(IOrganizationService svc)
{
    //Define properties to return
    MetadataPropertiesExpression EntityProperties =
        new MetadataPropertiesExpression()
        {
            AllProperties = false
        };
    EntityProperties.PropertyNames
        .AddRange(new string[] { "IsAuditEnabled" });

    //Define filter to apply
    MetadataFilterExpression EntityFilter =
        new MetadataFilterExpression(LogicalOperator.And);
    EntityFilter.Conditions
        .Add(new MetadataConditionExpression(
            "IsPrivate",
            MetadataConditionOperator.Equals,
            false));

    RetrieveMetadataChangesRequest request =
        new RetrieveMetadataChangesRequest()
        {
            Query = new EntityQueryExpression()
            {
                Criteria = EntityFilter,
                Properties = EntityProperties
            }
        };

    RetrieveMetadataChangesResponse response =
        (RetrieveMetadataChangesResponse)svc.Execute(request);

    Console.WriteLine("These tables can be enabled for auditing:");
    response.EntityMetadata.ToList().ForEach(x =>
    {
        if (x.IsAuditEnabled.CanBeChanged && !x.IsAuditEnabled.Value)
        {
            Console.WriteLine($"{x.LogicalName}");
        }
    });

    Console.WriteLine("\nThese tables cannot be enabled for auditing:");
    response.EntityMetadata.ToList().ForEach(x =>
    {
        if (!x.IsAuditEnabled.CanBeChanged && !x.IsAuditEnabled.Value)
        {
            Console.WriteLine($"{x.LogicalName}");
        }
    });
}

詳細情報

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

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

Web API
.NET 用 SDK

要求:

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 を使用してテーブル定義をクエリ

/// <summary>
/// Lists the columns of a table that can be enabled for auditing and 
/// the columns that cannot be enabled for auditing.
/// </summary>
/// <param name="svc">The IOrganizationService instance to use.</param>
/// <param name="tableLogicalName">The logical name of the table.</param>
static void ShowColumnAuditConfigurations(
IOrganizationService svc,
string tableLogicalName)
{

//Define properties to return
MetadataPropertiesExpression EntityProperties =
    new MetadataPropertiesExpression()
    {
        AllProperties = false
    };
EntityProperties.PropertyNames
    .AddRange(new string[] { "Attributes" });

//Define filter to apply
MetadataFilterExpression EntityFilter =
    new MetadataFilterExpression(LogicalOperator.And);
EntityFilter.Conditions.Add(
    new MetadataConditionExpression(
        "LogicalName",
        MetadataConditionOperator.Equals,
        tableLogicalName));

//Define properties to return
MetadataPropertiesExpression AttributeProperties =
    new MetadataPropertiesExpression()
    {
        AllProperties = false
    };
AttributeProperties.PropertyNames
    .AddRange(new string[] {
        "LogicalName",
        "IsAuditEnabled" });


RetrieveMetadataChangesRequest request =
    new RetrieveMetadataChangesRequest()
    {
        Query = new EntityQueryExpression()
        {
            Criteria = EntityFilter,
            Properties = EntityProperties,
            AttributeQuery = new AttributeQueryExpression
            {
                Criteria = null,
                Properties = AttributeProperties
            }

        }
    };

RetrieveMetadataChangesResponse response =
    (RetrieveMetadataChangesResponse)svc.Execute(request);

response.EntityMetadata.ToList().ForEach(x =>
{
    Console.WriteLine("These columns can be enabled for auditing:");
    x.Attributes.ToList().ForEach(y =>
    {
        if (y.IsAuditEnabled.CanBeChanged && !y.IsAuditEnabled.Value)
        {
            Console.WriteLine($"{y.LogicalName}");
        }
    });

    Console.WriteLine("\nThese columns cannot be enabled for auditing:");
    x.Attributes.ToList().ForEach(y =>
    {
        if (!y.IsAuditEnabled.CanBeChanged && !y.IsAuditEnabled.Value)
        {
            Console.WriteLine($"{y.LogicalName}");
        }
    });
});
}

詳細: スキーマの定義をクエリ

監査用テーブルおよび列を有効化または無効化

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

Tables

API	Property	詳細情報
Web API	EntityMetadata.`IsAuditEnabled.Value`	テーブル更新の定義
.NET 用 SDK	EntityMetadata.IsAuditEnabled.`Value`	テーブルを取得して更新する

Columns

API	Property	詳細情報
Web API	AttributeMetadata.`IsAuditEnabled.Value`	列の更新
.NET 用 SDK	AttributeMetadata.IsAuditEnabled.`Value`	列の更新

重要

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

列変更の公開

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

Web API
.NET 用 SDK

要求:

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

詳細情報

PublishXml アクション

次の例では、account テーブルを公開します。

PublishXmlRequest request = new PublishXmlRequest()
{
    ParameterXml = @"<importexportxml>
                        <entities>
                            <entity>account</entity>
                        </entities>
                    </importexportxml>"
};
svc.Execute(request);

詳細情報

参照

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

注意

ドキュメントの言語設定についてお聞かせください。簡単な調査を行います。 (この調査は英語です)

この調査には約 7 分かかります。個人データは収集されません (プライバシーステートメント)。

次の方法で共有

監査の構成

組織の設定を構成する

組織の設定の取得

組織設定の変更

テーブルと列を構成

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

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

監査用テーブルおよび列を有効化または無効化

Tables

Columns

列変更の公開

参照

その他のリソース