< Back
Get-vRAGroupPrincipal
Post
NAME Get-vRAGroupPrincipal
SYNOPSIS
Finds groups.
SYNTAX
Get-vRAGroupPrincipal [-Tenant <String>] [-Limit <String>] [<CommonParameters>]
Get-vRAGroupPrincipal -Id <String[]> [-Tenant <String>] [<CommonParameters>]
DESCRIPTION
Finds groups in one of the identity providers configured for the tenant.
PARAMETERS
-Id <String[]>
The Id of the group
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Tenant <String>
The tenant of the group
Required? false
Position? named
Default value $Global:vRAConnection.Tenant
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-vRAGroupPrincipal
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-vRAGroupPrincipal -Id group@vsphere.local
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-vRAGroupPrincipal -PrincipalId group@vsphere.local
RELATED LINKS
SYNOPSIS
Finds groups.
SYNTAX
Get-vRAGroupPrincipal [-Tenant <String>] [-Limit <String>] [<CommonParameters>]
Get-vRAGroupPrincipal -Id <String[]> [-Tenant <String>] [<CommonParameters>]
DESCRIPTION
Finds groups in one of the identity providers configured for the tenant.
PARAMETERS
-Id <String[]>
The Id of the group
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Tenant <String>
The tenant of the group
Required? false
Position? named
Default value $Global:vRAConnection.Tenant
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-vRAGroupPrincipal
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-vRAGroupPrincipal -Id group@vsphere.local
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-vRAGroupPrincipal -PrincipalId group@vsphere.local
RELATED LINKS