Citrix Virtual Apps and Desktops SDK

New-BrokerUserZonePreference

Creates a zone preference for a user/group account in this site

Syntax

New-BrokerUserZonePreference
   -HomeZoneUid <Guid>
   [-Name] <String>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
New-BrokerUserZonePreference
   -HomeZoneUid <Guid>
   [-SID] <String>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

The New-BrokerUserZonePreference cmdlet specifies a preferred home zone for resources launched using the specified user/group account.

Subject to the configuration of the desktop groups in use, and the availability of machines in the preferred zone, desktops and applications are launched using machines in that zone where possible.

Examples

EXAMPLE 1

Sets the preferred zone for resources launched by members of the EMEA\sales group account.

$zp = New-BrokerUserZonePreference EMEA\sales -HomeZoneUid 2E885C02-6B65-47AA-8B03-E855BE2FF7D7
<!--NeedCopy-->

Parameters

-Name

Name of the user/group account with which the new home zone preference is to be associated.

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

-SID

SID of the user/group account with which the new home zone preference is to be associated.

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

-HomeZoneUid

The home zone preference to be associated with the user/group account.

Type: Guid
Position: Named
Default value: None
Required: True
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.UserZonePreference

New-BrokerUserZonePreference returns the newly created zone preference object.

New-BrokerUserZonePreference