Citrix Virtual Apps and Desktops SDK

New-BrokerMergedResource

Introduced in: Citrix Virtual Apps and Desktop 7 2407

Creates a new merged resource in the site.

Syntax

New-BrokerMergedResource
   [-ApplicationUid] <Int32>
   [-Description <String>]
   -MergeGroupUid <Int32>
   [-Users <User[]>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
New-BrokerMergedResource
   [-Description <String>]
   [-EntitlementPolicyRuleUid] <Int32>
   -MergeGroupUid <Int32>
   [-Users <User[]>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

This cmdlet creates a new merged resource in the site.

Examples

EXAMPLE 1

This command creates a new merged resource in the merge group with the unique identifier 1, and links it to the application with the unique identifier 1. The users “domain\user1” and “domain\user2” are entitled to the merged resource.

New-BrokerMergedResource -MergeGroupUid 1 -ApplicationUid 1 -Users @("domain\user1", "domain\user2")
<!--NeedCopy-->

Parameters

-ApplicationUid

The unique identifier of the application.

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

-EntitlementPolicyRuleUid

The unique identifier of the entitlement policy rule.

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

-MergeGroupUid

The unique identifier of the merge group.

Type: Int32
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Description

The description of the merged resource.

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

-Users

The users who are entitled to the merged resource.

Type: User[]
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-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.MergedResource

New-BrokerMergedResource returns the created Merged Resource.

Notes

A MergedResource can only be linked to either an Application or an EntitlementPolicyRule i.e. only ApplicationUid or EntitlementPolicyRuleUid can be specified in New-BrokerMergedResource

User parameter specifies the users entitled to the MergeGroup. AddUsers and RemoveUsers can be used to add or remove users entitled to the MergedResource

New-BrokerMergedResource