Get-vRAUserPrincipal

NAME Get-vRAUserPrincipal



SYNOPSIS

Finds regular users





SYNTAX

Get-vRAUserPrincipal [-Tenant <String>] [-LocalUsersOnly] [-Limit <String>] [<CommonParameters>]



Get-vRAUserPrincipal -Id <String[]> [-Tenant <String>] [<CommonParameters>]





DESCRIPTION

Finds regular users in one of the identity providers configured for the tenant.





PARAMETERS

-Id <String[]>

The Id of the user



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Tenant <String>

The tenant of the user



Required? false

Position? named

Default value $Global:vRAConnection.Tenant

Accept pipeline input? false

Accept wildcard characters? false



-LocalUsersOnly [<SwitchParameter>]

Only return local users



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Limit <String>

The number of entries returned per page from the API. This has a default value of 100.



Required? false

Position? named

Default value 100

Accept pipeline input? false

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 (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.String





OUTPUTS

System.Management.Automation.PSObject.





-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Get-vRAUserPrincipal













-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get-vRAUserPrincipal -LocalUsersOnly













-------------------------- EXAMPLE 3 --------------------------



PS C:\\>Get-vRAUserPrincipal -Id user@vsphere.local













-------------------------- EXAMPLE 4 --------------------------



PS C:\\>Get-vRAUserPrincipal -UserName user@vsphere.local













-------------------------- EXAMPLE 5 --------------------------



PS C:\\>Get-vRAUserPrincipal -PrincipalId user@vsphere.local















RELATED LINKS