Citrix Virtual Apps and Desktops SDK

Set-AcctServiceAccountCapabilityEffectiveScope

Introduced in: Citrix Virtual Apps and Desktop 7 2308

Sets effective scope for a capability of the service account.

Syntax

Set-AcctServiceAccountCapabilityEffectiveScope
   -ServiceAccountUid <Guid>
   [-Capability <String>]
   [-EffectiveScope <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Provides the ability to set effective scope for a capability of the service account.

Examples

EXAMPLE 1

Set the effective scope for the capability AzureArcResourceManagement of service account specified by uid 17631afc-2e4c-491e-b0aa-f979a80e32c1 to a specific subscription 04b4abae-a80a-47c2-8156-daa28145e4fa.

c:\Set-AcctServiceAccountCapabilityEffectiveScope -ServiceAccountUid 17631afc-2e4c-491e-b0aa-f979a80e32c1 -Capability AzureArcResourceManagement -EffectiveScope 04b4abae-a80a-47c2-8156-daa28145e4fa
<!--NeedCopy-->

Parameters

-ServiceAccountUid

The unique identifier for the service account.

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

-Capability

The capability for the service account to be set.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-EffectiveScope

The effective scope for the capability of the service account to be set. Effective scope is the scope that the capability applies to.

For Azure AD, it can be the subscription id within the Azure AD tenant.

Type: String
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

None

You can’t pipe objects to this cmdlet.

Outputs

None

By default, this cmdlet returns no output.

Notes

In the case of failure the following errors can be produced.

Error Codes


ServiceAccountObjectNotFound

The specified service account could not be located.

ServiceAccountCapabilityNotFound

The specified service account capability is not found.

PermissionDenied

The user does not have administrative rights to perform this operation.

ConfigurationLoggingError

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

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.

ServiceStatusInvalidDb

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

CommunicationError

An error occurred while communicating with the service.

ExceptionThrown

An unexpected error occurred. To locate more details see the Windows event logs on the controller being used, or examine the Citrix Virtual Apps and Desktops logs.

Set-AcctServiceAccountCapabilityEffectiveScope