Espace de noms : microsoft.graph.security
Importante
Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .
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
Voici un exemple de demande.
POST https://graph.microsoft.com/beta/security/triggers/retentionEvents
Content-Type: application/json
Content-length: 616
{
"@odata.type": "#microsoft.graph.security.retentionEvent",
"displayName": "String",
"description": "String",
"eventQueries": [
{
"@odata.type": "microsoft.graph.security.eventQuery"
}
],
"eventTriggerDateTime": "String (timestamp)",
"createdBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"eventPropagationResults": [
{
"@odata.type": "microsoft.graph.security.eventPropagationResult"
}
],
"eventStatus": {
"@odata.type": "microsoft.graph.security.retentionEventStatus"
},
"lastStatusUpdateDateTime": "String (timestamp)"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models.Security;
using Microsoft.Graph.Beta.Models;
var requestBody = new RetentionEvent
{
OdataType = "#microsoft.graph.security.retentionEvent",
DisplayName = "String",
Description = "String",
EventQueries = new List<EventQuery>
{
new EventQuery
{
OdataType = "microsoft.graph.security.eventQuery",
},
},
EventTriggerDateTime = DateTimeOffset.Parse("String (timestamp)"),
CreatedBy = new IdentitySet
{
OdataType = "microsoft.graph.identitySet",
},
EventPropagationResults = new List<EventPropagationResult>
{
new EventPropagationResult
{
OdataType = "microsoft.graph.security.eventPropagationResult",
},
},
EventStatus = new RetentionEventStatus
{
OdataType = "microsoft.graph.security.retentionEventStatus",
},
LastStatusUpdateDateTime = DateTimeOffset.Parse("String (timestamp)"),
};
// 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);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
"time"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphmodelssecurity "github.com/microsoftgraph/msgraph-beta-sdk-go/models/security"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
requestBody := graphmodelssecurity.NewRetentionEvent()
displayName := "String"
requestBody.SetDisplayName(&displayName)
description := "String"
requestBody.SetDescription(&description)
eventQuery := graphmodelssecurity.NewEventQuery()
eventQueries := []graphmodelssecurity.EventQueryable {
eventQuery,
}
requestBody.SetEventQueries(eventQueries)
eventTriggerDateTime , err := time.Parse(time.RFC3339, "String (timestamp)")
requestBody.SetEventTriggerDateTime(&eventTriggerDateTime)
createdBy := graphmodels.NewIdentitySet()
requestBody.SetCreatedBy(createdBy)
eventPropagationResult := graphmodelssecurity.NewEventPropagationResult()
eventPropagationResults := []graphmodelssecurity.EventPropagationResultable {
eventPropagationResult,
}
requestBody.SetEventPropagationResults(eventPropagationResults)
eventStatus := graphmodelssecurity.NewRetentionEventStatus()
requestBody.SetEventStatus(eventStatus)
lastStatusUpdateDateTime , err := time.Parse(time.RFC3339, "String (timestamp)")
requestBody.SetLastStatusUpdateDateTime(&lastStatusUpdateDateTime)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
retentionEvents, err := graphClient.Security().Triggers().RetentionEvents().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.models.security.RetentionEvent retentionEvent = new com.microsoft.graph.beta.models.security.RetentionEvent();
retentionEvent.setOdataType("#microsoft.graph.security.retentionEvent");
retentionEvent.setDisplayName("String");
retentionEvent.setDescription("String");
LinkedList<com.microsoft.graph.beta.models.security.EventQuery> eventQueries = new LinkedList<com.microsoft.graph.beta.models.security.EventQuery>();
com.microsoft.graph.beta.models.security.EventQuery eventQuery = new com.microsoft.graph.beta.models.security.EventQuery();
eventQuery.setOdataType("microsoft.graph.security.eventQuery");
eventQueries.add(eventQuery);
retentionEvent.setEventQueries(eventQueries);
OffsetDateTime eventTriggerDateTime = OffsetDateTime.parse("String (timestamp)");
retentionEvent.setEventTriggerDateTime(eventTriggerDateTime);
IdentitySet createdBy = new IdentitySet();
createdBy.setOdataType("microsoft.graph.identitySet");
retentionEvent.setCreatedBy(createdBy);
LinkedList<com.microsoft.graph.beta.models.security.EventPropagationResult> eventPropagationResults = new LinkedList<com.microsoft.graph.beta.models.security.EventPropagationResult>();
com.microsoft.graph.beta.models.security.EventPropagationResult eventPropagationResult = new com.microsoft.graph.beta.models.security.EventPropagationResult();
eventPropagationResult.setOdataType("microsoft.graph.security.eventPropagationResult");
eventPropagationResults.add(eventPropagationResult);
retentionEvent.setEventPropagationResults(eventPropagationResults);
com.microsoft.graph.beta.models.security.RetentionEventStatus eventStatus = new com.microsoft.graph.beta.models.security.RetentionEventStatus();
eventStatus.setOdataType("microsoft.graph.security.retentionEventStatus");
retentionEvent.setEventStatus(eventStatus);
OffsetDateTime lastStatusUpdateDateTime = OffsetDateTime.parse("String (timestamp)");
retentionEvent.setLastStatusUpdateDateTime(lastStatusUpdateDateTime);
com.microsoft.graph.models.security.RetentionEvent result = graphClient.security().triggers().retentionEvents().post(retentionEvent);
const options = {
authProvider,
};
const client = Client.init(options);
const retentionEvent = {
'@odata.type': '#microsoft.graph.security.retentionEvent',
displayName: 'String',
description: 'String',
eventQueries: [
{
'@odata.type': 'microsoft.graph.security.eventQuery'
}
],
eventTriggerDateTime: 'String (timestamp)',
createdBy: {
'@odata.type': 'microsoft.graph.identitySet'
},
eventPropagationResults: [
{
'@odata.type': 'microsoft.graph.security.eventPropagationResult'
}
],
eventStatus: {
'@odata.type': 'microsoft.graph.security.retentionEventStatus'
},
lastStatusUpdateDateTime: 'String (timestamp)'
};
await client.api('/security/triggers/retentionEvents')
.version('beta')
.post(retentionEvent);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\Security\RetentionEvent;
use Microsoft\Graph\Beta\Generated\Models\Security\EventQuery;
use Microsoft\Graph\Beta\Generated\Models\IdentitySet;
use Microsoft\Graph\Beta\Generated\Models\Security\EventPropagationResult;
use Microsoft\Graph\Beta\Generated\Models\Security\RetentionEventStatus;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new RetentionEvent();
$requestBody->setOdataType('#microsoft.graph.security.retentionEvent');
$requestBody->setDisplayName('String');
$requestBody->setDescription('String');
$eventQueriesEventQuery1 = new EventQuery();
$eventQueriesEventQuery1->setOdataType('microsoft.graph.security.eventQuery');
$eventQueriesArray []= $eventQueriesEventQuery1;
$requestBody->setEventQueries($eventQueriesArray);
$requestBody->setEventTriggerDateTime(new \DateTime('String (timestamp)'));
$createdBy = new IdentitySet();
$createdBy->setOdataType('microsoft.graph.identitySet');
$requestBody->setCreatedBy($createdBy);
$eventPropagationResultsEventPropagationResult1 = new EventPropagationResult();
$eventPropagationResultsEventPropagationResult1->setOdataType('microsoft.graph.security.eventPropagationResult');
$eventPropagationResultsArray []= $eventPropagationResultsEventPropagationResult1;
$requestBody->setEventPropagationResults($eventPropagationResultsArray);
$eventStatus = new RetentionEventStatus();
$eventStatus->setOdataType('microsoft.graph.security.retentionEventStatus');
$requestBody->setEventStatus($eventStatus);
$requestBody->setLastStatusUpdateDateTime(new \DateTime('String (timestamp)'));
$result = $graphServiceClient->security()->triggers()->retentionEvents()->post($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Security
$params = @{
"@odata.type" = "#microsoft.graph.security.retentionEvent"
displayName = "String"
description = "String"
eventQueries = @(
@{
"@odata.type" = "microsoft.graph.security.eventQuery"
}
)
eventTriggerDateTime = [System.DateTime]::Parse("String (timestamp)")
createdBy = @{
"@odata.type" = "microsoft.graph.identitySet"
}
eventPropagationResults = @(
@{
"@odata.type" = "microsoft.graph.security.eventPropagationResult"
}
)
eventStatus = @{
"@odata.type" = "microsoft.graph.security.retentionEventStatus"
}
lastStatusUpdateDateTime = [System.DateTime]::Parse("String (timestamp)")
}
New-MgBetaSecurityTriggerRetentionEvent -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.security.retention_event import RetentionEvent
from msgraph_beta.generated.models.security.event_query import EventQuery
from msgraph_beta.generated.models.identity_set import IdentitySet
from msgraph_beta.generated.models.security.event_propagation_result import EventPropagationResult
from msgraph_beta.generated.models.security.retention_event_status import RetentionEventStatus
# 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_queries = [
EventQuery(
odata_type = "microsoft.graph.security.eventQuery",
),
],
event_trigger_date_time = "String (timestamp)",
created_by = IdentitySet(
odata_type = "microsoft.graph.identitySet",
),
event_propagation_results = [
EventPropagationResult(
odata_type = "microsoft.graph.security.eventPropagationResult",
),
],
event_status = RetentionEventStatus(
odata_type = "microsoft.graph.security.retentionEventStatus",
),
last_status_update_date_time = "String (timestamp)",
)
result = await graph_client.security.triggers.retention_events.post(request_body)
Réponse
Voici un exemple de 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",
"eventQueries": [
{
"@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)"
}