Citrix Virtual Apps and Desktops 2411 SDK

Get-AcctServiceAccount

Introduced in: Citrix Virtual Apps and Desktop 7 2308

Gets a list of existing service accounts.

Syntax

Get-AcctServiceAccount [-ServiceAccountUid <Guid>] [-IdentityProviderUid <Guid>] [-IsHealthy <Boolean>] [-ScopeId <Guid>] [-ScopeName <String>] [-IdentityProviderIdentifier <String>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-FilterScope <Guid>] [<CitrixCommonParameters>] [<CommonParameters>]

Description

Provides the ability to retrieve a list of existing service accounts.

Examples

EXAMPLE 1

Gets all the service accounts.

Get-AcctServiceAccount ServiceAccountUid : 440b77c3-9935-49b2-a696-01914dcffcbe IdentityProviderIdentifier : d1b46f6b-ad4c-4fcc-bb79-8e3c8fd813e8 IdentityProviderType : AzureAD SecretExpiryTime : 9/8/2029 8:00:00 PM AccountId : deb0811e-4839-4cce-87d3-8f36b31c2934 Capabilities : {AzureArcResourceManagement} CustomProperties : Description : description for this service account DisplayName : display name for this service account FailureReason : IsHealthy : True Revision : 34bf0bea-d9dd-4d42-80b2-610ee28230c1 Scopes : {Scope1} TenantId : ServiceAccountUid : 2eccb0ec-a760-44ad-a36d-e0928b4d7926 IdentityProviderIdentifier : d1b46f6b-ad4c-4fcc-bb79-8e3c8fd813e8 IdentityProviderType : AzureAD SecretExpiryTime : 9/8/2099 8:00:00 PM AccountId : ac14e785-cdb2-4e18-9240-8b49583b11a2 Capabilities : {AzureADDeviceManagement} CustomProperties : Description : description for this service account DisplayName : display name for this service account FailureReason : IsHealthy : True Revision : ff068e10-4f13-4a27-a8ab-6df680f39c42 Scopes : TenantId :

EXAMPLE 2

Gets the service accounts associated with the identity provider Identifier

Get-AcctServiceAccount -IdentityProviderIdentifier d1b46f6b-ad4c-4fcc-bb79-8e3c8fd813e8 ServiceAccountUid : 440b77c3-9935-49b2-a696-01914dcffcbe IdentityProviderIdentifier : d1b46f6b-ad4c-4fcc-bb79-8e3c8fd813e8 IdentityProviderType : AzureAD SecretExpiryTime : 9/8/2029 8:00:00 PM AccountId : deb0811e-4839-4cce-87d3-8f36b31c2934 Capabilities : {AzureArcResourceManagement} CustomProperties : Description : description for this service account DisplayName : display name for this service account FailureReason : IsHealthy : True Revision : 34bf0bea-d9dd-4d42-80b2-610ee28230c1 Scopes : {Scope1} TenantId :

EXAMPLE 3

Gets the service account specified by uid 2eccb0ec-a760-44ad-a36d-e0928b4d7926.

Get-AcctServiceAccount -ServiceAccountUid 2eccb0ec-a760-44ad-a36d-e0928b4d7926 ServiceAccountUid : 2eccb0ec-a760-44ad-a36d-e0928b4d7926 IdentityProviderIdentifier : d1b46f6b-ad4c-4fcc-bb79-8e3c8fd813e8 IdentityProviderType : AzureAD SecretExpiryTime : 9/8/2099 8:00:00 PM AccountId : ac14e785-cdb2-4e18-9240-8b49583b11a2 Capabilities : {AzureADDeviceManagement} CustomProperties : Description : description for this service account DisplayName : display name for this service account FailureReason : IsHealthy : True Revision : 34bf0bea-d9dd-4d42-80b2-610ee28230c1 Scopes : TenantId :

EXAMPLE 4

Gets the service account capabilities specified by uid 2eccb0ec-a760-44ad-a36d-e0928b4d7926.

$account = Get-AcctServiceAccount -ServiceAccountUid 2eccb0ec-a760-44ad-a36d-e0928b4d7926 $account.Capabilities Name EffectiveScope IsHealthy FailureReason ---- -------------- ----------------- ----------------- AzureADDeviceManagement False Device.ReadWrite.All IntuneDeviceManagement False DeviceManagementManagedDevices.ReadWrite.All

Parameters

-ServiceAccountUid

The unique identifier for the service account.

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

-IdentityProviderUid

The unique identifier for the identity provider that associates with the service account.

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

-IsHealthy

Whether the service account is healthy or not.

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

-ScopeId

Gets only results with a scope matching the specified scope identifier.

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

-ScopeName

Gets only results with a scope matching the specified scope name.

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

-IdentityProviderIdentifier

The identifier for the identity provider that associates with 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

-ReturnTotalRecordCount

See about_Acct_Filtering for details.

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

-MaxRecordCount

See about_Acct_Filtering for details.

Type: Int32
Position: Named
Default value: 250
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Skip

See about_Acct_Filtering for details.

Type: Int32
Position: Named
Default value: 0
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SortBy

See about_Acct_Filtering for details.

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

-Filter

See about_Acct_Filtering for details.

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

-FilterScope

Gets only results allowed by the specified scope id.

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.

  • Revison <GUID>

    The revision of the service account.

  • CustomProperties <string>

    The custom properties of the service account.

Notes

In the case of failure the following errors can result:

  • PartialData

    Only a subset of the available data was returned.

  • CouldNotQueryDatabase

    The query required to get the database was not defined.

  • 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

  • CommunicationError

    An error occurred while communicating with the service.

  • DatabaseNotConfigured

    The operation could not be completed because the database for the service is not configured.

  • InvalidFilter

    A filtering expression was supplied that could not be interpreted for this cmdlet.

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

Get-AcctServiceAccount