Espaço de nomes: microsoft.graph.security
Criar um novo objeto retentionEvent .
Esta API está disponível nas seguintes implementações de cloud nacionais.
| Serviço global |
US Government L4 |
US Government L5 (DOD) |
China operada pela 21Vianet |
| ✅ |
✅ |
✅ |
❌ |
Permissões
Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.
| Tipo de permissão |
Permissões com menos privilégios |
Permissões com privilégios superiores |
| Delegado (conta corporativa ou de estudante) |
RecordsManagement.ReadWrite.All |
Indisponível. |
| Delegado (conta pessoal da Microsoft) |
Sem suporte. |
Sem suporte. |
| Application |
RecordsManagement.ReadWrite.All |
Indisponível. |
Solicitação HTTP
POST /security/triggers/retentionEvents
| Nome |
Descrição |
| Autorização |
{token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização. |
| Content-Type |
application/json. Obrigatório. |
Corpo da solicitação
No corpo do pedido, forneça uma representação JSON do objeto retentionEvent .
Especifique as seguintes propriedades ao criar um retentionEvent.
| Propriedade |
Tipo |
Descrição |
| description |
Cadeia de caracteres |
Informações opcionais sobre o evento. |
| displayName |
Cadeia de caracteres |
Nome do evento. |
| eventQuery |
microsoft.graph.security.eventQuery collection |
Representa a carga de trabalho (SharePoint Online, OneDrive for Business, Exchange Online) e informações de identificação associadas a um evento de retenção. |
| eventTriggerDateTime |
DateTimeOffset |
Hora opcional em que o evento deve ser acionado. |
| retentionEventType |
Cadeia de caracteres |
Nome do tipo de evento associado ao evento. |
Resposta
Se for bem-sucedido, este método devolve um 201 Created código de resposta e um objeto microsoft.graph.security.retentionEvent no corpo da resposta.
Exemplos
Solicitação
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);
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do 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);
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do 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);
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do 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();
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do 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
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do 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)
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.
Resposta
O exemplo a seguir mostra a resposta.
Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.
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)"
}