New-RdsAppGroup

Reference

Module:: WindowsVirtualDesktopPowershell

Creates an app group.

Syntax

New-RdsAppGroup
   [-TenantName] <String>
   [-HostPoolName] <String>
   [-Name] <String>
   [-Description <String>]
   [-FriendlyName <String>]
   [-ResourceType <AppGroupResource>]
   [<CommonParameters>]

Description

The New-RdsAppGroup cmdlet creates a new app group within the specified host pool.

You can create as many RemoteApp app groups within a host pool as you would like, but you can have only one desktop app group within a host pool. A default "Desktop Application Group" is automatically created Whenever you create a new host pool, so you must remove the app group first if you would like to create a new desktop app group.

You can specify the type of the app group using the resource type parameter. If you do not specify this parameter, a RemoteApp app group is created by default.

Examples

Example 1: Create a RemoteApp app group

PS C:\> New-RdsAppGroup -TenantName "contoso" -HostPoolName "contosoHostPool" -Name "officeApps" -ResourceType RemoteApp

TenantGroupName : Default Tenant Group
TenantName      : contoso
HostPoolName    : contosoHostPool
AppGroupName    : officeApps
Description     :
FriendlyName    :
ResourceType    : RemoteApp

This command creates a new RemoteApp app group in the host pool. You can now run New-RdsRemoteApp to publish RemoteApps to the app group, along with Add-RdsAppGroupUser to assign users to the app group.

Example 2: Create a desktop app group

PS C:\> New-RdsAppGroup -TenantName "contoso" -HostPoolName "contosoHostPool" -Name "sharedDesktops" -ResourceType Desktop

TenantGroupName : Default Tenant Group
TenantName      : contoso
HostPoolName    : contosoHostPool
AppGroupName    : sharedDesktops
Description     :
FriendlyName    :
ResourceType    : Desktop

This command creates a new RemoteApp app group in the host pool. You can now run Add-RdsAppGroupUser to assign users to the app group.

Parameters

-Description

A 512 character string that describes the AppGroup 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, which must be unique in the host pool.

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

-ResourceType

A switch with two potential values:

Desktop, to publish a desktop
RemoteApp, to publish one or more RemoteApps

Type:	AppGroupResource
Accepted values:	RemoteApp, Desktop
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
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