Freigeben über

RetentionLabel erstellen

  • Artikel

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.

Erstellen Sie ein neues retentionLabel-Objekt .

Um eine Dispositionsprüfungsphase zu erstellen, schließen Sie die actionAfterRetentionPeriod-Eigenschaft in den Anforderungstext mit einem der angegebenen möglichen Werte ein.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Globaler Dienst US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet
✅ ✅ ✅ ❌

Berechtigungen

Wählen Sie für diese API die Als am wenigsten privilegierten Berechtigungen gekennzeichneten Berechtigungen aus. Verwenden Sie nur dann eine Berechtigung mit höheren Berechtigungen , wenn dies für Ihre App erforderlich ist. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) RecordsManagement.ReadWrite.All Nicht verfügbar.
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Anwendung Nicht unterstützt Nicht unterstützt

HTTP-Anforderung

POST /security/labels/retentionLabels

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über die Authentifizierung und Autorisierung.
Content-Type application/json. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext eine JSON-Darstellung des retentionLabel-Objekts an.

Geben Sie die folgenden Eigenschaften an, wenn Sie eine retentionLabel-Eigenschaft erstellen.

Eigenschaft Typ Beschreibung
actionAfterRetentionPeriod microsoft.graph.security.actionAfterRetentionPeriod Gibt die Aktion an, die für ein Dokument mit dieser Bezeichnung während des Aufbewahrungszeitraums 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.
descriptionForAdmins String Stellt Bezeichnungsinformationen für den Administrator bereit. Optional.
descriptionForUsers String Stellt die Bezeichnungsinformationen für den Benutzer bereit. Optional.
displayName String Eindeutige Zeichenfolge, die einen Bezeichnungsnamen definiert.
dispositionReviewStages microsoft.graph.security.dispositionReviewStage-Sammlung Überprüfungsphasen, in denen Prüfer benachrichtigt werden, um festzustellen, ob ein Dokument gelöscht oder aufbewahrt werden muss.
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 diese erstellt wird. Die möglichen Werte sind: startLocked, startUnlocked, unknownFutureValue.
labelToBeApplied String Gibt die Ersatzbezeichnung an, die nach Ablauf des Aufbewahrungszeitraums der aktuellen Bezeichnung automatisch angewendet werden soll.

Antwort

Bei erfolgreicher Ausführung gibt die Methode den 201 Created Antwortcode und ein microsoft.graph.security.retentionLabel-Objekt im Antworttext zurück.

Beispiele

Anforderung

Hier sehen Sie ein Beispiel für eine Anforderung.

POST https://graph.microsoft.com/beta/security/labels/retentionLabels
Content-Type: application/json
Content-length: 555

{
  "@odata.type": "#microsoft.graph.security.retentionLabel",
  "displayName": "Retention Schedule 10005",
  "behaviorDuringRetentionPeriod": "retain",
  "actionAfterRetentionPeriod": "startDispositionReview",
  "retentionTrigger": "dateOfEvent",
  "retentionEventType@odata.bind": "https://graph.microsoft.com/beta/security/triggerTypes/retentionEventTypes('e095f4fc-b966-4c40-94de-fb8a383658e4')",
  "retentionDuration": {
    "@odata.type": "microsoft.graph.security.retentionDurationInDays",
    "days": 2555
  },
   "dispositionReviewStages": [
    {
      "stageNumber" : 1,
      "name": "Stage1",
      "reviewersEmailAddresses ": [
        "Admin@contoso.onmicrosoft.com"
      ]
    }
  ],
  "descriptionForAdmins": "retain for 7 years",
  "descriptionForUsers": "retain for 7 years",
  "descriptors": {
    "authorityTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/authorities('fie3f4fc-b966-4c40-94de-fb8a383658e4')",
    "categoryTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/categories('0bjk8-b966-4c40-94de-fb8a383658e4')",
    "citationTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/citations('0e23f4fc-b966-4c40-94de-fb8a383658e4')",
    "departmentTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/departments('p99ef4fc-b966-4c40-94de-fb8a383658e4')",
    "filePlanReferenceTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/filePlanReferences('e095f4fc-b966-4c40-94de-fb8a383658e4')"
  },
  "defaultRecordBehavior":"startLocked",
}

Antwort

Hier ist ein Beispiel für die Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.security.retentionLabel",
  "id": "64a99fb4-07be-0481-8746-44c15c0eef1f",
  "displayName": "Retention Schedule 10005",
  "behaviorDuringRetentionPeriod": "retain",
  "actionAfterRetentionPeriod": "startDispositionReview",
  "retentionTrigger": "dateOfEvent",
  "retentionDuration": {
    "@odata.type": "microsoft.graph.security.retentionDurationInDays",
    "days": 2555
  },
  "dispositionReviewStages": [
    {
     "stageNumber" : 1,
      "name": "Stage1",
      "reviewersEmailAddresses ": [
        "Admin@contoso.onmicrosoft.com"
      ]
    }
  ],
  "isInUse": true,
  "descriptionForAdmins": "retain for 7 years",
  "descriptionForUsers": "retain for 7 years",
  "defaultRecordBehavior":"startLocked",
  "createdBy": {
   "user": {
      "id": "9563a605-e827-4324-a5a9-09efddff1e90",
      "displayName": "Admin"
    }
  },
  "createdDateTime": "2021-08-23T16:43:55Z",
  "labelToBeApplied": " ",
  "defaultRecordBehavior": "startLocked",
  "descriptors": {
    "authority": {
      "displayName": "Business"
    },
    "category": {
      "displayName": "Accounts Payable",
    },
    "citation": {
      "displayName" : "Contoso Company Policy",
      "citationUrl": "www.citationUrl.com",
      "citationJurisdiction": "Contoso"
    },
    "department": {
      "displayName" : "Finance"
    },
    "filePlanReference": {
      "displayName" : "FIN 01-02-001"
    }
  }
}