Type de ressource retentionLabel
Espace de noms : microsoft.graph.security
Importante
Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .
Représente la façon dont les organisations, à des fins de conformité et de gouvernance, peuvent gérer leurs données au niveau d’un élément (e-mail ou document), y compris si et pendant combien de temps conserver ou supprimer l’élément.
Les organisations peuvent utiliser des étiquettes de rétention pour différents types de contenu qui nécessitent des paramètres de rétention différents. Par exemple, ils peuvent appliquer une étiquette de rétention aux formulaires fiscaux et aux documents justificatifs pour les conserver pendant la période requise par la loi.
Les organisations peuvent configurer des étiquettes de rétention avec les périodes de rétention et les actions en fonction de facteurs tels que la date de dernière modification ou de création. Ils peuvent également démarrer différentes périodes de rétention en spécifiant un événement qui peut déclencher la rétention lorsque l’événement se produit.
Pour plus d’informations sur le fonctionnement des étiquettes de rétention, quand les utiliser et la façon dont Microsoft Purview prend en charge les étiquettes de rétention pour vous permettre de configurer les paramètres de rétention et de suppression, consultez En savoir plus sur les stratégies de rétention et les étiquettes de rétention.
Méthodes
| Méthode | Type de retour | Description |
|---|---|---|
| Lister retentionLabels | collection microsoft.graph.security.retentionLabel | Obtenez la liste des objets retentionLabel et de leurs propriétés. |
| Créer retentionLabel | microsoft.graph.security.retentionLabel | Créez un objet retentionLabel . |
| Obtenir retentionLabel | microsoft.graph.security.retentionLabel | Lisez les propriétés et les relations d’un objet retentionLabel . |
| Mettre à jour retentionLabel | microsoft.graph.security.retentionLabel | Mettez à jour les propriétés d’un objet retentionLabel . |
| Supprimer retentionLabel | Aucune | Supprime un objet retentionLabel . |
| List retentionEventType | collection microsoft.graph.security.retentionEventType | Obtenez les ressources retentionEventType à partir de la propriété de navigation eventType de l’exapnd. |
| Ajouter retentionEventType | microsoft.graph.security.retentionEventType | Ajoutez eventType en ajoutant la propriété odata appropriée lors de la création d’une étiquette. |
Propriétés
| Propriété | Type | Description |
|---|---|---|
| actionAfterRetentionPeriod | microsoft.graph.security.actionAfterRetentionPeriod | Spécifie l’action à effectuer sur le document étiqueté après l’expiration de la période spécifiée par la propriété retentionDuration. Les valeurs possibles sont : none, delete, startDispositionReview, unknownFutureValue. |
| behaviorDuringRetentionPeriod | microsoft.graph.security.behaviorDuringRetentionPeriod | Spécifie le comportement d’un document avec cette étiquette pendant la période de rétention. Les valeurs possibles sont : doNotRetain, retain, retainAsRecord, retainAsRegulatoryRecord, unknownFutureValue. |
| createdBy | microsoft.graph.identitySet | Représente l’utilisateur qui a créé la retentionLabel. |
| createdDateTime | DateTimeOffset | Représente la date et l’heure de création de retentionLabel. |
| descriptionForAdmins | Chaîne | Fournit des informations d’étiquette pour l’administrateur. Facultatif. |
| descriptionForUsers | Chaîne | Fournit les informations d’étiquette pour l’utilisateur. Optional. |
| displayName | Chaîne | Chaîne unique qui définit un nom d’étiquette. |
| id | Chaîne | ID unique de retentionLabel. |
| isInUse | Valeur booléenne | Spécifie si l’étiquette est en cours d’utilisation. |
| lastModifiedBy | microsoft.graph.identitySet | Utilisateur qui a modifié la dernière fois retentionLabel. |
| lastModifiedDateTime | DateTimeOffset | Date et heure de la dernière modification de retentionLabel. |
| retentionDuration | microsoft.graph.security.retentionDuration | Spécifie le nombre de jours pendant lesquels conserver le contenu. |
| retentionTrigger | microsoft.graph.security.retentionTrigger | Spécifie si la durée de rétention est calculée à partir de la date de création du contenu, de la date étiquetée ou de la date de la dernière modification. Les valeurs possibles sont : dateLabeled, dateCreated, dateModified, dateOfEvent, unknownFutureValue. |
| defaultRecordBehavior | microsoft.graph.security.defaultRecordBehavior | Spécifie l’état verrouillé ou déverrouillé d’une étiquette d’enregistrement lors de sa création. Les valeurs possibles sont : startLocked, startUnlocked, unknownFutureValue. |
| labelToBeApplied | Chaîne | Spécifie l’étiquette de remplacement à appliquer automatiquement après la fin de la période de rétention de l’étiquette actuelle. |
Relations
| Relation | Type | Description |
|---|---|---|
| dispositionReviewStages | collection microsoft.graph.security.dispositionReviewStage | Lorsque l’action à la fin de la rétention est choisie comme « dispositionReview », dispositionReviewStages spécifie un ensemble séquentiel d’étapes avec au moins un réviseur dans chaque phase. |
| retentionEventType | microsoft.graph.security.retentionEventType | Représente le type associé à un événement de rétention. |
| Descripteurs | microsoft.graph.security.filePlanDescriptor | Représente des valeurs prêtes à l’emploi qui fournissent davantage d’options pour améliorer la facilité de gestion et l’organisation du contenu que vous devez étiqueter. |
Représentation JSON
La représentation JSON suivante montre le type de ressource.
{
"@odata.type": "#microsoft.graph.security.retentionLabel",
"id": "String (identifier)",
"displayName": "String",
"behaviorDuringRetentionPeriod": "String",
"actionAfterRetentionPeriod": "String",
"retentionTrigger": "String",
"retentionDuration": {
"@odata.type": "microsoft.graph.security.retentionDuration"
},
"isInUse": "Boolean",
"descriptionForAdmins": "String",
"descriptionForUsers": "String",
"createdBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"createdDateTime": "String (timestamp)",
"lastModifiedBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"lastModifiedDateTime": "String (timestamp)",
"labelToBeApplied": "String",
"defaultRecordBehavior": "String"
}