Citrix Virtual Apps and Desktops SDK

Remove-AcctServiceAccountScope

Introduced in: Citrix Virtual Apps and Desktop 7 2308

Remove the specified service account(s) from the given scope(s).

Syntax

Remove-AcctServiceAccountScope
      [-Scope] <String[]>
      -ServiceAccountUid <Guid[]>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->
Remove-AcctServiceAccountScope
      [-Scope] <String[]>
      -InputObject <ServiceAccount[]>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

The Remove-AcctServiceAccountScope command is used to remove one or more service account objects from the given scope(s).

To remove a service account from a scope you need permission to change the scopes of the service account.

If the service account is not in a specified scope, that scope will be silently ignored.

The service accounts may be specified using the unique identifier, name, or as a powershell object.

Examples

EXAMPLE 1

Removes a single service account from the ‘Finance’ scope.

Remove-AcctServiceAccountScope Finance -ServiceAccountUid 17631afc-2e4c-491e-b0aa-f979a80e32c1
<!--NeedCopy-->

EXAMPLE 2

Removes a single service account from multiple scopes.

Remove-AcctServiceAccountScope Finance,Marketing -ServiceAccountUid 17631afc-2e4c-491e-b0aa-f979a80e32c1
<!--NeedCopy-->

EXAMPLE 3

Removes all visible service account objects from the ‘Finance’ scope.

Get-AcctServiceAccount | Remove-AcctServiceAccountScope Finance
<!--NeedCopy-->

Parameters

-InputObject

The service account objects to be removed.

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

-ServiceAccountUid

The unique identifier for the service accounts to be removed.

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

-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

None

You can’t pipe objects to this cmdlet.

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-AcctServiceAccountScope