< Back
New-vRAGroupPrincipal
Post
NAME New-vRAGroupPrincipal
SYNOPSIS
Create a vRA custom group
SYNTAX
New-vRAGroupPrincipal [-Tenant <String>] -Name <String> [-Description <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
New-vRAGroupPrincipal -JSON <String> [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Create a vRA Principal (user)
PARAMETERS
-Tenant <String>
The tenant of the group
Required? false
Position? named
Default value $Global:vRAConnection.Tenant
Accept pipeline input? false
Accept wildcard characters? false
-Name <String>
Group name
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Description <String>
A description for the group
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-JSON <String>
Body text to send in JSON format
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
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
System.Management.Automation.PSObject
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-vRAGroupPrincipal -Name TestGroup01 -Description "Test Group 01"
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>$JSON = @"
{
"@type": "Group",
"groupType": "CUSTOM",
"name": "TestGroup01",
"fqdn": "TestGroup01@Tenant",
"domain": "Tenant",
"description": "Test Group 01",
"principalId": {
"domain": "Tenant",
"name": "TestGroup01"
}
}
"@
RELATED LINKS
SYNOPSIS
Create a vRA custom group
SYNTAX
New-vRAGroupPrincipal [-Tenant <String>] -Name <String> [-Description <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
New-vRAGroupPrincipal -JSON <String> [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Create a vRA Principal (user)
PARAMETERS
-Tenant <String>
The tenant of the group
Required? false
Position? named
Default value $Global:vRAConnection.Tenant
Accept pipeline input? false
Accept wildcard characters? false
-Name <String>
Group name
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Description <String>
A description for the group
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-JSON <String>
Body text to send in JSON format
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
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
System.Management.Automation.PSObject
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-vRAGroupPrincipal -Name TestGroup01 -Description "Test Group 01"
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>$JSON = @"
{
"@type": "Group",
"groupType": "CUSTOM",
"name": "TestGroup01",
"fqdn": "TestGroup01@Tenant",
"domain": "Tenant",
"description": "Test Group 01",
"principalId": {
"domain": "Tenant",
"name": "TestGroup01"
}
}
"@
RELATED LINKS