Get-BrokerDesktopGroupAppDisk

Last published : Oct 31, 2026
Gets the AppDisks that are being used by desktop group
Related information
about_Broker_AccessPolicy

Syntax

Get-BrokerDesktopGroupAppDisk
   [[-DesktopGroupName] <String>]
   [-AppDiskUid <Guid>]
   [-AppDnaCompatibility <AppDnaCompatibility>]
   [-DesktopGroupUid <Int32>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]

Description

The Get-BrokerDesktopGroupAppDisk cmdlet returns all the AppDisks that are currently being used by the desktop groups and if they are compatible with their desktop group
-------------------------- BrokerDesktopGroupAppDisk Object
The BrokerDesktopGroupAppDisk object represents a single instance of a desktop group and AppDisk and if they are compatible
  • AppDiskUid (System.Guid)
    The Uid of the AppDisk
  • AppDnaCompatibility (Citrix.Broker.Admin.SDK.AppDnaCompatibility?)
    Specifies if the AppDisk is compatible with the desktop group
  • DesktopGroupName (System.String)
    The name of the desktop group
  • DesktopGroupUid (System.Int32)
    The Uid of the desktop group

Examples

EXAMPLE 1

Gets all the AppDisks that are assocated to the desktop group MyGroup
Get-BrokerDesktopGroupAppDisk -DesktopGroupName MyGroup

Parameters

-DesktopGroupName

Gets only the entries that match the specified Desktop Group Name
Type: String
Position: 2
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-AppDiskUid

Gets only the entries that match the specified AppDisk Uid
Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-AppDnaCompatibility

Gets only the entries that match the specified AppDnaCompatibility
Type: AppDnaCompatibility
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-DesktopGroupUid

Gets only the entries that match the specified Desktop Group Uid
Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ReturnTotalRecordCount

When specified, this causes the cmdlet to output an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Broker_Filtering for details.
Type: SwitchParameter
Position: Named
Default value: False
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-MaxRecordCount

Specifies the maximum number of records to return.
Type: Int32
Position: Named
Default value: 250
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Skip

Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.
Type: Int32
Position: Named
Default value: 0
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SortBy

Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present.
Type: String
Position: Named
Default value: The default sort order is by name or unique identifier.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Filter

Gets records that match a PowerShell style filter expression. See about_Broker_Filtering for details.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-FilterScope

Gets only results allowed by the specified scope id.
Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Property

Specifies the properties to be returned. This is similar to piping the output of the command through Select-Object, but the properties are filtered more efficiently at the server.
Type: String[]
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Input cannot be piped to this cmdlet.

Outputs

Citrix.Broker.Admin.SDK.DesktopGroupAppDisk

Returns an object for each enumerated Desktop Group and AppDisk combination.