Citrix Virtual Apps and Desktops SDK

Set-AcctServiceAccount

August 9, 2024

Contributed by:

Introduced in: Citrix Virtual Apps and Desktop 7 2308

Update parameters of a service account.

Syntax

Set-AcctServiceAccount
   -ServiceAccountUid <Guid>
   [-AccountId <String>]
   [-AccountSecret <SecureString>]
   [-SecretExpiryTime <String>]
   [-Capabilities <String[]>]
   [-DisplayName <String>]
   [-Description <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Provides the ability to modify the parameters of a service account.

Examples

EXAMPLE 1

Changes the AccountId for service account specified by uid 17631afc-2e4c-491e-b0aa-f979a80e32c1.

Set-AcctServiceAccount -ServiceAccountUid 17631afc-2e4c-491e-b0aa-f979a80e32c1 -AccountId deb0811e-4839-4cce-87d3-8f36b31c2934

                    ServiceAccountUid            : 17631afc-2e4c-491e-b0aa-f979a80e32c1
                    IdentityProviderIdentifier   : f439f4c0-fcd8-4fe6-95b8-71e7e49dc8c6
                    IdentityProviderType         : AzureAD
                    SecretExpiryTime             : 9/8/2024 8:00:00 PM
                    AccountId                    : deb0811e-4839-4cce-87d3-8f36b31c2934
                    Capabilities                 : {AzureArcResourceManagement}
                    FailureReason                :
                    IsHealthy                    : True
                    Scopes                       : {}
                    TenantId                     :
<!--NeedCopy-->

EXAMPLE 2

Changes the AccountSecret for service account specified by uid ad24284e-ba3d-4504-80db-9ac6640de533.

Set-AcctServiceAccount -ServiceAccountUid ad24284e-ba3d-4504-80db-9ac6640de533 -AccountSecret $newPassword

ServiceAccountUid            : ad24284e-ba3d-4504-80db-9ac6640de533
IdentityProviderIdentifier   : test.local
IdentityProviderType         : ActiveDirectory
SecretExpiryTime             : 9/8/2024 8:00:00 PM
AccountId                    : test\svcacct_1
Capabilities                 :
FailureReason                :
IsHealthy                    : True
Scopes                       : {}
TenantId                     :
<!--NeedCopy-->

EXAMPLE 3

Changes the DisplayName or Description for service account specified by uid ad24284e-ba3d-4504-80db-9ac6640de533.

Set-AcctServiceAccount -ServiceAccountUid ad24284e-ba3d-4504-80db-9ac6640de533 -DisplayName "ctxlabxx" -Description "xxapp"

ServiceAccountUid            : ad24284e-ba3d-4504-80db-9ac6640de533
IdentityProviderIdentifier   : test.local
IdentityProviderType         : ActiveDirectory
SecretExpiryTime             : 9/8/2024 8:00:00 PM
AccountId                    : test\svcacct_1
Capabilities                 :
Description                  : xxapp
DisplayName                  : ctxlabxx
FailureReason                :
IsHealthy                    : True
Scopes                       : {}
TenantId                     :
<!--NeedCopy-->

Parameters

-ServiceAccountUid

The unique identifier for the service account that is to be modified.

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

-AccountId

The identifier for the service account.

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

-AccountSecret

The secret for the service account. E.g. Azure application (client) secret if ‘IdentityProviderType’ is AzureAD. The secret will be encrypted and stored in database.

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

-SecretExpiryTime

The secret expiration time for the service account. If specify as empty string (“”), will set secret as never expires.

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

-Capabilities

The capabilities for the service account.

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

-DisplayName

The display name for the service account.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Length range:	0 to 128
Disallowed characters:	`\/;:#.*?=<>\\|[]()"'`
Introduced in:	Citrix Virtual Apps and Desktop 7 2407

-Description

The description for the service account.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Introduced in:	Citrix Virtual Apps and Desktop 7 2407

-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

Citrix.ADIdentity.Sdk.ServiceAccount

This object provides details of the service account and contains the following information:

ServiceAccountUid <GUID> The unique identifier of the service account. SecretExpiryTime <Datetime> The expiration time for the secret of the service account. AccountId <string> The identifier for the service account. E.g. Azure application ID if the service account is with Azure AD as identity provider. IdentityProviderIdentifier <string> The identifier of the identity provider that the service account belongs to. E.g. Azure AD tenant ID. IdentityProviderType <string> The type of the identity provider of the service account. Can be AzureAD or ActiveDirectory. IsHealthy <bool> Indicates if the service account is healthy. Capabilities <string[]> Capabilities of the service account. Can be AzureArcResourceManagement. FailureReason <string> The reason why the service account becomes unhealthy. Scopes <Citrix.ADIdentity.Sdk.ScopeReference[]> The administration scopes associated with this identity pool. TenantId <GUID> Identity of the Citrix tenant associated with this identity pool. Not applicable (always blank) in non-multitenant sites. DisplayName <string> The display name of the service account. Description <string> The description of the service account.

Notes

In the case of failure, the following errors can result.

Error Codes

ServiceAccountObjectNotFound

The specified service account could not be located.

InvalidServiceAccountCapabilities

One or more specified service account capabilities are not supported.

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.

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

Set-AcctServiceAccount

August 9, 2024

Contributed by:

August 9, 2024

Contributed by:

Set-AcctServiceAccount

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

EXAMPLE 3

Parameters

-ServiceAccountUid

-AccountId

-AccountSecret

-SecretExpiryTime

-Capabilities

-DisplayName

-Description

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.ADIdentity.Sdk.ServiceAccount

Notes

Related Links

In this article