Citrix Virtual Apps and Desktops SDK

New-BrokerMergeGroup

Introduced in: Citrix Virtual Apps and Desktop 7 2407

Creates a Merge Group

Syntax

New-BrokerMergeGroup
   [-Description <String>]
   [-Name] <String>
   [-PublishedName <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Creates a Merge Group with the specified Name and Description (optional)

Examples

EXAMPLE 1

Creates a Merge Group called ZoneAMergeGroup and with a Description of Merge Group for the Resouces in Zone A

New-BrokerMergeGroup -Name 'ZoneAMergeGroup' -Description 'Merge Group for the Resouces in Zone A'
<!--NeedCopy-->

Parameters

-Name

Name of the Merge Group

Type: String
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
Length range: 1 to 64
Disallowed characters: /;:#.*?=<>\|[]()"'`\ and all ASCII control characters

-Description

Description of the Merge Group (optional)

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
Length range: 1 to 512

-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: True (ByPropertyName)
Accept wildcard characters: True
Length range: 1 to 255
Disallowed characters: /;:#.*?=<>\|[]()"'\ and all ASCII control characters

-LoggingId

Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop Director typically create High Level Operations. PowerShell scripts can also wrap a series of cmdlet calls in a High Level Operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

Type: Guid
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

You cannot pipe input into this cmdlet.

Outputs

Citrix.Broker.Admin.SDK.MergeGroup

New-BrokerMergeGroup returns the created Merge Group.

Notes

DefaultResourceUid cannot be set using the New-BrokerMergeGroup because no resource exists in the Merge Group at the time of the creation

New-BrokerMergeGroup