ITeamFoundationIdentityService.ReadIdentity Method (TeamFoundationRequestContext, IdentitySearchFactor, String, MembershipQuery, ReadIdentityOptions, IEnumerable<String>, IdentityPropertyScope)
Overload for above method that takes a single search factor and returns match following this order. 1. When there is no match, null. 2. When there is a single match, that identity regardless of whether the identity is active. 3. When there is a single active identity match, that identity.
Namespace: Microsoft.TeamFoundation.Server.Core
Assembly: Microsoft.TeamFoundation.Server.Core (in Microsoft.TeamFoundation.Server.Core.dll)
Syntax
'Declaration
Function ReadIdentity ( _
requestContext As TeamFoundationRequestContext, _
searchFactor As IdentitySearchFactor, _
factorValue As String, _
queryMembership As MembershipQuery, _
readOptions As ReadIdentityOptions, _
propertyNameFilters As IEnumerable(Of String), _
propertyScope As IdentityPropertyScope _
) As TeamFoundationIdentity
TeamFoundationIdentity ReadIdentity(
TeamFoundationRequestContext requestContext,
IdentitySearchFactor searchFactor,
string factorValue,
MembershipQuery queryMembership,
ReadIdentityOptions readOptions,
IEnumerable<string> propertyNameFilters,
IdentityPropertyScope propertyScope
)
TeamFoundationIdentity^ ReadIdentity(
TeamFoundationRequestContext^ requestContext,
IdentitySearchFactor searchFactor,
String^ factorValue,
MembershipQuery queryMembership,
ReadIdentityOptions readOptions,
IEnumerable<String^>^ propertyNameFilters,
IdentityPropertyScope propertyScope
)
abstract ReadIdentity :
requestContext:TeamFoundationRequestContext *
searchFactor:IdentitySearchFactor *
factorValue:string *
queryMembership:MembershipQuery *
readOptions:ReadIdentityOptions *
propertyNameFilters:IEnumerable<string> *
propertyScope:IdentityPropertyScope -> TeamFoundationIdentity
function ReadIdentity(
requestContext : TeamFoundationRequestContext,
searchFactor : IdentitySearchFactor,
factorValue : String,
queryMembership : MembershipQuery,
readOptions : ReadIdentityOptions,
propertyNameFilters : IEnumerable<String>,
propertyScope : IdentityPropertyScope
) : TeamFoundationIdentity
Parameters
requestContext
Type: Microsoft.TeamFoundation.Framework.Server.TeamFoundationRequestContextOnly required when read options includes extended properties, refer Prpoperty Service API. Can be null otherwise.
- searchFactor
Type: Microsoft.TeamFoundation.Framework.Common.IdentitySearchFactor
- factorValue
Type: System.String
- queryMembership
Type: Microsoft.TeamFoundation.Framework.Common.MembershipQuery
- readOptions
Type: Microsoft.TeamFoundation.Framework.Common.ReadIdentityOptions
- propertyNameFilters
Type: System.Collections.Generic.IEnumerable<String>
- propertyScope
Type: Microsoft.TeamFoundation.Framework.Common.IdentityPropertyScope
Return Value
Type: Microsoft.TeamFoundation.Server.Core.TeamFoundationIdentity
Returns TeamFoundationIdentity.
Exceptions
| Exception | Condition |
|---|---|
| MultipleIdentitiesFoundException | Thrown when there are multiple matches, unless exactly one identity is active. |
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.