Set-ComplianceSecurityFilter
This cmdlet is functional only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.
Use the Set-ComplianceSecurityFilter cmdlet to modify compliance security filters in the Microsoft Purview compliance portal.
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.
Syntax
Set-ComplianceSecurityFilter
-FilterName <String>
[-Action <ComplianceSecurityFilterActionType>]
[-Confirm]
[-Description <String>]
[-Filters <MultiValuedProperty>]
[-Region <String>]
[-Users <MultiValuedProperty>]
[-WhatIf]
[<CommonParameters>] Description
To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see Permissions in the Microsoft Purview compliance portal.
Examples
Example 1
$filterusers = Get-ComplianceSecurityFilter -FilterName "Ottawa Users Filter"
$filterusers.users.add("[email protected]")
Set-ComplianceSecurityFilter -FilterName "Ottawa Users Filter" -Users $filterusers.usersThis example adds user [email protected] to the compliance security filter named Ottawa Users Filter without affecting other users assigned to the filter.
Example 2
$filterusers = Get-ComplianceSecurityFilter -FilterName "Ottawa Users Filter"
$filterusers.users.remove("[email protected]")
Set-ComplianceSecurityFilter -FilterName "Ottawa Users Filter" -Users $filterusers.usersThis example removes user [email protected] to the compliance security filter named Ottawa Users Filter without affecting other users assigned to the filter.
Parameters
-Action
The Action parameter specifies that type of search action that the filter is applied to. A valid value for this parameter is All, which means the filter is applied to all search actions.
- Export: The filter is applied when exporting search results, or preparing them for analysis in eDiscovery Premium.
- Preview: The filter is applied when previewing search results.
- Purge: The filter is applied when purging search results. How the items are deleted is controlled by the PurgeType parameter value on the New-ComplianceSearchAction cmdlet. The default value is SoftDelete, which means the purged items are recoverable by users until the deleted items retention period expires.
- Search: The filter is applied when running a search.
- All: The filter is applied to all search actions.
| Type: | ComplianceSecurityFilterActionType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Confirm
The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if 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 acknowledge the command before proceeding.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Description
The Description parameter specifies a description for the compliance security filter. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks (").
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-FilterName
The FilterName parameter specifies the name of the compliance security filter that you want to modify. If the value contains spaces, enclose the value in quotation marks (").
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Filters
The Filters parameter specifies the search criteria for the compliance security filter. You can create three different types of filters:
- Mailbox filter: Specifies the mailboxes that can be searched by the assigned users. Valid syntax is
Mailbox_<MailboxPropertyName>, where<MailboxPropertyName>is a mailbox property value. For example,"Mailbox_CustomAttribute10 -eq 'OttawaUsers'"allows users to only search mailboxes that have the value OttawaUsers in the CustomAttribute10 property. For a list of supported mailbox properties, see Filterable properties for the RecipientFilter parameter. - Mailbox content filter: Specifies the mailbox content the assigned users can search for. Valid syntax is
MailboxContent_<SearchablePropertyName>, where<SearchablePropertyName>specifies a Keyword Query Language (KQL) property that can be specified in a compliance search. For example,"MailboxContent_Recipients -like 'contoso.com'"allows users to only search for messages sent to recipients in the contoso.com domain. For a list of searchable email properties, see Keyword queries for eDiscovery. - Site and site content filter: There are two SharePoint Online and OneDrive for Business site-related filters that you can create:
Site_<SearchableSiteProperty>(specifies site-related properties. For example,"Site_Path -eq 'https://contoso.sharepoint.com/sites/doctors'"allows users to only search for content in thehttps://contoso.sharepoint.com/sites/doctorssite collection) andSiteContent_<SearchableSiteProperty>(specifies content-related properties. For example,"SiteContent_FileExtension -eq 'docx'"allows users to only search for Word documents). For a list of searchable site properties, see Overview of crawled and managed properties in SharePoint Server. Properties marked with a Yes in the Queryable column can be used to create a site or site content filter.
You can specify multiple filters of the same type. For example, "Mailbox_CustomAttribute10 -eq 'FTE' -and Mailbox_MemberOfGroup -eq '$($DG.DistinguishedName)'".
| Type: | MultiValuedProperty |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Region
The Region parameter specifies the satellite location for multi-geo tenants to conduct eDiscovery searches in. Valid values are:
- APC: Asia-Pacific
- AUS: Australia
- CAN: Canada
- EUR: Europe, Middle East, Africa
- FRA: France
- GBR: United Kingdom
- IND: India
- JPN: Japan
- LAM: Latin America
- NAM: North America
If you don't use this parameter in a multi-geo tenant, eDiscovery searches are performed in the central location.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Users
The Users parameter specifies the user who gets this filter applied to their searches. Valid values are:
- One or more users: Identify users by their alias or email address. You can specify multiple values separated by commas.
- The value All: Assigns the filter to all users. You can only use this value by itself.
- One or more role groups: Identify the role group by its name. You can specify multiple values separated by commas.
You can't specify distribution groups with this parameter.
The values you specify will overwrite any existing entries. See the Examples section to add or remove users without affecting other existing entries.
| Type: | MultiValuedProperty |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-WhatIf
The WhatIf switch doesn't work in Security & Compliance PowerShell.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |