Citrix Virtual Apps and Desktops SDK

Remove-BrokerAssignmentPolicyRule

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

Syntax

Remove-BrokerAssignmentPolicyRule
      [-InputObject] <AssignmentPolicyRule[]>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->
Remove-BrokerAssignmentPolicyRule
      [-Name] <String>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

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.

Examples

EXAMPLE 1

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.

Remove-BrokerAssignmentPolicyRule 'Temp Staff'
<!--NeedCopy-->

EXAMPLE 2

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.

$dg = Get-BrokerDesktopGroup 'Sales Support'
Get-BrokerAssignmentPolicyRule -DesktopGroupUid $dg.Uid | Remove-BrokerAssignmentPolicyRule
<!--NeedCopy-->

Parameters

-InputObject

The desktop rule to be deleted from the assignment policy.

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

-Name

The name of the desktop rule to be deleted from the assignment policy.

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

The desktop rule to be deleted from the assignment policy.

Outputs

None

By default, this cmdlet returns no output.

Remove-BrokerAssignmentPolicyRule