Remove-RdsAppGroup
Removes an app group from a host pool.
Syntax
Default (Default)
Remove-RdsAppGroup
[-TenantName] <String>
[-HostPoolName] <String>
[-Name] <String>
[<CommonParameters>]
Description
The Remove-RdsAppGroup cmdlet removes an app group from the specified host pool. If the specified app group is a RemoteApp app group, you must first remove all RemoteApps published to the app group before running this command.
Examples
Example 1
PS C:\> Remove-RdsAppGroup -TenantName "contoso" -HostPoolName "contosoHostPool" -Name "officeApps"
This command removes an app group in the host pool.
Parameters
-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.
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 |
-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.