Set-RdsTenantGroup
Sets properties for a tenant group.
Syntax
Default (Default)
Set-RdsTenantGroup
[-Name] <String>
[-FriendlyName <String>]
[-Description <String>]
[<CommonParameters>]
Description
The Set-RdsTenantGroup cmdlet sets properties for the specified tenant group.
Examples
Example 1: Set properties for the tenant group
PS C:\> Set-RdsTenantGroup -Name "contosoTenantGroup" -FriendlyName "Contoso TG" -Description "A custom tenant group for Contoso"
TenantGroupName FriendlyName Description
--------------- ------------ -----------
contosoTenantGroup Contoso TG A custom tenant group for Contoso
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 group.
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.