Set-RdsAppGroup

Reference

Module:: WindowsVirtualDesktopPowershell

Sets properties for an app group.

Syntax

Set-RdsAppGroup
   [-TenantName] <String>
   [-HostPoolName] <String>
   [-Name] <String>
   [-Description <String>]
   [-FriendlyName <String>]
   [<CommonParameters>]

Description

The Set-RdsAppGroup cmdlet sets properties for the specified app group.

Examples

Example 1: Set properties for the app group

PS C:\> Set-RdsAppGroup -TenantName "contoso" -HostPoolName "contosoHostPool" -Name "officeApps" -FriendlyName "Office" -Description "RemoteApp group for Office applications"

TenantGroupName : Microsoft Internal
TenantName      : contoso
HostPoolName    : contosoHostPool
AppGroupName    : officeApps
Description     : RemoteApp group for Office applications
FriendlyName    : Office
ResourceType    : RemoteApp

This command sets the properties for the app group.

Parameters

-Description

A 512 character string that describes the app group to help administrators. Any character is allowed.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
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:	False
Accept wildcard characters:	False

-HostPoolName

The name of the host pool.

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

-Name

The name of the app group.

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

-TenantName

The name of the tenant.

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

Inputs

System.String

Outputs

Microsoft.RDInfra.RDManagementData.RdMgmtAppGroup