New-ComplianceSecurityFilter
This cmdlet is functional only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.
Use the New-ComplianceSecurityFilter cmdlet to create compliance security filters in the Microsoft Purview compliance portal. These filters allow specified users to search only a subset of mailboxes and SharePoint Online or OneDrive for Business sites in your Microsoft 365 organization.
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.
Syntax
New-ComplianceSecurityFilter
-Action <ComplianceSecurityFilterActionType>
-FilterName <String>
-Users <MultiValuedProperty>
[-Confirm]
[-Description <String>]
[-Filters <MultiValuedProperty>]
[-Region <String>]
[-WhatIf]
[<CommonParameters>] Description
Compliance security filters work with compliance searches in the Microsoft Purview compliance portal (*-ComplianceSearch cmdlets), not In-Place eDiscovery searches in Exchange Online (*-MailboxSearch cmdlets).
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
New-ComplianceSecurityFilter -FilterName CountryFilter -Users annb@contoso.com -Filters "Mailbox_CountryCode -eq '124'" -Action AllThis example allows the user annb to perform all compliance search actions only for mailboxes in Canada. The filter uses the ISO 3166-1 numeric country code value.
Example 2
New-ComplianceSecurityFilter -FilterName USDiscoveryManagers -Users "US Discovery Managers" -Filters "Mailbox_CountryCode -eq '840'" -Action AllThis example allows members of the US Discovery Managers role group to perform all compliance search actions only on mailboxes in the United States.
Example 3
New-ComplianceSecurityFilter -FilterName EmailDateRestrictionFilter -Users donh@contoso.com -Filters "MailboxContent_Received -ge '01-01-2018' -and MailboxContent_Received -le '12-31-2018'" -Action AllThis example restricts the user to performing all compliance search actions only on email messages sent during the calendar year 2018.
Example 4
New-ComplianceSecurityFilter -FilterName DocumentDateRestrictionFilter -Users donh@contoso.com -Filters "SiteContent_LastModifiedTime -ge '01-01-2018' -and SiteContent_LastModifiedTime -le '12-31-2018'" -Action AllThis example restricts the user to performing all compliance search actions on documents that were last changed sometime in the calendar year 2018.
Example 5
New-ComplianceSecurityFilter -FilterName NoEXO -Users suzanf@contoso.com -Filters "Mailbox_Alias -notlike '*'" -Action AllThis example prevents the user from performing any compliance search actions on any mailbox in the organization.
Parameters
-Action
The Action parameter specifies that type of search action that the filter is applied to. Valid values are:
- 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: | True |
| 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 for the compliance security filter. 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. The filters are applied to the users specified by the Users parameter. 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)'".
You need to create a search permissions filter to explicitly prevent users from searching any content location in a specific Microsoft 365 service (such as preventing a user from searching Exchange mailboxes or SharePoint sites). In other words, creating a search permissions filter that allows a user to search all SharePoint sites in the organization doesn't prevent that user from searching mailboxes. For example, to allow a SharePoint admin to only search SharePoint sites, you need to create a filter that prevents them from searching mailboxes (as described in Example 5). Similarly, to allow an Exchange admin to only search mailboxes, you need to create a filter that prevents them from searching sites.
| 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.
| Type: | MultiValuedProperty |
| 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 |
-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 |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for