Citrix Virtual Apps and Desktops SDK

Remove-BrokerUserZonePreference

Removes any zone preference associated with a user/group account in this site

Syntax

Remove-BrokerUserZonePreference
      [-InputObject] <UserZonePreference[]>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->
Remove-BrokerUserZonePreference
      [-Name] <String>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

The Remove-BrokerUserZonePreference cmdlet removes any preferred home zone associated with a user/group account.

Removing a home preference means that the account no longer has an influence on any choice of zone used for resource launches.

Examples

EXAMPLE 1

Removes any home zone preference associated with the APAC\sales account for this site.

Remove-BrokerUserZonePreference APAC\sales
<!--NeedCopy-->

Parameters

-InputObject

The account zone preference to be removed.

Type: UserZonePreference[]
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

The name of the user/group account whose home zone preference is to be removed.

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

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

The account zone preference to be removed.

Outputs

None

By default, this cmdlet returns no output.

Remove-BrokerUserZonePreference