Freigeben über


retentionLabel-Ressourcentyp

Namespace: microsoft.graph.security

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Gibt an, wie Organisationen aus Compliance- und Governancegründen ihre Daten auf Elementebene (E-Mail oder Dokument) verwalten können, einschließlich, ob und wie lange das Element aufbewahrt oder gelöscht werden soll.

Organisationen können Aufbewahrungsbezeichnungen für verschiedene Arten von Inhalten verwenden, die unterschiedliche Aufbewahrungseinstellungen erfordern. Sie können z. B. ein Aufbewahrungsetikett auf Steuerformulare und Belege anwenden, um sie für den gesetzlich vorgeschriebenen Zeitraum aufzubewahren.

Organisationen können Aufbewahrungsbezeichnungen mit den Aufbewahrungszeiträumen und Aktionen basierend auf Faktoren wie dem Datum der letzten Änderung oder Erstellung konfigurieren. Sie können auch verschiedene Aufbewahrungszeiträume starten, indem sie ein Ereignis angeben, das die Aufbewahrung auslösen kann , wenn das Ereignis eintritt.

Weitere Informationen dazu, wie Aufbewahrungsbezeichnungen funktionieren, wann sie verwendet werden sollten und wie Microsoft Purview Aufbewahrungsbezeichnungen unterstützt, damit Sie Aufbewahrungs- und Löscheinstellungen konfigurieren können, finden Sie unter Informationen zu Aufbewahrungsrichtlinien und Aufbewahrungsbezeichnungen.

Methoden

Methode Rückgabetyp Beschreibung
RetentionLabels auflisten microsoft.graph.security.retentionLabel-Sammlung Ruft eine Liste der retentionLabel-Objekte und deren Eigenschaften ab.
RetentionLabel erstellen microsoft.graph.security.retentionLabel Erstellen Sie ein neues retentionLabel-Objekt .
Abrufen von retentionLabel microsoft.graph.security.retentionLabel Liest die Eigenschaften und Beziehungen eines retentionLabel-Objekts .
Aktualisieren von retentionLabel microsoft.graph.security.retentionLabel Aktualisieren sie die Eigenschaften eines retentionLabel-Objekts .
retentionLabel löschen Keine Löschen eines retentionLabel-Objekts .
List retentionEventType microsoft.graph.security.retentionEventType-Sammlung Rufen Sie die retentionEventType-Ressourcen aus der exapnd eventType-Navigationseigenschaft ab.
Hinzufügen von retentionEventType microsoft.graph.security.retentionEventType Fügen Sie eventType hinzu, indem Sie beim Erstellen einer Bezeichnung die relevante odata-Eigenschaft hinzufügen.

Eigenschaften

Eigenschaft Typ Beschreibung
actionAfterRetentionPeriod microsoft.graph.security.actionAfterRetentionPeriod Gibt die Aktion an, die nach Ablauf des durch die retentionDuration-Eigenschaft angegebenen Zeitraums für das bezeichnete Dokument ausgeführt werden soll. Mögliche Werte sind: none, delete, startDispositionReview, unknownFutureValue.
behaviorDuringRetentionPeriod microsoft.graph.security.behaviorDuringRetentionPeriod Gibt an, wie das Verhalten eines Dokuments mit dieser Bezeichnung während des Aufbewahrungszeitraums sein soll. Mögliche Werte sind: doNotRetain, retain, retainAsRecord, retainAsRegulatoryRecord, unknownFutureValue.
createdBy microsoft.graph.identitySet Stellt den Benutzer dar, der das retentionLabel erstellt hat.
createdDateTime DateTimeOffset Stellt das Datum und die Uhrzeit dar, zu dem das retentionLabel erstellt wird.
descriptionForAdmins Zeichenfolge Stellt Bezeichnungsinformationen für den Administrator bereit. Optional.
descriptionForUsers Zeichenfolge Stellt die Bezeichnungsinformationen für den Benutzer bereit. Optional.
displayName Zeichenfolge Eindeutige Zeichenfolge, die einen Bezeichnungsnamen definiert.
id Zeichenfolge Eindeutige ID des retentionLabel-Werts.
isInUse Boolesch Gibt an, ob die Bezeichnung derzeit verwendet wird.
lastModifiedBy microsoft.graph.identitySet Der Benutzer, der das retentionLabel zuletzt geändert hat.
lastModifiedDateTime DateTimeOffset Das letzte Datum, zu dem das RetentionLabel geändert wurde.
retentionDuration microsoft.graph.security.retentionDuration Gibt die Anzahl der Tage an, für die der Inhalt aufbewahrt werden soll.
retentionTrigger microsoft.graph.security.retentionTrigger Gibt an, ob die Aufbewahrungsdauer anhand des Inhaltserstellungsdatums, des bezeichneten Datums oder des Datums der letzten Änderung berechnet wird. Mögliche Werte sind: dateLabeled, dateCreated, dateModified, dateOfEvent, unknownFutureValue.
defaultRecordBehavior microsoft.graph.security.defaultRecordBehavior Gibt den gesperrten oder entsperrten Zustand einer Datensatzbezeichnung an, wenn sie erstellt wird. Die möglichen Werte sind: startLocked, startUnlocked, unknownFutureValue.
labelToBeApplied Zeichenfolge Gibt die Ersatzbezeichnung an, die nach Ablauf des Aufbewahrungszeitraums der aktuellen Bezeichnung automatisch angewendet werden soll.

Beziehungen

Beziehung Typ Beschreibung
dispositionReviewStages microsoft.graph.security.dispositionReviewStage-Sammlung Wenn aktion am Ende der Aufbewahrung als "dispositionReview" ausgewählt wird, gibt dispositionReviewStages eine sequenzielle Gruppe von Phasen an, in denen in jeder Phase mindestens ein Prüfer vorhanden ist.
retentionEventType microsoft.graph.security.retentionEventType Stellt den Typ dar, der einem Aufbewahrungsereignis zugeordnet ist.
Deskriptoren microsoft.graph.security.filePlanDescriptor Stellt sofort einsatzbereite Werte dar, die mehr Optionen bieten, um die Verwaltbarkeit und Organisation der Zu bezeichnenden Inhalte zu verbessern.

JSON-Darstellung

Die folgende JSON-Darstellung zeigt den Ressourcentyp.

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