This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
Get-BrokerUser
Gets broker users configured for this site.
Syntax
Get-BrokerUser -SID <String> [-Property <String[]>] [-AdminClientIP <String>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]
Get-BrokerUser [[-Name] <String>] [-DirectoryContext <String>] [-FullName <String>] [-HomeZoneName <String>] [-HomeZoneUid <Guid>] [-IdentityClaims <String>] [-NameLookupFailureCount <Int32>] [-PrimaryClaim <String>] [-UPN <String>] [-ApplicationGroupUid <Int32>] [-ApplicationUid <Int32>] [-SessionLingerDesktopGroupUid <Int32>] [-SessionPreLaunchDesktopGroupUid <Int32>] [-MachineUid <Int32>] [-PrivateDesktopUid <Int32>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-FilterScope <Guid>] [-Property <String[]>] [-AdminClientIP <String>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]
<!--NeedCopy-->
Detailed Description
Retrieve broker users matching the specified criteria. If no parameters are specified this cmdlet enumerates all broker users.
For information about advanced filtering options, see about_Broker_Filtering.
Brokeruser Object
The BrokerUser object represents a single instance of an user. It contains the following properties:
-
DirectoryContext (System.String) The directory context of a user
-
FullName (System.String) The full name of a user
-
HomeZoneName (System.String) Name of home zone associated with user
-
HomeZoneUid (System.Guid?) Home zone associated with this user
-
IdentityClaims (System.String) The identity claims of a user
-
Name (System.String) The name of a user
-
NameLookupFailureCount (System.Int32) Tracks the number of consecutive directory lookup failures for this account
-
PrimaryClaim (System.String) The primary identity claim of a user
-
SID (System.String) The SID of a user
-
UPN (System.String) The UPN of a user
Related Commands
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| SID | Gets the broker user with the specified SID property value. | true | false | |
| Name | Gets the broker user with the specified Name property. | false | false | |
| DirectoryContext | Gets the broker user with the specified directory context property value. | false | false | |
| FullName | Gets the broker user with the specified FullName property. | false | false | |
| HomeZoneName | Gets user/group accounts having a home zone preference matching the specified name. | false | false | |
| HomeZoneUid | Gets user/group accounts having a home zone preference matching the specified UID. | false | false | |
| IdentityClaims | Gets the broker user with the specified identity claims property value. | false | false | |
| NameLookupFailureCount | Tracks the number of consecutive directory lookup failures for this account. | false | false | |
| PrimaryClaim | Gets the broker user with the specified primary claim property value. | false | false | |
| UPN | Gets the broker user with the specified UPN property value. | false | false | |
| ApplicationGroupUid | Gets broker users associated with the application group with the specified Uid. | false | false | |
| ApplicationUid | Gets broker users associated with the application with the specified Uid. | false | false | |
| SessionLingerDesktopGroupUid | Gets broker users associated with the desktop group session linger settings with the specified Uid. | false | false | |
| SessionPreLaunchDesktopGroupUid | Gets broker users associated with the desktop group session pre-launch settings with the specified Uid. | false | false | |
| MachineUid | Gets broker users associated with the broker machine with the specified Uid. | false | false | |
| PrivateDesktopUid | Gets broker users associated with the private desktop with the specified Uid. | false | false | |
| ReturnTotalRecordCount | When specified, this causes the cmdlet to output 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_Broker_Filtering for details. | false | false | False |
| MaxRecordCount | Specifies the maximum number of records to return. | false | false | 250 |
| Skip | Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount. | false | false | 0 |
| 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. | false | false | The default sort order is by name or unique identifier. |
| Filter | Gets records that match a PowerShell style filter expression. See about_Broker_Filtering for details. | false | false | |
| FilterScope | Gets only results allowed by the specified scope id. | false | false | |
| Property | Specifies the properties to be returned. This is similar to piping the output of the command through Select-Object, but the properties are filtered more efficiently at the server. | false | false | |
| AdminClientIP | Internal use only. | false | false | |
| AdminAddress | Specifies the address of a XenDesktop controller that the PowerShell snapin will connect to. This can be provided as a host name or an IP address. | false | false | Localhost. Once a value is provided by any cmdlet, this value will become the default. |
| BearerToken | Specifies the bearer token assigned to the calling user | false | false | |
| TraceParent | Specifies the trace parent assigned for internal diagnostic tracing use | false | false | |
| TraceState | Specifies the trace state assigned for internal diagnostic tracing use | false | false | |
| VirtualSiteId | Specifies the virtual site the PowerShell snap-in will connect to. | false | false |
Input Type
None
You cannot pipe input into this cmdlet.
Return Values
Citrix.Broker.Admin.Sdk.User
Get-BrokerUser returns an object for each matching broker user.
Examples
Example 1
Get-BrokerUser DOMAIN7\\*
<!--NeedCopy-->
Description
Get all broker user objects with names matching the supplied pattern
Example 2
$pdt = Get-BrokerPrivateDesktop DOMAIN\MACHINENAME\n
Get-BrokerUser -PrivateDesktopUid $pdt.Uid
<!--NeedCopy-->
Description
Get all broker user objects added to the specified private desktop
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.