Citrix Virtual Apps and Desktops SDK

Get-BrokerMergeGroup

Introduced in: Citrix Virtual Apps and Desktop 7 2407

A group of resources shown as a single resource to an end user.

Syntax

Get-BrokerMergeGroup
   [[-Name] <String>]
   [-DefaultResourceUid <Int32>]
   [-Description <String>]
   [-PublishedName <String>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Get-BrokerMergeGroup
   [-Uid] <Int32>
   [-Property <String[]>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

This can be used for selectively rolling out different versions of resources to end users.

————————– BrokerMergeGroup Object

The BrokerMergeGroup object represents a single instance of a MergeGroup containing 0 or more resources. It contains the following properties:

  • DefaultResourceUid (System.Int32?)

    Resource Uid of the MergedResource that represents this Merge Group

  • Description (System.String)

    Description of the Merge Group (optional)

  • Name (System.String)

    Name of the Merge Group

  • PublishedName (System.String)

    Published name of Merge Group as seen by end user

  • Uid (System.Int32)

    The Uid of the Merge Group

Examples

EXAMPLE 1

Gets the Merge Group with the Uid 1

Get-BrokerMergeGroup -Uid 1
<!--NeedCopy-->

Parameters

-Uid

The Uid of the Merge Group

Type: Int32
Position: 2
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-Name

Name of the Merge Group

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

-DefaultResourceUid

Resource Uid of the MergedResource that represents this Merge Group

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Description

Description of the Merge Group (optional)

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-PublishedName

Published name of Merge Group as seen by end user. If not specified

value used defaults to the administrative name.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-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

Citrix.Broker.Admin.SDK.MergeGroup

String

Outputs

Citrix.Broker.Admin.SDK.MergeGroup

Get-BrokerMergeGroup