retentionLabel リソースの種類
名前空間: microsoft.graph.security
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
コンプライアンスとガバナンスを目的として、組織がアイテム レベル (電子メールまたはドキュメント) でデータを管理する方法を表します。これには、アイテムを保持または削除する期間や期間が含まれます。
組織は、異なる保持設定を必要とするさまざまな種類のコンテンツに保持ラベルを使用できます。 たとえば、税フォームやサポート ドキュメントに保持ラベルを適用して、法律で必要な期間保持することができます。
組織は、最後に変更または作成された日付などの要因に基づいて、保持期間とアクションを含む保持ラベルを構成できます。 また、イベントが発生したときにリテンション期間を トリガーできるイベント を指定することで、さまざまな保持期間を開始することもできます。
保持ラベルのしくみ、使用するタイミング、保持と削除の設定を構成するための保持ラベルのサポートについては、「 保持ポリシーと保持ラベルの詳細」を参照してください。
メソッド
| メソッド | 戻り値の種類 | 説明 |
|---|---|---|
| retentionLabels を一覧表示する | microsoft.graph.security.retentionLabel コレクション | retentionLabel オブジェクトとそのプロパティの一覧を取得します。 |
| retentionLabel を作成する | microsoft.graph.security.retentionLabel | 新しい retentionLabel オブジェクトを作成します。 |
| retentionLabel を取得する | microsoft.graph.security.retentionLabel | retentionLabel オブジェクトのプロパティとリレーションシップを読み取ります。 |
| retentionLabel を更新する | microsoft.graph.security.retentionLabel | retentionLabel オブジェクトのプロパティを更新します。 |
| retentionLabel を削除する | なし | retentionLabel オブジェクトを削除します。 |
| retentionEventType を一覧表示する | microsoft.graph.security.retentionEventType コレクション | exapnd eventType ナビゲーション プロパティから retentionEventType リソースを取得します。 |
| retentionEventType を追加する | microsoft.graph.security.retentionEventType | ラベルの作成時に関連する odata プロパティを追加して eventType を追加します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| actionAfterRetentionPeriod | microsoft.graph.security.actionAfterRetentionPeriod | retentionDuration プロパティで指定された期間が経過した後にラベル付きドキュメントに対して実行するアクションを指定します。 使用可能な値: none、delete、startDispositionReview、unknownFutureValue。 |
| behaviorDuringRetentionPeriod | microsoft.graph.security.behaviorDuringRetentionPeriod | 保持期間中にこのラベルを持つドキュメントの動作を指定します。 使用可能な値: doNotRetain、retain、retainAsRecord、retainAsRegulatoryRecord、unknownFutureValue。 |
| createdBy | microsoft.graph.identitySet | retentionLabel を作成したユーザーを表します。 |
| createdDateTime | DateTimeOffset | retentionLabel が作成される日時を表します。 |
| descriptionForAdmins | String | 管理者のラベル情報を提供します。省略可能です。 |
| descriptionForUsers | String | ユーザーのラベル情報を提供します。 省略可能。 |
| displayName | String | ラベル名を定義する一意の文字列。 |
| id | String | retentionLabel の一意の ID。 |
| isInUse | ブール型 | ラベルが現在使用されているかどうかを指定します。 |
| lastModifiedBy | microsoft.graph.identitySet | retentionLabel を最後に変更したユーザー。 |
| lastModifiedDateTime | DateTimeOffset | retentionLabel が変更された最新の日付時刻。 |
| retentionDuration | microsoft.graph.security.retentionDuration | コンテンツを保持する日数を指定します。 |
| retentionTrigger | microsoft.graph.security.retentionTrigger | 保持期間をコンテンツの作成日、ラベル付き日付、または最終変更日から計算するかどうかを指定します。 使用可能な値: dateLabeled、dateCreated、dateModified、dateOfEvent、unknownFutureValue。 |
| defaultRecordBehavior | microsoft.graph.security.defaultRecordBehavior | レコード ラベルの作成時にロックまたはロック解除された状態を指定します。使用可能な値は、 startLocked、 startUnlocked、 unknownFutureValueです。 |
| labelToBeApplied | String | 現在のラベルの保持期間が終了した後に自動的に適用される置換ラベルを指定します。 |
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| dispositionReviewStages | microsoft.graph.security.dispositionReviewStage コレクション | リテンション期間の終了時のアクションが "dispositionReview" として選択されている場合、dispositionReviewStages は、各ステージに少なくとも 1 人のレビュー担当者を含む段階的なセットを指定します。 |
| retentionEventType | microsoft.graph.security.retentionEventType | 保持イベントに関連付けられている型を表します。 |
| 記述子 | microsoft.graph.security.filePlanDescriptor | ラベル付けする必要があるコンテンツの管理容易性と編成を向上させるためのオプションを提供する、すぐに使用できる値を表します。 |
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"@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"
}