Citrix Virtual Apps and Desktops SDK

Get-BrokerMergedResource

Introduced in: Citrix Virtual Apps and Desktop 7 2407

Represents a Resource in the MergeGroup

Syntax

Get-BrokerMergedResource
   [-ApplicationName <String>]
   [-ApplicationUid <Int32>]
   [-Description <String>]
   [-EntitlementPolicyRuleName <String>]
   [-EntitlementPolicyRuleUid <Int32>]
   [-Metadata <String>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Get-BrokerMergedResource
   -Uid <Int32>
   [-Property <String[]>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

This cmdlet retrieves a merged resource from the site.

————————– BrokerMergedResource Object

Represents a Resource in the MergeGroup

  • ApplicationName (System.String)

    The name of the application.

  • ApplicationUid (System.Int32?)

    The unique identifier of the application.

  • Description (System.String)

    The description of the merged resource.

  • EntitlementPolicyRuleName (System.String)

    The name of the entitlement policy rule.

  • EntitlementPolicyRuleUid (System.Int32?)

    The unique identifier of the entitlement policy rule.

  • MergeGroupName (System.String)

    The name of the merge group.

  • MergeGroupUid (System.Int32)

    The unique identifier of the merge group.

  • MetadataMap (System.Collections.Generic.Dictionary<string, string>)

    The metadata map of the merged resource.

  • Uid (System.Int32)

    The unique identifier of the merged resource.

  • Users (Citrix.Broker.Admin.SDK.ChbUser[])

    The users who are entitled to the merged resource.

Examples

EXAMPLE 1

This command retrieves all the merged resources in the merge group named “MyMergeGroup”.

Get-BrokerMergedResource -MergeGroupName "MyMergeGroup"
<!--NeedCopy-->

Parameters

-Uid

The unique identifier of the merged resource.

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

-ApplicationName

The name of the application.

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

-ApplicationUid

The unique identifier of the application.

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

-Description

The description of the merged resource.

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

-EntitlementPolicyRuleName

The name of the entitlement policy rule.

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

-EntitlementPolicyRuleUid

The unique identifier of the entitlement policy rule.

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

-Metadata

Gets records with matching metadata entries.

The value being compared with is a concatenation of the key name, a colon, and the value. For example: -Metadata “abc:x*” matches records with a metadata entry having a key name of “abc” and a value starting with the letter “x”.

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

Citrix.Broker.Admin.SDK.MergedResource

String

Outputs

Citrix.Broker.Admin.SDK.MergedResource

Get-BrokerMergedResource