retentionLabel を取得する
名前空間: microsoft.graph.security
retentionLabel オブジェクトのプロパティとリレーションシップを読み取ります。
この API は、次の国内クラウド展開で使用できます。
| グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
|---|---|---|---|
| ✅ | ✅ | ✅ | ❌ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
| アクセス許可の種類 | 最小特権アクセス許可 | より高い特権のアクセス許可 |
|---|---|---|
| 委任 (職場または学校のアカウント) | RecordsManagement.Read.All | RecordsManagement.ReadWrite.All |
| 委任 (個人用 Microsoft アカウント) | サポートされていません。 | サポートされていません。 |
| アプリケーション | サポートされていません。 | サポートされていません。 |
HTTP 要求
GET /security/labels/retentionLabels/{retentionLabelId}
GET /security/triggers/retentionEvents/{retentionEventId}/labels/{retentionLabelId}
オプションのクエリ パラメーター
このメソッドは、応答のカスタマイズに役立つ拡張 OData クエリ パラメーターをサポートします。 たとえば、 retentionEventType プロパティを取得するには、 expand パラメーター:$expand=retentionEventType または $expand=descriptorsを使用できます。 一般的な情報については、「OData クエリ パラメーター」を参照してください。
要求ヘッダー
| 名前 | 説明 |
|---|---|
| Authorization | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
要求本文
このメソッドには、要求本文を指定しません。
応答
成功した場合、このメソッドは応答コード 200 OK と、応答本文に microsoft.graph.security.retentionLabel オブジェクトを返します。
例
要求
要求の例を次に示します。
GET https://graph.microsoft.com/v1.0/security/labels/retentionLabels/{retentionLabelId}
応答
応答の例を下に示します。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-Type: application/json
{
"value": {
"@odata.type": "#microsoft.graph.security.retentionLabel",
"id": "64a99fb4-07be-0481-8746-44c15c0eef1f",
"displayName": "Retention Schedule 10004",
"behaviorDuringRetentionPeriod": "retain",
"actionAfterRetentionPeriod": "relabel",
"retentionTrigger": "dateCreated",
"retentionDuration": {
"@odata.type": "microsoft.graph.security.retentionDurationInDays",
"days": 730
},
"isInUse": true,
"descriptionForAdmins": "creation based retention label for schedule 10004",
"descriptionForUsers": "retains for 2 years then relabeled",
"createdBy": {
"user": {
"id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
"displayName": "Admin"
}
},
"createdDateTime": "2017-11-27T02:10:12Z",
"lastModifiedBy": {
"user": {
"id": "9563a605-e827-4324-a5a9-09efddff1e90",
"displayName": "Records Manager"
}
},
"lastModifiedDateTime": "2020-08-28T22:13:09Z",
"labelToBeApplied": "Retention schedule 10005",
"defaultRecordBehavior": "startLocked"
}
}