Set-BrokerMergedResource
Introduced in: Citrix Virtual Apps and Desktop 7 2407
Sets the properties of a MergedResource.
Syntax
Set-BrokerMergedResource
[-InputObject] <MergedResource[]>
[-PassThru]
[-AddUsers <User[]>]
[-Description <String>]
[-RemoveUsers <User[]>]
[-Users <User[]>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
This cmdlet sets the properties of a MergedResource object.
Examples
EXAMPLE 1
This command sets the description of all the merged resources in the merge group named "MyMergeGroup" to "My new description".
$resource = Get-BrokerMergedResource -MergeGroupName "MyMergeGroup"
$resource | Set-BrokerMergedResource -Description "My new description"
Parameters
-InputObject
Specifies the MergedResource object to be modified.
| Type: | MergedResource[] |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-PassThru
This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it returns the affected record.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AddUsers
Specifies the users to add to the merged resource.
| Type: | User[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
Specifies the description of the merged resource.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Length range: | 1 to 512 |
-RemoveUsers
Specifies the users to remove from the merged resource.
| Type: | User[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Users
Specifies the users who are entitled to the merged resource.
| Type: | User[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| 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
Citrix.Broker.Admin.SDK.MergedResource
You can pipe in the MergedResources whose properties you want to set.
Outputs
None or Citrix.Broker.Admin.SDK.MergedResource
This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it generates a Citrix.Broker.Admin.SDK.MergedResource object.