Citrix Virtual Apps and Desktops SDK

Add-AcctServiceAccountScope

Introduced in: Citrix Virtual Apps and Desktop 7 2308

Add the specified service account(s) to the given scope(s).

Syntax

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

Description

The Add-AcctServiceAccountScope command is used to associate one or more service account objects with given scope(s).

To add a service account to a scope you need permission to change the scopes of the service account and permission to add objects to all of the scopes you have specified.

When attempting to add a service account to a scope it is already associated with, no change will be made.

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

Examples

EXAMPLE 1

Adds a single service account to the ‘Finance’ scope.

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

EXAMPLE 2

Adds a single service account to the multiple scopes.

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

EXAMPLE 3

Adds all visible service account objects to the ‘Finance’ scope.

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

Parameters

-InputObject

The service account objects to be added.

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 added.

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

-Scope

Specifies the scopes to add the objects to.

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.

Add-AcctServiceAccountScope