legalHold resource type

Article
05/24/2024

Namespace: microsoft.graph.ediscovery

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents a legal hold. Legal holds are holds that are tied to an eDiscovery case. Legal holds should not be confused with retention holds, which are used to control retention policies for Microsoft 365 content. eDiscovery legal holds are for holding content indefinitely for litigation, internal investigations, and other legal actions where content needs to be protected against deletion. For more information, see Manage holds in Advanced eDiscovery

Inherits from entity.

Methods

Method	Return type	Description
List	microsoft.graph.ediscovery.legalHold collection	Get a list of the legalHold objects and their properties.
Create	microsoft.graph.ediscovery.legalHold	Create a new legalHold object.
Get	microsoft.graph.ediscovery.legalHold	Read the properties and relationships of a legalHold object.
Update	microsoft.graph.ediscovery.legalHold	Update the properties of a legalHold object.
Delete	None	Delete a legalHold object.
List site sources	microsoft.graph.ediscovery.siteSource collection	Get the list of siteSource objects associated with a legal hold.
Create site source	microsoft.graph.ediscovery.siteSource	Create a new siteSource object.
List user sources	microsoft.graph.ediscovery.userSource collection	Get the list of userSource objects associated with a legal hold.
Create user source	microsoft.graph.ediscovery.userSource	Create a new userSource object.

Properties

Property	Type	Description
contentQuery	String	KQL query that specifies content to be held in the specified locations. To learn more, see Keyword queries and search conditions for Content Search and eDiscovery. To hold all content in the specified locations, leave contentQuery blank.
createdBy	identitySet	The user who created the legal hold.
createdDateTime	DateTimeOffset	The date and time the legal hold was created.
description	String	The legal hold description.
displayName	String	The display name of the legal hold.
errors	String collection	Lists any errors that happened while placing the hold.
id	String	The ID for the eDiscovery case. Read-only. Inherited from entity.
isEnabled	Boolean	Indicates whether the hold is enabled and actively holding content.
lastModifiedBy	identitySet	the user who last modified the legal hold.
lastModifiedDateTime	DateTimeOffset	The date and time the legal hold was last modified.
status	microsoft.graph.ediscovery.legalHoldStatus	The status of the legal hold. Possible values are: `Pending`, `Error`, `Success`, `UnknownFutureValue`.

legalHoldStatus values

Member	Description
Pending	The hold distribution process is in progress.
Error	There was an error when the hold was applied. For details, see the errors property of the legalHold object.
Success	The hold was successfully applied and is holding the specified content.

Relationships

Relationship	Type	Description
siteSources	microsoft.graph.ediscovery.siteSource collection	Data source entity for SharePoint sites associated with the legal hold.
userSources	microsoft.graph.ediscovery.userSource collection	Data source entity for a the legal hold. This is the container for a mailbox and OneDrive for Business site.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.ediscovery.legalHold",
  "id": "String (identifier)",
  "description": "String",
  "createdBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "lastModifiedBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "lastModifiedDateTime": "String (timestamp)",
  "isEnabled": "Boolean",
  "status": "String",
  "contentQuery": "String",
  "errors": [
    "String"
  ],
  "displayName": "String",
  "createdDateTime": "String (timestamp)"
}

Share via