配置审核

Microsoft Dataverse 审计功能会使用组织表中的设置以及各个表和列的定义,来确定应捕获何种审计历史记录数据。 任何人都可以查看配置,但必须具有系统管理员或系统定制员角色才能更改设置。 对审核配置所做的更改包含在审核历史记录中。

配置组织设置

“组织”表中的五个属性控制如何为环境启用审核。 组织表包含一行。 列 organizationid 是主键。 直接查询该行以获取键值,或执行 WhoAmI 消息并获取 WhoAmIResponse.OrganizationId 属性的值。

下表描述了控制审计行为的组织表列。

架构名称
逻辑名称
显示名称
类型 Description
IsAuditEnabled
isauditenabled
是否已启用审核
布尔 是否为环境启用审计
AuditRetentionPeriodV2
auditretentionperiodv2
审核保留期设置
Integer 保留审核日志记录的天数
默认值为 30。 有效值为 1 到 365,000 天(约 1,000 年)。 如果该值设置为 -1,则记录将永久保留。
管理员指南:启动/停止审计并设置保留策略
IsUserAccessAuditEnabled
isuseraccessauditenabled
是否已启用用户访问审核
布尔 是否启用用户访问日志记录
必须启用环境审核才能启用用户访问日志记录。
UserAccessAuditingInterval
useraccessauditinginterval
用户身份验证审核间隔
Integer 用户访问的记录频率(以小时为单位)
默认值为 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>"
        }
    ]
}

了解有关以下方面的详细信息:

更改组织设置

更改组织表中的列值,即可更改该环境中的审计行为。 必须具有系统管理员或系统定制员角色才能更改这些设置。 详细了解如何读取和更新环境设置

更改 AuditSettings

Organization.AuditSettings 包含用于存储设置以启用不同功能的 JSON 字符串。 可以通过更新组织记录的 auditsettings 列来启用某些功能。 下表指定了存在哪些审核设置、其用途以及是否可以更改这些设置。

设置 Description 可更新的
StoreLabelNameforPicklistAudits 对于选取列表值的审核,请审核选项值和选项名称。 否则,仅选项值。 原始用户选择的标签选项将保留在审计记录中。 Yes
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 的受管属性,用于控制是否启用审计。

物品 网络应用程序接口 用于 .NET 的 SDK
Table EntityMetadata.IsAuditEnabled EntityMetadata.IsAuditEnabled 属性
列 AttributeMetadata.IsAuditEnabled AttributeMetadata.IsAuditEnabled 属性

该 IsAuditEnabled 属性是由以下类型定义的托管属性:

网络应用程序接口 用于 .NET 的 SDK
布尔型托管属性复杂类型 BooleanManagedProperty 类

一个 BooleanManagedProperty 有两个重要属性:

财产 Description
Value 判断该设置是否启用。
CanBeChanged 确定在托管解决方案中包含表或列后,是否可以更改 Value 设置。

添加数据表的托管解决方案的发布者可能会阻止安装该解决方案的人员启用审计。 由于 false 属性设置为 CanBeChanged,因此无法启用或禁用某些 Dataverse 系统表的审核。 详细了解托管属性。

Note

该 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 财产 更多信息
网络应用程序接口 EntityMetadata.IsAuditEnabled.Value 更新表定义
用于 .NET 的 SDK EntityMetadata.IsAuditEnabled.Value 检索和更新表

启用或禁用列审计

API 财产 更多信息
网络应用程序接口 AttributeMetadata.IsAuditEnabled.Value 更新列
用于 .NET 的 SDK AttributeMetadata.IsAuditEnabled.Value 更新列

Important

在发布表自定义项之前,更改不会生效。

发布列更改

使用该 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 审计
管理员指南:“系统设置审核”选项卡
审核概述
检索已审核数据更改的历史记录
删除审核数据