Developer Documentation
Citrix Daas SDK

Get-AcctServiceAccountIdentityPool

November 26, 2024
Contributed by: 
C

Gets the service account associated identity pools.

Syntax

Get-AcctServiceAccountIdentityPool
   -ServiceAccountUid <Guid>
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Provides the ability to retrieve the service account associated identity pools.

Examples

EXAMPLE 1

Gets the service account associated identity pools

Get-AcctServiceAccountIdentityPool -ServiceAccountUid bc291088-9c2b-406e-b0d3-a4ddc0b3da14

ServiceAccountUid                    IdentityPools
-----------------                    -------------
bc291088-9c2b-406e-b0d3-a4ddc0b3da14 {IdentityPool-1, IdentityPool-2, IdentityPool-3,...}
<!--NeedCopy-->

EXAMPLE 2

Gets the service account associated identity pools

(Get-AcctServiceAccountIdentityPool -ServiceAccountUid bc291088-9c2b-406e-b0d3-a4ddc0b3da14).IdentityPools

IdentityPoolName IdentityPoolUid
---------------- ---------------
IdentityPool-1   f361eb59-21b0-49a2-a153-49bd70f1c109
IdentityPool-2   63ea6af9-cbbe-4816-b598-be0521220a34
IdentityPool-3   0e239697-e4b2-4a65-a206-ea90583de68f
<!--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: True

-ReturnTotalRecordCount

When specified, the cmdlet outputs an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Acct_Filtering for details.

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

-MaxRecordCount

Specifies the maximum number of records to return.

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

-Skip

Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.

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

-SortBy

Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present.

Type: String
Position: Named
Default value: The default sort order is by name or unique identifier.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Filter

Gets records that match a PowerShell-style filter expression. 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.ServiceAccountIdentityPool

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

  • ServiceAccountUid <GUID>

    The unique identifier of the service account.

  • IdentityPools <ServiceAccountIdentityPoolReference>

    Array of Identity Pool Uid and Identity Pool Name associated with 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.

  • 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-AcctServiceAccountIdentityPool
November 26, 2024
Contributed by: 
C
November 26, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.