Share via

Update-MgSecurityCaseEdiscoveryCaseSetting

Module:
Microsoft.Graph.Security Module

Update the properties of an ediscoveryCaseSettings object.

Note

To view the beta release of this cmdlet, view Update-MgBetaSecurityCaseEdiscoveryCaseSetting

Syntax

UpdateExpanded (Default) 

Update-MgSecurityCaseEdiscoveryCaseSetting
    -EdiscoveryCaseId <string>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-CaseType <string>]
    [-Id <string>]
    [-Ocr <IMicrosoftGraphSecurityOcrSettings>]
    [-RedundancyDetection <IMicrosoftGraphSecurityRedundancyDetectionSettings>]
    [-ReviewSetSettings <string>]
    [-TopicModeling <IMicrosoftGraphSecurityTopicModelingSettings>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Update 

Update-MgSecurityCaseEdiscoveryCaseSetting
    -EdiscoveryCaseId <string>
    -BodyParameter <IMicrosoftGraphSecurityEdiscoveryCaseSettings>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentityExpanded 

Update-MgSecurityCaseEdiscoveryCaseSetting
    -InputObject <ISecurityIdentity>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-CaseType <string>]
    [-Id <string>]
    [-Ocr <IMicrosoftGraphSecurityOcrSettings>]
    [-RedundancyDetection <IMicrosoftGraphSecurityRedundancyDetectionSettings>]
    [-ReviewSetSettings <string>]
    [-TopicModeling <IMicrosoftGraphSecurityTopicModelingSettings>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentity 

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

Description

Update the properties of an ediscoveryCaseSettings 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.Security

$params = @{
	"@odata.type" = "#microsoft.graph.security.ediscoveryCaseSettings"
	redundancyDetection = @{
		"@odata.type" = "microsoft.graph.security.redundancyDetectionSettings"
	}
	topicModeling = @{
		"@odata.type" = "microsoft.graph.security.topicModelingSettings"
	}
	ocr = @{
		"@odata.type" = "microsoft.graph.security.ocrSettings"
	}
}

Update-MgSecurityCaseEdiscoveryCaseSetting -EdiscoveryCaseId $ediscoveryCaseId -BodyParameter $params

This example shows how to use the Update-MgSecurityCaseEdiscoveryCaseSetting 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

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

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IMicrosoftGraphSecurityEdiscoveryCaseSettings
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

-CaseType

caseType

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

-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

-EdiscoveryCaseId

The unique identifier of ediscoveryCase

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

-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.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.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.PowerShell.Models.ISecurityIdentity
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.PowerShell.Models.IMicrosoftGraphSecurityOcrSettings
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.PowerShell.Models.IMicrosoftGraphSecurityRedundancyDetectionSettings
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

-ReviewSetSettings

reviewSetSettings

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

-TopicModeling

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

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IMicrosoftGraphSecurityTopicModelingSettings
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.PowerShell.Models.IMicrosoftGraphSecurityEdiscoveryCaseSettings

{{ Fill in the Description }}

Microsoft.Graph.PowerShell.Models.ISecurityIdentity

{{ Fill in the Description }}

System.Collections.IDictionary

{{ Fill in the Description }}

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphSecurityEdiscoveryCaseSettings

{{ 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 <IMicrosoftGraphSecurityEdiscoveryCaseSettings>: ediscoveryCaseSettings [(Any) <Object>]: This indicates any property can be added to this object. [Id <String>]: The unique identifier for an entity. Read-only. [CaseType <String>]: caseType [Ocr <IMicrosoftGraphSecurityOcrSettings>]: 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 might increase success of OCR, but might add to the total processing time. [RedundancyDetection <IMicrosoftGraphSecurityRedundancyDetectionSettings>]: 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. [ReviewSetSettings <String>]: reviewSetSettings [TopicModeling <IMicrosoftGraphSecurityTopicModelingSettings>]: topicModelingSettings [(Any) <Object>]: This indicates any property can be added to this object. [DynamicallyAdjustTopicCount <Boolean?>]: Indicates whether the themes model should dynamically optimize the number of generated topics. To learn more, see Adjust maximum number of themes dynamically. [IgnoreNumbers <Boolean?>]: Indicates whether the themes model should exclude numbers while parsing document texts. To learn more, see Include numbers in themes. [IsEnabled <Boolean?>]: Indicates whether themes model is enabled for the case. [TopicCount <Int32?>]: The total number of topics that the themes model will generate for a review set. To learn more, see Maximum number of themes.

INPUTOBJECT <ISecurityIdentity>: Identity Parameter [AlertId <String>]: The unique identifier of alert [ArticleId <String>]: The unique identifier of article [ArticleIndicatorId <String>]: The unique identifier of articleIndicator [AttackSimulationOperationId <String>]: The unique identifier of attackSimulationOperation [AuthoredNoteId <String>]: The unique identifier of authoredNote [AuthorityTemplateId <String>]: The unique identifier of authorityTemplate [CaseOperationId <String>]: The unique identifier of caseOperation [CategoryTemplateId <String>]: The unique identifier of categoryTemplate [CitationTemplateId <String>]: The unique identifier of citationTemplate [ContentFormats <String[]>]: Usage: contentFormats={contentFormats} [DataSourceId <String>]: The unique identifier of dataSource [DepartmentTemplateId <String>]: The unique identifier of departmentTemplate [DispositionReviewStageNumber <String>]: The unique identifier of dispositionReviewStage [EdiscoveryCaseId <String>]: The unique identifier of ediscoveryCase [EdiscoveryCustodianId <String>]: The unique identifier of ediscoveryCustodian [EdiscoveryNoncustodialDataSourceId <String>]: The unique identifier of ediscoveryNoncustodialDataSource [EdiscoveryReviewSetId <String>]: The unique identifier of ediscoveryReviewSet [EdiscoveryReviewSetQueryId <String>]: The unique identifier of ediscoveryReviewSetQuery [EdiscoveryReviewTagId <String>]: The unique identifier of ediscoveryReviewTag [EdiscoveryReviewTagId1 <String>]: The unique identifier of ediscoveryReviewTag [EdiscoverySearchId <String>]: The unique identifier of ediscoverySearch [EndUserNotificationDetailId <String>]: The unique identifier of endUserNotificationDetail [EndUserNotificationId <String>]: The unique identifier of endUserNotification [FilePlanReferenceTemplateId <String>]: The unique identifier of filePlanReferenceTemplate [HealthIssueId <String>]: The unique identifier of healthIssue [HostComponentId <String>]: The unique identifier of hostComponent [HostCookieId <String>]: The unique identifier of hostCookie [HostId <String>]: The unique identifier of host [HostPairId <String>]: The unique identifier of hostPair [HostPortId <String>]: The unique identifier of hostPort [HostSslCertificateId <String>]: The unique identifier of hostSslCertificate [HostTrackerId <String>]: The unique identifier of hostTracker [IncidentId <String>]: The unique identifier of incident [IntelligenceProfileId <String>]: The unique identifier of intelligenceProfile [IntelligenceProfileIndicatorId <String>]: The unique identifier of intelligenceProfileIndicator [LabelIds <String[]>]: Usage: labelIds={labelIds} [LandingPageDetailId <String>]: The unique identifier of landingPageDetail [LandingPageId <String>]: The unique identifier of landingPage [Locale <String>]: Usage: locale='{locale}' [LoginPageId <String>]: The unique identifier of loginPage [PassiveDnsRecordId <String>]: The unique identifier of passiveDnsRecord [PayloadId <String>]: The unique identifier of payload [RetentionEventId <String>]: The unique identifier of retentionEvent [RetentionEventTypeId <String>]: The unique identifier of retentionEventType [RetentionLabelId <String>]: The unique identifier of retentionLabel [SecureScoreControlProfileId <String>]: The unique identifier of secureScoreControlProfile [SecureScoreId <String>]: The unique identifier of secureScore [SensitivityLabelId <String>]: The unique identifier of sensitivityLabel [SensitivityLabelId1 <String>]: The unique identifier of sensitivityLabel [SensorId <String>]: The unique identifier of sensor [SimulationAutomationId <String>]: The unique identifier of simulationAutomation [SimulationAutomationRunId <String>]: The unique identifier of simulationAutomationRun [SimulationId <String>]: The unique identifier of simulation [SiteSourceId <String>]: The unique identifier of siteSource [SslCertificateId <String>]: The unique identifier of sslCertificate [SubcategoryTemplateId <String>]: The unique identifier of subcategoryTemplate [SubdomainId <String>]: The unique identifier of subdomain [SubjectRightsRequestId <String>]: The unique identifier of subjectRightsRequest [TrainingId <String>]: The unique identifier of training [TrainingLanguageDetailId <String>]: The unique identifier of trainingLanguageDetail [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 [VulnerabilityComponentId <String>]: The unique identifier of vulnerabilityComponent [VulnerabilityId <String>]: The unique identifier of vulnerability [WhoisHistoryRecordId <String>]: The unique identifier of whoisHistoryRecord [WhoisRecordId <String>]: The unique identifier of whoisRecord

OCR <IMicrosoftGraphSecurityOcrSettings>: 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 might increase success of OCR, but might add to the total processing time.

REDUNDANCYDETECTION <IMicrosoftGraphSecurityRedundancyDetectionSettings>: 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 <IMicrosoftGraphSecurityTopicModelingSettings>: topicModelingSettings [(Any) <Object>]: This indicates any property can be added to this object. [DynamicallyAdjustTopicCount <Boolean?>]: Indicates whether the themes model should dynamically optimize the number of generated topics. To learn more, see Adjust maximum number of themes dynamically. [IgnoreNumbers <Boolean?>]: Indicates whether the themes model should exclude numbers while parsing document texts. To learn more, see Include numbers in themes. [IsEnabled <Boolean?>]: Indicates whether themes model is enabled for the case. [TopicCount <Int32?>]: The total number of topics that the themes model will generate for a review set. To learn more, see Maximum number of themes.