Citrix Virtual Apps and Desktops SDK

Test-Brokerapplicationnameavailable

Determine whether the proposed Application Name is available for use.

Syntax

Test-BrokerApplicationNameAvailable [-Name] <String[]> [-AdminAddress <String>] [-BearerToken <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

This cmdlet checks whether proposed Application 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 Application 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  

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-BrokerApplicationNameAvailable -Name Test1
<!--NeedCopy-->

Description

Checks whether the Name “Test1” is available.

Example 2

C:\PS> Test-BrokerApplicationNameAvailable @("Test1","Test2","Test3")
<!--NeedCopy-->

Description

Checks whether each of the specified names is available.

Test-Brokerapplicationnameavailable