< Back
Remove-vRAUserPrincipal
Post
NAME Remove-vRAUserPrincipal
SYNOPSIS
Remove a vRA local user principal
SYNTAX
Remove-vRAUserPrincipal [-Id] <String[]> [[-Tenant] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Remove a vRA local user principal
PARAMETERS
-Id <String[]>
The principal 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
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
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
None
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Remove-vRAUserPrincipal -PrincipalId user@vsphere.local
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-vRAUserPrincipal -Id user@vsphere.local | Remove-vRAUserPrincipal
RELATED LINKS
SYNOPSIS
Remove a vRA local user principal
SYNTAX
Remove-vRAUserPrincipal [-Id] <String[]> [[-Tenant] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Remove a vRA local user principal
PARAMETERS
-Id <String[]>
The principal 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
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
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
None
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Remove-vRAUserPrincipal -PrincipalId user@vsphere.local
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-vRAUserPrincipal -Id user@vsphere.local | Remove-vRAUserPrincipal
RELATED LINKS