Espace de noms : microsoft.graph.security
Créez un objet retentionEvent .
Cette API est disponible dans les déploiements de cloud national suivants.
| Service global |
Gouvernement des États-Unis L4 |
Us Government L5 (DOD) |
Chine gérée par 21Vianet |
| ✅ |
✅ |
✅ |
❌ |
Autorisations
Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.
| Type d’autorisation |
Autorisations avec privilèges minimum |
Autorisations privilégiées plus élevées |
| Déléguée (compte professionnel ou scolaire) |
RecordsManagement.ReadWrite.All |
Non disponible. |
| Déléguée (compte Microsoft personnel) |
Non prise en charge. |
Non prise en charge. |
| Application |
RecordsManagement.ReadWrite.All |
Non disponible. |
Requête HTTP
POST /security/triggers/retentionEvents
Corps de la demande
Dans le corps de la demande, fournissez une représentation JSON de l’objet retentionEvent .
Spécifiez les propriétés suivantes lors de la création d’un retentionEvent.
| Propriété |
Type |
Description |
| description |
String |
Informations facultatives sur l’événement. |
| displayName |
String |
Nom de l’événement. |
| eventQuery |
collection microsoft.graph.security.eventQuery |
Représente la charge de travail (SharePoint Online, OneDrive Entreprise, Exchange Online) et les informations d’identification associées à un événement de rétention. |
| eventTriggerDateTime |
DateTimeOffset |
Heure facultative à laquelle l’événement doit être déclenché. |
| retentionEventType |
String |
Nom du type d’événement associé à l’événement. |
Réponse
Si elle réussit, cette méthode renvoie un 201 Created code de réponse et un objet microsoft.graph.security.retentionEvent dans le corps de la réponse.
Exemples
Demande
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);
Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (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);
Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (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);
Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (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();
Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (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
Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (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)
Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).
Réponse
L’exemple suivant illustre la réponse.
Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.
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)"
}