名前空間: microsoft.graph.security
新しい retentionEvent オブジェクトを作成します。
この API は、次の国内クラウド展開で使用できます。
| グローバル サービス |
米国政府機関 L4 |
米国政府機関 L5 (DOD) |
21Vianet が運営する中国 |
| ✅ |
✅ |
✅ |
❌ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。
アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
| アクセス許可の種類 |
最小特権アクセス許可 |
より高い特権のアクセス許可 |
| 委任 (職場または学校のアカウント) |
RecordsManagement.ReadWrite.All |
注意事項なし。 |
| 委任 (個人用 Microsoft アカウント) |
サポートされていません。 |
サポートされていません。 |
| アプリケーション |
RecordsManagement.ReadWrite.All |
注意事項なし。 |
HTTP 要求
POST /security/triggers/retentionEvents
| 名前 |
説明 |
| Authorization |
ベアラー {token}。 必須です。
認証と認可についての詳細をご覧ください。 |
| Content-Type |
application/json. 必須です。 |
要求本文
要求本文で、 retentionEvent オブジェクトの JSON 表現を指定します。
retentionEvent を作成するときに、次のプロパティを指定します。
| プロパティ |
型 |
説明 |
| description |
String |
イベントに関する省略可能な情報。 |
| displayName |
文字列 |
イベントの名前。 |
| eventQuery |
microsoft.graph.security.eventQuery コレクション |
保持イベントに関連付けられているワークロード (SharePoint Online、OneDrive for Business、Exchange Online) と識別情報を表します。 |
| eventTriggerDateTime |
DateTimeOffset |
イベントをトリガーする必要がある省略可能な時刻。 |
| retentionEventType |
文字列 |
イベントに関連付けられているイベントの種類の名前。 |
応答
成功した場合、このメソッドは応答コード 201 Created と、応答本文に microsoft.graph.security.retentionEvent オブジェクトを返します。
例
要求
POST https://graph.microsoft.com/v1.0/security/triggers/retentionEvents
Content-Type: application/json
Content-length: 616
{
"@odata.type": "#microsoft.graph.security.retentionEvent",
"displayName": "String",
"description": "String",
"eventQuery": [
{
"@odata.type": "microsoft.graph.security.eventQuery"
}
],
"eventTriggerDateTime": "String (timestamp)",
"retentionEventType@odata.bind": "https://graph.microsoft.com/v1.0/security/triggerTypes/retentionEventType/9eecef97-fb3c-4c68-825b-4dd74530863a"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models.Security;
using Microsoft.Kiota.Abstractions.Serialization;
var requestBody = new RetentionEvent
{
OdataType = "#microsoft.graph.security.retentionEvent",
DisplayName = "String",
Description = "String",
EventTriggerDateTime = DateTimeOffset.Parse("String (timestamp)"),
AdditionalData = new Dictionary<string, object>
{
{
"eventQuery" , new List<object>
{
new UntypedObject(new Dictionary<string, UntypedNode>
{
{
"@odata.type", new UntypedString("microsoft.graph.security.eventQuery")
},
}),
}
},
{
"retentionEventType@odata.bind" , "https://graph.microsoft.com/v1.0/security/triggerTypes/retentionEventType/9eecef97-fb3c-4c68-825b-4dd74530863a"
},
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Security.Triggers.RetentionEvents.PostAsync(requestBody);
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.models.security.RetentionEvent retentionEvent = new com.microsoft.graph.models.security.RetentionEvent();
retentionEvent.setOdataType("#microsoft.graph.security.retentionEvent");
retentionEvent.setDisplayName("String");
retentionEvent.setDescription("String");
OffsetDateTime eventTriggerDateTime = OffsetDateTime.parse("String (timestamp)");
retentionEvent.setEventTriggerDateTime(eventTriggerDateTime);
HashMap<String, Object> additionalData = new HashMap<String, Object>();
LinkedList<Object> eventQuery = new LinkedList<Object>();
property = new ();
property.setOdataType("microsoft.graph.security.eventQuery");
eventQuery.add(property);
additionalData.put("eventQuery", eventQuery);
additionalData.put("retentionEventType@odata.bind", "https://graph.microsoft.com/v1.0/security/triggerTypes/retentionEventType/9eecef97-fb3c-4c68-825b-4dd74530863a");
retentionEvent.setAdditionalData(additionalData);
com.microsoft.graph.models.security.RetentionEvent result = graphClient.security().triggers().retentionEvents().post(retentionEvent);
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
const options = {
authProvider,
};
const client = Client.init(options);
const retentionEvent = {
'@odata.type': '#microsoft.graph.security.retentionEvent',
displayName: 'String',
description: 'String',
eventQuery: [
{
'@odata.type': 'microsoft.graph.security.eventQuery'
}
],
eventTriggerDateTime: 'String (timestamp)',
'retentionEventType@odata.bind': 'https://graph.microsoft.com/v1.0/security/triggerTypes/retentionEventType/9eecef97-fb3c-4c68-825b-4dd74530863a'
};
await client.api('/security/triggers/retentionEvents')
.post(retentionEvent);
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\Security\RetentionEvent;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new RetentionEvent();
$requestBody->setOdataType('#microsoft.graph.security.retentionEvent');
$requestBody->setDisplayName('String');
$requestBody->setDescription('String');
$requestBody->setEventTriggerDateTime(new \DateTime('String (timestamp)'));
$additionalData = [
'eventQuery' => [
[
'@odata.type' => 'microsoft.graph.security.eventQuery',
],
],
'retentionEventType@odata.bind' => 'https://graph.microsoft.com/v1.0/security/triggerTypes/retentionEventType/9eecef97-fb3c-4c68-825b-4dd74530863a',
];
$requestBody->setAdditionalData($additionalData);
$result = $graphServiceClient->security()->triggers()->retentionEvents()->post($requestBody)->wait();
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
Import-Module Microsoft.Graph.Security
$params = @{
"@odata.type" = "#microsoft.graph.security.retentionEvent"
displayName = "String"
description = "String"
eventQuery = @(
@{
"@odata.type" = "microsoft.graph.security.eventQuery"
}
)
eventTriggerDateTime = [System.DateTime]::Parse("String (timestamp)")
"retentionEventType@odata.bind" = "https://graph.microsoft.com/v1.0/security/triggerTypes/retentionEventType/9eecef97-fb3c-4c68-825b-4dd74530863a"
}
New-MgSecurityTriggerRetentionEvent -BodyParameter $params
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.security.retention_event import RetentionEvent
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = RetentionEvent(
odata_type = "#microsoft.graph.security.retentionEvent",
display_name = "String",
description = "String",
event_trigger_date_time = "String (timestamp)",
additional_data = {
"event_query" : [
{
"@odata_type" : "microsoft.graph.security.eventQuery",
},
],
"retention_event_type@odata_bind" : "https://graph.microsoft.com/v1.0/security/triggerTypes/retentionEventType/9eecef97-fb3c-4c68-825b-4dd74530863a",
}
)
result = await graph_client.security.triggers.retention_events.post(request_body)
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 201 Created
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.security.retentionEvent",
"id": "fcdbfb58-d0c6-85dd-d011-4e0ff9a6805d",
"displayName": "String",
"description": "String",
"eventQuery": [
{
"@odata.type": "microsoft.graph.security.eventQuery"
}
],
"eventTriggerDateTime": "String (timestamp)",
"createdBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"createdDateTime": "String (timestamp)",
"lastModifiedBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"lastModifiedDateTime": "String (timestamp)",
"eventPropagationResults": [
{
"@odata.type": "microsoft.graph.security.eventPropagationResult"
}
],
"eventStatus": {
"@odata.type": "microsoft.graph.security.retentionEventStatus"
},
"lastStatusUpdateDateTime": "String (timestamp)"
}