Citrix Virtual Apps and Desktops SDK

Test-BrokerAppEntitlementPolicyRuleNameAvailable

August 3, 2023

Contributed by:

Determine whether the proposed AppEntitlementPolicyRule Name is available for use.

Syntax

Test-BrokerAppEntitlementPolicyRuleNameAvailable [-Name] <String[]> [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

This cmdlet checks whether proposed AppEntitlementPolicyRule Name is available for use. It returns a record for each Name indicating the availability of that Name, with $true indicating that the Name is unused and available for use, or $false if it is not available.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
Name	The AppEntitlementPolicyRule Name to be tested.	true	true (ByValue, ByPropertyName)
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
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

System.String

You can pipe a string that contains the Name to test.

Return Values

Citrix.Broker.Admin.Sdk.Nameavailability

The cmdlet returns a result for each Name specified. An availability of “True” indicates the Name is available for use, and “False” if it is not available.

Examples

Example 1

C:\PS> Test-BrokerAppEntitlementPolicyRuleNameAvailable -Name Test1

<!--NeedCopy-->

Description

Checks whether the Name “Test1” is available.

Example 2

C:\PS> Test-BrokerAppEntitlementPolicyRuleNameAvailable @("Test1","Test2","Test3")

<!--NeedCopy-->

Description

Checks whether each of the specified names is available.

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

Test-BrokerAppEntitlementPolicyRuleNameAvailable

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Test-BrokerAppEntitlementPolicyRuleNameAvailable

Syntax

Detailed Description

Related Commands

Parameters

Input Type

System.String

Return Values

Citrix.Broker.Admin.Sdk.Nameavailability

Examples

Example 1

Description

Example 2

Description

In this article