< Back

Get-vRAUserPrincipalGroupMembership

Sat Jan 18, 2020 10:00 pm

NAME Get-vRAUserPrincipalGroupMembership



SYNOPSIS

Retrieve a list of groups that a user is a member of





SYNTAX

Get-vRAUserPrincipalGroupMembership [-Id] <String[]> [[-Tenant] <String>] [[-GroupType] <String>] [[-Limit]

<Int32>] [[-Page] <Int32>] [<CommonParameters>]





DESCRIPTION

Retrieve a list of groups that a user is a member of





PARAMETERS

-Id <String[]>

The Id of the user



Required? true

Position? 1

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-Tenant <String>

The tenant of the user



Required? false

Position? 2

Default value $Global:vRAConnection.Tenant

Accept pipeline input? false

Accept wildcard characters? false



-GroupType <String>

Return either custom or sso groups



Required? false

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Limit <Int32>

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



Required? false

Position? 4

Default value 100

Accept pipeline input? false

Accept wildcard characters? false



-Page <Int32>

The page of response to return. By default this is 1.



Required? false

Position? 5

Default value 1

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

System.Int





OUTPUTS

System.Management.Automation.PSObject.





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



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













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



PS C:\\>Get-vRAUserPrincipal -Id user@vsphere.local | Get-vRAUserPrincipalGroupMembership -GroupType SSO













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



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













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



PS C:\\>Get-vRAUserPrincipalGroupMembership -UserPrincipal user@vsphere.local















RELATED LINKS