Get-User

Syntax

AnrSet

Get-User
    [-Anr <String>]
    [-Arbitration]
    [-AuditLog]
    [-AuxAuditLog]
    [-Credential <PSCredential>]
    [-DomainController <Fqdn>]
    [-Filter <String>]
    [-IgnoreDefaultScope]
    [-IncludeDirectReportsWithDisplayNames]
    [-IsVIP]
    [-OrganizationalUnit <OrganizationalUnitIdParameter>]
    [-PublicFolder]
    [-ReadFromDomainController]
    [-RecipientTypeDetails <RecipientTypeDetails[]>]
    [-ResultSize <Unlimited>]
    [-Sortby <String>]
    [-SupervisoryReviewPolicy]
    [<CommonParameters>]

Identity

Get-User
    [[-Identity] <UserIdParameter>]
    [-Arbitration]
    [-AuditLog]
    [-AuxAuditLog]
    [-Credential <PSCredential>]
    [-DomainController <Fqdn>]
    [-Filter <String>]
    [-IgnoreDefaultScope]
    [-IncludeDirectReportsWithDisplayNames]
    [-IsVIP]
    [-OrganizationalUnit <OrganizationalUnitIdParameter>]
    [-PublicFolder]
    [-ReadFromDomainController]
    [-RecipientTypeDetails <RecipientTypeDetails[]>]
    [-ResultSize <Unlimited>]
    [-Sortby <String>]
    [-SupervisoryReviewPolicy]
    [<CommonParameters>]

Description

Examples

Example 1

Get-User -ResultSize unlimited

Example 2

Get-User -Identity "Coy Damon" | Format-List

Example 3

Get-User -OrganizationalUnit "Marketing"

Example 4

Get-User -Filter "Title -like 'Manager*'"

Parameters

-Anr

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection

The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are:

• CommonName (CN)
• DisplayName
• FirstName
• LastName
• Alias

Parameter properties

Parameter sets

-Arbitration

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

This parameter is available only in on-premises Exchange.

The Arbitration switch is required to return arbitration mailboxes in the results. You don't need to specify a value with this switch.

Arbitration mailboxes are system mailboxes that are used for storing different types of system data and for managing messaging approval workflow.

To return arbitration mailboxes that are used to store audit log settings or data, don't use this switch. Instead, use the AuditLog or AuxAuditLog switches.

Parameter properties

Parameter sets

-AuditLog

Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE

This parameter is available only in on-premises Exchange.

The AuditLog switch is required to return audit log mailboxes in the results. You don't need to specify a value with this switch.

Audit log mailboxes are arbitration mailboxes that are used to store audit log settings.

To return other types of arbitration mailboxes, don't use this switch. Instead, use the Arbitration switch.

Parameter properties

Parameter sets

-AuxAuditLog

Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE

This parameter is available only in on-premises Exchange.

The AuxAuditLog switch is required to return auxiliary audit log mailboxes in the results. You don't need to specify a value with this switch.

Audit log mailboxes are arbitration mailboxes that are used to store audit log settings.

To return other types of arbitration mailboxes, don't use this switch. Instead, use the Arbitration switch.

Parameter properties

Parameter sets

-Credential

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

This parameter is available only in on-premises Exchange.

The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions.

A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value (Get-Credential). Or, before you run this command, store the credentials in a variable (for example, $cred = Get-Credential) and then use the variable name ($cred) for this parameter. For more information, see Get-Credential.

Parameter properties

Parameter sets

-DomainController

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

This parameter is available only in on-premises Exchange.

The DomainController parameter specifies the ___domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the ___domain controller by its fully qualified ___domain name (FQDN). For example, dc01.contoso.com.

Parameter properties

Parameter sets

-Filter

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection

The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax "Property -ComparisonOperator 'Value'".

• 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 this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables.
• Property is a filterable property. For more information about the filterable properties in Exchange server and Exchange Online, see Filterable properties for the Filter parameter.
• ComparisonOperator is an OPATH comparison operator (for example -eq for equals and -like for string comparison). For more information about comparison operators, see about_Comparison_Operators.
• Value is the property value to search for. Enclose text values and variables in single quotation marks ('Value' or '$Variable'). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of '$User', use '$($User -Replace "'","''")'. Don't enclose integers or system values in quotation marks (for example, use 500, $true, $false, or $null instead).

You can chain multiple search criteria together using the logical operators -and and -or. For example, "Criteria1 -and Criteria2" or "(Criteria1 -and Criteria2) -or Criteria3".

For detailed information about OPATH filters in Exchange, see Additional OPATH syntax information.

Parameter properties

Parameter sets

-Identity

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection

The Identity parameter specifies the user that you want to view. You can use any value that uniquely identifies the user. For example:

• Name
• User principal name (UPN)
• Distinguished name (DN)
• Canonical DN
• GUID

Parameter properties

Parameter sets

-IgnoreDefaultScope

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

This parameter is available only in on-premises Exchange.

The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch.

This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions:

• You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically.
• You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted.

Parameter properties

Parameter sets

-IncludeDirectReportsWithDisplayNames

Applicable: Exchange Online, Exchange Online Protection

This parameter is available only in the cloud-based service.

{{ Fill IncludeDirectReportsWithDisplayNames Description }}

Parameter properties

Parameter sets

-IsVIP

Applicable: Exchange Online, Exchange Online Protection

This parameter is available only in the cloud-based service.

The IsVIP switch filters the results by priority accounts. You don't need to specify a value with this switch.

For more information about priority accounts, see Manage and monitor priority accounts.

Parameter properties

Parameter sets

-OrganizationalUnit

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection

The OrganizationalUnit parameter filters the results based on the object's ___location in Active Directory. Only objects that exist in the specified ___location are returned. Valid input for this parameter is an organizational unit (OU) or ___domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or ___domain. For example:

• Name
• Canonical name
• Distinguished name (DN)
• GUID

Parameter properties

Parameter sets

-PublicFolder

Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance

The PublicFolder switch is required to return public folder mailboxes in the results. You don't need to specify a value with this switch.

Public folder mailboxes are specially designed mailboxes that store the hierarchy and content of public folders.

Parameter properties

Parameter sets

-ReadFromDomainController

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

This parameter is available only in on-premises Exchange.

The ReadFromDomainController switch specifies that information should be read from a ___domain controller in the user's ___domain. You don't need to specify a value with this switch.

The command: Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information.

By default, the recipient scope is set to the ___domain that hosts your Exchange servers.

Parameter properties

Parameter sets

-RecipientTypeDetails

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection

The RecipientTypeDetails parameter filters the results by the specified user subtype. Valid values are:

• DisabledUser
• DiscoveryMailbox
• EquipmentMailbox
• GuestMailUser (Exchange 2016 or later and cloud)
• GroupMailbox (Exchange 2013 only)
• LegacyMailbox
• LinkedMailbox
• LinkedRoomMailbox (Exchange 2013 or later and cloud)
• LinkedUser
• MailUser
• PublicFolderMailbox (Exchange 2013 or later and cloud)
• RemoteEquipmentMailbox
• RemoteRoomMailbox
• RemoteSharedMailbox
• RemoteTeamMailbox (Exchange 2013 or later and cloud)
• RemoteUserMailbox
• RoomMailbox
• SchedulingMailbox (Exchange 2016 or later and cloud)
• SharedMailbox
• SharedWithMailUser (cloud only)
• TeamMailbox (Exchange 2013 or later and cloud)
• User
• UserMailbox

You can specify multiple values separated by commas.

Parameter properties

Parameter sets

-ResultSize

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection

The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.

Parameter properties

Parameter sets

-Sortby

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection

The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order.

If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto Property1,Property2,...PropertyX. to create a new view that contains all of the properties that you want to see. Wildcards (*) in the property names are supported.

You can sort by the following properties:

• Name
• DisplayName
• City
• FirstName
• LastName
• Office

Parameter properties

Parameter sets

-SupervisoryReviewPolicy

Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE

This parameter is available only in on-premises Exchange.

This parameter is reserved for internal Microsoft use.

Parameter properties

Parameter sets

CommonParameters

Inputs

Input types

Outputs

Output types