Citrix Virtual Apps and Desktops SDK

New-BrokerAutoTagRule

March 11, 2024

Contributed by:

Creates a new AutoTagRule.

Syntax

New-BrokerAutoTagRule [-Name] <String> -ObjectType <String> -RuleText <String> -TagUid <Int32> [-Description <String>] [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Creates an AutoTagRule which defines a rule to select objects to assign (or remove) a Tag to (or from).

Parameters

Name	Description	Required?	Pipeline Input	Default Value
Name	The rule name.	true	true (ByPropertyName)
ObjectType	The object type on which the rule is applied.	true	true (ByPropertyName)
RuleText	Rule in the text format.	true	true (ByPropertyName)
TagUid	The Tag Uid this rule applies to.	true	true (ByPropertyName)
Description	The Description of rule.	false	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
AdminClientIP	Internal use only.	false	false
TraceParent	Specifies the trace parent assigned for internal diagnostic tracing use	false	false
TraceState	Specifies the trace state assigned for internal diagnostic tracing use	false	false
VirtualSiteId	Specifies the virtual site the PowerShell snap-in will connect to.	false	false

Input Type

None

Input cannot be piped to this cmdlet.

Return Values

Citrix.Broker.Admin.Sdk.Autotagrule

Outputs the AutoTagRule object.

Examples

Example 1

C:\PS> $tag = New-BrokerTag -Name MyExample

C:\PS> New-BrokerAutoTagRule -Name RandomAllocatedCatalogs -TagUid $tag.Uid -ObjectType Catalog -RuleText "-AllocationType Random"

<!--NeedCopy-->

Description

Creates a new rule for the “MyExample” tag.

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

New-BrokerAutoTagRule

March 11, 2024

Contributed by:

March 11, 2024

Contributed by:

New-BrokerAutoTagRule

Syntax

Detailed Description

Related Commands

Parameters

Input Type

None

Return Values

Citrix.Broker.Admin.Sdk.Autotagrule

Examples

Example 1

Description

In this article