Citrix Virtual Apps and Desktops 2411 SDK

New-AcctServiceAccount

December 4, 2024

Contributed by:

Introduced in: Citrix Virtual Apps and Desktop 7 2308

Creates a new service account.

Syntax

New-AcctServiceAccount
   -IdentityProviderType <String>
   -IdentityProviderIdentifier <String>
   -AccountId <String>
   -AccountSecret <SecureString>
   [-SecretExpiryTime <String>]
   [-Capabilities <String[]>]
   [-Scope <String[]>]
   [-TenantId <Guid>]
   -DisplayName <String>
   [-Description <String>]
   [-CustomProperties <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Provides the ability to create service accounts that can be used to store credential to access identity provider like Azure AD.

Each service account is tied to a single identity provider.

Examples

EXAMPLE 1

Create a new service account to access AzureAD with AzureArcResourceManagement capability.

New-AcctServiceAccount -IdentityProviderType AzureAD -IdentityProviderIdentifier f439f4c0-fcd8-4fe6-95b8-71e7e49dc8c6 -AccountId ac14e785-cdb2-4e18-9240-8b49583b11a2 -AccountSecret $password -SecretExpiryTime "2024-09-09" -Capabilities 'AzureArcResourceManagement' -DisplayName "display name for this service account"

ServiceAccountUid            : 17631afc-2e4c-491e-b0aa-f979a80e32c1
IdentityProviderIdentifier   : f439f4c0-fcd8-4fe6-95b8-71e7e49dc8c6
IdentityProviderType         : AzureAD
SecretExpiryTime             : 9/9/2024 8:00:00 PM
AccountId                    : ac14e785-cdb2-4e18-9240-8b49583b11a2
Capabilities                 : {AzureArcResourceManagement}
CustomProperties             :
Description                  :
DisplayName                  : display name for this service account
FailureReason                :
IsHealthy                    : True
Scopes                       : {}
TenantId                     :
<!--NeedCopy-->

EXAMPLE 2

Create a new service account to access AzureAD with connection properties.

New-AcctServiceAccount -IdentityProviderType AzureAD -IdentityProviderIdentifier f439f4c0-fcd8-4fe6-95b8-71e7e49dc8c6 -AccountId ac14e785-cdb2-4e18-9240-8b49583b11a2 -AccountSecret $password -SecretExpiryTime "2024-09-09" -Capabilities 'AzureArcResourceManagement' -DisplayName "display name for this service account" -CustomProperties '{"ProxyHypervisorTrafficThroughConnector":true,"UseSystemProxyForHypervisorTrafficOnConnectors":false,"ProxyTrafficThroughHighlyAvailableServer":false,"ZoneUid":["ac65fbab-71d3-4a18-a991-97c2683d4401"]}'

ServiceAccountUid            : 17631afc-2e4c-491e-b0aa-f979a80e32c1
IdentityProviderIdentifier   : f439f4c0-fcd8-4fe6-95b8-71e7e49dc8c6
IdentityProviderType         : AzureAD
SecretExpiryTime             : 9/9/2024 8:00:00 PM
AccountId                    : ac14e785-cdb2-4e18-9240-8b49583b11a2
Capabilities                 : {AzureArcResourceManagement}
CustomProperties             : {"ProxyHypervisorTrafficThroughConnector":true,"UseSystemProxyForHypervisorTrafficOnConnectors":false,"ProxyTrafficThroughHighlyAvailableServer":false,"ZoneUid":["ac65fbab-71d3-4a18-a991-97c2683d4401"]}
Description                  :
DisplayName                  : display name for this service account
FailureReason                :
IsHealthy                    : True
Revision                     : a94a3cd1-abe7-4bdd-9a77-fa6820c5a5c2
Scopes                       : {}
TenantId                     :
<!--NeedCopy-->

EXAMPLE 3

Create a new service account to access ActiveDirectory.

New-AcctServiceAccount -IdentityProviderType ActiveDirectory -IdentityProviderIdentifier test.local -AccountId test\svcacct_1 -AccountSecret $password -SecretExpiryTime "2024-09-09" -DisplayName "display name for this service account"

ServiceAccountUid            : ad24284e-ba3d-4504-80db-9ac6640de533
IdentityProviderIdentifier   : test.local
IdentityProviderType         : ActiveDirectory
SecretExpiryTime             : 9/9/2024 8:00:00 PM
AccountId                    : test\svcacct_1
Capabilities                 :
CustomProperties             :
Description                  :
DisplayName                  : display name for this service account
FailureReason                :
IsHealthy                    : True
Revision                     : a94a3cd1-abe7-4bdd-9a77-fa6820c5a5c2
Scopes                       : {}
TenantId                     :
<!--NeedCopy-->

EXAMPLE 4

Create a new service account to access ActiveDirectory.

New-AcctServiceAccount -IdentityProviderType ActiveDirectory -IdentityProviderIdentifier test.local -AccountId test\svcacct_1 -AccountSecret $password -SecretExpiryTime "2024-09-09" -DisplayName "display name for this service account" -Description "description for this service account"

ServiceAccountUid            : ad24284e-ba3d-4504-80db-9ac6640de533
IdentityProviderIdentifier   : test.local
IdentityProviderType         : ActiveDirectory
SecretExpiryTime             : 9/9/2024 8:00:00 PM
AccountId                    : test\svcacct_1
Capabilities                 :
CustomProperties             :
Description                  : description for this service account
DisplayName                  : display name for this service account
FailureReason                :
IsHealthy                    : True
Revision                     : a94a3cd1-abe7-4bdd-9a77-fa6820c5a5c2
Scopes                       : {}
TenantId                     :
<!--NeedCopy-->

EXAMPLE 5

Create a new service account to access AzureAD with AzureADDeviceManagement and IntuneDeviceManagement capability.

$account = New-AcctServiceAccount -IdentityProviderType AzureAD -IdentityProviderIdentifier f439f4c0-fcd8-4fe6-95b8-71e7e49dc8c6 -AccountId ac14e785-cdb2-4e18-9240-8b49583b11a2 -AccountSecret $password -SecretExpiryTime "2024-09-09" -Capabilities @("AzureADDeviceManagement","IntuneDeviceManagement") -DisplayName "display name for this service account"
$account.Capabilities

Name                        EffectiveScope IsHealthy         FailureReason
----                        -------------- ----------------- -----------------
AzureADDeviceManagement                    False             Device.ReadWrite.All
IntuneDeviceManagement                     False             DeviceManagementManagedDevices.ReadWrite.All
<!--NeedCopy-->

Parameters

-IdentityProviderType

The type of the identity provider that associates with this service account. Can be AzureAD or ActiveDirectory.

Type:	String
Accepted values:	AzureAD, ActiveDirectory
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-IdentityProviderIdentifier

The identifier of the given identity provider. E.g. Azure AD tenant id if ‘IdentityProviderType’ is AzureAD.

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

-AccountId

The identifier for the service account. E.g. Azure application (client) id if ‘IdentityProviderType’ is AzureAD.

Type:	String
Position:	Named
Default value:	None
Required:	True
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:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-DisplayName

The display name for the service account.

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

-SecretExpiryTime

The secret expiration time for the service account. If it is not specified, 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

-Scope

The administration scopes to be applied to the new service account.

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

-TenantId

Specifies identity of tenant associated with service account. Must always be specified in multi-tenant sites, must not be specified otherwise.

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

-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

-CustomProperties

The custom properties 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 2411

-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 AzureADDeviceManagement AzureADSecurityGroupManagement IntuneDeviceManagement. 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. CustomProperties <string> The custom properties of the service account.

Notes

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

Error Codes

IdentityProviderTypeDoesNotMatch

The specified identity provider type doesn’t match the existing identity provider for the given tenant.

ServiceAccountDuplicateObjectExists

Duplicate object exists.

UnsupportedIdentityProviderType

The specified identity provider type is not supported.

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

New-AcctServiceAccount

December 4, 2024

Contributed by:

December 4, 2024

Contributed by:

New-AcctServiceAccount

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

EXAMPLE 3

EXAMPLE 4

EXAMPLE 5

Parameters

-IdentityProviderType

-IdentityProviderIdentifier

-AccountId

-AccountSecret

-DisplayName

-SecretExpiryTime

-Capabilities

-Scope

-TenantId

-Description

-CustomProperties

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.ADIdentity.Sdk.ServiceAccount

Notes

Related Links

In this article