Citrix Virtual Apps and Desktops SDK

Remove-Brokerassignmentpolicyrule

August 3, 2023

Contributed by:

Deletes a desktop rule from the site’s assignment policy.

Syntax

Remove-BrokerAssignmentPolicyRule [-InputObject] <AssignmentPolicyRule[]> [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [<CommonParameters>]

Remove-BrokerAssignmentPolicyRule [-Name] <String> [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

The Remove-BrokerAssignmentPolicyRule cmdlet deletes a desktop rule from the site’s assignment policy.

A desktop rule in the assignment policy defines the users who are entitled to self-service persistent machine assignments from the rule’s desktop group. A rule defines how many machines a user is allowed from the group for delivery of full desktop sessions.

Deleting a desktop rule does not remove machine assignments that have already been made by the rule, nor does it affect active sessions to those machines in any way.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
InputObject	The desktop rule to be deleted from the assignment policy.	true	true (ByValue)
Name	The name of the desktop rule to be deleted from the assignment policy.	true	true (ByPropertyName)
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.	false	false
AdminAddress	Specifies the address of a XenDesktop controller that the PowerShell snapin will connect to. This can be provided as a host name or an IP address.	false	false	Localhost. Once a value is provided by any cmdlet, this value will become the default.
BearerToken	Specifies the bearer token assigned to the calling user	false	false

Input Type

Citrix.Broker.Admin.Sdk.Assignmentpolicyrule

The desktop rule to be deleted from the assignment policy.

Return Values

None

Examples

Example 1

C:\PS> Remove-BrokerAssignmentPolicyRule 'Temp Staff'
<!--NeedCopy-->

Description

Deletes the desktop rule called Temp Staff from the assignment policy. Access to machines already assigned by this rule is not affected in any way.

Example 2

C:\PS> $dg = Get-BrokerDesktopGroup 'Sales Support'

C:\PS> Get-BrokerAssignmentPolicyRule -DesktopGroupUid $dg.Uid | Remove-BrokerAssignmentPolicyRule
<!--NeedCopy-->

Description

Deletes all desktop rules for the Sales Support desktop group from the site’s assignment policy. This prevents any further machine assignments being made from this group, but it does not affect existing assignments made by these rules.

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

Remove-Brokerassignmentpolicyrule

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Remove-Brokerassignmentpolicyrule

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Citrix.Broker.Admin.Sdk.Assignmentpolicyrule

Return Values

None

Examples

Example 1

Description

Example 2

Description

In this article