< Back
New-vRABusinessGroup
Post
NAME New-vRABusinessGroup
SYNOPSIS
Create a vRA Business Group
SYNTAX
New-vRABusinessGroup [-TenantId <String>] -Name <String> [-Description <String>] [-BusinessGroupManager
<String[]>] [-SupportUser <String[]>] [-SharedAccessUser <String[]>] [-User <String[]>] [-MachinePrefixId
<String>] -SendManagerEmailsTo <String> [-WhatIf] [-Confirm] [<CommonParameters>]
New-vRABusinessGroup [-TenantId <String>] -JSON <String> [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Create a vRA Business Group
PARAMETERS
-TenantId <String>
Tenant ID
Required? false
Position? named
Default value $Global:vRAConnection.Tenant
Accept pipeline input? false
Accept wildcard characters? false
-Name <String>
Business Group Name
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Description <String>
Business Group Description
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-BusinessGroupManager <String[]>
Business Group Managers
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SupportUser <String[]>
Business Group Support Users
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SharedAccessUser <String[]>
Business Group Shared Access Users
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-User <String[]>
Business Group Users
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MachinePrefixId <String>
Machine Prefix Id
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SendManagerEmailsTo <String>
Send Manager Emails To
Required? true
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-vRABusinessGroup -TenantId Tenant01 -Name BusinessGroup01 -Description "Business Group 01"
-BusinessGroupManager "busgroupmgr01@vrademo.local","busgroupmgr02@vrademo.local" -SupportUser
"supportusers@vrademo.local" `
-User "basicusers@vrademo.local" -MachinePrefixId "87e99513-cbea-4589-8678-c84c5907bdf2" -SendManagerEmailsTo
"busgroupmgr01@vrademo.local"
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>New-vRABusinessGroup -TenantId Tenant01 -Name BusinessGroup02 -Description "Business Group 02"
-BusinessGroupManager "busgroupmgr02@vrademo.local" -SharedAccessUser "sharedaccess01@vrademo.local" `
-SendManagerEmailsTo "busgroupmgr02@vrademo.local"
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>$JSON = @"
{
"name": "BusinessGroup01",
"description": "Business Group 01",
"subtenantRoles": [ {
"name": "Business Group Manager",
"scopeRoleRef" : "CSP_SUBTENANT_MANAGER",
"principalId": [
{
"domain": "vrademo.local",
"name": "busgroupmgr01"
},
{
"domain": "vrademo.local",
"name": "busgroupmgr02"
}
]
},
{
"name": "Basic User",
"scopeRoleRef": "CSP_CONSUMER",
"principalId": [
{
"domain": "vrademo.local",
"name": "basicusers"
}
]
} ,
{
"name": "Support User",
"scopeRoleRef": "CSP_SUPPORT",
"principalId": [
{
"domain": "vrademo.local",
"name": "supportusers"
}
]
} ],
"extensionData": {
"entries": [
{
"key": "iaas-machine-prefix",
"value": {
"type": "string",
"value": "87e99513-cbea-4589-8678-c84c5907bdf2"
}
},
{
"key": "iaas-manager-emails",
"value": {
"type": "string",
"value": "busgroupmgr01@vrademo.local"
}
}
]
},
"tenant": "Tenant01"
}
"@
$JSON | New-vRABusinessGroup -TenantId Tenant01
RELATED LINKS
SYNOPSIS
Create a vRA Business Group
SYNTAX
New-vRABusinessGroup [-TenantId <String>] -Name <String> [-Description <String>] [-BusinessGroupManager
<String[]>] [-SupportUser <String[]>] [-SharedAccessUser <String[]>] [-User <String[]>] [-MachinePrefixId
<String>] -SendManagerEmailsTo <String> [-WhatIf] [-Confirm] [<CommonParameters>]
New-vRABusinessGroup [-TenantId <String>] -JSON <String> [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Create a vRA Business Group
PARAMETERS
-TenantId <String>
Tenant ID
Required? false
Position? named
Default value $Global:vRAConnection.Tenant
Accept pipeline input? false
Accept wildcard characters? false
-Name <String>
Business Group Name
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Description <String>
Business Group Description
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-BusinessGroupManager <String[]>
Business Group Managers
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SupportUser <String[]>
Business Group Support Users
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SharedAccessUser <String[]>
Business Group Shared Access Users
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-User <String[]>
Business Group Users
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MachinePrefixId <String>
Machine Prefix Id
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SendManagerEmailsTo <String>
Send Manager Emails To
Required? true
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-vRABusinessGroup -TenantId Tenant01 -Name BusinessGroup01 -Description "Business Group 01"
-BusinessGroupManager "busgroupmgr01@vrademo.local","busgroupmgr02@vrademo.local" -SupportUser
"supportusers@vrademo.local" `
-User "basicusers@vrademo.local" -MachinePrefixId "87e99513-cbea-4589-8678-c84c5907bdf2" -SendManagerEmailsTo
"busgroupmgr01@vrademo.local"
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>New-vRABusinessGroup -TenantId Tenant01 -Name BusinessGroup02 -Description "Business Group 02"
-BusinessGroupManager "busgroupmgr02@vrademo.local" -SharedAccessUser "sharedaccess01@vrademo.local" `
-SendManagerEmailsTo "busgroupmgr02@vrademo.local"
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>$JSON = @"
{
"name": "BusinessGroup01",
"description": "Business Group 01",
"subtenantRoles": [ {
"name": "Business Group Manager",
"scopeRoleRef" : "CSP_SUBTENANT_MANAGER",
"principalId": [
{
"domain": "vrademo.local",
"name": "busgroupmgr01"
},
{
"domain": "vrademo.local",
"name": "busgroupmgr02"
}
]
},
{
"name": "Basic User",
"scopeRoleRef": "CSP_CONSUMER",
"principalId": [
{
"domain": "vrademo.local",
"name": "basicusers"
}
]
} ,
{
"name": "Support User",
"scopeRoleRef": "CSP_SUPPORT",
"principalId": [
{
"domain": "vrademo.local",
"name": "supportusers"
}
]
} ],
"extensionData": {
"entries": [
{
"key": "iaas-machine-prefix",
"value": {
"type": "string",
"value": "87e99513-cbea-4589-8678-c84c5907bdf2"
}
},
{
"key": "iaas-manager-emails",
"value": {
"type": "string",
"value": "busgroupmgr01@vrademo.local"
}
}
]
},
"tenant": "Tenant01"
}
"@
$JSON | New-vRABusinessGroup -TenantId Tenant01
RELATED LINKS