Creación de ediscoveryHoldPolicy

Artículo
10/30/2023

Espacio de nombres: microsoft.graph.security

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Cree un nuevo objeto ediscoveryHoldPolicy .

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global	Gobierno de EE. UU. L4	Us Government L5 (DOD)	China operada por 21Vianet
✅	✅	✅	❌

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso	Permisos con privilegios mínimos	Permisos con privilegios más altos
Delegado (cuenta profesional o educativa)	eDiscovery.Read.All	eDiscovery.ReadWrite.All
Delegado (cuenta personal de Microsoft)	No admitida.	No admitida.
Aplicación	No admitida.	No admitida.

Solicitud HTTP

POST /security/cases/ediscoveryCases/{ediscoveryCaseId}/legalHolds

Encabezados de solicitud

Nombre	Descripción
Authorization	{token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.
Content-Type	application/json. Obligatorio.

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione una representación JSON del objeto ediscoveryHoldPolicy .

Puede especificar las siguientes propiedades al crear una ediscoveryHoldPolicy.

Propiedad	Tipo	Descripción
displayName	Cadena	Nombre para mostrar de la directiva de suspensión legal. Obligatorio.
description	Cadena	Descripción de la directiva de suspensión legal. Opcional.

Respuesta

Si se ejecuta correctamente, este método devuelve un 201 Created código de respuesta y un objeto microsoft.graph.security.ediscoveryHoldPolicy en el cuerpo de la respuesta.

Ejemplos

Solicitud

En el ejemplo siguiente se muestra la solicitud.

POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/b0073e4e-4184-41c6-9eb7-8c8cc3e2288b/legalHolds
Content-Type: application/json

{
    "displayName": "My legalHold with sources",
    "description": "Created from Graph API",
    "userSources@odata.bind": [
        {
            "@odata.type": "microsoft.graph.security.userSource",
            "email": "SalesTeam@contoso.com"
        }
    ],
    "siteSources@odata.bind": [
        {
            "@odata.type": "microsoft.graph.security.siteSource",
            "site": {
                "webUrl": "https://m365x809305.sharepoint.com/sites/Design-topsecret"
            }
        }
    ]
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models.Security;

var requestBody = new EdiscoveryHoldPolicy
{
	DisplayName = "My legalHold with sources",
	Description = "Created from Graph API",
	AdditionalData = new Dictionary<string, object>
	{
		{
			"userSources@odata.bind" , new List<object>
			{
				new 
				{
					OdataType = "microsoft.graph.security.userSource",
					Email = "SalesTeam@contoso.com",
				},
			}
		},
		{
			"siteSources@odata.bind" , new List<object>
			{
				new 
				{
					OdataType = "microsoft.graph.security.siteSource",
					Site = new 
					{
						WebUrl = "https://m365x809305.sharepoint.com/sites/Design-topsecret",
					},
				},
			}
		},
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Security.Cases.EdiscoveryCases["{ediscoveryCase-id}"].LegalHolds.PostAsync(requestBody);

Importante

Los SDK de Microsoft Graph usan la versión v1.0 de la API de manera predeterminada y no admiten todos los tipos, propiedades y API disponibles en la versión beta. Para obtener más información sobre cómo acceder a la API beta con el SDK, consulte Uso de los SDK de Microsoft Graph con la API beta.

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta security cases ediscovery-cases legal-holds create --ediscovery-case-id {ediscoveryCase-id} --body '{\
    "displayName": "My legalHold with sources",\
    "description": "Created from Graph API",\
    "userSources@odata.bind": [\
        {\
            "@odata.type": "microsoft.graph.security.userSource",\
            "email": "SalesTeam@contoso.com"\
        }\
    ],\
    "siteSources@odata.bind": [\
        {\
            "@odata.type": "microsoft.graph.security.siteSource",\
            "site": {\
                "webUrl": "https://m365x809305.sharepoint.com/sites/Design-topsecret"\
            }\
        }\
    ]\
}\
'

Importante

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


// 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.EdiscoveryHoldPolicy ediscoveryHoldPolicy = new com.microsoft.graph.beta.models.security.EdiscoveryHoldPolicy();
ediscoveryHoldPolicy.setDisplayName("My legalHold with sources");
ediscoveryHoldPolicy.setDescription("Created from Graph API");
HashMap<String, Object> additionalData = new HashMap<String, Object>();
LinkedList<Object> userSourcesOdataBind = new LinkedList<Object>();
 property = new ();
property.setOdataType("microsoft.graph.security.userSource");
property.setEmail("SalesTeam@contoso.com");
userSourcesOdataBind.add(property);
additionalData.put("userSources@odata.bind", userSourcesOdataBind);
LinkedList<Object> siteSourcesOdataBind = new LinkedList<Object>();
 property1 = new ();
property1.setOdataType("microsoft.graph.security.siteSource");
 site = new ();
site.setWebUrl("https://m365x809305.sharepoint.com/sites/Design-topsecret");
property1.setSite(site);
siteSourcesOdataBind.add(property1);
additionalData.put("siteSources@odata.bind", siteSourcesOdataBind);
ediscoveryHoldPolicy.setAdditionalData(additionalData);
com.microsoft.graph.models.security.EdiscoveryHoldPolicy result = graphClient.security().cases().ediscoveryCases().byEdiscoveryCaseId("{ediscoveryCase-id}").legalHolds().post(ediscoveryHoldPolicy);

Importante

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


const options = {
	authProvider,
};

const client = Client.init(options);

const ediscoveryHoldPolicy = {
    displayName: 'My legalHold with sources',
    description: 'Created from Graph API',
    'userSources@odata.bind': [
        {
            '@odata.type': 'microsoft.graph.security.userSource',
            email: 'SalesTeam@contoso.com'
        }
    ],
    'siteSources@odata.bind': [
        {
            '@odata.type': 'microsoft.graph.security.siteSource',
            site: {
                webUrl: 'https://m365x809305.sharepoint.com/sites/Design-topsecret'
            }
        }
    ]
};

await client.api('/security/cases/ediscoveryCases/b0073e4e-4184-41c6-9eb7-8c8cc3e2288b/legalHolds')
	.version('beta')
	.post(ediscoveryHoldPolicy);

Importante

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\EdiscoveryHoldPolicy;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new EdiscoveryHoldPolicy();
$requestBody->setDisplayName('My legalHold with sources');
$requestBody->setDescription('Created from Graph API');
$additionalData = [
	'userSources@odata.bind' => [
			[
				'@odata.type' => 'microsoft.graph.security.userSource',
				'email' => 'SalesTeam@contoso.com',
			],
		],
	'siteSources@odata.bind' => [
			[
				'@odata.type' => 'microsoft.graph.security.siteSource',
				'site' => [
					'webUrl' => 'https://m365x809305.sharepoint.com/sites/Design-topsecret',
				],
			],
		],
];
$requestBody->setAdditionalData($additionalData);

$result = $graphServiceClient->security()->cases()->ediscoveryCases()->byEdiscoveryCaseId('ediscoveryCase-id')->legalHolds()->post($requestBody)->wait();

Importante

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


Import-Module Microsoft.Graph.Beta.Security

$params = @{
	displayName = "My legalHold with sources"
	description = "Created from Graph API"
	"userSources@odata.bind" = @(
		@{
			"@odata.type" = "microsoft.graph.security.userSource"
			email = "SalesTeam@contoso.com"
		}
	)
	"siteSources@odata.bind" = @(
		@{
			"@odata.type" = "microsoft.graph.security.siteSource"
			site = @{
				webUrl = "https://m365x809305.sharepoint.com/sites/Design-topsecret"
			}
		}
	)
}

New-MgBetaSecurityCaseEdiscoveryCaseLegalHold -EdiscoveryCaseId $ediscoveryCaseId -BodyParameter $params

Importante

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


from msgraph import GraphServiceClient
from msgraph.generated.models.ediscovery_hold_policy import EdiscoveryHoldPolicy

graph_client = GraphServiceClient(credentials, scopes)

request_body = EdiscoveryHoldPolicy(
	display_name = "My legalHold with sources",
	description = "Created from Graph API",
	additional_data = {
			"user_sources@odata_bind" : [
				{
						"@odata_type" : "microsoft.graph.security.userSource",
						"email" : "SalesTeam@contoso.com",
				},
			],
			"site_sources@odata_bind" : [
				{
						"@odata_type" : "microsoft.graph.security.siteSource",
						"site" : {
								"web_url" : "https://m365x809305.sharepoint.com/sites/Design-topsecret",
						},
				},
			],
	}
)

result = await graph_client.security.cases.ediscovery_cases.by_ediscovery_case_id('ediscoveryCase-id').legal_holds.post(request_body)

Importante

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Respuesta

En el ejemplo siguiente se muestra la respuesta.

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

HTTP/1.1 201 Created
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#security/cases/ediscoveryCases('b0073e4e-4184-41c6-9eb7-8c8cc3e2288b')/legalHolds/$entity",
    "isEnabled": true,
    "errors": [],
    "description": "Created from Graph API",
    "createdDateTime": "2022-05-23T03:54:11.1Z",
    "lastModifiedDateTime": "2022-05-23T03:54:11.1Z",
    "status": "pending",
    "id": "b9758bbc-ddbd-45e0-8484-3eb49cf1ded3",
    "displayName": "My legalHold with sources",
    "createdBy": {
        "application": null,
        "user": {
            "id": "MOD Administrator",
            "displayName": null
        }
    },
    "lastModifiedBy": {
        "application": null,
        "user": {
            "id": "MOD Administrator",
            "displayName": null
        }
    }
}

Creación de ediscoveryHoldPolicy

Permissions

Solicitud HTTP

Encabezados de solicitud

Cuerpo de la solicitud

Respuesta

Ejemplos

Solicitud

Respuesta

Comentarios

Comentarios

Recursos adicionales