retentionLabel を更新する

名前空間: microsoft.graph.security

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

retentionLabel オブジェクトのプロパティを更新します。

廃棄レビュー ステージを更新するには、指定可能な値の 1 つを指定して、要求本文に actionAfterRetentionPeriod プロパティを含めます。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ✅ ✅ ❌

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) RecordsManagement.ReadWrite.All 注意事項なし。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション サポートされていません。 サポートされていません。

HTTP 要求

PATCH /security/labels/retentionLabels/{retentionLabelId}

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-Type application/json. 必須です。

要求本文

リクエストの本文には、更新するプロパティの値 のみ を指定します。 要求本文に含まれていない既存のプロパティは、以前の値を維持するか、他のプロパティ値の変更に基づいて再計算されます。

次の表に、更新できるプロパティを示します。

プロパティ 型 説明
descriptionForAdmins 文字列 これは、管理者にラベル情報を提供する省略可能なプロパティです。
descriptionForUsers 文字列 これは、ユーザーにラベル情報を提供する省略可能なプロパティです。
dispositionReviewStages microsoft.graph.security.dispositionReviewStage コレクション ドキュメントを削除または保持する必要があるかどうかを決定するためにレビュー担当者に通知されるレビュー ステージ。
retentionDuration microsoft.graph.security.retentionDuration コンテンツを保持する日数を指定します。
defaultRecordBehavior microsoft.graph.security.defaultRecordBehavior レコード レーベルの作成時にロックまたはロック解除の状態を指定します。 使用可能な値: startLocked、startUnlocked、unknownFutureValue。
labelToBeApplied 文字列 現在のラベルの保持期間が終了した後に自動的に適用される置換ラベルを指定します。

応答

成功した場合、このメソッドは 204 No Content 応答コードを返します。

例

要求

次の例は要求を示しています。

PATCH https://graph.microsoft.com/beta/security/labels/retentionLabels/9563a605-e827-4324-a5a9-09efddff1e50
Content-Type: application/json
Content-length: 555

{
  "@odata.type": "#microsoft.graph.security.retentionLabel",
  "retentionDuration": {
    "@odata.type": "microsoft.graph.security.retentionDurationInDays",
    "days": 2555
  },
}

応答

次の例は応答を示しています。

HTTP/1.1 204 No Content