Share via

Clear-MgBetaComplianceEdiscoveryCaseSourceCollectionData

  • Reference
Module:
Microsoft.Graph.Beta.Compliance

Permanently delete Microsoft Teams messages contained in a sourceCollection. You can collect and purge the following categories of Teams content:- Teams 1:1 chats - Chat messages, posts, and attachments shared in a Teams conversation between two people. Teams 1:1 chats are also called conversations.- Teams group chats - Chat messages, posts, and attachments shared in a Teams conversation between three or more people. Also called 1:N chats or group conversations.- Teams channels - Chat messages, posts, replies, and attachments shared in a standard Teams channel.- Private channels - Message posts, replies, and attachments shared in a private Teams channel.- Shared channels - Message posts, replies, and attachments shared in a shared Teams channel. For more information about purging Teams messages, see:- eDiscovery solution series: Data spillage scenario - Search and purge- Advanced eDiscovery workflow for content in Microsoft Teams

Syntax

Clear-MgBetaComplianceEdiscoveryCaseSourceCollectionData
     -CaseId <String>
     -SourceCollectionId <String>
     [-ResponseHeadersVariable <String>]
     [-Headers <IDictionary>]
     [-PassThru]
     [-ProgressAction <ActionPreference>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Clear-MgBetaComplianceEdiscoveryCaseSourceCollectionData
     -InputObject <IComplianceIdentity>
     [-ResponseHeadersVariable <String>]
     [-Headers <IDictionary>]
     [-PassThru]
     [-ProgressAction <ActionPreference>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Description

Permanently delete Microsoft Teams messages contained in a sourceCollection. You can collect and purge the following categories of Teams content:- Teams 1:1 chats - Chat messages, posts, and attachments shared in a Teams conversation between two people. Teams 1:1 chats are also called conversations.- Teams group chats - Chat messages, posts, and attachments shared in a Teams conversation between three or more people. Also called 1:N chats or group conversations.- Teams channels - Chat messages, posts, replies, and attachments shared in a standard Teams channel.- Private channels - Message posts, replies, and attachments shared in a private Teams channel.- Shared channels - Message posts, replies, and attachments shared in a shared Teams channel. For more information about purging Teams messages, see:- eDiscovery solution series: Data spillage scenario - Search and purge- Advanced eDiscovery workflow for content in Microsoft Teams

Permissions

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) eDiscovery.ReadWrite.All Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application Not supported. Not supported.

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.Beta.Compliance

Clear-MgBetaComplianceEdiscoveryCaseSourceCollectionData -CaseId $caseId -SourceCollectionId $sourceCollectionId

This example shows how to use the Clear-MgBetaComplianceEdiscoveryCaseSourceCollectionData Cmdlet.

Parameters

-CaseId

The unique identifier of case

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Headers

Optional headers that will be added to the request.

Type:IDictionary
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:IComplianceIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

Returns true when the command succeeds

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ProgressAction

{{ Fill ProgressAction Description }}

Type:ActionPreference
Aliases:proga
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResponseHeadersVariable

Optional Response Headers Variable.

Type:String
Aliases:RHV
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SourceCollectionId

The unique identifier of sourceCollection

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.Graph.Beta.PowerShell.Models.IComplianceIdentity

System.Collections.IDictionary

Outputs

System.Boolean

Notes

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IComplianceIdentity>: Identity Parameter

  • [AuthoredNoteId <String>]: The unique identifier of authoredNote
  • [CaseId <String>]: The unique identifier of case
  • [CaseOperationId <String>]: The unique identifier of caseOperation
  • [CustodianId <String>]: The unique identifier of custodian
  • [DataSourceId <String>]: The unique identifier of dataSource
  • [LegalHoldId <String>]: The unique identifier of legalHold
  • [NoncustodialDataSourceId <String>]: The unique identifier of noncustodialDataSource
  • [ReviewSetId <String>]: The unique identifier of reviewSet
  • [ReviewSetQueryId <String>]: The unique identifier of reviewSetQuery
  • [SiteSourceId <String>]: The unique identifier of siteSource
  • [SourceCollectionId <String>]: The unique identifier of sourceCollection
  • [SubjectRightsRequestId <String>]: The unique identifier of subjectRightsRequest
  • [TagId <String>]: The unique identifier of tag
  • [TagId1 <String>]: The unique identifier of tag
  • [UnifiedGroupSourceId <String>]: The unique identifier of unifiedGroupSource
  • [UserId <String>]: The unique identifier of user
  • [UserSourceId <String>]: The unique identifier of userSource