New-RdsTenantGroup
Creates a new tenant group.
Syntax
Default (Default)
New-RdsTenantGroup
[-Name] <String>
[-FriendlyName <String>]
[-Description <String>]
[<CommonParameters>]
Description
Creates a new tenant group within the deployment.
Examples
Example 1
PS C:\> New-RdsTenantGroup -Name "contosoTenantGroup"
TenantGroupName Description FriendlyName
--------------- ----------- ------------
contosoTenantGroup
This command creates a new tenant group in Windows Virtual Desktop.
Parameters
-Description
A 512 character string that describes the TenantGroup to help administrators. Any character is allowed
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-FriendlyName
A 256 character string that is intended for display to end users. Any character is allowed.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Name
The name of the tenant, which must be unique in Windows Virtual Desktop.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | TenantGroupName |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.