Get-​Azure​Rm​AD​User

Filters active directory users.

Syntax

Get-AzureRmADUser
   -Mail <String>
   [<CommonParameters>]
Get-AzureRmADUser
   -ObjectId <Guid>
   [<CommonParameters>]
Get-AzureRmADUser
   -SearchString <String>
   [<CommonParameters>]
Get-AzureRmADUser
   [-UserPrincipalName <String>]
   [<CommonParameters>]
Get-AzureRmADUser
   -UserPrincipalName <String>
   [<CommonParameters>]

Description

Filters active directory users.

Examples

-------------------------- Filters users using UPN --------------------------

PS C:\> Get-AzureRmADUser -UPN foo@domain.com

Gets user with foo@domain.com

-------------------------- Filters users using Search String --------------------------

PS C:\> Get-AzureRmADUser -SearchString Joe

Filters all ad users that has Joe in the display name.

-------------------------- List AD users --------------------------

PS C:\> Get-AzureRmADUser

Gets all AD users

Required Parameters

-Mail
Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ObjectId

Object id of the user.

Type:Guid
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-SearchString

The user display name

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-UserPrincipalName

UPN of the user.

Type:String
Aliases:UPN
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False