Set-RdsTenantGroup

Reference

Module:: WindowsVirtualDesktopPowershell

Sets properties for a tenant group.

Syntax

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.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-FriendlyName

A 256 character string that is intended for display to end users. Any character is allowed.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

The name of the tenant group.

Type:	String
Aliases:	TenantGroupName
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

Inputs

System.String

Outputs

Microsoft.RDInfra.RDManagementData.RdMgmtTenantGroup