Citrix Virtual Apps and Desktops SDK

Get-BrokerUserZonePreference

March 11, 2024

Contributed by:

Gets user/group accounts with zone preferences configured for this site

Syntax

Get-BrokerUserZonePreference
   [[-Name] <String>]
   [-DirectoryContext <String>]
   [-FullName <String>]
   [-HomeZoneName <String>]
   [-HomeZoneUid <Guid>]
   [-IdentityClaims <String>]
   [-PrimaryClaim <String>]
   [-SAMName <String>]
   [-UPN <String>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Get-BrokerUserZonePreference
   -SID <String>
   [-Property <String[]>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Retrieve user/group account details with a home zone preference specified and matching the specified criteria. If no parameters are specified this cmdlet enumerates all account details with associated home zones preferences.

For information about advanced filtering options, see about_Broker_Filtering.

————————– BrokerUserZonePreference Object

The BrokerUserZonePreference object represents a user/group account having an associated home zone preference to be used when launching desktop or application sessions. It contains the following properties:

DirectoryContext (System.String)

The directory context of a user
FullName (System.String)

Full name of user/group account.
HomeZoneName (System.String)

Name of home zone preference associated with user/group account for this site.
HomeZoneUid (System.Guid)

Home zone preference associated with user/group account for this site.
IdentityClaims (System.String)

The identity claims of a user
Name (System.String)

SAM name of user group/account (domain\user).
PrimaryClaim (System.String)

The primary identity claim of a user
SAMName (System.String)

The SAMName of a user
SID (System.String)

SID of user/group account.
UPN (System.String)

UPN of user/group account (user@domain).

Examples

EXAMPLE 1

Get all user/group accounts with a home zone preference whose names match the supplied pattern

Get-BrokerUserZonePreference DOMAIN7\*
<!--NeedCopy-->

EXAMPLE 2

Get all user/group accounts with the specified zone as their home zone preference.

Get-BrokerUserZonePreference -HomeZoneUid 79AD8059-05B7-4BAA-9369-5C74EF52D3EB
<!--NeedCopy-->

Parameters

-SID

Gets user/group accounts with a home zone preference and the specified SID.

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

-Name

Gets user/group accounts with a home zone preference and the specified SAM name (domain\user).

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

-DirectoryContext

Gets the broker user with the specified directory context property value.

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

-FullName

Gets user/group accounts with a home zone preference and the specified full name.

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

-HomeZoneName

Gets user/group accounts having a home zone preference with the specified name.

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

-HomeZoneUid

Gets user/group accounts having a home zone preference with the specified UID.

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

-IdentityClaims

Gets the broker user with the specified identity claims property value.

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

-PrimaryClaim

Gets the broker user with the specified primary claim property value.

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

-SAMName

The SAMName of a user

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

-UPN

Gets user/group accounts with a home zone preference and the specified UPN (user@domain).

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

None

You cannot pipe input into this cmdlet.

Outputs

Citrix.Broker.Admin.SDK.UserZonePreference

Get-BrokerUserZonePreference returns an object for each user/group account with a home zone preference.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Get-BrokerUserZonePreference

March 11, 2024

Contributed by:

March 11, 2024

Contributed by:

Get-BrokerUserZonePreference

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

Parameters

-SID

-Name

-DirectoryContext

-FullName

-HomeZoneName

-HomeZoneUid

-IdentityClaims

-PrimaryClaim

-SAMName

-UPN

-ReturnTotalRecordCount

-MaxRecordCount

-Skip

-SortBy

-Filter

-FilterScope

-Property

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.Broker.Admin.SDK.UserZonePreference

Related Links

In this article