Share via


Update-MgBetaComplianceEdiscoveryCaseSetting

Update the properties of a an eDiscovery caseSettings object.

Syntax

UpdateExpanded (Default)

Update-MgBetaComplianceEdiscoveryCaseSetting
    -CaseId <string>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-Id <string>]
    [-Ocr <IMicrosoftGraphEdiscoveryOcrSettings>]
    [-RedundancyDetection <IMicrosoftGraphEdiscoveryRedundancyDetectionSettings>]
    [-TopicModeling <IMicrosoftGraphEdiscoveryTopicModelingSettings>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Update

Update-MgBetaComplianceEdiscoveryCaseSetting
    -CaseId <string>
    -BodyParameter <IMicrosoftGraphEdiscoveryCaseSettings>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentityExpanded

Update-MgBetaComplianceEdiscoveryCaseSetting
    -InputObject <IComplianceIdentity>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-Id <string>]
    [-Ocr <IMicrosoftGraphEdiscoveryOcrSettings>]
    [-RedundancyDetection <IMicrosoftGraphEdiscoveryRedundancyDetectionSettings>]
    [-TopicModeling <IMicrosoftGraphEdiscoveryTopicModelingSettings>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentity

Update-MgBetaComplianceEdiscoveryCaseSetting
    -InputObject <IComplianceIdentity>
    -BodyParameter <IMicrosoftGraphEdiscoveryCaseSettings>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Update the properties of a an eDiscovery caseSettings object.

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) eDiscovery.ReadWrite.All,
Delegated (personal Microsoft account) Not supported
Application eDiscovery.ReadWrite.All,

Examples

Example 1: Code snippet


Import-Module Microsoft.Graph.Beta.Compliance

$params = @{
	redundancyDetection = @{
		isEnabled = $false
		similarityThreshold = 70
		minWords = 12
		maxWords = 400000
	}
	topicModeling = @{
		isEnabled = $false
		ignoreNumbers = $false
		topicCount = 50
		dynamicallyAdjustTopicCount = $false
	}
	ocr = @{
		isEnabled = $true
		maxImageSize = 12000
	}
}

Update-MgBetaComplianceEdiscoveryCaseSetting -CaseId $caseId -BodyParameter $params

This example shows how to use the Update-MgBetaComplianceEdiscoveryCaseSetting Cmdlet.

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

Type:System.Collections.Hashtable
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-BodyParameter

caseSettings To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Parameter properties

Type:Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphEdiscoveryCaseSettings
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
Update
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Break

Wait for .NET debugger to attach

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CaseId

The unique identifier of case

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Update
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:System.Collections.IDictionary
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-HttpPipelineAppend

SendAsync Pipeline Steps to be appended to the front of the pipeline

Parameter properties

Type:

Microsoft.Graph.Beta.PowerShell.Runtime.SendAsyncStep[]

Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-HttpPipelinePrepend

SendAsync Pipeline Steps to be prepended to the front of the pipeline

Parameter properties

Type:

Microsoft.Graph.Beta.PowerShell.Runtime.SendAsyncStep[]

Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

The unique identifier for an entity. Read-only.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

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

Parameter properties

Type:Microsoft.Graph.Beta.PowerShell.Models.IComplianceIdentity
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Ocr

ocrSettings To construct, see NOTES section for OCR properties and create a hash table.

Parameter properties

Type:Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphEdiscoveryOcrSettings
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Proxy

The URI for the proxy server to use

Parameter properties

Type:System.Uri
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProxyCredential

Credentials for a proxy server to use for the remote call

Parameter properties

Type:System.Management.Automation.PSCredential
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProxyUseDefaultCredentials

Use the default credentials for the proxy

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RedundancyDetection

redundancyDetectionSettings To construct, see NOTES section for REDUNDANCYDETECTION properties and create a hash table.

Parameter properties

Type:Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphEdiscoveryRedundancyDetectionSettings
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False
Aliases:RHV

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TopicModeling

topicModelingSettings To construct, see NOTES section for TOPICMODELING properties and create a hash table.

Parameter properties

Type:Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphEdiscoveryTopicModelingSettings
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Runs the command in a mode that only reports what would happen without performing the actions.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.Graph.Beta.PowerShell.Models.IComplianceIdentity

{{ Fill in the Description }}

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphEdiscoveryCaseSettings

{{ Fill in the Description }}

System.Collections.IDictionary

{{ Fill in the Description }}

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphEdiscoveryCaseSettings

{{ Fill in the Description }}

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.

BODYPARAMETER <IMicrosoftGraphEdiscoveryCaseSettings>: caseSettings [(Any) <Object>]: This indicates any property can be added to this object. [Id <String>]: The unique identifier for an entity. Read-only. [Ocr <IMicrosoftGraphEdiscoveryOcrSettings>]: ocrSettings [(Any) <Object>]: This indicates any property can be added to this object. [IsEnabled <Boolean?>]: Indicates whether or not OCR is enabled for the case. [MaxImageSize <Int32?>]: Maximum image size that will be processed in KB). [Timeout <TimeSpan?>]: The timeout duration for the OCR engine. A longer timeout may increase success of OCR, but may add to the total processing time. [RedundancyDetection <IMicrosoftGraphEdiscoveryRedundancyDetectionSettings>]: redundancyDetectionSettings [(Any) <Object>]: This indicates any property can be added to this object. [IsEnabled <Boolean?>]: Indicates whether email threading and near duplicate detection are enabled. [MaxWords <Int32?>]: Specifies the maximum number of words used for email threading and near duplicate detection. To learn more, see Minimum/maximum number of words. [MinWords <Int32?>]: Specifies the minimum number of words used for email threading and near duplicate detection. To learn more, see Minimum/maximum number of words. [SimilarityThreshold <Int32?>]: Specifies the similarity level for documents to be put in the same near duplicate set. To learn more, see Document and email similarity threshold. [TopicModeling <IMicrosoftGraphEdiscoveryTopicModelingSettings>]: topicModelingSettings [(Any) <Object>]: This indicates any property can be added to this object. [DynamicallyAdjustTopicCount <Boolean?>]: To learn more, see Adjust maximum number of themes dynamically. [IgnoreNumbers <Boolean?>]: To learn more, see Include numbers in themes. [IsEnabled <Boolean?>]: Indicates whether themes are enabled for the case. [TopicCount <Int32?>]: To learn more, see Maximum number of themes.

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 [UserPrincipalName <String>]: Alternate key of user [UserSourceId <String>]: The unique identifier of userSource

OCR <IMicrosoftGraphEdiscoveryOcrSettings>: ocrSettings [(Any) <Object>]: This indicates any property can be added to this object. [IsEnabled <Boolean?>]: Indicates whether or not OCR is enabled for the case. [MaxImageSize <Int32?>]: Maximum image size that will be processed in KB). [Timeout <TimeSpan?>]: The timeout duration for the OCR engine. A longer timeout may increase success of OCR, but may add to the total processing time.

REDUNDANCYDETECTION <IMicrosoftGraphEdiscoveryRedundancyDetectionSettings>: redundancyDetectionSettings [(Any) <Object>]: This indicates any property can be added to this object. [IsEnabled <Boolean?>]: Indicates whether email threading and near duplicate detection are enabled. [MaxWords <Int32?>]: Specifies the maximum number of words used for email threading and near duplicate detection. To learn more, see Minimum/maximum number of words. [MinWords <Int32?>]: Specifies the minimum number of words used for email threading and near duplicate detection. To learn more, see Minimum/maximum number of words. [SimilarityThreshold <Int32?>]: Specifies the similarity level for documents to be put in the same near duplicate set. To learn more, see Document and email similarity threshold.

TOPICMODELING <IMicrosoftGraphEdiscoveryTopicModelingSettings>: topicModelingSettings [(Any) <Object>]: This indicates any property can be added to this object. [DynamicallyAdjustTopicCount <Boolean?>]: To learn more, see Adjust maximum number of themes dynamically. [IgnoreNumbers <Boolean?>]: To learn more, see Include numbers in themes. [IsEnabled <Boolean?>]: Indicates whether themes are enabled for the case. [TopicCount <Int32?>]: To learn more, see Maximum number of themes.