sourceCollection resource type

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 an eDiscovery collection, commonly known as a search. For details, see Collect data for a case in Advanced eDiscovery.

Methods

Method Return type Description
Add additionalSource microsoft.graph.ediscovery.dataSource collection Add an additional dataSource object to the source collection.
Add custodianSource microsoft.graph.ediscovery.dataSource collection Add a custodian dataSource object to the source collection.
Add noncustodialSource microsoft.graph.ediscovery.noncustodialSource collection Add a non-custodial source noncustodialSource object to the source collection.
List sourceCollections microsoft.graph.ediscovery.sourceCollection collection Get a list of the sourceCollection objects and their properties.
Create sourceCollection microsoft.graph.ediscovery.sourceCollection Create a new sourceCollection object.
Get sourceCollection microsoft.graph.ediscovery.sourceCollection Read the properties and relationships of a sourceCollection object.
Update sourceCollection microsoft.graph.ediscovery.sourceCollection Update the properties of a sourceCollection object.
Delete sourceCollection None Delete a sourceCollection object.
estimateStatistics None Run an estimate of the number of emails and documents in the source collection.
List additionalSources microsoft.graph.ediscovery.dataSource collection Get a list of additional dataSource objects associated with a source collection.
List custodianSources microsoft.graph.ediscovery.dataSource collection Get a list of custodian dataSource objects associated with a source collection.
List noncustodialSources microsoft.graph.ediscovery.noncustodialSource collection Get a list of non-custodial sources noncustodialSource objects associated with a source collection.
Purge data None Run a purge data operation on the Teams data contained in the source collection.

Properties

Property Type Description
contentQuery String The query string in KQL (Keyword Query Language) query. For details, see Keyword queries and search conditions for Content Search and eDiscovery. You can refine searches by using fields paired with values; for example, subject:"Quarterly Financials" AND Date>=06/01/2016 AND Date<=07/01/2016.
createdBy identitySet The user who created the sourceCollection.
createdDateTime DateTimeOffset The date and time the sourceCollection was created.
dataSourceScopes microsoft.graph.ediscovery.dataSourceScopes When specified, the collection will span across a service for an entire workload. Possible values are: none, allTenantMailboxes, allTenantSites, allCaseCustodians, allCaseNoncustodialDataSources.
description String The description of the sourceCollection.
displayName String The display name of the sourceCollection.
id String The ID for the sourceCollection. Read-only.
lastModifiedBy identitySet The last user who modified the sourceCollection.
lastModifiedDateTime DateTimeOffset The last date and time the sourceCollection was modified.

dataSourceScopes values

Member Description
none Do not specify any scopes - locations would be referenced separately.
allTenantMailboxes Include all tenant mailboxes in the sourceCollection.
allTenantSites Include all tenant sites in the sourceCollection.
allCaseCustodians Include all custodian locations in the sourceCollection.
allCaseNoncustodialDataSources Include all non-custodial data sources in the sourceCollection.

Relationships

Relationship Type Description
additionalSources microsoft.graph.ediscovery.dataSource collection Adds an additional source to the sourceCollection.
addToReviewSetOperation microsoft.graph.ediscovery.addToReviewSetOperation Adds the results of the sourceCollection to the specified reviewSet.
custodianSources microsoft.graph.ediscovery.dataSource collection Custodian sources that are included in the sourceCollection.
lastEstimateStatisticsOperation microsoft.graph.ediscovery.estimateStatisticsOperation The last estimate operation associated with the sourceCollection.
noncustodialSources microsoft.graph.ediscovery.noncustodialDataSource collection noncustodialDataSource sources that are included in the sourceCollection

JSON representation

The following is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.ediscovery.sourceCollection",
  "displayName": "String",
  "description": "String",
  "createdBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "createdDateTime": "String (timestamp)",
  "lastModifiedBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "lastModifiedDateTime": "String (timestamp)",
  "contentQuery": "String",
  "dataSourceScopes": "String"
}