Citrix Virtual Apps and Desktops SDK

Test-ProvSchemeNameAvailable

Check if the proposed provisioning scheme name is unused.

Syntax

Test-ProvSchemeNameAvailable
    -ProvisioningSchemeName <String[]>
    [<CitrixCommonParameters>]
    [<CommonParameters>]
<!--NeedCopy-->

Description

Provides the ability to validate if the proposed name for a provisioning scheme is unused. This check is not limited to scopes of existing provisioning schemes, therefore, the names of inaccessible schemes are also checked.

Examples

EXAMPLE 1

This tests whether the value of $NewSchemeName is unique or not, and can be used to create a new provisioning scheme or rename an existing one without failing. True is returned if the name is good.

Test-ProvSchemeNameAvailable -ProvisioningSchemeName $NewSchemeName

Name      : NewScheme1
Available : True
<!--NeedCopy-->

Parameters

-ProvisioningSchemeName

The name or names of the provisioning scheme(s) to be tested.

Type: String[]
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
Length range: 1 to 64

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

Citrix.MachineCreation.Sdk.ProvisioningScheme

You can pipe an object containing a parameter called ‘ProvisioningSchemeName’ to Test-ProvSchemeNameAvailable.

Outputs

Citrix.MachineCreation.Sdk.NameAvailability

Key value pairs of name and its availability.

Name <string>

The provisioning scheme name to be tested.

Available <bool>

The availability of the name.

Notes

In the case of failure, the following errors can result.

Error Codes


DatabaseError

An error occurred in the service while attempting a database operation.

DatabaseNotConfigured

The operation could not be completed because the database for the service is not configured.

ServiceStatusInvalidDb

An error occurred in the service while attempting a database operation - communication with the database failed for

for various reasons.

CommunicationError

An error occurred while communicating with the service.

PermissionDenied

The user does not have administrative rights to perform this operation.

ExceptionThrown

An unexpected error occurred. For more details, see the Windows event logs on the controller being used or Citrix Virtual Apps and Desktops logs.

Test-ProvSchemeNameAvailable