Skip to content

Commit 9ec356a

Browse files
authored
Update filter-properties.md
1 parent 03ca938 commit 9ec356a

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

exchange/docs-conceptual/exchange-server/recipient-filters/filter-properties.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -135,21 +135,21 @@ The properties that have been _confirmed_ to work with the _Filter_ parameter in
135135
|_ExchangeVersion_|_msExchVersion_|**Get-CASMailbox** <br/> **Get-Contact** <br/> **Get-DistributionGroup** <br/> **Get-DynamicDistributionGroup** <br/> **Get-Group** <br/> **Get-LinkedUser** <br/> **Get-Mailbox** <br/> **Get-MailContact** <br/> **Get-MailPublicFolder** <br/> **Get-MailUser** <br/> **Get-Recipient** <br/> **Get-RemoteMailbox** <br/> **Get-SecurityPrincipal** <br/> **Get-UMMMailbox** <br/> **Get-User**|Integer|This property contains the earliest version of Exchange that you can use to manage the recipient. The property values that you see are different than the values that you need to use in the filter. To see the **ExchangeVersion** property values, run this command: `Get-Recipient | Format-Table Name,RecipientType,ExchangeVersion`. <br/> For the Exchange 2010 value `0.10 (14.0.100.0)`, use the value 44220983382016 in the filter. <br/> For the Exchange 2013 or Exchange 2016 value `0.20 (15.0.0.0)`, use the value 88218628259840 in the filter. <br/> For example, `Get-Recipient -Filter {ExchangeVersion -lt 88218628259840}`.|
136136
|_ExpansionServer_|_msExchExpansionServerName_|**Get-DistributionGroup** <br/> **Get-DynamicDistributionGroup** <br/> **Get-Recipient**|String (wildcards accepted) or `$null`|For example, `Get-Recipient -Filter {ExpansionServer -like '*Mailbox01'}`. <br/> For an exact match, you need to use the **ExchangeLegacyDN** value of the server. For example, `Get-Recipient -Filter {ExpansionServer -eq '/o=Contoso Corporation/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Mailbox01'}` <br/> You can find the **ExchangeLegacyDN** value by running this command: `Get-ExchangeServer | Format-List Name,ExchangeLegacyDN`.|
137137
|_ExtensionCustomAttribute1_ to _ExtensionCustomAttribute5_|_msExchExtensionCustomAttribute1_ to _msExchExtensionCustomAttribute5_|**Get-DistributionGroup** <br/> **Get-DynamicDistributionGroup** <br/> **Get-Mailbox** <br/> **Get-MailContact** <br/> **Get-MailPublicFolder** <br/> **Get-MailUser** <br/> **Get-Recipient** <br/> **Get-RemoteMailbox** <br/> **Get-UnifiedGroup**|String (wildcards accepted) or `$null`|For example, `Get-Recipient -Filter {ExtensionCustomAttribute8 -like '*audited*'}`.|
138-
|_ExternalDirectoryObjectId_|_msExchExternalDirectoryObjectId_|**Get-DistributionGroup** <br/> **Get-DynamicDistributionGroup** <br/> **Get-LinkedUser** <br/> **Get-Mailbox** <br/> **Get-MailContact** <br/> **Get-MailPublicFolder** <br/> **Get-MailUser** <br/> **Get-Recipient** <br/> **Get-RemoteMailbox** <br/> **Get-User**|String or `$null`|For example, `Get-Recipient -Filter {ExternalDirectoryObjectId -ne $null}`.|
138+
|_ExternalDirectoryObjectId_|_msExchExternalDirectoryObjectId_|**Get-DistributionGroup** <br/> **Get-DynamicDistributionGroup** <br/> **Get-LinkedUser** <br/> **Get-Mailbox** <br/> **Get-MailContact** <br/> **Get-MailPublicFolder** <br/> **Get-MailUser** <br/> **Get-Recipient** <br/> **Get-RemoteMailbox** <br/> **Get-User** <br/> **Get-UnifiedGroup**|String or `$null`|For example, `Get-Recipient -Filter {ExternalDirectoryObjectId -ne $null}`.|
139139
|_ExternalEmailAddress_|_targetAddress_|**Get-MailContact** <br/> **Get-MailPublicFolder** <br/> **Get-MailUser** <br/> **Get-Recipient**|String (wildcards accepted) or `$null`|For example, `Get-Recipient -Filter {ExternalEmailAddress -like '*@fabrikam.com'}`. <br/> When you use a complete email address, you don't need to account for the `smtp:` prefix. If you use wildcards, you do. For example, if `{ExternalEmailAddress -eq '[email protected]'}` returns a match, `{ExternalEmailAddress -like 'lila*'}` won't return a match, but `{ExternalEmailAddress -like '*lila*'}` or `{ExternalEmailAddress -like 'smtp:lila*'}` will return a match.|
140140
|_ExternalOofOptions_|_msExchExternalOOFOptions_|**Get-Mailbox**|`External` (0) or `InternalOnly` (1)|For example, `Get-Mailbox -Filter {ExternalOofOptions -eq 'External'}`.|
141141
|_Fax_|_facsimileTelephoneNumber_|**Get-Contact** <br/> **Get-LinkedUser** <br/> **Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter {Fax -like '206*'}`.|
142142
|_FirstName_|_givenName_|**Get-Contact** <br/> **Get-LinkedUser** <br/> **Get-Recipient** <br/> **Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter {FirstName -like 'Chris*'}`.|
143143
|_ForwardingAddress_|_altRecipient_|**Get-Mailbox** <br/> **Get-MailPublicFolder** <br/> **Get-MailUser** <br/> **Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the forwarding recipient. For example, `Get-Mailbox -Filter {ForwardingAddress -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'}` or `Get-Mailbox -Filter {ForwardingAddress -eq 'contoso.com/Users/Angela Gruber'}`. <br/> To find the distinguished name of a forwarding recipient, replace _\<RecipientIdentity\>_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "<RecipientIdentity>" | Format-List Name,DistinguishedName`.|
144144
|_ForwardingSmtpAddress_|_msExchGenericForwardingAddress_|**Get-Mailbox**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter {ForwardingSmtpAddress -like '*@fabrikam.com'}`. <br/> When you use a complete email address, you don't need to account for the `smtp:` prefix. If you use wildcards, you do. For example, if `{ForwardingSmtpAddress -eq '[email protected]'}` returns a match, `{ForwardingSmtpAddress -like 'lila*'}` won't return a match, but `{ForwardingSmtpAddress -like '*lila*'}` or `{ForwardingSmtpAddress -like 'smtp:lila*'}` will return a match.|
145145
|_GeneratedOfflineAddressBooks_|_msExchOABGeneratingMailboxBL_|**Get-Mailbox**|String or `$null`|This property is only meaningful on arbitration mailboxes, so you need to use the _Arbitration_ switch in the filter command. Also, This filter requires the distinguished name of the offline address book. For example, `Get-Mailbox -Arbitration -Filter {GeneratedOfflineAddressBooks -eq 'CN=OAB 1,CN=Offline Address Lists,CN=Address Lists Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'}`. <br/> You can find the distinguished names of offline address books by running this command: `Get-OfflineAddressBook | Format-List Name,DistinguishedName`. <br/> Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.|
146-
|_GrantSendOnBehalfTo_|_publicDelegates_|**Get-DistributionGroup** <br/> **Get-DynamicDistributionGroup** <br/> **Get-Mailbox** <br/> **Get-MailContact** <br/> **Get-MailPublicFolder** <br/> **Get-MailUser** <br/> **Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the mail-enabled security principal (mailbox, mail user, or mail-enabled security group). For example, `Get-Mailbox -Filter {GrantSendOnBehalfTo -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'}` or `Get-Mailbox -Filter {GrantSendOnBehalfTo -eq 'contoso.com/Users/Angela Gruber'}`. <br/> To find the distinguished name of a mail-enabled security principal, replace _\<RecipientIdentity\>_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "<RecipientIdentity>" | Format-List Name,DistinguishedName`. <br/> Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.|
146+
|_GrantSendOnBehalfTo_|_publicDelegates_|**Get-DistributionGroup** <br/> **Get-DynamicDistributionGroup** <br/> **Get-Mailbox** <br/> **Get-MailContact** <br/> **Get-MailPublicFolder** <br/> **Get-MailUser** <br/> **Get-RemoteMailbox** <br/> **Get-UnifiedGroup**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the mail-enabled security principal (mailbox, mail user, or mail-enabled security group). For example, `Get-Mailbox -Filter {GrantSendOnBehalfTo -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'}` or `Get-Mailbox -Filter {GrantSendOnBehalfTo -eq 'contoso.com/Users/Angela Gruber'}`. <br/> To find the distinguished name of a mail-enabled security principal, replace _\<RecipientIdentity\>_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "<RecipientIdentity>" | Format-List Name,DistinguishedName`. <br/> Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.|
147147
|_GroupMemberCount_|_n/a_|**Get-UnifiedGroup**|Integer|For example, `Get-UnifiedGroup -Filter {GroupMemberCount -gt 100}`.|
148148
|_GroupExternalMemberCount_|_n/a_|**Get-UnifiedGroup**|Integer|For example, `Get-UnifiedGroup -Filter {GroupExternalMemberCount -gt 0}`.|
149149
|_GroupType_|_groupType_|**Get-DistributionGroup** <br/> **Get-Group** <br/> **Get-UnifiedGroup**|`None` (0), `Global` (2), `DomainLocal` (4), `BuiltinLocal` (5), `Universal` (8), or `SecurityEnabled` (-2147483648).|Distribution groups have the value `Universal`, and mail-enabled security groups have the value `Universal, SecurityEnabled`. You can specify multiple values separated by commas, and the order doesn't matter. For example, `Get-DistributionGroup -Filter {GroupType -eq 'Universal,SecurityEnabled'}` returns the same results as `Get-DistributionGroup -Filter {GroupType -eq 'SecurityEnabled,Universal'}`. <br/> This multivalued property will only return a match if the property *equals* the specified value.|
150150
|_Guid_|_objectGuid_|**Get-CASMailbox** <br/> **Get-Contact** <br/> **Get-DistributionGroup** <br/> **Get-DynamicDistributionGroup** <br/> **Get-Group** <br/> **Get-LinkedUser** <br/> **Get-Mailbox** <br/> **Get-MailContact** <br/> **Get-MailPublicFolder** <br/> **Get-MailUser** <br/> **Get-Recipient** <br/> **Get-RemoteMailbox** <br/> **Get-SecurityPrincipal** <br/> **Get-UMMMailbox** <br/> **Get-User**|String|For example, `Get-Recipient -Filter {Guid -eq '8a68c198-be28-4a30-83e9-bffb760c65ba'}`. <br/> You can find the GUIDs of recipients by running this command: `Get-Recipient | Format-List Name,RecipientType,Guid`. <br/> Note that an object's GUID value is different than its Exchange GUID value.|
151151
|_HasActiveSyncDevicePartnership_|n/a|**Get-CASMailbox** <br/> **Get-Recipient**|Boolean (`$true` or `$false`)|For example, `Get-Recipient -Filter {HasActiveSyncDevicePartnership -eq $true}`.|
152-
|_HiddenFromAddressListsEnabled_|_msExchHideFromAddressLists_|**Get-DistributionGroup** <br/> **Get-DynamicDistributionGroup** <br/> **Get-Mailbox** <br/> **Get-MailContact** <br/> **Get-MailPublicFolder** <br/> **Get-MailUser** <br/> **Get-Recipient** <br/> **Get-RemoteMailbox**|Boolean (`$true` or `$false`)|For example, `Get-Recipient -Filter {HiddenFromAddressListsEnabled -eq $true}`.|
152+
|_HiddenFromAddressListsEnabled_|_msExchHideFromAddressLists_|**Get-DistributionGroup** <br/> **Get-DynamicDistributionGroup** <br/> **Get-Mailbox** <br/> **Get-MailContact** <br/> **Get-MailPublicFolder** <br/> **Get-MailUser** <br/> **Get-Recipient** <br/> **Get-RemoteMailbox** <br/> **Get-UnifiedGroup**|Boolean (`$true` or `$false`)|For example, `Get-Recipient -Filter {HiddenFromAddressListsEnabled -eq $true}`.|
153153
|_HiddenGroupMembershipEnabled_|_hideDLMembership_|**Get-UnifiedGroup**|Boolean (`$true` or `$false`)|For example, `Get-UnifiedGroup -Filter {HiddenGroupMembershipEnabled -eq $true}`.|
154154
|_HomePhone_|_homePhone_|**Get-Contact** <br/> **Get-LinkedUser** <br/> **Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter {HomePhone -like '206*'}`.|
155155
|_Id_|_distinguishedName_|**Get-CASMailbox** <br/> **Get-Contact** <br/> **Get-DistributionGroup** <br/> **Get-DynamicDistributionGroup** <br/> **Get-Group** <br/> **Get-LinkedUser** <br/> **Get-Mailbox** <br/> **Get-MailContact** <br/> **Get-MailPublicFolder** <br/> **Get-MailUser** <br/> **Get-Recipient** <br/> **Get-RemoteMailbox** <br/> **Get-UMMMailbox** <br/> **Get-User** <br/> **Get-SecurityPrincipal**|String|This filter requires the distinguished name or canonical distinguished name of the recipient. For example, `Get-Mailbox -Filter {Id -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'}` or `Get-Mailbox -Filter {Id -eq 'contoso.com/Users/Angela Gruber'}`. <br/> To find the distinguished name of a recipient, replace _\<RecipientIdentity\>_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "<RecipientIdentity>" | Format-List Name,DistinguishedName`.|
@@ -175,8 +175,8 @@ The properties that have been _confirmed_ to work with the _Filter_ parameter in
175175
|_IssueWarningQuota_|_mDBStorageQuota_|**Get-Mailbox** <br/> **Get-MailUser** <br/> **Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter {IssueWarningQuota -eq 'Unlimited'}` or `Get-Mailbox -Filter {IssueWarningQuota -ne 'Unlimited'}`. <br/> You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where {$_.IssueWarningQuota -<Operator> '<Size>'`}. For example, `Get-Mailbox | where {$_.IssueWarningQuota -lt '50GB'}`.|
176176
|_JournalArchiveAddress_|n/a|**Get-Mailbox** <br/> **Get-MailUser** <br/> **Get-RemoteMailbox**|String|This property uses an SMTP email address. For example, `Get-Mailbox -Filter {JournalArchiveAddress -eq '[email protected]'}`.|
177177
|_LanguagesRaw_|_msExchUserCulture_|**Get-Mailbox**|String (wildcards accepted) or `$null`|This property is named **Languages** in the properties of a mailbox, and it contains the language preference for the mailbox in the format `<ISO 639 two-letter culture code>-<ISO 3166 two-letter subculture code>`. For example, United States English is `en-US`. For more information, see [CultureInfo Class](https://go.microsoft.com/fwlink/p/?LinkID=255174). <br/> You can specify multiple values separated by commas, but the order matters. For example, `Get-Mailbox -Filter {LanguagesRaw -eq 'en-US,es-MX'}` returns different results than `Get-Mailbox -Filter {LanguagesRaw -eq 'es-MX,en-US'}`. <br/> For single values, this multivalued property will return a match if the property _contains_ the specified value.|
178-
|_LastExchangeChangedTime_|_msExchLastExchangeChangedTime_|**Get-DistributionGroup** <br/> **Get-DynamicDistributionGroup** <br/> **Get-Mailbox** <br/> **Get-MailContact** <br/> **Get-MailPublicFolder** <br/> **Get-MailUser** <br/> **Get-RemoteMailbox**|A date/time value or `$null`|For example, `Get-Mailbox -Filter {LastExchangeChangedTime -ne $null}`.|
179-
|_LegacyExchangeDN_|_legacyExchangeDN_|**Get-CASMailbox** <br/> **Get-DistributionGroup** <br/> **Get-DynamicDistributionGroup** <br/> **Get-LinkedUser** <br/> **Get-Mailbox** <br/> **Get-MailContact** <br/> **Get-MailPublicFolder** <br/> **Get-MailUser** <br/> **Get-RemoteMailbox** <br/> **Get-UMMailbox** <br/> **Get-User**|String (wildcards accepted)|For example, `Get-User -Filter {LegacyExchangeDN -like '*-Osca'}`. <br/> You can find LegacyExchangeDN values for users by running this command: `Get-User | Format-List Name,LegacyExchangeDN`|
178+
|_LastExchangeChangedTime_|_msExchLastExchangeChangedTime_|**Get-DistributionGroup** <br/> **Get-DynamicDistributionGroup** <br/> **Get-Mailbox** <br/> **Get-MailContact** <br/> **Get-MailPublicFolder** <br/> **Get-MailUser** <br/> **Get-RemoteMailbox** <br/> **Get-UnifiedGroup**|A date/time value or `$null`|For example, `Get-Mailbox -Filter {LastExchangeChangedTime -ne $null}`.|
179+
|_LegacyExchangeDN_|_legacyExchangeDN_|**Get-CASMailbox** <br/> **Get-DistributionGroup** <br/> **Get-DynamicDistributionGroup** <br/> **Get-LinkedUser** <br/> **Get-Mailbox** <br/> **Get-MailContact** <br/> **Get-MailPublicFolder** <br/> **Get-MailUser** <br/> **Get-RemoteMailbox** <br/> **Get-UMMailbox** <br/> **Get-User** <br/> **Get-UnifiedGroup**|String (wildcards accepted)|For example, `Get-User -Filter {LegacyExchangeDN -like '*-Osca'}`. <br/> You can find LegacyExchangeDN values for users by running this command: `Get-User | Format-List Name,LegacyExchangeDN`|
180180
|_LitigationHoldDate_|_msExchLitigationHoldDate_|**Get-Mailbox** <br/> **Get-MailUser** <br/> **Get-RemoteMailbox**|A date/time value or `$null`|For example, `Get-Mailbox -Filter {LitigationHoldDate -gt '8/13/2017'}`.|
181181
|_LitigationHoldEnabled_|n/a|**Get-Mailbox** <br/> **Get-MailUser** <br/> **Get-Recipient** <br/> **Get-RemoteMailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter {LitigationHoldEnabled -eq $true}`.|
182182
|_LitigationHoldOwner_|_msExchLitigationHoldOwner_|**Get-Mailbox** <br/> **Get-MailUser** <br/> **Get-RemoteMailbox**|String (wildcards accepted) or `$null`|This property uses the user principal name of the litigation hold owner. For example, `Get-Mailbox -Filter {LitigationHoldOwner -eq '[email protected]'}`.|

0 commit comments

Comments
 (0)