Commands › Exchange Online

Get-MailUser

Exchange Online ExchangeOnlineManagement Get-*

View mail users and also guest users for Microsoft 365 Groups in cloud environments.

Quick start script

# Get-MailUser — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org

# 2. Run and inspect
Get-MailUser | Format-List

# 3. Export for evidence / drift tracking
Get-MailUser | Export-Clixml .\MailUser-$(Get-Date -Format yyyyMMdd).xml

Syntax — 3 parameter sets

AnrSet

Get-MailUser [-Anr <String>]
 [-Credential <PSCredential>]
 [-DomainController <Fqdn>]
 [-Filter <String>]
 [-IgnoreDefaultScope]
 [-OrganizationalUnit <OrganizationalUnitIdParameter>]
 [-ReadFromDomainController]
 [-ResultSize <Unlimited>]
 [-SharedWithMailUser]
 [-SoftDeletedMailUser]
 [-SortBy <String>]
 [<CommonParameters>]

Identity

Get-MailUser [[-Identity] <MailUserIdParameter>]
 [-Credential <PSCredential>]
 [-DomainController <Fqdn>]
 [-Filter <String>]
 [-IgnoreDefaultScope]
 [-OrganizationalUnit <OrganizationalUnitIdParameter>]
 [-ReadFromDomainController]
 [-ResultSize <Unlimited>]
 [-SharedWithMailUser]
 [-SoftDeletedMailUser]
 [-SortBy <String>]
 [<CommonParameters>]

HVEAccount

Get-MailUser [-HVEAccount]
 [-Filter <String>]
 [-OrganizationalUnit <OrganizationalUnitIdParameter>]
 [-ResultSize <Unlimited>]
 [-SharedWithMailUser]
 [-SortBy <String>]
 [-SoftDeletedMailUser]
 [<CommonParameters>]

Parameters (13)

ParameterTypeRequiredWhat it controls
-Identity MailUserIdParameter The Identity parameter specifies the mail user that you want to view. You can use any value that uniquely identifies the mail user. For example:
-Anr String 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...
-Credential PSCredential This parameter is available only in on-premises Exchange.
-DomainController Fqdn This parameter is available only in on-premises Exchange.
-Filter String 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'"`.
-HVEAccount SwitchParameter This parameter is available only in the cloud-based service.
-IgnoreDefaultScope SwitchParameter This parameter is available only in on-premises Exchange.
-OrganizationalUnit OrganizationalUnitIdParameter 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...
-ReadFromDomainController SwitchParameter This parameter is available only in on-premises Exchange.
-ResultSize Unlimited 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.
-SharedWithMailUser SwitchParameter This parameter is available only in the cloud-based service.
-SortBy String 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.
-SoftDeletedMailUser SwitchParameter This parameter is available only in the cloud-based service.

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.