Citrix Virtual Apps and Desktops SDK

Test-HypPvsCollectionNameAvailable

Tests availability of collection name.

Syntax


Test-HypPvsCollectionNameAvailable -SiteId <Guid> -CollectionName <String> [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Test the availability of a collection name against a site.

Parameters

Name Description Required? Pipeline Input Default Value
SiteId Target Site ID to validate against. true true (ByValue)  
CollectionName Collection name to test. true true (ByValue)  
BearerToken Specifies the bearer token assigned to the calling user false false  
AdminClientIP Specifies the client IP of 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  
AdminAddress Specifies the address of a XenDesktop controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address. false false Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

Guid

The GUID of a Site to validate against.

String

Collection name to test availability for.

Return Values

Examples

Example 1


C:\PS>Test-HypPvsCollectionNameAvailable -SiteId 00000000-0000-0000-0000-000000000000 -CollectionName "CollectionName"

<!--NeedCopy-->

Description

This command tests the availability of a Collection Name.

Test-HypPvsCollectionNameAvailable