Edit

Set-FeatureConfiguration

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Note

This cmdlet is currently available in Public Preview, isn't available in all organizations, and is subject to change.

Use the Set-FeatureConfiguration cmdlet to modify Microsoft Purview feature configurations within your organization, including:

  • Collection policies.
  • Advanced label based protection.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Syntax

Default (Default)

Set-FeatureConfiguration
    [-Identity] <PolicyIdParameter>
    [-Locations <String>]
    [-Comment <String>]
    [-Confirm]
    [-Mode <PolicyMode>]
    [-ScenarioConfig <String>]
    [-WhatIf]
    [<CommonParameters>]

Description

To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see Permissions in Security & Compliance.

Examples

Example 1

Set-FeatureConfiguration "DSPM for AI - Capture interactions for Copilot experiences" -ScenarioConfig '{"Activities":["UploadText","DownloadText"],"EnforcementPlanes":["CopilotExperiences"],"SensitiveTypeIds":["All"],"IsIngestionEnabled":false}'

This example updates a collection policy named "DSPM for AI - Capture interactions for Copilot experiences" to disable content capture.

Example 2

Set-FeatureConfiguration "Microsoft Copilot collection policy for Contoso Sales" -Locations '[{"Workload":"Applications","Location":"52655","AddInclusions":[{"Type":"Group","Identity":"USSales@contoso.com"}]}]'

This example updates a collection policy named "Microsoft Copilot collection policy for Contoso Sales" to include the USSales@contoso.com group.

Example 3

Set-FeatureConfiguration "Microsoft Copilot collection policy for Contoso Sales" -Locations '[{"Workload":"Applications","Location":"52655","AddExclusions":[{"Type":"IndividualResource","Identity":"adele@contoso.com"}]}]'

This example updates a collection policy named "Microsoft Copilot collection policy for Contoso Sales" to exclude the adele@contoso.com.

Parameters

-Comment

Applicable: Security & Compliance

The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note".

Parameter properties

Type:String
Default value:None
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

-Confirm

Applicable: Security & Compliance

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.
  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you to acknowledge the command before proceeding.

Parameter properties

Type:SwitchParameter
Default value:None
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

-Identity

Applicable: Security & Compliance

The Identity parameter specifies the feature configuration that you want to modify. You can use any value that uniquely identifies the policy. For example:

  • Name
  • Distinguished name (DN)
  • GUID

Parameter properties

Type:PolicyIdParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-Locations

Applicable: Security & Compliance

The locations parameter specifies where the feature configuration applies.

Parameter properties

Type:String
Default value:None
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

-Mode

Applicable: Security & Compliance

The Mode parameter specifies feature configuration mode. Valid values are:

  • Enable: The feature configuration is enabled.
  • Disable: The feature configuration is disabled.

Parameter properties

Type:PolicyMode
Default value:None
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

-ScenarioConfig

Applicable: Security & Compliance

The ScenarioConfig parameter specifies additional information about the feature configuration.

Parameter properties

Type:String
Default value:None
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

-WhatIf

Applicable: Security & Compliance

The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch.

Parameter properties

Type:SwitchParameter
Default value:None
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.