Get-AzureRmADUser

NAME Get-AzureRmADUser



SYNOPSIS

Filters active directory users.





SYNTAX

Get-AzureRmADUser [-DefaultProfile <IAzureContextContainer>] -Mail <String> [<CommonParameters>]



Get-AzureRmADUser [-DefaultProfile <IAzureContextContainer>] -ObjectId <Guid> [<CommonParameters>]



Get-AzureRmADUser [-DefaultProfile <IAzureContextContainer>] -SearchString <String> [<CommonParameters>]



Get-AzureRmADUser [-DefaultProfile <IAzureContextContainer>] [-UserPrincipalName <String>] [<CommonParameters>]



Get-AzureRmADUser [-DefaultProfile <IAzureContextContainer>] -UserPrincipalName <String> [<CommonParameters>]





DESCRIPTION

Filters active directory users.





PARAMETERS

-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Mail <String>





Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ObjectId <Guid>

Object id of the user.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-SearchString <String>

The user display name



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-UserPrincipalName <String>

UPN of the user.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS

System.Collections.Generic.List`1[Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADUser]







NOTES









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







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... rermaduser

New-AzureRmADUser

Set-AzureRmADUser

Remove-AzureRmADUser