Configurar auditoría

Artículo
09/29/2023

Las auditorías de Microsoft Dataverse utilizan la configuración en la Tabla Organization y definiciones de tablas y columnas individuales para determinar qué tipo de datos del historial de auditoría capturar. Cualquiera puede ver la configuración, pero debe tener los roles Administrador del sistema o Personalizador del sistema para cambiar esta configuración. Los cambios realizados en la configuración de auditoría se incluyen en el historial de auditoría.

Ajustar la configuración para la organización

Cuatro propiedades en la Tabla Organization controlan cómo se habilita la auditoría para un entorno. La tabla Organization contiene una sola fila. La clave principal es la columna organizationid. Consulte la fila directamente para obtener el valor de la clave o ejecute el mensaje WhoAmI y tome el valor de la propiedad WhoAmIResponse.OrganizationId.

La siguiente tabla describe las columnas de la tabla Organiation que controlan el comportamiento de auditoría.

Nombre de esquema Nombre lógico Nombre para mostrar	Tipo	Descripción
`IsAuditEnabled` `isauditenabled` Está habilitada la auditoría	Booleana	Si la auditoría está habilitada para el entorno
`AuditRetentionPeriodV2` `auditretentionperiodv2` Configuración del período de retención de auditoría	Número entero	El número de días para conservar los registros de auditoría El valor predeterminado es 30. Los valores válidos están entre 1 y 365 000 días (~1000 años). Si el valor se establece en -1, los registros se conservan para siempre. Guía del administrador: iniciar/detener la auditoría y establecer la directiva de retención
`IsUserAccessAuditEnabled` `isuseraccessauditenabled` Está habilitado para auditoría de acceso de usuario	Booleana	Si el registro de acceso de usuario está habilitado La auditoría del entorno debe estar habilitada para habilitar el registro de acceso de usuarios.
`UserAccessAuditingInterval` `useraccessauditinginterval` Intervalo de auditoría de autenticación de usuario	Número entero	Con qué frecuencia se registra el acceso del usuario en horas El valor predeterminado es 4.

Recuperar configuración de organización

Utilice las siguientes consultas para recuperar la configuración de su organización.

API web
SDK para .NET

Solicitud:

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

Respuesta:

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>"
        }
    ]
}

Más información sobre:

/// <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"]}");
}

Más información sobre:

Cambiar configuración de organización

Cambie los valores de la columna en la tabla Organization para cambiar cómo funciona la auditoría para el entorno. Para cambiar esta configuración debe tener los roles de seguridad Personalizador del sistema o Administrador del sistema.

Puede utilizar la API web o el SDK de Dataverse para .NET para cambiar la configuración de su organización:

Configurar tablas y columnas

Cuando la auditoría está habilitada para la organización, cualquier tabla habilitada para auditoría escribirá datos de auditoría para todas las columnas que están habilitadas para auditoría. El control principal está en la organización y luego en el nivel de la tabla.

Las tablas y las columnas tienen cada una propiedad administrada nombrada IsAuditEnabled que controla si están habilitados para la auditoría.

Item	API Web	SDK para .NET
Tabla	EntityMetadata.`IsAuditEnabled`	Propiedad EntityMetadata.IsAuditEnabled
Columna	AttributeMetadata.`IsAuditEnabled`	Propiedad AttributeMetadata.IsAuditEnabled

La propiedad IsAuditEnabled es una propiedad administrada que está definida por los siguientes tipos:

API Web	SDK para .NET
BooleanManagedProperty ComplexType	Clase BooleanManagedProperty

Una BooleanManagedProperty tiene dos propiedades importantes:

Property	Descripción
`Value`	Determina si la configuración está habilitada.
`CanBeChanged`	Determina si la configuración `Value` se puede cambiar después de que la tabla o columna se incluya en un solución administrada.

El editor de la solución administrada que agrega una tabla puede impedir que las personas que instalan la solución habiliten la auditoría. Algunas tablas del sistema de Dataverse no se pueden habilitar o deshabilitar para la auditoría porque la propiedad CanBeChanged se establece en false. Obtenga más información acerca de las propiedades administradas.

Nota

La propiedad IsAuditEnabled se expone en el diseñador como una propiedad booleana simple con la etiqueta Auditar los cambios en sus datos para tablas o Habilitar auditoría para columnas. La propiedad CanBeChanged solo se puede leer o establecer mediante programación.

Detectar qué tablas están habilitadas para la auditoría

Consulte las definiciones de la tabla y mire la propiedad IsAuditEnabled para determinar qué tablas actualmente admiten la auditoría y cuáles se pueden cambiar.

API web
SDK para .NET

Esta consulta devuelve Logicalname para todas las tablas públicas que están habilitadas para la auditoría.

Solicitud:

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

Respuesta:

{
    "@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 >
    ]
}

Más información sobre:

/// <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}");
        }
    });
}

Más información sobre:

Detectar qué columnas están habilitadas para la auditoría

Consulte las definiciones de columna y mire la propiedad IsAuditEnabled para determinar qué columnas actualmente admiten la auditoría y cuáles se pueden cambiar.

API web
SDK para .NET

Solicitud:

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

Respuesta:

{
    "@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 >
    ]
}

Más información: Consultar definiciones de tabla mediante la API web

/// <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}");
        }
    });
});
}

Más información: Consultar definiciones de esquema

Habilitar o deshabilitar tablas y columnas para auditoría

Para cambiar qué tablas y columnas admiten la auditoría, debe actualizar la propiedad IsAuditEnabled.Value.

Tablas

API	Property	Más información
API Web	EntityMetadata.`IsAuditEnabled.Value`	Actualizar definiciones de tabla
SDK para .NET	EntityMetadata.IsAuditEnabled.`Value`	Recuperar y actualizar una tabla

Columns

API	Property	Más información
API Web	AttributeMetadata.`IsAuditEnabled.Value`	Actualizar una columna
SDK para .NET	AttributeMetadata.IsAuditEnabled.`Value`	Actualizar una columna

Importante

Los cambios no se implementan hasta que publique las personalizaciones de la tabla.

Publicar cambios de columna

Use el mensaje PublishXml para publicar personalizaciones para la tabla.

API web
SDK para .NET

Solicitud:

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>"
}

Respuesta:

HTTP/1.1 204 OK

Más información sobre:

Acción PublishXml

El siguiente ejemplo publica la tabla account:

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

Más información sobre:

Consulte también

Guía del administrador: Administrar auditoría de Dataverse
Guía del administrador: Configuración del sistema - pestaña Auditoría
Información general de auditoría
Recuperar el historial de cambios de datos auditados
Eliminar datos de auditoría

Nota

¿Puede indicarnos sus preferencias de idioma de documentación? Realice una breve encuesta. (tenga en cuenta que esta encuesta está en inglés)

La encuesta durará unos siete minutos. No se recopilan datos personales (declaración de privacidad).

Configurar auditoría

Ajustar la configuración para la organización

Recuperar configuración de organización

Cambiar configuración de organización

Configurar tablas y columnas

Detectar qué tablas están habilitadas para la auditoría

Detectar qué columnas están habilitadas para la auditoría

Habilitar o deshabilitar tablas y columnas para auditoría

Tablas

Columns

Publicar cambios de columna

Consulte también

Comentarios

Recursos adicionales