Training
Module
Manage Active Directory Domain Services using PowerShell cmdlets - Training
This module covers the cmdlets that are used to administer Active Directory Domain Services.
This browser is no longer supported.
Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.
You use the Filter parameter to create OPATH filters based on the properties of user and group objects in the Exchange Management Shell (Exchange Server PowerShell) and in Exchange Online PowerShell. The Filter parameter is available on these recipient cmdlets:
For more information about recipient filters in Exchange PowerShell, see Recipient filters in Exchange PowerShell commands.
Note
The Filter parameter is also available on other cmdlets (for example, Get-MailboxStatistics, Get-Queue, and Get-Message). However, the property values that are accepted by the Filter parameter on these cmdlets aren't similar to the user and group properties that are described in this article.
The properties that have been confirmed to work with the Filter parameter in user and group cmdlets are described in this article.
Notes:
The list might include:
None
) only in one type of environment.Not all recipient properties have a corresponding Active Directory property. The LDAP display name value is "n/a" for these properties, which indicates that the property is calculated (likely by Exchange).
Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, $true
, $false
, or $null
), use single quotation marks ' ' instead. Although the Filter parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. For more information, see Additional OPATH syntax information.
Text string properties that accept wildcard characters require the -like
operator (for example, "Property -like 'abc*'"
).
To look for blank or non-blank property values, use the value $null
(for example, 'Property -eq $null'
or 'Property -ne $null'
).
For filtering considerations for the nine exclusive Get-EXO* cmdlets in the Exchange Online PowerShell module, see Filters in the Exchange Online PowerShell module.
LDAP display name | Available on cmdlets | Value |
---|---|---|
authOrig | Get-DistributionGroup Get-DynamicDistributionGroup Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-RemoteMailbox Get-UnifiedGroup |
String or $null |
This filter requires the distinguished name of the individual recipient (a mailbox, mail user, or mail contact). For example, Get-DistributionGroup -Filter "AcceptMessagesOnlyFrom -eq 'CN=Yuudai Uchida,CN=Users,DC=contoso,DC=com'"
or Get-DistributionGroup -Filter "AcceptMessagesOnlyFrom -eq 'contoso.com/Users/Angela Gruber'"
.
To find the distinguished name of the individual 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
.
Although this property is multi-valued, the filter returns a match if the property contains the specified value.
LDAP display name | Available on cmdlets | Value |
---|---|---|
dLMemSubmitPerms | Get-DistributionGroup Get-DynamicDistributionGroup Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-RemoteMailbox Get-UnifiedGroup |
String or $null |
This filter requires the distinguished name or canonical distinguished name of the group (a distribution group, mail-enabled security group, or dynamic distribution group). For example, Get-Mailbox -Filter "AcceptMessagesOnlyFromDLMembers -eq 'CN=Marketing Department,CN=Users,DC=contoso,DC=com'"
. or Get-Mailbox -Filter "AcceptMessagesOnlyFromDLMembers -eq 'contoso.com/Users/Marketing Department'"
.
To find the distinguished name of the group, replace <GroupIdentity> with the name, alias, or email address of the group, and run one of these commands: Get-DistributionGroup -Identity "<GroupIdentity>" | Format-List Name,DistinguishedName
or Get-DynamicDistributionGroup -Identity "<GroupIdentity>" | Format-List Name,DistinguishedName
.
Although this property is multi-valued, the filter returns a match if the property contains the specified value.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchMobileAllowedDeviceIds | Get-CASMailbox | String (wildcards accepted) or $null |
A device ID is a text string that uniquely identifies the device. Use the Get-MobileDevice cmdlet to see the devices that have ActiveSync partnerships with a mailbox. To see the device IDs on a mailbox, replace <MailboxIdentity> with the name, alias, or email address of the mailbox, and run this command: Get-MobileDevice -Mailbox <MailboxIdentity> | Format-List
.
After you have the device ID value, you can use it in the filter. For example, Get-CasMailbox -Filter "(ActiveSyncAllowedDeviceIDs -like 'text1*') -or (ActiveSyncAllowedDeviceIDs -eq 'text2'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchMobileBlockedDeviceIds | Get-CASMailbox | String (wildcards accepted) or $null |
A device ID is a text string that uniquely identifies the device. Use the Get-MobileDevice cmdlet to see the devices that have ActiveSync partnerships with a mailbox. To see the device IDs on a mailbox, replace <MailboxIdentity> with the name, alias, or email address of the mailbox, and run this command: Get-MobileDevice -Mailbox <MailboxIdentity> | Format-List
.
After you have the device ID value, you can use it in a filter. For example, Get-CasMailbox -Filter "(ActiveSyncBlockedDeviceIDs -like 'text1*') -or (ActiveSyncBlockedDeviceIDs -eq 'text2'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-CASMailbox | Boolean ($true or $false ) |
For example, Get-CasMailbox -Filter 'ActiveSyncEnable -eq $false'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchMobileMailboxPolicyLink | Get-CASMailbox Get-Recipient |
String or $null |
This filter requires the distinguished name of the ActiveSync mailbox policy. For example, Get-CASMailbox -Filter "ActiveSyncMailboxPolicy -eq 'CN=Default,CN=Mobile Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"
.
You can find the distinguished names of ActiveSync mailbox policies by running this command: Get-MobileDeviceMailboxPolicy | Format-List Name,DistinguishedName
.
Note
For the default assignment of the default ActiveSync mailbox policy (named Default) to a mailbox, the value of the ActiveSyncMailboxPolicy property is blank ($null
).
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-CASMailbox | Boolean ($true or $false ) |
For example, Get-CasMailbox -Filter 'ActiveSyncSuppressReadReceipt -eq $true'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchAddressBookPolicyLink | Get-Mailbox Get-Recipient |
String or $null |
This filter requires the distinguished name of the address book policy. For example, Get-Mailbox -Filter "AddressBookPolicy -eq 'CN=Contoso ABP,CN=AddressBook Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"
.
You can find the distinguished names of address book policies by running this command: Get-AddressBookPolicy | Format-List Name,DistinguishedName
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
showInAddressBook | Get-DistributionGroup Get-DynamicDistributionGroup Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-Recipient Get-RemoteMailbox Get-UnifiedGroup |
String or $null |
This filter requires the distinguished name of the address list. For example, Get-MailContact -Filter "AddressListMembership -eq 'CN=All Contacts,CN=All Address Lists,CN=Address Lists Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"
.
You can find the distinguished names of address lists by running this command: Get-AddressList | Format-List Name,DistinguishedName
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
adminDisplayName | Get-SecurityPrincipal | String (wildcards accepted) or $null |
For example, Get-SecurityPrincipal -Filter 'AdminDisplayName -ne $null' | Format-Table -Auto Name,AdminDisplayName
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchAdministrativeUnitLink | Get-Contact Get-DistributionGroup Get-DynamicDistributionGroup Get-Group Get-LinkedUser Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-RemoteMailbox Get-User Get-UnifiedGroup |
$null |
For example, Get-User -Filter 'AdministrativeUnits -ne $null'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchAlternateMailboxes | Get-Mailbox Get-MailUser Get-RemoteMailbox |
String or $null |
For example, Get-Mailbox -Filter 'AggregatedMailboxGuids -ne $null'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
mailNickname | Get-DistributionGroup Get-DynamicDistributionGroup Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-Recipient Get-RemoteMailbox Get-UnifiedGroup |
String (wildcards accepted) |
For example, Get-Recipient -Filter "Alias -like 'smith*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchUMListInDirectorySearch | Get-Contact Get-LinkedUser Get-UMMailbox Get-User |
None (0) or SearchEnabled (1) |
For example, Get-User -Filter "AllowUMCallsFromNonUsers -ne 'SearchEnabled'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchArbitrationMailbox | Get-DistributionGroup Get-DynamicDistributionGroup Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-RemoteMailbox |
String or $null |
This filter requires the distinguished name of the arbitration mailbox. For example, Get-DistributionGroup -Filter "ArbitrationMailbox -eq 'CN=SystemMailbox"1f05a927-2e8f-4cbb-9039-2cfb8b95e486",CN=Users,DC=contoso,DC=com'"
.
You can find the distinguished names of arbitration mailboxes by running this command: Get-Mailbox -Arbitration | Format-List Name,DistinguishedName
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchArchiveDatabaseLink | Get-Mailbox Get-MailUser Get-Recipient Get-RemoteMailbox |
String or $null |
This filter requires the distinguished name of the archive mailbox database. For example, Get-Mailbox -Filter "ArchiveMailbox -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"
.
You can find the distinguished names of mailbox databases by running this command: Get-MailboxDatabase | Format-List Name,DistinguishedName
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchArchiveAddress | Get-Mailbox | String (wildcards accepted) or $null |
This property is used in on-premises Exchange environments to identify the Exchange Online organization that holds the archive mailbox. For example, Get-Mailbox -Filter "ArchiveDomain -like 'contoso.onmicrosoft.com*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchArchiveGUID | Get-Mailbox Get-MailUser Get-Recipient Get-RemoteMailbox |
String or $null |
This filter requires the GUID of the archive mailbox. For example, Get-Mailbox -Filter "ArchiveMailbox -eq '6476f55e-e5eb-4462-a095-f2cb585d648d'"
.
You can find the GUID of archive mailboxes by running this command: Get-Mailbox -Archive | Format-Table -Auto Name,ArchiveGUID
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchArchiveName | Get-Mailbox Get-MailUser Get-RemoteMailbox |
String (wildcards accepted) or $null |
This filter requires the name of the archive mailbox. For example, Get-Mailbox -Filter "ArchiveName -like 'In-Place Archive*'"
.
You can find the names of archive mailboxes by running this command: Get-Mailbox -Archive | Format-Table -Auto Name,ArchiveName
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchArchiveQuota | Get-Mailbox Get-MailUser 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 "ArchiveQuota -eq 'Unlimited'"
or Get-Mailbox -Filter "ArchiveQuota -ne 'Unlimited'"
.
You can't use the Filter parameter to look for size values of this property. Instead, use this syntax: Get-Mailbox | where "$_.ArchiveQuota -<Operator> '<Size>'"
. For example, Get-Mailbox | where "$_.ArchiveQuota -gt '85GB'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchArchiveRelease | Get-Mailbox Get-MailUser Get-Recipient Get-RemoteMailbox Get-User |
None , E14 , E15 , or $null . |
For example, Get-Recipient -Filter 'ArchiveRelease -ne $null'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-Mailbox Get-Recipient Get-RemoteMailbox |
None (0), Local (1), HostedProvisioned (2), HostedPending (3), or OnPremise (4). |
For example, Get-Recipient -Filter "ArchiveState -eq 'HostedProvisioned'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchArchiveStatus | Get-Mailbox Get-MailUser Get-Recipient Get-RemoteMailbox |
None (0) or Active (1). |
For example, Get-Recipient -Filter "ArchiveStatus -eq 'Active'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchArchiveWarnQuota | Get-Mailbox Get-MailUser 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 "ArchiveWarningQuota -eq 'Unlimited'"
or Get-Mailbox -Filter "ArchiveWarningQuota -ne 'Unlimited'"
.
You can't use the Filter parameter to look for size values of this property. Instead, use this syntax: Get-Mailbox | where "$_.ArchiveWarningQuota -<Operator> '<Size>'"
. For example, Get-Mailbox | where "$_.ArchiveWarningQuota -gt '85GB'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchAssistantName | Get-Contact Get-LinkedUser Get-User |
String (wildcards accepted) or $null |
For example, Get-User -Filter "AssistantName -like 'Julia*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchMailboxAuditEnable | Get-Mailbox | Boolean ($true or $false ) |
For example, Get-Mailbox -Filter 'AuditEnabled -eq $true'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchMailboxAuditLogAgeLimit | Get-Mailbox Get-UnifiedGroup |
A time span value: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. |
You can't use the Filter parameter to look for time span values for this property. Instead, use this syntax: Get-Mailbox | where "$_.AuditLogAgeLimit -<Operator> '<TimeSpan>'"
. For example, Get-Mailbox | where "$_.AuditLogAgeLimit -gt '60.00:00:00'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchAuthPolicyLink | Get-User | String (wildcards accepted) or $null |
For example, Get-User -Filter "AuthenticationPolicy -eq 'CN=Block Basic Auth,CN=Auth Policies,CN=Configuration,CN=contoso.onmicrosoft.com,CN=ConfigurationUnits,DC=NAMPR11B009,DC=PROD,DC=OUTLOOK,DC=COM'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchBlockedSendersHash | Get-Recipient | Blank ( $null ) or a hashed value. |
Realistically, you can only use this value to filter on blank or non-blank values. For example, Get-Recipient -Filter 'BlockedSendersHash -ne $null'.
LDAP display name | Available on cmdlets | Value |
---|---|---|
c | Get-Contact Get-LinkedUser Get-Recipient Get-SecurityPrincipal Get-User |
String (wildcards accepted) or $null |
This filter requires the ISO 3166-1 two-letter country code for the user (for example, US
for the United States). This property is used together with the co and countryCode properties to define the user's country in Active Directory.
For example, Get-User -Filter "c -eq 'US'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchCalendarLoggingQuota | Get-Mailbox | 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 "CalendarLoggingQuota -eq 'Unlimited'"
or Get-Mailbox -Filter "CalendarLoggingQuota -ne 'Unlimited'"
.
You can't use the Filter parameter to look for size values of this property. Instead, use this syntax: Get-Mailbox | where "$_.CalendarLoggingQuota -<Operator> '<Size>'"
. For example, Get-Mailbox | where "$_.CalendarLoggingQuota -gt '10GB'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchCalendarRepairDisabled | Get-Mailbox | Boolean ($true or $false ) |
For example, Get-Mailbox -Filter 'CalendarRepairDisabled -eq $true'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-LinkedUser Get-User |
String or $null |
The X509 certificate that's published for the user account (visible on the Published Certificates tab in Active Directory Users and Computers).
For example, Get-User -Filter "CertificateSubject -eq 'X509:<I>C=US,O=InternetCA,CN=APublicCertificateAuthority<S>C=US,O=Fabrikam,OU=Sales,CN=Jeff Smith
')
LDAP display name | Available on cmdlets | Value |
---|---|---|
l | Get-Contact Get-LinkedUser Get-Recipient Get-User |
String (wildcards accepted) or $null |
For example, Get-User -Filter "City -eq 'Redmond'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
company | Get-Contact Get-LinkedUser Get-Recipient Get-User |
String (wildcards accepted) or $null |
For example, Get-User -Filter "Company -like 'Contoso*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-Mailbox Get-MailUser |
Boolean ($true or $false ) |
For example, Get-Mailbox -Filter 'ComplianceTagHoldApplied -eq $true'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-LinkedUser Get-User |
String or $null |
For example, Get-User -Filter 'ConsumerNetID -ne $null'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
countryCode | Get-Contact Get-LinkedUser Get-Recipient Get-SecurityPrincipal Get-User |
Integer |
This filter requires the ISO 3166-1 three-digit country code for the user (for example, 840
for the United States). This property is used together with the c and co properties to define the user's country in Active Directory.
For example, Get-User -Filter "countryCode -eq 796"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
co | Get-Contact Get-LinkedUser Get-Recipient Get-SecurityPrincipal Get-User |
String |
This filter requires the ISO 3166-1 country name for the user (for example, United States
). You can select an available value in Active Directory Users and Computers ( Address tab > Country/region field), or the Exchange admin center (user properties > Contact information tab > Country/Region field).
When you select a user's country in Active Directory Users and Computers or the EAC, the corresponding values for the co and countryCode properties are automatically configured.
For example, Get-User -Filter "CountryOrRegion -like 'United*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
extensionAttribute1 to extensionAttribute15 | Get-DistributionGroup Get-DynamicDistributionGroup Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-Recipient Get-RemoteMailbox Get-UnifiedGroup |
String (wildcards accepted) or $null |
For example, Get-Recipient -Filter "CustomAttribute8 -like 'audited*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
homeMDB | Get-Mailbox Get-Recipient |
String |
This filter requires the distinguished name of the mailbox database. For example, Get-Mailbox -Filter "Database -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"
.
You can find the distinguished names of mailbox databases by running this command: Get-MailboxDatabase | Format-List Name,DistinguishedName
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchPublicFolderMailbox | Get-Mailbox | String or $null |
This filter requires the distinguished name or canonical distinguished name of the public folder mailbox. For example, Get-Mailbox -Filter "DefaultPublicFolderMailbox -eq 'CN=PF Mailbox01,CN=Users,DC=contoso,DC=com'"
or Get-Mailbox -Filter "DefaultPublicFolderMailbox -eq 'contoso.com/Users/PF Mailbox01'"
.
To find the distinguished names of public folder mailboxes, run this command: Get-Mailbox -PublicFolder | Format-List Name,DistinguishedName
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
deletedItemFlags | Get-Mailbox Get-SecurityPrincipal |
DatabaseDefault (0), RetainUntilBackupOrCustomPeriod (3), or RetainForCustomPeriod (5). |
For example, Get-Mailbox -Filter "DeletedItemFlags -ne 'DatabaseDefault'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
deliverAndRedirect | Get-Mailbox Get-MailPublicFolder Get-MailUser Get-MailPublicFolder |
Boolean ($true or $false ) |
For example, Get-Mailbox -Filter 'DeliverToMailboxAndForward -eq $true'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
department | Get-Contact Get-LinkedUser Get-Recipient Get-User |
String (wildcards accepted) or $null |
For example, Get-Recipient -Filter "Department -like 'Engineering*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
directReports | Get-Contact Get-LinkedUser Get-User |
String or $null |
This filter requires the distinguished name or canonical distinguished name of the direct report. For example, Get-User -Filter "DirectReports -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"
or Get-User -Filter "DirectReports -eq 'contoso.com/Users/Angela Gruber'"
.
To find the distinguished name of a direct report, replace <RecipientIdentity> with the name, alias, or email address of the recipient, and run this command: Get-Recipient -Identity "<RecipientIdentity>" | Format-List Name,DistinguishedName
.
Although this property is multi-valued, the filter returns a match if the property contains the specified value.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchDisabledArchiveDatabaseLink | Get-Mailbox Get-MailUser Get-RemoteMailbox |
String or $null |
This filter requires the distinguished name of the disabled archive mailbox database. For example, Get-Mailbox -Filter "DisabledArchiveDatabase -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"
.
You can find the distinguished names of mailbox databases by running this command: Get-MailboxDatabase | Format-List Name,DistinguishedName
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchDisabledArchiveDatabaseGUID | Get-Mailbox Get-MailUser Get-RemoteMailbox |
String or $null |
This filter requires the GUID of the disabled archive mailbox. For example, Get-Mailbox -Filter "DisabledArchiveGuid -eq '6476f55e-e5eb-4462-a095-f2cb585d648d'"
.
You can find the GUID of archive mailboxes by running this command: Get-Mailbox -Archive | Format-Table -Auto Name,ArchiveGUID
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
displayName | Get-CASMailbox Get-Contact Get-DistributionGroup Get-DynamicDistributionGroup Get-Group Get-LinkedUser Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-Recipient Get-RemoteMailbox Get-SecurityPrincipal Get-UMMailbox Get-User Get-UnifiedGroup |
String (wildcards accepted) |
For example, Get-Recipient -Filter "DisplayName -like 'Julia*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
distinguishedName | Get-CASMailbox Get-Contact Get-DistributionGroup Get-DynamicDistributionGroup Get-Group Get-LinkedUser Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-Recipient Get-RemoteMailbox Get-SecurityPrincipal Get-UMMMailbox Get-User Get-UnifiedGroup |
String |
This filter requires the distinguished name of the recipient. For example, Get-Mailbox -Filter "DistinguishedName -eq 'CN=Basho Kato,CN=Users,DC=contoso,DC=com'"
.
You can find the distinguished names of recipients by running this command: Get-Recipient | Format-List Name,RecipientType,DistinguishedName
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-CASMailbox | Boolean ($true or $false ) |
For example, Get-CASMailbox -Filter 'EcpEnabled -eq $false'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
proxyAddresses | Get-CASMailbox Get-DistributionGroup Get-DynamicDistributionGroup Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-Recipient Get-RemoteMailbox Get-UMMailbox Get-UnifiedGroup |
String (wildcards accepted) |
For example, Get-Recipient -Filter "EmailAddresses -like 'marketing*'"
.
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 "EmailAddresses -eq 'lila@fabrikam.com'"
returns a match, "EmailAddresses -like 'lila*'"
won't return a match, but or "EmailAddresses -like 'smtp:lila*'"
will return a match.
Although this property is multi-valued, the filter returns a match if the property contains the specified value.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-DistributionGroup Get-DynamicDistributionGroup Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-Recipient Get-RemoteMailbox Get-UnifiedGroup |
Boolean ($true or $false ) |
For example, Get-Recipient -Filter 'EmailAddressPolicyEnabled -eq $false'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchPublicFolderEntryId | Get-MailPublicFolder | String (wildcards accepted) |
For example, Get-MailPublicFolder -Filter "EntryId -like '60000*'"
.
You can find the entry IDs of mail-enabled public folders by running this command: Get-MailPublicFolder | Format-List Name,EntryId
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchEwsApplicationAccessPolicy | Get-CASMailbox | EnforceAllowList , EnforceBlockList . or $null |
For example, Get-CASMailbox -Filter 'EwsApplicationAccessPolicy -ne $null'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchEwsEnabled | Get-CASMailbox | 0 (disabled), 1 (enabled) or $null . |
For example, Get-CASMailbox -Filter "EwsEnabled -eq 1"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchMailboxGuid | Get-Mailbox Get-MailUser Get-Recipient Get-RemoteMailbox Get-UnifiedGroup |
String |
For example, Get-Mailbox -Filter "ExchangeGuid -eq 'c80a753d-bd4a-4e19-804a-6344d833ecd8'"
.
To find the Exchange GUID 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,ExchangeGuid
.
Note that an object's Exchange GUID value is different than its GUID value. Also, the Exchange GUID value for non-mailboxes (mail contacts, mail users, distribution groups, dynamic distribution groups, mail-enabled security groups, and mail-enabled public folders) is 00000000-0000-0000-0000-000000000000
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchUserAccountControl | Get-Mailbox Get-MailUser Get-RemoteMailbox |
None (0) or AccountDisabled (2) |
For example, Get-Mailbox -Filter "ExchangeUserAccountControl -eq 'AccountDisabled'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchVersion | Get-CASMailbox Get-Contact Get-DistributionGroup Get-DynamicDistributionGroup Get-Group Get-LinkedUser Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-Recipient Get-RemoteMailbox Get-SecurityPrincipal Get-UMMMailbox 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
.
For the Exchange 2010 value 0.10 (14.0.100.0)
, use the value 44220983382016 in the filter.
For the Exchange 2013 or Exchange 2016 value 0.20 (15.0.0.0)
, use the value 88218628259840 in the filter.
For example, Get-Recipient -Filter "ExchangeVersion -lt 88218628259840"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchExpansionServerName | Get-DistributionGroup Get-DynamicDistributionGroup Get-Recipient |
String (wildcards accepted) or $null |
For example, Get-Recipient -Filter "ExpansionServer -like 'Mailbox01*'"
.
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'"
You can find the ExchangeLegacyDN value by running this command: Get-ExchangeServer | Format-List Name,ExchangeLegacyDN
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchExtensionCustomAttribute1 to msExchExtensionCustomAttribute5 | Get-DistributionGroup Get-DynamicDistributionGroup Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-Recipient Get-RemoteMailbox Get-UnifiedGroup |
String (wildcards accepted) or $null |
For example, Get-Recipient -Filter "ExtensionCustomAttribute8 -like 'audited*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchExternalDirectoryObjectId | Get-DistributionGroup Get-DynamicDistributionGroup Get-LinkedUser Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-Recipient Get-RemoteMailbox Get-User Get-UnifiedGroup |
String or $null |
For example, Get-Recipient -Filter 'ExternalDirectoryObjectId -ne $null'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
targetAddress | Get-MailContact Get-MailPublicFolder Get-MailUser Get-Recipient |
String (wildcards accepted) or $null |
For example, Get-Recipient -Filter "ExternalEmailAddress -like '@fabrikam.com*'"
.
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 'lila@fabrikam.com'"
returns a match, "ExternalEmailAddress -like 'lila*'"
won't return a match, but "ExternalEmailAddress -like 'smtp:lila*'"
will return a match.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchExternalOOFOptions | Get-Mailbox | External (0) or InternalOnly (1) |
For example, Get-Mailbox -Filter "ExternalOofOptions -eq 'External'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
facsimileTelephoneNumber | Get-Contact Get-LinkedUser Get-User |
String (wildcards accepted) or $null |
For example, Get-User -Filter "Fax -like '206*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
givenName | Get-Contact Get-LinkedUser Get-Recipient Get-User |
String (wildcards accepted) or $null |
For example, Get-User -Filter "FirstName -like 'Chris*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
altRecipient | Get-Mailbox Get-MailPublicFolder Get-MailUser 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'"
.
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
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchGenericForwardingAddress | Get-Mailbox | String (wildcards accepted) or $null |
For example, Get-Mailbox -Filter "ForwardingSmtpAddress -like '@fabrikam.com*'"
.
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 'lila@fabrikam.com'"
returns a match, "ForwardingSmtpAddress -like 'lila*'"
won't return a match, but "ForwardingSmtpAddress -like 'smtp:lila*'"
will return a match.
LDAP display name | Available on cmdlets | Value |
---|---|---|
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'"
.
You can find the distinguished names of offline address books by running this command: Get-OfflineAddressBook | Format-List Name,DistinguishedName
.
Although this property is multi-valued, the filter returns a match if the property contains the specified value.
LDAP display name | Available on cmdlets | Value |
---|---|---|
publicDelegates | Get-DistributionGroup Get-DynamicDistributionGroup Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-RemoteMailbox 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'"
.
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
.
Although this property is multi-valued, the filter returns a match if the property contains the specified value.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-UnifiedGroup | Integer |
For example, Get-UnifiedGroup -Filter "GroupMemberCount -gt 100"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-UnifiedGroup | Integer |
For example, Get-UnifiedGroup -Filter "GroupExternalMemberCount -gt 0"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
groupType | Get-DistributionGroup Get-Group 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'"
.
This multivalued property will only return a match if the property equals the specified value.
LDAP display name | Available on cmdlets | Value |
---|---|---|
objectGuid | Get-CASMailbox Get-Contact Get-DistributionGroup Get-DynamicDistributionGroup Get-Group Get-LinkedUser Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-Recipient Get-RemoteMailbox Get-SecurityPrincipal Get-UMMMailbox Get-User Get-UnifiedGroup |
String |
For example, Get-Recipient -Filter "Guid -eq '8a68c198-be28-4a30-83e9-bffb760c65ba'"
.
You can find the GUIDs of recipients by running this command: Get-Recipient | Format-List Name,RecipientType,Guid
.
Note that an object's GUID value is different than its Exchange GUID value.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-CASMailbox Get-Recipient |
Boolean ($true or $false ) |
For example, Get-Recipient -Filter 'HasActiveSyncDevicePartnership -eq $true'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchHideFromAddressLists | Get-DistributionGroup Get-DynamicDistributionGroup Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-Recipient Get-RemoteMailbox Get-UnifiedGroup |
Boolean ($true or $false ) |
For example, Get-Recipient -Filter 'HiddenFromAddressListsEnabled -eq $true'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
hideDLMembership | Get-UnifiedGroup | Boolean ($true or $false ) |
For example, Get-UnifiedGroup -Filter 'HiddenGroupMembershipEnabled -eq $true'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
homePhone | Get-Contact Get-LinkedUser Get-User |
String (wildcards accepted) or $null |
For example, Get-User -Filter "HomePhone -like '206*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
distinguishedName | Get-CASMailbox Get-Contact Get-DistributionGroup Get-DynamicDistributionGroup Get-Group Get-LinkedUser Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-Recipient Get-RemoteMailbox Get-UMMMailbox Get-User Get-SecurityPrincipal Get-UnifiedGroup |
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'"
.
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
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-MailPublicFolder | Boolean ($true or $false ) |
For example, Get-MailPublicFolder -Filter 'IgnoreMissingFolderLink -eq $true'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-CASMailbox | Boolean ($true or $false ) |
For example, Get-CASMailbox -Filter 'ImapEnabled -eq $false'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchGenericImmutableId | Get-Mailbox Get-MailUser Get-RemoteMailbox |
String or $null |
For example, Get-Mailbox -Filter 'ImmutableId -ne $null'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-Mailbox | Boolean ($true or $false ) |
For example, Get-Mailbox -Filter 'IncludeInGarbageCollection -eq $true'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
initials | Get-Contact Get-LinkedUser Get-User |
String (wildcards accepted) or $null |
For example, Get-User -Filter "Initials -like 'B.'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchUserHoldPolicies | Get-Mailbox Get-MailUser Get-RemoteMailbox |
String |
This filter requires the InPlaceHoldIdentity value of the mailbox search. For example, Get-Mailbox -Filter "InPlaceHolds -eq '9d0f81154cc64c6b923ecc0be5ced0d7'"
.
To find the InPlaceHoldIdentity values of mailbox searches, run this command: Get-MailboxSearch | Format-Table Name,InPlaceHoldIdentity
.
Although this property is multi-valued, the filter returns a match if the property contains the specified value.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-LinkedUser Get-User |
String |
This filter requires the InPlaceHoldIdentity value of the mailbox search. For example, Get-Mailbox -Filter "InPlaceHoldsRaw -eq '9d0f81154cc64c6b923ecc0be5ced0d7'"
.
To find the InPlaceHoldIdentity values of mailbox searches, run this command: Get-MailboxSearch | Format-Table Name,InPlaceHoldIdentity
.
Although this property is multi-valued, the filter returns a match if the property contains the specified value.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchIsMSODirsynced | Get-Contact Get-DistributionGroup Get-Group Get-LinkedUser Get-Mailbox Get-MailContact Get-MailUser Get-Recipient Get-RemoteMailbox Get-User Get-UnifiedGroup |
Boolean ($true or $false ) |
For example, Get-User -Filter 'IsDirSynced -eq $true'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-Mailbox | Boolean ($true or $false ) |
For example, Get-Mailbox -Filter 'IsExcludedFromServingHierarchy -eq $true'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-Mailbox | Boolean ($true or $false ) |
For example, Get-Mailbox -Filter 'IsHierarchyReady -eq $false'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-Mailbox | Boolean ($true or $false ) |
For example, Get-Mailbox -Filter 'IsHierarchySyncEnabled -eq $false'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-Mailbox | Boolean ($true or $false ) |
For example, Get-Mailbox -Filter 'IsInactiveMailbox -eq $false'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-LinkedUser Get-Mailbox Get-User |
Boolean ($true or $false ) |
For example, Get-Mailbox -Filter 'IsLinked -eq $true'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-Mailbox | Boolean ($true or $false ) |
For example, Get-Mailbox -Filter 'IsMailboxEnabled -eq $false'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-Mailbox | Boolean ($true or $false ) |
For example, Get-Mailbox -Filter 'IsResource -eq $true'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-LinkedUser Get-User |
Boolean ($true or $false ) |
For example, Get-User -Filter 'IsSecurityPrincipal -eq $false'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-Mailbox | Boolean ($true or $false ) |
For example, Get-Mailbox -Filter 'IsShared -eq $true'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-LinkedUser Get-Mailbox Get-MailUser Get-RemoteMailbox Get-User |
Boolean ($true or $false ) |
For example, Get-Mailbox -Filter 'IsSoftDeletedByDisable -eq $true'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-LinkedUser Get-Mailbox Get-MailUser Get-RemoteMailbox Get-User |
Boolean ($true or $false ) |
For example, Get-Mailbox -Filter 'IsSoftDeletedByRemove -eq $true'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
mDBStorageQuota | Get-Mailbox Get-MailUser 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'"
.
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'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-Mailbox Get-MailUser Get-RemoteMailbox |
String |
This property uses an SMTP email address. For example, Get-Mailbox -Filter "JournalArchiveAddress -eq 'michelle@contoso.com'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
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.
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'"
.
For single values, this multivalued property will return a match if the property contains the specified value.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchLastExchangeChangedTime | Get-DistributionGroup Get-DynamicDistributionGroup Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-RemoteMailbox Get-UnifiedGroup |
$null or a date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC) |
For example, Get-Mailbox -Filter 'LastExchangeChangedTime -ne $null'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
legacyExchangeDN | Get-CASMailbox Get-DistributionGroup Get-DynamicDistributionGroup Get-LinkedUser Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-RemoteMailbox Get-UMMailbox Get-User Get-UnifiedGroup |
String (wildcards accepted) |
For example, Get-User -Filter "LegacyExchangeDN -like 'Osca*'"
.
You can find LegacyExchangeDN values for users by running this command: Get-User | Format-List Name,LegacyExchangeDN
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchLitigationHoldDate | Get-Mailbox Get-MailUser Get-RemoteMailbox |
$null or a date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC) |
For example, Get-Mailbox -Filter "LitigationHoldDate -gt '8/13/2017'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-Mailbox Get-MailUser Get-Recipient Get-RemoteMailbox |
Boolean ($true or $false ) |
For example, Get-Mailbox -Filter 'LitigationHoldEnabled -eq $true'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchLitigationHoldOwner | Get-Mailbox Get-MailUser 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 'agruber@contoso.com'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
sn | Get-Contact Get-LinkedUser Get-Recipient Get-User |
String (wildcards accepted) or $null |
For example, Get-User -Filter "LastName -like 'Martin*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchMailboxContainerGuid | Get-Mailbox Get-MailUser Get-RemoteMailbox |
String or $null |
For example, Get-Mailbox -Filter 'MailboxContainerGUID -ne $null'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchMailboxMoveBatchName | Get-Mailbox Get-MailUser Get-Recipient Get-RemoteMailbox |
String (wildcards accepted) or $null |
This property includes the name of the migration batch. For example, Get-Mailbox -Filter "MailboxMoveBatchName -like 'LocalMove 01*'"
.
You can find the names of migration batches by running the Get-MigrationBatch command. Note that migration batches that you create in the Exchange admin center use the naming convention MigrationService:<MigrationBatchName>
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchMailboxMoveFlags | Get-Mailbox Get-MailUser Get-Recipient Get-RemoteMailbox |
For valid values, see the description of the Flags parameter in Get-MoveRequest. |
For example, Get-Mailbox -Filter "MailboxMoveFlags -ne 'None'"
.
You can specify multiple values separated by commas, and the order doesn't matter. For example, Get-Recipient -Filter "MailboxMoveFlags -eq 'IntraOrg,Pull'"
returns the same results as Get-Recipient -Filter "MailboxMoveFlags -eq 'Pull,IntraOrg'"
.
This multivalued property will only return a match if the property equals the specified value.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchMailboxMoveRemoteHostName | Get-Mailbox Get-MailUser Get-Recipient Get-RemoteMailbox |
String or $null |
For example, Get-Mailbox -Filter 'MailboxMoveRemoteHostName -ne $null'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchMailboxMoveSourceMDBLink | Get-Mailbox Get-MailUser Get-Recipient Get-RemoteMailbox |
String or $null |
This filter requires the distinguished name of the source mailbox database. For example, Get-Mailbox -Filter "MailboxMoveSourceMDB -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"
.
You can find the distinguished names of mailbox databases by running this command: Get-MailboxDatabase | Format-List Name,DistinguishedName
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchMailboxMoveStatus | Get-Mailbox Get-MailUser Get-Recipient Get-RemoteMailbox |
For valid values, see the description of the MoveStatus parameter in Get-MoveRequest. |
For example, Get-Mailbox -Filter "MailboxMoveStatus -eq 'Completed'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchMailboxMoveTargetMDBLink | Get-Mailbox Get-MailUser Get-Recipient Get-RemoteMailbox |
String or $null |
This filter requires the distinguished name of the target mailbox database. For example, Get-Mailbox -Filter "MailboxMoveTargetMDB -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"
.
You can find the distinguished names of mailbox databases by running this command: Get-MailboxDatabase | Format-List Name,DistinguishedName
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchParentPlanLink | Get-Mailbox | String or $null |
Mailbox plans correspond to Microsoft 365 license types. The availability of a license plans is determined by the selections that you make when you enroll your domain.
For example, Get-Mailbox -Filter 'MailboxPlan -ne $null'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchMailboxRelease | Get-Mailbox Get-MailUser Get-Recipient Get-RemoteMailbox Get-User |
None , E14 , E15 , or $null . |
For example, Get-Recipient -Filter 'MailboxRelease -ne $null'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchSenderHintTranslations | Get-DistributionGroup Get-DynamicDistributionGroup Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-RemoteMailbox Get-UnifiedGroup |
String (wildcards accepted) or $null |
When you use this property in a filter, you need to account for the leading and trailing HTML tags. For example, Get-DistributionGroup -Filter "MailTipTranslations -like 'is not monitored.*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
managedBy | Get-DistributionGroup Get-DynamicDistributionGroup Get-Group Get-Recipient Get-UnifiedGroup |
String or $null |
This filter requires the distinguished name or canonical distinguished name of the group owner (a mail-enabled security principal, which is a mailbox, mail user, or mail-enabled security group). For example, Get-Mailbox -Filter "ManagedBy -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"
or Get-Mailbox -Filter "ManagedBy -eq 'contoso.com/Users/Angela Gruber'"
.
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
.
Although this property is multi-valued, the filter returns a match if the property contains the specified value.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchMailboxTemplateLink | Get-Mailbox Get-Recipient |
String or $null |
Managed folder mailbox policies aren't available in Exchange 2013 or later.
For example, Get-Mailbox -Filter 'ManagedFolderMailboxPolicy -eq $null'
.
This filter requires the distinguished name of the managed folder mailbox policy. For example, Get-Mailbox -Filter "ManagedFolderMailboxPolicy -eq 'CN=MFM Inbox Policy,CN=ELC Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"
.
You can find the distinguished names of managed folder mailbox policies on Exchange 2010 servers by running this command: Get-ManagedFolderMailboxPolicy | Format-List Name,DistinguishedName
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
manager | Get-Contact Get-LinkedUser Get-Recipient Get-User |
String or $null |
This filter requires the distinguished name or canonical distinguished name of the manager (a mailbox or mail user). For example, Get-User -Filter "Manager -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"
or Get-Mailbox -Filter "Manager -eq 'contoso.com/Users/Angela Gruber'"
.
To find the distinguished name of a manager, replace <RecipientIdentity> with the name, alias, or email address of the recipient, and run this command: Get-Recipient -Identity "<RecipientIdentity>" | Format-List Name,DistinguishedName.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-CASMailbox | Boolean ($true or $false ) |
For example, Get-CASMailbox -Filter 'MAPIEnabled -eq $false'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchMasterAccountSid | Get-Mailbox Get-LinkedUser Get-Recipient Get-SecurityPrincipal Get-User |
String or $null |
For example, Get-Mailbox -Filter 'MasterAccountSid -ne $null'
.
This value is blank ( $null
) for mailboxes with associated user accounts, and S-1-5-10
(Self) for mailboxes without associated user accounts (for example, shared mailboxes, resource mailboxes, discovery search mailboxes, arbitration mailboxes, and public folder mailboxes).
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchMaxBlockedSenders | Get-Mailbox | Integer or $null |
For example, Get-Mailbox -Filter "MaxBlockedSenders -gt 0"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
delivContLength | Get-DistributionGroup Get-DynamicDistributionGroup Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-RemoteMailbox Get-UnifiedGroup |
A byte quantified size value (for example, 75MB ), 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 "MaxReceiveSize -eq 'Unlimited'"
or Get-Mailbox -Filter "MaxReceiveSize -ne 'Unlimited'"
.
You can't use the Filter parameter to look for size values of this property. Instead, use this syntax: Get-Mailbox | where "$_.MaxReceiveSize -<Operator> '<Size>'"
. For example, Get-Mailbox | where "$_.MaxReceiveSize -gt '50GB'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchMaxSafeSenders | Get-Mailbox | Integer or $null |
For example, Get-Mailbox -Filter "MaxSafeSenders -gt 0"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
submissionContLength | Get-DistributionGroup Get-DynamicDistributionGroup Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-RemoteMailbox Get-UnifiedGroup |
A byte quantified size value (for example, 75MB ), 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 "MaxSendSize -eq 'Unlimited'"
or Get-Mailbox -Filter "MaxSendSize -ne 'Unlimited'"
.
You can't use the Filter parameter to look for size values of this property. Instead, use this syntax: Get-Mailbox | where "$_.MaxReceiveSize -<Operator> '<Size>'"
. For example, Get-Mailbox | where "$_.MaxSendSize -gt '50GB'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchGroupDepartRestriction | Get-DistributionGroup | Closed (0), Open (1), or ApprovalRequired (2). |
For example, Get-DistributionGroup -Filter "MemberDepartRestriction -eq 'ApprovalRequired'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchGroupDepartRestriction | Get-DistributionGroup | Closed (0), Open (1), or ApprovalRequired (2). |
For example, Get-DistributionGroup -Filter "MemberJoinRestriction -eq 'ApprovalRequired'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
memberOf | Get-CASMailbox Get-Contact Get-DistributionGroup Get-DynamicDistributionGroup Get-Group Get-LinkedUser Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-Recipient Get-RemoteMailbox Get-SecurityPrincipal Get-UMMMailbox Get-User |
String or $null |
This filter requires the distinguished name or canonical distinguished name of the distribution group or mail-enabled security group. For example, Get-User -Filter "MemberOfGroup -eq 'CN=Marketing Department,CN=Users,DC=contoso,DC=com'"
or Get-User -Filter "MemberOfGroup -eq 'contoso.com/Users/Marketing Group'"
.
To find the distinguished name of a group, replace <GroupIdentity> with the name, alias, or email address of the group, and run this command: Get-DistributionGroup -Identity "<GroupIdentity>" | Format-List Name,DistinguishedName
.
Although this property is multi-valued, the filter returns a match if the property contains the specified value.
LDAP display name | Available on cmdlets | Value |
---|---|---|
member | Get-DistributionGroup Get-Group Get-Recipient Get-SecurityPrincipal |
String or $null |
This filter requires the distinguished name or canonical distinguished name of the group member. For example, Get-Group -Filter "Members -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"
or Get-User -Filter "Members -eq 'contoso.com/Users/Angela Gruber'"
.
To find the distinguished name of a group member, replace <RecipientIdentity> with the name, alias, or email address of the group member, and run this command: Get-Recipient -Identity "<RecipientIdentity>" | Format-List Name,DistinguishedName
.
Although this property is multi-valued, the filter returns a match if the property contains the specified value.
LDAP display name | Available on cmdlets | Value |
---|---|---|
mobile | Get-Contact Get-LinkedUser Get-User |
String (wildcards accepted) or $null |
For example, Get-User -Filter "MobilePhone -like '555*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchModeratedByLink | Get-DistributionGroup Get-DynamicDistributionGroup Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-RemoteMailbox Get-UnifiedGroup |
String |
This filter requires the distinguished name or canonical distinguished name of the group moderator (a mail-enabled security principal, which is a mailbox, mail-user, or mail-enabled security group). For example, Get-DistributionGroup -Filter "ModeratedBy -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"
or Get-DistributionGroup -Filter "ModeratedBy -eq 'contoso.com/Users/Angela Gruber'"
.
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
.
Although this property is multi-valued, the filter returns a match if the property contains the specified value.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchEnableModeration | Get-DistributionGroup Get-DynamicDistributionGroup Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-RemoteMailbox Get-UnifiedGroup |
Boolean ($true or $false ) |
For example, Get-DistributionGroup -Filter 'ModerationEnabled -eq $true'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
name | Get-CASMailbox Get-Contact Get-DistributionGroup Get-DynamicDistributionGroup Get-Group Get-LinkedUser Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-Recipient Get-RemoteMailbox Get-SecurityPrincipal Get-UMMailbox Get-User Get-UnifiedGroup |
String (wildcards accepted) |
For example, Get-User -Filter "Name -like 'Laura*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-LinkedUser Get-Mailbox Get-User |
String or $null |
This property is populated for Exchange Online mailboxes in hybrid environments. A sample value is 1003BFFD9A0CFA03
.
For example, Get-User -Filter 'NetId -ne $null'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
info | Get-Contact Get-DynamicDistributionGroup Get-Group Get-LinkedUser Get-Recipient Get-User Get-UnifiedGroup |
String (wildcards accepted) or $null |
For example, Get-User -Filter "Notes -like 'Events Team*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
objectCategory | Get-CASMailbox Get-Contact Get-DistributionGroup Get-DynamicDistributionGroup Get-Group Get-LinkedUser Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-Recipient Get-RemoteMailbox Get-SecurityPrincipal Get-UMMailbox Get-User Get-UnifiedGroup |
String |
This filter requires the canonical distinguished name of the object. The value uses the syntax <domain>/Configuration/Schema/<Type>
.
Valid <Type> values are: Person
for mailboxes, mail users, and mail contacts, Group
for distribution groups, mail-enabled security groups and Microsoft 365 Groups, ms-Exch-Public-Folder
for mail-enabled public folders, and ms-Exch-Dynamic-Distribution-List
for dynamic distribution groups.
For example, Get-Recipient -Filter "ObjectCategory -eq 'contoso.com/Configuration/Schema/Group'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
objectClass | Get-CASMailbox Get-Contact Get-DistributionGroup Get-DynamicDistributionGroup Get-Group Get-LinkedUser Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-Recipient Get-RemoteMailbox Get-SecurityPrincipal Get-UMMailbox Get-User Get-UnifiedGroup |
String |
The value of this property is top, person, organizationalPerson, user
for mailboxes and mail users, top, person, organizationalPerson, contact
for mail contacts, top, group
for distribution groups, mail-enabled security groups and Microsoft 365 Groups, msExchDynamicDistributionList
for dynamic distribution groups and top, publicFolder
for mail-enabled public folders
For example, Get-Recipient -Filter "ObjectClass -eq 'Contact'"
.
Although this property is multi-valued, the filter returns a match if the property contains the specified value.
LDAP display name | Available on cmdlets | Value |
---|---|---|
physicalDeliveryOfficeName | Get-Contact Get-LinkedUser Get-Mailbox Get-Recipient Get-User |
String (wildcards accepted) or $null |
For example, Get-User -Filter "Office -like '22*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchUseOAB | Get-Mailbox | String or $null |
This filter requires the distinguished name of the offline address book. For example, Get-Mailbox -Arbitration -Filter "OfflineAddressBook -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'"
You can find the distinguished names of offline address books by running this command: Get-OfflineAddressBook | Format-List Name,DistinguishedName
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-MailPublicFolder | String or $null |
For example, Get-MailPublicFolder -Filter 'OnPremisesObjectId -ne $null'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchUMOperatorNumber | Get-UMMailbox | String (wildcards accepted) or $null |
For example, Get-UMMailbox -Filter "OperatorNumber -eq 5"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
otherFacsimileTelephoneNumber | Get-Contact Get-LinkedUser Get-User |
String (wildcards accepted) or $null |
For example, Get-User -Filter "OtherFax -like '206*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
otherHomePhone | Get-Contact Get-LinkedUser Get-User |
String (wildcards accepted) or $null |
For example, Get-User -Filter "OtherHomePhone -like '206*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
otherTelephone | Get-Contact Get-LinkedUser Get-User |
String (wildcards accepted) or $null |
For example, Get-User -Filter "OtherTelephone -like '206*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-CASMailbox | Boolean ($true or $false ) |
The filter operates backwards. For example, Get-CASMailbox -Filter 'OWAEnabled -eq $true'
returns mailboxes where the OWAEnabled property is False
, and Get-CASMailbox -Filter 'OWAEnabled -eq $false'
returns mailboxes where the OWAEnabled property is True
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchOmaAdminWirelessEnable | Get-CASMailbox | Boolean ($true or $false ) |
For example, Get-CASMailbox -Filter 'OWAForDevicesEnabled -eq $true'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchOWAPolicy | Get-CASMailbox Get-Recipient |
String or $null |
This filter requires the distinguished name of the Outlook on the web mailbox policy (formerly known as an Outlook Web App mailbox policy). For example, Get-CASMailbox -Filter "OWAMailboxPolicy -eq 'CN=Default,CN=OWA Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com
'".
You can find the distinguished names of Outlook on the web mailbox policies by running this command: Get-OwaMailboxPolicy | Format-List Name,DistinguishedName
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
pager | Get-Contact Get-LinkedUser Get-User |
String (wildcards accepted) or $null |
For example, Get-User -Filter "Pager -like '206*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-Mailbox Get-MailUser Get-RemoteMailbox |
String or $null |
Typically, the value of this property something other than $null
(blank) for Microsoft 365 accounts and mailboxes. For more information about the valid property values, see Capability enumeration.
For example, Get-Mailbox -Filter 'PersistedCapabilities -ne $null'
.
Although this property is multi-valued, the filter returns a match if the property contains the specified value.
LDAP display name | Available on cmdlets | Value |
---|---|---|
telephoneNumber | Get-Contact Get-LinkedUser Get-Recipient Get-User |
String (wildcards accepted) or $null |
For example, Get-User -Filter "Phone -like '206*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchUMPhoneProvider | Get-UMMailbox | String (wildcards accepted) or $null |
For example, Get-UMMailbox -Filter "PhoneProviderId -like '206*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msDS-PhoneticDisplayName | Get-Contact Get-DynamicDistributionGroup Get-Group Get-LinkedUser Get-MailPublicFolder Get-User |
String (wildcards accepted) or $null |
For example, Get-User -Filter "PhoneticDisplayName -like 'Lila*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchPoliciesExcluded | Get-DistributionGroup Get-DynamicDistributionGroup Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-Recipient Get-RemoteMailbox Get-UnifiedGroup |
String or $null |
For example, Get-Recipient -Filter 'PoliciesExcluded -ne $null'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchPoliciesIncluded | Get-DistributionGroup Get-DynamicDistributionGroup Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-Recipient Get-RemoteMailbox Get-UnifiedGroup |
String or $null |
For example, Get-Recipient -Filter 'PoliciesIncluded -eq $null'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-CASMailbox | Boolean ($true or $false ) |
For example, Get-CASMailbox -Filter 'POPEnabled -eq $false'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
postalCode | Get-Contact Get-LinkedUser Get-Recipient Get-User |
String (wildcards accepted) or $null |
For example, Get-Recipient -Filter "PostalCode -eq 90210"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
postOfficeBox | Get-Contact Get-LinkedUser Get-User |
String (wildcards accepted) or $null |
For example, Get-User -Filter "PostOfficeBox -like '555*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchPreviousRecipientTypeDetails | Get-LinkedUser Get-User |
String or $null |
For valid values, see the description of the RecipientTypeDetails parameter in Get-Recipient.
For example, Get-User -Filter 'PreviousRecipientTypeDetails -ne $null'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-CASMailbox Get-DistributionGroup Get-DynamicDistributionGroup Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-Recipient Get-RemoteMailbox Get-UMMailbox Get-UnifiedGroup |
String (wildcards accepted) |
Don't use the PrimarySmtpAddress property; use the EmailAddresses property instead. Any filter that uses the PrimarySmtpAddress property will also search values in the EmailAddresses property. For example, if a mailbox has the primary email address dario@contoso.com, and the additional proxy addresses dario2@contoso.com and dario3@contoso.com, all of the following filters will return that mailbox in the result: "PrimarySmtpAddress -eq 'dario@contoso.com'"
, "PrimarySmtpAddress -eq 'dario2@contoso.com'"
, or "PrimarySmtpAddress -eq 'dario3@contoso.com'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
mDBOverQuotaLimit | Get-Mailbox Get-MailUser 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 "ProhibitSendQuota -eq 'Unlimited'"
or Get-Mailbox -Filter "ProhibitSendQuota -ne 'Unlimited'"
.
You can't use the Filter parameter to look for size values of this property. Instead, use this syntax: Get-Mailbox | where "$_.ProhibitSendQuota -<Operator> '<Size>'"
. For example, Get-Mailbox | where "$_.ProhibitSendQuota -lt '70GB'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
mDBOverHardQuotaLimit | Get-Mailbox Get-MailUser 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 "ProhibitSendReceiveQuota -eq 'Unlimited'"
or Get-Mailbox -Filter "ProhibitSendReceiveQuota -ne 'Unlimited'"
.
You can't use the Filter parameter to look for size values of this property. Instead, use this syntax: Get-Mailbox | where "$_.ProhibitSendReceiveQuota -<Operator> '<Size>'"
. For example, Get-Mailbox | where "$_.ProhibitSendReceiveQuota -lt '70GB'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
protocolSettings | Get-Mailbox Get-MailUser Get-RemoteMailbox |
String (wildcards accepted) or $null |
The default value of this property on mailboxes is RemotePowerShell§1
. This property is populated with additional values when you use Set-CASMailbox to disable protocols (for example, POP3 or IMAP4).
For example, Get-Mailbox -Filter "ProtocolSettings -like 'POP3*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
pFContacts | Get-MailPublicFolder | String or $null |
This property is displayed as Contacts in the results of the command Get-MailPublicFolder -Identity <PublicFolderIdentity> | Format-List
, but you need to use the property name PublicFolderContacts in the filter.
This filter requires the distinguished name or canonical distinguished name of the public folder contact. For example, Get-MailPublicFolder -Filter "PublicFolderContacts -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"
or Get-MailPublicFolder -Filter "PublicFolderContacts -eq 'contoso.com/Users/Angela Gruber'"
.
To find the distinguished name of a public folder contact, replace <RecipientIdentity> with the name, alias, or email address of the recipient, and run this command: Get-Recipient -Identity "<RecipientIdentity>" | Format-List Name,DistinguishedName
.
Although this property is multi-valued, the filter returns a match if the property contains the specified value.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchQueryBaseDN | Get-Mailbox | String or $null |
This property was used in Exchange 2007 global address list segregation to specify a location in Active Directory. This feature was replaced by address book policies in Exchange 2010 Service Pack 2, so the value of this property should always be blank ( $null
).
For example, Get-Mailbox -Filter 'QueryBaseDN -ne $null'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchDynamicDLBaseDN | Get-DynamicDistributionGroup | String or $null |
This filter requires the distinguished name or canonical distinguished name of the organizational unit or container in Active Directory. For example, Get-DynamicDistributionGroup -Filter "RecipientContainer -eq 'CN=Users,DC=contoso,DC=com'"
or Get-DynamicDistributionGroup -Filter "RecipientContainer -eq 'contoso.com/Users'"
To find the distinguished names or canonical distinguished names of organizational units and containers in Active Directory, run this command: Get-OrganizationalUnit -IncludeContainers | Format-List Name,DistinguishedName,ID
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchRecipLimit | Get-Mailbox Get-MailUser Get-RemoteMailbox |
Integer or Unlimited |
For example, Get-Mailbox -Filter "RecipientLimits -ne 'Unlimited'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-Contact Get-DistributionGroup Get-DynamicDistributionGroup Get-Group Get-LinkedUser Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-Recipient Get-RemoteMailbox Get-SecurityPrincipal Get-User Get-UnifiedGroup |
DynamicDistributionGroup , MailContact , MailNonUniversalGroup , MailUniversalDistributionGroup , MailUniversalSecurityGroup , MailUser , PublicFolder or UserMailbox |
For example, Get-Recipient -Filter "RecipientType -eq 'MailContact'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-Contact Get-DistributionGroup Get-DynamicDistributionGroup Get-Group Get-LinkedUser Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-Recipient Get-RemoteMailbox Get-SecurityPrincipal Get-User Get-UnifiedGroup |
String |
For valid values, see the description of the RecipientTypeDetails parameter in Get-Recipient.
For example, Get-Recipient -Filter "RecipientTypeDetails -eq 'SharedMailbox'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchDumpsterQuota | Get-Mailbox Get-MailUser 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 "RecoverableItemsQuota -eq 'Unlimited'"
or Get-Mailbox -Filter "RecoverableItemsQuota -ne 'Unlimited'"
.
You can't use the Filter parameter to look for size values of this property. Instead, use this syntax: Get-Mailbox | where "$_.RecoverableItemsQuota -<Operator> '<Size>'
. For example, Get-Mailbox | where "$_.RecoverableItemsQuota -gt '35GB'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchDumpsterWarningQuota | Get-Mailbox Get-MailUser 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 "RecoverableItemsWarningQuota -eq 'Unlimited'"
or Get-Mailbox -Filter "RecoverableItemsWarningQuota -ne 'Unlimited'"
.
You can't use the Filter parameter to look for size values of this property. Instead, use this syntax: Get-Mailbox | where "$_.RecoverableItemsWarningQuota -<Operator> '<Size>'
". For example, Get-Mailbox | where "$_.RecoverableItemsWarningQuota -gt '25GB'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
unauthOrig | Get-DistributionGroup Get-DynamicDistributionGroup Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-RemoteMailbox Get-UnifiedGroup |
String or $null |
This filter requires the distinguished name of the individual recipient (a mailbox, mail user, or mail contact). For example, Get-DistributionGroup -Filter "RejectMessagesFrom -eq 'CN=Yuudai Uchida,CN=Users,DC=contoso,DC=com'"
or Get-DistributionGroup -Filter "RejectMessagesFrom -eq 'contoso.com/Users/Angela Gruber'"
.
To find the distinguished name of the individual 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
.
Although this property is multi-valued, the filter returns a match if the property contains the specified value.
LDAP display name | Available on cmdlets | Value |
---|---|---|
dLMemRejectPerms | Get-DistributionGroup Get-DynamicDistributionGroup Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-RemoteMailbox Get-UnifiedGroup |
String or $null |
This filter requires the distinguished name or canonical distinguished name of the group (a distribution group, mail-enabled security group, or dynamic distribution group). For example, Get-Mailbox -Filter "RejectMessagesFromDLMembers -eq 'CN=Marketing Department,CN=Users,DC=contoso,DC=com'"
or Get-Mailbox -Filter "RejectMessagesFromDLMembers -eq 'contoso.com/Users/Marketing Department'"
.
To find the distinguished name of the group, replace <GroupIdentity> with the name, alias, or email address of the group, and run one of these commands: Get-DistributionGroup -Identity "<GroupIdentity>" | Format-List Name,DistinguishedName
or Get-DynamicDistributionGroup -Identity "<GroupIdentity>" | Format-List Name,DistinguishedName
.
Although this property is multi-valued, the filter returns a match if the property contains the specified value.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchSyncAccountsPolicyDN | Get-Mailbox | String or $null |
This filter requires the distinguished name of the remote account policy. For example, Get-Mailbox -Filter "RemoteAccountPolicy -eq 'CN=Contoso Remote Account Policy,CN=Remote Accounts Policies Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-User | Boolean ($true or $false ) |
For example, Get-User -Filter 'RemotePowerShellEnabled -eq $false'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchRemoteRecipientType | Get-Mailbox Get-RemoteMailbox |
None (0), ProvisionMailbox (1), ProvisionArchive (2), Migrated (4), DeprovisionMailbox (8), DeprovisionArchive (16), RoomMailbox (32), EquipmentMailbox (64), SharedMailbox (96), TeamMailbox (128), or $null . |
For example, Get-RemoteMailbox -Filter "RemoteRecipientType -eq 'ProvisionMailbox'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
reportToOwner | Get-DistributionGroup Get-DynamicDistributionGroup Get-UnifiedGroup |
Boolean ($true or $false ) |
For example, Get-DistributionGroup -Filter 'ReportToManagerEnabled -eq $true'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
reportToOriginator | Get-DistributionGroup Get-DynamicDistributionGroup Get-UnifiedGroup |
Boolean ($true or $false ) |
For example, Get-DistributionGroup -Filter 'ReportToOriginatorEnabled -eq $false'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchRequireAuthToSendTo | Get-DistributionGroup Get-DynamicDistributionGroup Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-RemoteMailbox Get-SecurityPrincipal |
Boolean ($true or $false ) |
This property is displayed as RequireSenderAuthenticationEnabled in the results of the command Get-<RecipientType> -Identity <RecipientIdentity> | Format-List
, but you need to use the property name RequireAllSendersAreAuthenticated in the filter. For example, Get-DistributionGroup -Filter 'RequireAllSendersAreAuthenticated -eq $false'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-UnifiedGroup | AllowOnlyMembersToPost , CalendarMemberReadOnly , ConnectorsEnabled , HideGroupInOutlook , NotebookForLearningCommunitiesEnabled , ReportToOriginator , SharePointReadonlyForMembers , SubscriptionEnabled , SubscribeMembersToCalendarEvents , SubscribeMembersToCalendarEventsDisabled , SubscribeNewGroupMembers , WelcomeEmailDisabled , WelcomeEmailEnabled , or $null |
For example, Get-UnifiedGroup -Filter "ResourceBehaviorOptions -eq 'CalendarMemberReadOnly'"
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchResourceCapacity | Get-Mailbox | Integer or $null |
For example, Get-Mailbox -Filter "ResourceCapacity -gt 15"
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-Mailbox | String or $null |
You create custom resource properties by using the Set-ResourceConfig cmdlet. For example, Set-ResourceConfig -ResourcePropertySchema Room/Whiteboard,Equipment/Van
. After you create the properties, you can assign them to room or equipment mailboxes. For example, Set-Mailbox -Identity "Conference Room 1" -ResourceCustom Whiteboard
.
When you search for values, use the custom resource property that's assigned to the room or equipment mailbox. For example, Get-Mailbox -Filter "ResourceCustom -eq 'Whiteboard'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-UnifiedGroup | Team or $null |
For example, Get-UnifiedGroup -Filter "ResourceProvisioningOptions -eq 'Team'"
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-Mailbox Get-Recipient |
Room (0), Equipment (1), or $null |
For example, Get-Mailbox -Filter "ResourceType -eq 'Equipment'"
LDAP display name | Available on cmdlets | Value |
---|---|---|
garbageCollPeriod | Get-Mailbox Get-MailUser Get-RemoteMailbox |
A time span value: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. |
You can't use the Filter parameter to look for time span values for this property. Instead, use this syntax: Get-Mailbox | where "$_.RetainDeletedItemsFor -<Operator> '<TimeSpan>'"
. For example, Get-Mailbox | where "$_.RetainDeletedItemsFor -gt '14.00:00:00'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchRetentionComment | Get-Mailbox Get-MailUser Get-RemoteMailbox |
String (wildcards accepted) or $null |
For example, Get-Mailbox -Filter "RetentionComment -like '7 years*'"
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-Mailbox Get-Recipient |
String or $null |
This filter requires the distinguished name of the retention policy. For example, Get-Mailbox -Filter "RetentionPolicy -eq 'CN=Default MRM Policy,CN=Retention Policies Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"
.
To find the distinguished names of retention policies, run this command: Get-RetentionPolicy | Format-List Name,DistinguishedName
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchRetentionURL | Get-Mailbox Get-MailUser Get-RemoteMailbox |
String (wildcards accepted) or $null |
For example, Get-Mailbox -Filter "RetentionUrl -like 'https://intranet.contoso.com/*'"
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchRBACPolicyLink | Get-Mailbox | String (wildcards accepted) or $null |
This filter requires the distinguished name of the role assignment policy in Exchange Online. For example, Get-Mailbox -Filter "RoleAssignmentPolicy -eq 'CN=Default Role Assignment Policy,CN=Policies,CN=RBAC,CN=Configuration,CN=contoso.onmicrosoft.com,CN=ConfigurationUnits,DC=NAMPR10A001,DC=PROD,DC=OUTLOOK,DC=COM'"
.
To find the distinguished names of role assignment policies in Exchange Online, run this command: Get-RoleAssignmentPolicy | Format-List Name,DistinguishedName
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchMDBRulesQuota | Get-Mailbox | A byte quantified size value (for example, 50B or 128KB ). Unqualified values are treated as bytes. |
You can't use the Filter parameter to look for size values of this property. Instead, use this syntax: Get-Mailbox | where "$_.RulesQuota -<Operator> '<Size>'"
. For example, Get-Mailbox | where "$_.RulesQuota -lt '256KB'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchSafeRecipientsHash | Get-Recipient | Blank ( $null ) or a hashed value. |
Realistically, you can only use this value to filter on blank or non-blank values. For example, Get-Recipient -Filter 'SafeRecipientsHash -ne $null'.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchSafeSendersHash | Get-Recipient | Blank ( $null ) or a hashed value. |
Realistically, you can only use this value to filter on blank or non-blank values. For example, Get-Recipient -Filter 'SafeSendersHash -ne $null'.
LDAP display name | Available on cmdlets | Value |
---|---|---|
SamAccountName | Get-CASMailbox Get-DistributionGroup Get-Group Get-LinkedUser Get-Mailbox Get-MailUser Get-Recipient Get-RemoteMailbox Get-UMMailbox Get-User |
String (wildcards accepted) or $null |
For example, Get-Recipient -Filter "SamAccountName -like 'laura*'"
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchMessageHygieneSCLDeleteThreshold | Get-Mailbox | -2147483648 (SCL value 0), -2147483647 (SCL value 1), -2147483646 (SCL value 2), -2147483645 (SCL value 3), -2147483644 (SCL value 4), -2147483643 (SCL value 5), -2147483642 (SCL value 6), -2147483641 (SCL value 7), -2147483640 (SCL value 8), -2147483639 (SCL value 9) or $null |
This property is displayed as SCLDeleteThreshold in the results of the command Get-Mailbox -Identity <MailboxIdentity> | Format-List
, but you need to use the property name SCLDeleteThresholdInt in the filter. For example, Get-Mailbox -Filter "SCLDeleteThresholdInt -ge -2147483640"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchMessageHygieneSCLJunkThreshold | Get-Mailbox | -2147483648 (SCL value 0), -2147483647 (SCL value 1), -2147483646 (SCL value 2), -2147483645 (SCL value 3), -2147483644 (SCL value 4), -2147483643 (SCL value 5), -2147483642 (SCL value 6), -2147483641 (SCL value 7), -2147483640 (SCL value 8), -2147483639 (SCL value 9) or $null |
This property is displayed as SCLJunkThreshold in the results of the command Get-Mailbox -Identity <MailboxIdentity> | Format-List
, but you need to use the property name SCLJunkThresholdInt in the filter. For example, Get-Mailbox -Filter "SCLJunkThresholdInt -ge -2147483645"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchMessageHygieneSCLQuarantineThreshold | Get-Mailbox | -2147483648 (SCL value 0), -2147483647 (SCL value 1), -2147483646 (SCL value 2), -2147483645 (SCL value 3), -2147483644 (SCL value 4), -2147483643 (SCL value 5), -2147483642 (SCL value 6), -2147483641 (SCL value 7), -2147483640 (SCL value 8), -2147483639 (SCL value 9) or $null |
This property is displayed as SCLQuarantineThreshold in the results of the command Get-Mailbox -Identity <MailboxIdentity> | Format-List
, but you need to use the property name SCLQuarantineThresholdInt in the filter. For example, Get-Mailbox -Filter "SCLQuarantineThresholdInt -ge -2147483643"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchMessageHygieneSCLRejectThreshold | Get-Mailbox | -2147483648 (SCL value 0), -2147483647 (SCL value 1), -2147483646 (SCL value 2), -2147483645 (SCL value 3), -2147483644 (SCL value 4), -2147483643 (SCL value 5), -2147483642 (SCL value 6), -2147483641 (SCL value 7), -2147483640 (SCL value 8), -2147483639 (SCL value 9) or $null |
This property is displayed as SCLRejectThreshold in the results of the command Get-Mailbox -Identity <MailboxIdentity> | Format-List
, but you need to use the property name SCLRejectThresholdInt in the filter. For example, Get-Mailbox -Filter "SCLRejectThresholdInt -ge -2147483641"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
oOFReplyToOriginator | Get-DistributionGroup Get-DynamicDistributionGroup Get-UnifiedGroup |
Boolean ($true or $false ) |
For example, Get-DistributionGroup -Filter 'SendOofMessageToOriginatorEnabled -eq $true'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchHomeServerName | Get-CASMailbox Get-Mailbox Get-Recipient Get-UMMailbox |
String (wildcards accepted) or $null |
For example, Get-Mailbox -Filter "ServerLegacyDN -like 'Mailbox01'"
.
This is an example of a complete ServerLegacyDN value: /o=Contoso Corporation/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Mailbox01
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-CASMailbox Get-Mailbox Get-Recipient Get-UMMailbox |
String or $null |
For example, Get-Recipient -Filter "ServerName -eq 'Mailbox01'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchSharingPolicyLink | Get-Mailbox Get-Recipient |
String or $null |
This filter requires the distinguished name of the sharing policy. For example, Get-Mailbox -Filter "SharingPolicy -eq 'CN=Custom Sharing Policy,CN=Federation,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"
.
To find the distinguished names of sharing policies, run this command: Get-SharingPolicy | Format-List Name,DistinguishedName
.
Note
For the default assignment of the default sharing policy (named Default Sharing Policy) to a mailbox, the value of the SharingPolicy property is blank ($null
).
LDAP display name | Available on cmdlets | Value |
---|---|---|
objectSid | Get-Group Get-LinkedUser Get-SecurityPrincipal Get-User |
String |
For example, Get-User -Filter "Sid -eq 's-1-5-21-3628364307-1600040346-819251021-2603'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
SIDHistory | Get-Group Get-LinkedUser Get-User |
String or $null |
For example, Get-User -Filter "SidHistory -eq 's-1-5-21-3628364307-1600040346-819251021-2603'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
displayNamePrintable | Get-Contact Get-DistributionGroup Get-DynamicDistributionGroup Get-Group Get-LinkedUser Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-RemoteMailbox Get-User |
String (wildcards accepted) or $null |
For example, Get-User -Filter "SimpleDisplayName -like 'lila*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-Mailbox Get-MailUser Get-RemoteMailbox |
Boolean ($true or $false ) |
For example, Get-Mailbox -Filter 'SingleItemRecoveryEnabled -eq $true'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-LinkedUser Get-Mailbox Get-MailUser Get-Recipient Get-User |
Boolean ($true or $false ) or $null . |
For example, Get-User -Filter 'SKUAssigned -eq $true'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-Mailbox | String (wildcards accepted) or $null |
For example, Get-Mailbox -Filter 'SourceAnchor -ne $null'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
st | Get-Contact Get-LinkedUser Get-Recipient Get-User |
String (wildcards accepted) or $null |
For example, Get-User -Filter "StateOrProvince -like 'Carolina*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
streetAddress | Get-Contact Get-LinkedUser Get-User |
String (wildcards accepted) or $null |
For example, Get-User -Filter "StreetAddress -like '36th Ave NE*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchStsRefreshTokensValidFrom | Get-LinkedUser Get-Mailbox Get-MailUser Get-RemoteMailbox Get-User |
$null or a date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC) |
For example, Get-User -Filter "StsRefreshTokensValidFrom -gt '8/1/2017'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
telephoneAssistant | Get-Contact Get-LinkedUser Get-User |
String (wildcards accepted) or $null |
For example, Get-User -Filter "TelephoneAssistant -like '206*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchThrottlingPolicyDN | Get-Mailbox | String or $null |
This filter requires the distinguished name of the throttling policy. For example, Get-Mailbox -Filter "ThrottlingPolicy -eq 'CN=Custom Throttling Policy,CN=Global Settings,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"
.
To find the distinguished names of throttling policies, run this command: Get-ThrottlingPolicy | Format-List Name,DistinguishedName
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
title | Get-Contact Get-LinkedUser Get-Recipient Get-User |
String (wildcards accepted) or $null |
For example, Get-User -Filter "Title -eq 'Dr.'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchUMAddresses | Get-UMMailbox | String (wildcards accepted) or $null |
For example, Get-UMMailbox -Filter 'UMAddresses -ne $null'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchUMCallingLineIds | Get-Contact Get-LinkedUser Get-User |
String (wildcards accepted) or $null |
For example, Get-User -Filter "UMCallingLineIds -like '123*'"
.
Although this property is multi-valued, the filter returns a match if the property contains the specified value.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchUMDtmfMap | Get-Contact Get-DistributionGroup Get-DynamicDistributionGroup Get-LinkedUser Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-RemoteMailbox Get-UMMailbox Get-User |
String (wildcards accepted) or $null |
For example, Get-Mailbox -Filter "UMDtmfMap -like '26297*'"
.
Although this property is multi-valued, the filter returns a match if the property contains the specified value.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-Mailbox Get-Recipient Get-UMMailbox |
Boolean ($true or $false ) |
For example, Get-Mailbox -Filter 'UMEnabled -eq $true'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchUMTemplateLink | Get-Recipient Get-UMMailbox |
String or $null |
This filter requires the distinguished name of the UM mailbox policy. For example, Get-Recipient -Filter "UMMailboxPolicy -eq 'CN=Contoso Default Policy,CN=UM Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"
.
To find the distinguished names of UM mailbox policies, run this command: Get-UMMailboxPolicy | Format-List Name,DistinguishedName
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchUMRecipientDialPlanLink | Get-Recipient | String or $null |
This filter requires the distinguished name of the UM dial plan. For example, Get-Recipient -Filter "UMMailboxPolicy -eq 'CN=Contoso Dial Plan,CN=UM DialPlan Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"
.
To find the distinguished names of UM dial plans, run this command: Get-UMDialPlan | Format-List Name,DistinguishedName
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-User | None (0), TenantUpgrade (1), PrestageUpgrade (2), CancelPrestageUpgrade (3), PilotUpgrade (4), or TenantUpgradeDryRun (5), |
For example, Get-User -Filter "UpgradeRequest -ne 'None'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-User | None (0), NotStarted (1), InProgress (2), Warning (3), Error (4), Cancelled (5), Complete (6), or ForceComplete (7). |
For example, Get-User -Filter "UpgradeStatus -ne 'None'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchUsageLocation | Get-Mailbox Get-MailUser Get-Recipient |
String or $null |
This filter requires the ISO 3166-1 country name (for example, United States
), or two-letter country code (for example US
) for the user in Microsoft 365. For more information, see Country Codes - ISO 3166.
For example, Get-Recipient -Filter 'UsageLocation -eq "US"'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
mDBUseDefaults | Get-Mailbox | Boolean ($true or $false ) |
For example, Get-Mailbox -Filter 'UseDatabaseQuotaDefaults -eq $false'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
userAccountControl | Get-LinkedUser Get-User |
AccountDisabled , DoNotExpirePassword , or NormalAccount |
For example, Get-User -Filter "UserAccountControl -eq 'NormalAccount'"
.
You can specify multiple values separated by commas, but the order matters. For example, Get-User -Filter "UserAccountControl -eq 'AccountDisabled,NormalAccount'"
returns different results than Get-User -Filter "UserAccountControl -eq 'NormalAccount,AccountDisabled'"
.
This multivalued property will only return a match if the property equals the specified value.
LDAP display name | Available on cmdlets | Value |
---|---|---|
userPrincipalName | Get-LinkedUser Get-Mailbox Get-MailUser Get-RemoteMailbox Get-User |
String (wildcards accepted) |
For example, Get-User -Filter "UserPrincipalName -like 'julia@*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchUCVoiceMailSettings | Get-Contact Get-LinkedUser Get-User |
String or $null |
For example, Get-User -Filter 'VoiceMailSettings -ne $null'
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
wWWHomePage | Get-Contact Get-LinkedUser Get-User |
String (wildcards accepted) or $null |
For example, Get-User -Filter "WebPage -like 'https://intranet.contoso.com/*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
WhenChanged | Get-CASMailbox Get-Contact Get-DistributionGroup Get-DynamicDistributionGroup Get-Group Get-LinkedUser Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-Recipient Get-RemoteMailbox Get-SecurityPrincipal Get-UMMailbox Get-User Get-UnifiedGroup |
A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC) |
For example, Get-Recipient -Filter "WhenChanged -gt '8/1/2017 2:00:00 PM'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-CASMailbox Get-Contact Get-DistributionGroup Get-DynamicDistributionGroup Get-Group Get-LinkedUser Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-Recipient Get-RemoteMailbox Get-SecurityPrincipal Get-UMMailbox Get-User Get-UnifiedGroup |
A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC) |
For example, Get-Recipient -Filter "WhenChangedUTC -gt '8/1/2017 2:00:00 PM'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
whenCreated | Get-CASMailbox Get-Contact Get-DistributionGroup Get-DynamicDistributionGroup Get-Group Get-LinkedUser Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-Recipient Get-RemoteMailbox Get-SecurityPrincipal Get-UMMailbox Get-User Get-UnifiedGroup |
A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC) |
For example, Get-Recipient -Filter "WhenCreated -gt '8/1/2017 2:00:00 PM'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
n/a | Get-CASMailbox Get-Contact Get-DistributionGroup Get-DynamicDistributionGroup Get-Group Get-LinkedUser Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-Recipient Get-RemoteMailbox Get-SecurityPrincipal Get-UMMailbox Get-User Get-UnifiedGroup |
A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC) |
For example, Get-Recipient -Filter "WhenCreatedUTC -gt '8/1/2017 2:00:00 PM'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchWhenMailboxCreated | Get-Mailbox Get-MailUser Get-Recipient Get-RemoteMailbox |
A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC) |
For example, Get-Recipient -Filter "WhenMailboxCreated -gt '8/1/2017 2:00:00 PM'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchWhenSoftDeletedTime | Get-LinkedUser Get-Mailbox Get-MailUser Get-RemoteMailbox Get-User Get-UnifiedGroup |
A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC) |
This filter requires the SoftDeleted switch in the command for mailboxes.
For example, Get-Mailbox -SoftDeletedMailbox -Filter "WhenSoftDeleted -gt '8/1/2017 2:00:00 PM'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
Get-Contact Get-DistributionGroup Get-DynamicDistributionGroup Get-Group Get-LinkedUser Get-Mailbox Get-MailContact Get-MailPublicFolder Get-MailUser Get-RemoteMailbox Get-User |
String (wildcards accepted) or $null |
For example, Get-Mailbox -Filter "WindowsEmailAddress -like '@fabrikam.com*'"
.
LDAP display name | Available on cmdlets | Value |
---|---|---|
msExchWindowsLiveID | Get-LinkedUser Get-Mailbox Get-MailUser Get-Recipient Get-User |
String (wildcards accepted) or $null |
For example, Get-Mailbox -Filter "WindowsEmailAddress -like '@fabrikam.onmicrosoft.com*'"
.|
Exchange 2007 was the first version of Exchange that required OPATH filters instead of LDAP filters. For more information about converting LDAP filters to OPATH filters, see the Microsoft Exchange Team Blog article, Need help converting your LDAP filters to OPATH?.
Training
Module
Manage Active Directory Domain Services using PowerShell cmdlets - Training
This module covers the cmdlets that are used to administer Active Directory Domain Services.