Skip to content

Commit bf427d1

Browse files
authored
Merge pull request MicrosoftDocs#5807 from MicrosoftDocs/V2Filters-chrisda
V2Filters-chrisda to Master
2 parents b3b2959 + 96b0182 commit bf427d1

File tree

5 files changed

+72
-4
lines changed

5 files changed

+72
-4
lines changed

exchange/docs-conceptual/exchange-online/exchange-online-powershell-v2/app-only-auth-powershell-v2.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,13 @@ The following examples show how to use the Exchange Online PowerShell V2 module
3030
```powershell
3131
Connect-ExchangeOnline -CertificateFilePath "C:\Users\johndoe\Desktop\automation-cert.pfx" -AppID "alpha-beta-gamma-123456" -TenantID "contosoelectronics.onmicrosoft.com"
3232
```
33-
33+
3434
- Connect using a certificate thumbprint:
3535

3636
```powershell
3737
Connect-ExchangeOnline -CertificateThumbPrint "012THISISADEMOTHUMBPRINT" -AppID "alpha-beta-gamma-123456" -TenantID "contosoelectronics.onmicrosoft.com"
3838
```
39+
3940
When you use the _CertificateThumbPrint_ parameter, the certificate needs to be installed on the computer where you are running the command. The certificate should be installed in the user certificate store.
4041

4142
- Connect using an existing service principal and client-secret:

exchange/docs-conceptual/exchange-online/exchange-online-powershell-v2/cmdlet-property-sets.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ description: "Learn about the available property sets in the Exchange Online Pow
2020

2121
This topic describes the property sets that are available in the new cmdlets in the [Exchange Online PowerShell V2 module](exchange-online-powershell-v2.md). For more information about property sets, see [Properties and property sets in the EXO V2 module](exchange-online-powershell-v2.md#properties-and-property-sets-in-the-exo-v2-module).
2222

23+
For more information about filtering in the EXO V2 module, see [Filters in the Exchange Online V2 module](filters-v2.md).
24+
2325
## Get-EXOCasMailbox property sets
2426

2527
The available property sets for the **Get-EXOCasMailbox** cmdlet and the properties they contain are described in the following table:

exchange/docs-conceptual/exchange-online/exchange-online-powershell-v2/exchange-online-powershell-v2.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,6 @@ The new cmdlets in the EXO V2 module are listed in the following table:
5252
|[Disconnect-ExchangeOnline](https://docs.microsoft.com/powershell/module/exchange/disconnect-exchangeonline)|[Remove-PSSession](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/remove-pssession)|
5353
|[Connect-IPPSSession](https://docs.microsoft.com/powershell/module/exchange/connect-ippssession)|[Connect-IPPSSession](https://docs.microsoft.com/powershell/exchange/office-365-scc/connect-to-scc-powershell/mfa-connect-to-scc-powershell)|
5454

55-
5655
## Install and maintain the Exchange Online PowerShell V2 module
5756

5857
You can download the EXO V2 module from the PowerShell gallery [here](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/).
@@ -268,6 +267,8 @@ Get-EXOMailbox -ResultSize 10 -PropertySets All
268267
> [!NOTE]
269268
> We highly discourage using the _PropertySets_ parameter with the value `All` because it slows down the cmdlet and reduces reliability. Always use the _PropertySets_ and _Properties_ parameters to retrieve only the required properties.
270269
270+
For more information about filtering in the EXO V2 module, see [Filters in the Exchange Online V2 module](filters-v2.md).
271+
271272
## Release notes
272273

273274
### Current release: Version 1.0.1
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
title: Filters in the V2 module
3+
ms.author: chrisda
4+
author: chrisda
5+
manager: dansimp
6+
ms.date:
7+
ms.audience: Admin
8+
ms.topic: article
9+
ms.service: exchange-online
10+
ms.reviewer: navgupta
11+
localization_priority: Priority
12+
ms.collection: Strat_EX_Admin
13+
ms.custom:
14+
ms.assetid:
15+
search.appverid: MET150
16+
description: "Learn about how to use filtering for cmdlets in the Exchange Online V2 module."
17+
---
18+
19+
# Filters in the Exchange Online V2 module
20+
21+
The Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module) contains a few new cmdlets that are optimized for high speed, high volume operations, and (after you connect to your organization) gives you access to the hundreds of existing cmdlets in the service. For more information, see [Use the Exchange Online PowerShell V2 module](exchange-online-powershell-v2.md).
22+
23+
In order to get the most out of the EXO V2 module, you need to follow the guidance in this topic.
24+
25+
## Use client-side filtering for the best performance
26+
27+
Server-side filtering uses the available _Filter_ or _RecipientFilter_ parameters on a cmdlet. Client-side filtering uses the [Where-Object](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/where-object) cmdlet (also known as **where** or **?**).
28+
29+
Generally, you get much better performance with server-side filtering. However, for the EXO V2 module, you actually get better performance when using client-side filtering. We're working on improving the performance of server-side filtering in module.
30+
31+
## Supported and unsupported attributes
32+
33+
Although the EXO V2 module supports the majority of filterable attributes, the following attributes are currently not supported for filtering:
34+
35+
||||
36+
|---|---|---|
37+
|**Cmdlet**|**Attribute**|**LDAP Display Name**|
38+
|[Get-CASMailbox](https://docs.microsoft.com/powershell/module/exchange/get-casmailbox)|MemberOfGroup <br/><br/> ExternalDirectoryObjectId|memberOf <br/><br/> msExchExternalDirectoryObjectId|
39+
|[Get-Mailbox](https://docs.microsoft.com/powershell/module/exchange/get-mailbox)|DeletedItemFlags <br/><br/> ExternalDirectoryObjectId <br/><br/> LanguagesRaw <br/><br/> MasterAccountSid <br/><br/> MemberOfGroup <br/><br/> RequireAllSendersAreAuthenticated <br/><br/> SCLDeleteThresholdInt <br/><br/> SCLJunkThresholdInt <br/><br/> SCLQuarantineThresholdInt <br/><br/> SCLRejectThresholdInt|deletedItemFlags <br/><br/> msExchExternalDirectoryObjectId <br/><br/> msExchUserCulture <br/><br/> msExchMasterAccountSid <br/><br/> memberOf <br/><br/> msExchRequireAuthToSendTo <br/><br/> msExchMessageHygieneSCLDeleteThreshold <br/><br/> msExchMessageHygieneSCLJunkThreshold <br/><br/> msExchMessageHygieneSCLQuarantineThreshold <br/><br/> msExchMessageHygieneSCLRejectThreshold|
40+
|[Get-Recipient](https://docs.microsoft.com/powershell/module/exchange/get-recipient)|CountryCode <br/><br/> ExternalDirectoryObjectId <br/><br/> MasterAccountSid <br/><br/> MemberOfGroup <br/><br/> Members|countryCode <br/><br/> msExchExternalDirectoryObjectId <br/><br/> msExchMasterAccountSid <br/><br/> memberOf <br/><br/> member|
41+
|
42+
43+
## Supported and unsupported operators
44+
45+
The following operators are fully supported for all string formats in the EXO V2 module:
46+
47+
- -eq
48+
- -and
49+
- -ne
50+
- -or
51+
- -not
52+
- -lt
53+
- -gt
54+
55+
The -like and -notlike operators are limited in using wildcards (*). Specifically, you can only use wildcards at the beginning of a string value, at the end of a string value, or both.
56+
57+
For example, the following text search is not supported:
58+
59+
`"UPN -like 'A*B*C'`
60+
61+
However, the following searches are supported:
62+
63+
`"UPN -like 'A*' -and UPN -like '*C' -and UPN like '*B*'"`

exchange/docs-conceptual/toc.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
- name: Home
32
href: index.md
43
items:
@@ -46,8 +45,10 @@
4645
- name: Exchange Online PowerShell V2
4746
href: exchange-online/exchange-online-powershell-v2/exchange-online-powershell-v2.md
4847
items:
49-
- name: Property sets in cmdlets
48+
- name: Property sets in V2 cmdlets
5049
href: exchange-online/exchange-online-powershell-v2/cmdlet-property-sets.md
50+
- name: Filters in the V2 module
51+
href: exchange-online/exchange-online-powershell-v2/filters-v2.md
5152
- name: Office 365 Security & Compliance Center PowerShell
5253
href: office-365-scc/office-365-scc-powershell.md
5354
items:

0 commit comments

Comments
 (0)