Citrix Virtual Apps and Desktops SDK

Test-HypPvsCollectionNameAvailable

Introduced in: Citrix Virtual Apps and Desktop 7 2305

Tests availability of collection name.

Syntax

Test-HypPvsCollectionNameAvailable
    -SiteId <Guid>
    -CollectionName <String>
    [<CitrixCommonParameters>]
    [<CommonParameters>]
<!--NeedCopy-->

Description

Test the availability of a collection name against a site.

Examples

EXAMPLE 1

This command tests the availability of a Collection Name.

Test-HypPvsCollectionNameAvailable -SiteId 00000000-0000-0000-0000-000000000000 -CollectionName "CollectionName"
<!--NeedCopy-->

Parameters

-SiteId

Target Site ID to validate against.

Type: Guid
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-CollectionName

Collection name to test.

Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByValue)
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

Guid

The GUID of a Site to validate against.

String

Collection name to test availability for.

Outputs

None

By default, this cmdlet returns no output.

Test-HypPvsCollectionNameAvailable