New-RdsAppGroup
Creates an app group.
Syntax
Default (Default)
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| 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: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-HostPoolName
The name of the host pool.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Name
The name of the app group, which must be unique in the host pool.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AppGroupName |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ResourceType
A switch with two potential values:
- Desktop, to publish a desktop
- RemoteApp, to publish one or more RemoteApps
Parameter properties
| Type: | AppGroupResource |
| Default value: | None |
| Accepted values: | RemoteApp, Desktop |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TenantName
The name of the tenant.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
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.