Citrix Virtual Apps and Desktops SDK

Remove-ProvSchemeScope

Remove the specified provisioning scheme(s) from the given scope(s).

Syntax

Remove-ProvSchemeScope
      [-Scope] <String[]>
      -ProvisioningSchemeUid <Guid[]>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->
Remove-ProvSchemeScope
      [-Scope] <String[]>
      -InputObject <ProvisioningScheme[]>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->
Remove-ProvSchemeScope
      [-Scope] <String[]>
      -ProvisioningSchemeName <String[]>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

The Remove-ProvSchemeScope command is used to remove one or more provisioning schemes from the given scope(s).

To remove a provisioning scheme from a scope you need permission to change the scopes of the provisioning scheme.

If the provisioning scheme is not in a specified scope, that scope will be silently ignored.

Examples

EXAMPLE 1

Removes a single provisioning scheme from the ‘Finance’ scope.

Remove-ProvSchemeScope Finance -ProvisioningSchemeUid 6702C5D0-C073-4080-A0EE-EC74CB537C52
<!--NeedCopy-->

EXAMPLE 2

Removes a single provisioning scheme from multiple scopes.

Remove-ProvSchemeScope Finance,Marketing -ProvisioningSchemeUid 6702C5D0-C073-4080-A0EE-EC74CB537C52
<!--NeedCopy-->

EXAMPLE 3

Removes all visible provisioning schemes from the ‘Finance’ scope.

Get-ProvScheme | Remove-ProvSchemeScope Finance
<!--NeedCopy-->

EXAMPLE 4

Removes provisioning schemes whose name starts with an ‘A’ from the ‘Finance’ scope.

Remove-ProvSchemeScope Finance -ProvisioningSchemeName A*
<!--NeedCopy-->

Parameters

-InputObject

Specifies the ProvisioningScheme objects to be removed.

Type: ProvisioningScheme[]
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-ProvisioningSchemeUid

Specifies the ProvisioningScheme objects to be removed by the unique identifier of the provisioning scheme(s).

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

-ProvisioningSchemeName

Specifies the ProvisioningScheme objects to be removed by the name of the provisioning scheme(s).

Type: String[]
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: True

-Scope

Specifies the scopes to remove the objects from.

Type: String[]
Position: 2
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-LoggingId

Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
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

Citrix.MachineCreation.Sdk.ProvisioningScheme

You can pipe a ProvisioningScheme object or any object containing a parameter called ‘ProvisioningSchemeName’ or ‘ProvisioningSchemeUid’ to Remove-ProvSchemeScope.

Outputs

None

By default, this cmdlet returns no output.

Notes

If the command fails, the following errors can be returned.

Error Codes


UnknownObject

One of the specified objects was not found.

ScopeNotFound

One of the specified scopes was not found.

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.

DataStoreException

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

PermissionDenied

You do not have permission to execute this command with the specified objects or scopes.

AuthorizationError

There was a problem communicating with the Citrix Delegated Administration Service.

ConfigurationLoggingError

The operation could not be performed because of a configuration logging error.

CommunicationError

There was a problem communicating with the remote service.

ExceptionThrown

An unexpected error occurred. For more details, see the Windows event logs

on the controller or the Citrix Virtual Apps and Desktops logs.

Remove-ProvSchemeScope