Citrix Daas SDK

Remove-AdminScope

August 9, 2024

Contributed by:

C C

Removes a scope from the site.

Syntax

Remove-AdminScope
      [-InputObject] <Scope[]>
      [-Force]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Remove-AdminScope
      [-Id] <Guid[]>
      [-Force]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

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

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.

Examples

EXAMPLE 1

Remove the Sales scope.

Remove-AdminScope -Name Sales
<!--NeedCopy-->

EXAMPLE 2

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

Get-AdminScope -BuiltIn $false | Remove-AdminScope
<!--NeedCopy-->

Parameters

-InputObject

Specifies the scopes to remove (by scope object).

Type:	Scope[]
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True (ByValue)
Accept wildcard characters:	False

-Id

Specifies the scopes to remove (by scope id).

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

-Name

Specifies the scopes to remove (by scope name).

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

-Force

Allow removal of scopes that are still in use.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
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.DelegatedAdmin.Sdk.Scope

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

Outputs

None

By default, this cmdlet returns no output.

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 9, 2024

Contributed by:

C C

August 9, 2024

Contributed by:

C C

Remove-AdminScope

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

Parameters

-InputObject

-Id

-Name

-Force

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

Citrix.DelegatedAdmin.Sdk.Scope

Outputs

None

Related Links

In this article