Configurer l’audit

Article
08/25/2023

L’audit Microsoft Dataverse utilise les paramètres de la table Organization et les définitions des tables et des colonnes individuelles pour déterminer le type de données d’historique d’audit à capturer. Tout le monde peut afficher la configuration, mais vous devez disposer des rôles Administrateur système ou Personnalisateur système pour modifier les paramètres. Les modifications apportées à la configuration d’audit sont incluses dans l’historique d’audit.

Configurer les paramètres d’organisation

Quatre propriétés dans la table Organization contrôlent la façon dont l’audit est activé pour un environnement. La table d’organisation contient une seule ligne. La colonne organizationid est la clé primaire. Interrogez directement la ligne pour obtenir la valeur de la clé ou exécutez le message WhoAmI et extrayez la valeur de la propriété WhoAmIResponse.OrganizationId.

Le tableau suivant décrit les colonnes de la table d’organisation qui contrôlent le comportement d’audit.

Nom du schéma Nom logique Nom d’affichage	Type	Description
`IsAuditEnabled` `isauditenabled` Est activé pour l’audit	Entier	Si l’audit est activé pour l’environnement
`AuditRetentionPeriodV2` `auditretentionperiodv2` Paramètres de la période de rétention de l’audit	Integer	Le nombre de jours de conservation des enregistrements du journal d’audit La valeur par défaut est 30. Les valeurs valides sont comprises entre 1 et 365 000 jours (~ 1 000 ans). Si la valeur est définie sur -1, les enregistrements sont conservés indéfiniment. Guide de l’administrateur : démarrer/arrêter l’audit et définir la stratégie de rétention
`IsUserAccessAuditEnabled` `isuseraccessauditenabled` L’audit de l’accès utilisateur est-il activé	Entier	Si la journalisation des accès utilisateur est activée L’audit de l’environnement doit être activé pour que la journalisation des accès utilisateur soit activée.
`UserAccessAuditingInterval` `useraccessauditinginterval` Intervalle d’audit de l’authentification de l’utilisateur	Integer	Fréquence à laquelle l’accès utilisateur est journalisé, en heures La valeur par défaut est 4.

Récupérer les paramètres d’organisation

Utilisez les requêtes suivantes pour récupérer les paramètres de votre organisation.

API web
SDK pour .NET

Demande :

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

Réponse :

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

En savoir plus sur :

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

En savoir plus sur :

Modifier les paramètres d’organisation

Modifiez les valeurs de la colonnes dans la table d’organisation pour modifier le fonctionnement de l’audit pour l’environnement. Vous devez disposer du rôle de sécurité Administrateur système ou Personnalisateur système pour modifier ces paramètres.

Vous pouvez utiliser l’API web ou le SDK Dataverse pour .NET pour modifier les paramètres de votre organisation :

Configurer les tables et les colonnes

Lorsque l’audit est activé pour l’organisation, toutes les tables qui sont activées pour l’audit écrivent des données d’audit pour toutes les colonnes activées pour l’audit. Le contrôle principal se situe au niveau de l’organisation, puis au niveau de la table.

Les tables et les colonnes ont chacune une propriété gérée nommée IsAuditEnabled qui contrôle si elles sont activées pour l’audit.

Item	API web	Kit de développement logiciel (SDK) pour .NET
Table	EntityMetadata.`IsAuditEnabled`	Propriété EntityMetadata.IsAuditEnabled
Colonne	AttributeMetadata.`IsAuditEnabled`	Propriété AttributeMetadata.IsAuditEnabled

La propriété IsAuditEnabled est une propriété gérée qui est définie par les types suivants :

API web	Kit de développement logiciel (SDK) pour .NET
BooleanManagedProperty ComplexType	Classe BooleanManagedProperty

Une propriété BooleanManagedProperty comporte deux propriétés importantes :

Property	Description
`Value`	Détermine si le paramètre est activé.
`CanBeChanged`	Détermine si le paramètre `Value` peut être modifié une fois la table ou la colonne incluse dans un solution gérée.

L’éditeur d’une solution gérée qui ajoute une table peut empêcher les personnes qui installent leur solution d’activer l’audit. Certaines tables système Dataverse ne peuvent pas être activées ou désactivées pour l’audit car la propriété CanBeChanged est définie sur false. Découvrir les propriétés gérées.

Notes

La propriété IsAuditEnabled est exposée dans le concepteur comme une simple propriété booléenne avec l’étiquette Auditer les modifications de ses données pour les tables ou Activer l’audit pour les colonnes. La propriété CanBeChanged ne peut être lue ou définie que par programmation.

Détecter les tables activées pour l’audit

Interrogez les définitions de table et recherchez la propriété IsAuditEnabled pour déterminer quelles tables prennent en charge l’audit et celles qui peuvent être changées.

API web
SDK pour .NET

Cette requête retourne le Logicalname pour toutes les tables publiques activées pour l’audit.

Demande :

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

Réponse :

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

En savoir plus sur :

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

En savoir plus sur :

Détecter les colonnes activées pour l’audit

Interrogez les définitions de colonne et recherchez la propriété IsAuditEnabled pour déterminer quelles colonnes prennent en charge l’audit et celles qui peuvent être changées.

API web
SDK pour .NET

Demande :

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

Réponse :

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

Pour plus d’informations : Interroger les définitions de table à l’aide de l’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}");
        }
    });
});
}

Pour plus d’informations : Interroger les définitions du schéma

Activer ou désactiver des tables et des colonnes pour l’audit

Pour modifier les tables et les colonnes prenant en charge l’audit, mettez à jour leur propriété IsAuditEnabled.Value.

Tables

API	Property	Pour plus d’informations :
API web	EntityMetadata.`IsAuditEnabled.Value`	Mettre à jour des définitions de table
Kit de développement logiciel (SDK) pour .NET	EntityMetadata.IsAuditEnabled.`Value`	Récupérer et mettre à jour une table

Columns

API	Property	Pour plus d’informations :
API web	AttributeMetadata.`IsAuditEnabled.Value`	Mettre à jour une colonne
Kit de développement logiciel (SDK) pour .NET	AttributeMetadata.IsAuditEnabled.`Value`	Mettre à jour une colonne

Important

Les modifications ne sont effectives qu’une fois les personnalisations de table publiées.

Publier les modifications de colonne

Utilisez le message PublishXml pour publier les personnalisations de la table.

API web
SDK pour .NET

Demande :

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

Réponse :

HTTP/1.1 204 OK

En savoir plus sur :

Action PublishXml

L’exemple suivant publie la table account :

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

En savoir plus sur :

Voir aussi

Guide de l’administrateur : gérer l’audit Dataverse
Guide de l’administrateur : Onglet Audit des Paramètres système
Présentation de l’audit
Extraire l’historique de modifications de données auditées
Supprimer des données d’audit

Notes

Pouvez-vous nous indiquer vos préférences de langue pour la documentation ? Répondez à un court questionnaire. (veuillez noter que ce questionnaire est en anglais)

Le questionnaire vous prendra environ sept minutes. Aucune donnée personnelle n’est collectée (déclaration de confidentialité).

Partager via

Configurer l’audit

Configurer les paramètres d’organisation

Récupérer les paramètres d’organisation

Modifier les paramètres d’organisation

Configurer les tables et les colonnes

Détecter les tables activées pour l’audit

Détecter les colonnes activées pour l’audit

Activer ou désactiver des tables et des colonnes pour l’audit

Tables

Columns

Publier les modifications de colonne

Voir aussi

Commentaires

Ressources supplémentaires