Get-RdsAppGroup

Reference

Module:: WindowsVirtualDesktopPowershell

Gets the properties of an app group.

Syntax

Get-RdsAppGroup
   [-TenantName] <String>
   [-HostPoolName] <String>
   [-Name <String>]
   [<CommonParameters>]

Description

The Get-RdsAppGroup cmdlet gets the properties of the specified app group. If you do not specify an app group name, this cmdlet returns properties for all app groups in the specified hostpool.

Examples

Example 1: Get all app groups in the specified host pool

PS C:\> Get-RdsAppGroup -TenantName "contoso" -HostPoolName "contosoHostPool"

TenantGroupName : Default Tenant Group
TenantName      : contoso
HostPoolName    : contosoHostPool
AppGroupName    : Desktop Application Group
Description     : The default desktop application group for the session host pool
FriendlyName    : Desktop Application Group
ResourceType    : Desktop

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

This command gets the properties of all app groups in the specified tenant and host pool that are authorized for the current user.

Example 2: Get a specific app group

PS C:\> Get-RdsAppGroup -TenantName "contoso" -HostPoolName "contosoHostPool" -Name "Desktop Application Group"

TenantGroupName : Default Tenant Group
TenantName      : contoso
HostPoolName    : contosoHostPool
AppGroupName    : Desktop Application Group
Description     : The default desktop application group for the session host pool
FriendlyName    : Desktop Application Group
ResourceType    : Desktop

This command gets the properties of the specified app group in the host pool. The app group and its properties are displayed only if the app group exists in the host pool and the current user is properly authorized.

Parameters

-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:	Named
Default value:	None
Required:	False
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