Get-MsolUser

Syntax

Get-MsolUser
   [-ReturnDeletedUsers]
   [-City <String>]
   [-Country <String>]
   [-Department <String>]
   [-DomainName <String>]
   [-EnabledFilter <UserEnabledFilter>]
   [-State <String>]
   [-Synchronized]
   [-Title <String>]
   [-HasErrorsOnly]
   [-LicenseReconciliationNeededOnly]
   [-UnlicensedUsersOnly]
   [-UsageLocation <String>]
   [-SearchString <String>]
   [-MaxResults <Int32>]
   [-TenantId <Guid>]
   [<CommonParameters>]

Get-MsolUser
   -ObjectId <Guid>
   [-ReturnDeletedUsers]
   [-TenantId <Guid>]
   [<CommonParameters>]

Get-MsolUser
   [-ReturnDeletedUsers]
   -UserPrincipalName <String>
   [-TenantId <Guid>]
   [<CommonParameters>]

Get-MsolUser
   [-ReturnDeletedUsers]
   [-City <String>]
   [-Country <String>]
   [-Department <String>]
   [-DomainName <String>]
   [-EnabledFilter <UserEnabledFilter>]
   [-State <String>]
   [-Synchronized]
   [-Title <String>]
   [-HasErrorsOnly]
   [-LicenseReconciliationNeededOnly]
   [-UnlicensedUsersOnly]
   [-UsageLocation <String>]
   [-SearchString <String>]
   [-All]
   [-TenantId <Guid>]
   [<CommonParameters>]

Description

The Get-MsolUser cmdlet gets an individual user or list of users. Specify the ObjectId or UserPrincipalName parameter to get a specific user.

Examples

Example 1: Get all users

PS C:\> Get-MsolUser

This command retrieves all users in the company. It displays up to the default value of 500 results.

Example 2: Get enabled users

PS C:\> Get-MsolUser -EnabledFilter EnabledOnly -MaxResults 2000

This command gets up to 2000 enabled users.

Example 3: Get a user by UPN

PS C:\> Get-MsolUser -UserPrincipalName "[email protected]"

This command retrieves the user with the UPN [email protected].

Example 4: Get a user by object ID

PS C:\> Get-MsolUser -ObjectId aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb

This command retrieves a user that has the specified object ID.

Example 5: Get users by search String

PS C:\> Get-MsolUser -SearchString "David"

This command retrieves a list of users with David in the display name or email address.

Example 6: Get preferred data location of a user

PS C:\> Get-MsolUser -UserPrincipalName "[email protected]" | Select PreferredDataLocation

This command returns the preferred data location of a user.

Parameters

-All

-City

-Country

-Department

-DomainName

-EnabledFilter

-HasErrorsOnly

-LicenseReconciliationNeededOnly

-MaxResults

-ObjectId

-ReturnDeletedUsers

-SearchString

-State

-Synchronized

-TenantId

-Title

-UnlicensedUsersOnly

-UsageLocation

-UserPrincipalName

Outputs

Microsoft.Online.Administration.User

This cmdlet returns user objects, which include the following information:

• AlternateEmailAddresses. Alternate email address of the user (external to Azure Active Directory).

• BlockCredential. Whether or not the user is able to sign in.

• City. The user's city.

• Country. The user's country or region.

• Department. The user's department.

• DisplayName. The user's display name.

• Errors. An array of errors. These are validation errors that may result in loss of services.

• Fax. The user's fax number.

• FirstName. The user's first name.

• ImmutableID. Only returned for federated users. This is the ID that is required to be federated with Azure Active Directory.

• isBlackBerryUser. Returns whether or not the user has a BlackBerry device.

• isLicensed. Whether or not the user has any licenses assigned.

• LastDirSyncTime. The date and time of the last directory synchronization (only returned from users synced with Azure Active Directory through Active Directory synchronization).

• LastPasswordChangeTimestamp. The most recent time at which a password change for the user was registered in Azure Active Directory.

• LastName. The user's last name.

• LicenseReconciliationNeeded. Whether or not the user currently has a mailbox without a license. In this case, the user should be licensed with 30 days to avoid losing their mailbox.

• Licenses. A list of the user's licenses.

• LiveID. The user's unique login ID.

• MobilePhone. The user's mobile phone number.

• ObjectId. The user's unique ID.

• Office. The user's office number.

• OverallProvisioningStatus. Whether or not the user has been provisioned for their services.

• PasswordNeverExpires. Whether the user's password should be forced to change every 90 days.

• PhoneNumber. The user's phone number.

• PostalCode. The user's postal code.

• PreferredDataLocation. The user's preferred data location.

• PreferredLanguage. The user's preferred language.

• ProxyAddresses. The proxy addresses associated with this user.

• State. The user's state.

• StreetAddress. The user's street address.

• StrongPasswordRequired. Whether the user is required to set a strong password when they change their password. Strong passwords are recommended.

• Title. The user's title.

• UsageLocation. The country or region where the services are consumed by the user. This must be a two letter country or region code.

• UserPrincipalName. The user ID of the user.

• ValidationStatus. Whether or not the user has any errors.

Related Links

• New-MsolUser
• Remove-MsolUser
• Restore-MsolUser
• Set-MsolUser