Citrix Virtual Apps and Desktops SDK

Remove-Adminscope

August 3, 2023

Contributed by:

Removes a scope from the site.

Syntax

Remove-AdminScope [-InputObject] <Scope[]> [-Force] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>]

Remove-AdminScope [-Id] <Guid[]> [-Force] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>]

Remove-AdminScope [-Name] <String[]> [-Force] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

The Remove-AdminScope cmdlet deletes scopes from the site.

You cannot remove the built-in ‘All’ scope.

An error will be produced if the scope being removed is currently assigned to an administrator unless you specify the -Force option. When -Force is specified, any rights that reference the scope are also removed.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
InputObject	Specifies the scopes to remove (by scope object).	true	true (ByValue)
Id	Specifies the scopes to remove (by scope id).	true	true (ByPropertyName)
Name	Specifies the scopes to remove (by scope name).	true	true (ByPropertyName)
Force	Allow removal of scopes that are still in use.	false	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.	false	false
BearerToken	Specifies the bearer token assigned to the calling user	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

Citrix.Delegatedadmin.Sdk.Scope

You can pipe the scopes to be deleted into this command.

Return Values

None

Examples

Example 1

C:\PS> Remove-AdminScope -Name Sales
<!--NeedCopy-->

Description

Remove the Sales scope.

Example 2

C:\PS> Get-AdminScope -BuiltIn $false | Remove-AdminScope
<!--NeedCopy-->

Description

Attempt to remove all scopes (excluding the built-in ‘All’ scope). This fails if one of the scopes is assigned to an administrator.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Remove-Adminscope

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Remove-Adminscope

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Citrix.Delegatedadmin.Sdk.Scope

Return Values

None

Examples

Example 1

Description

Example 2

Description

In this article