TeamFoundationIdentityService Class

  • Article

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.Framework.Server.TeamFoundationIdentityService

Namespace:  Microsoft.TeamFoundation.Framework.Server
Assembly:  Microsoft.TeamFoundation.Framework.Server (in Microsoft.TeamFoundation.Framework.Server.dll)

Syntax

'Declaration
<TeamFoundationServiceDependency(GetType(TeamFoundationSecurityService))> _
<TeamFoundationServiceDependency(GetType(TeamFoundationRegistryService))> _
<TeamFoundationServiceDependency(GetType(TeamFoundationTaskService))> _
<TeamFoundationServiceDependency(GetType(TeamFoundationSqlNotificationService))> _
<TeamFoundationServiceDependency(GetType(TeamFoundationFeatureAvailabilityService))> _
<TeamFoundationServiceDependency(GetType(TeamFoundationHostManagementService))> _
<TeamFoundationServiceDependency(GetType(TeamFoundationEventService))> _
Public Class TeamFoundationIdentityService _
    Implements ITeamFoundationService, IDisposable, ITeamFoundationIdentityService

[TeamFoundationServiceDependency(typeof(TeamFoundationSecurityService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationRegistryService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationTaskService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationSqlNotificationService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationFeatureAvailabilityService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationHostManagementService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationEventService))]
public class TeamFoundationIdentityService : ITeamFoundationService, 
    IDisposable, ITeamFoundationIdentityService

[TeamFoundationServiceDependency(typeof(TeamFoundationSecurityService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationRegistryService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationTaskService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationSqlNotificationService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationFeatureAvailabilityService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationHostManagementService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationEventService))]
public ref class TeamFoundationIdentityService : ITeamFoundationService, 
    IDisposable, ITeamFoundationIdentityService

[<TeamFoundationServiceDependency(typeof(TeamFoundationSecurityService))>]
[<TeamFoundationServiceDependency(typeof(TeamFoundationRegistryService))>]
[<TeamFoundationServiceDependency(typeof(TeamFoundationTaskService))>]
[<TeamFoundationServiceDependency(typeof(TeamFoundationSqlNotificationService))>]
[<TeamFoundationServiceDependency(typeof(TeamFoundationFeatureAvailabilityService))>]
[<TeamFoundationServiceDependency(typeof(TeamFoundationHostManagementService))>]
[<TeamFoundationServiceDependency(typeof(TeamFoundationEventService))>]
type TeamFoundationIdentityService =  
    class 
        interface ITeamFoundationService 
        interface IDisposable 
        interface ITeamFoundationIdentityService 
    end

public class TeamFoundationIdentityService implements ITeamFoundationService, IDisposable, ITeamFoundationIdentityService

The TeamFoundationIdentityService type exposes the following members.

Properties

  Name Description
Public property ReadBatchSizeLimit

Top

Methods

  Name Description
Public method AddGroupAdministrator Makes the passed-in Team Foundation identity an administrator for the passed in group.
Public method AddMemberToApplicationGroup(TeamFoundationRequestContext, IdentityDescriptor, IdentityDescriptor) Add member to TFS Group.
Public method AddMemberToApplicationGroup(TeamFoundationRequestContext, IdentityDescriptor, TeamFoundationIdentity) Add member to TFS Group.
Public method AddRecentUser AddRecentUser is used to note a user who the calling user has recently used in an action. This enables this system to track recent users and use this list to improve suggestions for the selection of users.
Public method CreateApplicationGroup(TeamFoundationRequestContext, String, String, String) Creates a TFS application group
Public method CreateApplicationGroup(TeamFoundationRequestContext, String, String, String, Boolean, Boolean) Creates a TFS application group.
Public method CreateApplicationGroup(TeamFoundationRequestContext, String, String, String, Boolean, Boolean, Guid)
Public method CreateDescriptor
Public method CreateScope Create a scope for TFS groups (similar to Team Project scope).
Public method CreateUser(TeamFoundationRequestContext, String, String, String) Create a Team Foundation identity (user) with domain\account alias. Users have global scope; they are not scoped to any project. Currently the only usage case for this function is to track an identity imported from another environment. Hence the identity is marked inactive. It is not desirable for it to remain active, because it could interfere with a real, active account by this name.
Public method CreateUser(TeamFoundationRequestContext, String, String, String, Guid)
Public method DeleteApplicationGroup Deletes a TFS application group.
Public method DeleteScope Delete a TFS "scope".
Public method DeleteUser
Public method EnsureIsMember(TeamFoundationRequestContext, IdentityDescriptor, IdentityDescriptor) Ensure that given descriptor is a member of specified TFS Group.
Public method EnsureIsMember(TeamFoundationRequestContext, IdentityDescriptor, TeamFoundationIdentity) Ensure that given descriptor is a member of specified TFS Group.
Public method EnsureNotMember Ensure that given descriptor is not a member of specified TFS Group.
Public method EnsureWellKnownGroupExists Ensure that a well-known TFS application group has been created.
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetIdentityChanges
Public method GetMostRecentlyUsedUsers
Public method GetPreferredEmailAddress(TeamFoundationRequestContext, Guid)
Public method GetPreferredEmailAddress(TeamFoundationRequestContext, Guid, Boolean)
Public method GetProjectAdminSid
Public method GetScopeInfo Get information about a IMS scope.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IsIdentityCached(TeamFoundationRequestContext, IdentityDescriptor) Obsolete. Check if a particular ID is cached.
Public method IsIdentityCached(TeamFoundationRequestContext, SecurityIdentifier)
Public method IsMember(TeamFoundationRequestContext, IdentityDescriptor, IdentityDescriptor) Expanded membership query.
Public method IsMember(TeamFoundationRequestContext, IdentityDescriptor, IdentityDescriptor, Boolean) Expanded membership query.
Public method ListApplicationGroups(TeamFoundationRequestContext, String, ReadIdentityOptions, IEnumerable<String>)
Public method ListApplicationGroups(TeamFoundationRequestContext, String, ReadIdentityOptions, IEnumerable<String>, IdentityPropertyScope) Lists all TFS application groups in the specified scope.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ReadFilteredIdentities ReadFilteredIdentities is used to retrieve a set of identities based on an expression. The expression is a syntax that resembles a SQL WHERE clause. For details about the expressions capabilities, see the documentation of the QueryExpression class. There are two parts to the expression. There are a set of values that can be used from the identity and they must be AND'ed together. These are things such as the identities DisplayName or IdentityType. All string comparisons are performed case insensitive. Specific Properties available from all identities: Microsoft.TeamFoundation.Identity Supports: In (FUTURE) -- A direct member of the value which must be a TFID. Under (FUTURE) -- A direct or indirect member of the value which must be a TFID. Near -- Specilized term that has extensible conditions that define near Value must be a TFID. Microsoft.TeamFoundation.Identity.DisplayName Supports: = -- The display name of the identity is equal to the value. Contains -- The display name of the identity contains to the value. StartsWith -- The display name of the identity is starts with the value Microsoft.TeamFoundation.Identity.Type. Supports: = -- Value must be 'Group' or 'User' Microsoft.TeamFoundation.Identity.Scope. Supports: = -- Value must a string representing the scope Valid scopes are [SERVER], [projecturi], [projectname], and projecturi. If this condition is not supplied, [SERVER] is used. All other properties will compared with extensible properties associated with the identity. These comparisons MUST follow any well-known properties otherwise these comaprisons will be made against extensible properties. No parentheses are supported.
Public method ReadIdentities(TeamFoundationRequestContext, array<IdentityDescriptor[]) Read identities for given descriptors. Simple overload.
Public method ReadIdentities(TeamFoundationRequestContext, array<Guid[]) Read identities by Team Foundation ID.
Public method ReadIdentities(TeamFoundationRequestContext, IdentitySearchFactor, array<String[]) Read identities. Simple overload, see below.
Public method ReadIdentities(TeamFoundationRequestContext, array<IdentityDescriptor[], MembershipQuery, ReadIdentityOptions, IEnumerable<String>)
Public method ReadIdentities(TeamFoundationRequestContext, array<Guid[], MembershipQuery, ReadIdentityOptions, IEnumerable<String>) Read identities by Team Foundation ID. Note - performs FASTEST when no membership information is requested.
Public method ReadIdentities(TeamFoundationRequestContext, IdentitySearchFactor, array<String[], MembershipQuery, ReadIdentityOptions, IEnumerable<String>) Read identities. First try IMS store, and then optionally source like AD. The actual source will be indicated by a property of the identity object itself.
Public method ReadIdentities(TeamFoundationRequestContext, array<IdentityDescriptor[], MembershipQuery, ReadIdentityOptions, IEnumerable<String>, IdentityPropertyScope) Read identities for given descriptors. First try IMS store. If not found, optionally try source like AD. The actual source will be indicated by a property of the identity object itself. Note - performs FASTEST when no membership information is requested.
Public method ReadIdentities(TeamFoundationRequestContext, array<Guid[], MembershipQuery, ReadIdentityOptions, IEnumerable<String>, IdentityPropertyScope) Read identities by Team Foundation Id. Note - performs FASTEST when no membership information is requested.
Public method ReadIdentities(TeamFoundationRequestContext, IdentitySearchFactor, array<String[], MembershipQuery, ReadIdentityOptions, IEnumerable<String>, IdentityPropertyScope) Read identities. First try IMS store, and then optionally source like AD. The actual source will be indicated by a property of the identity object itself.
Public method ReadIdentity(TeamFoundationRequestContext, String) Overload 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.
Public method ReadIdentity(TeamFoundationRequestContext, IdentitySearchFactor, String) See overload.
Public method ReadIdentity(TeamFoundationRequestContext, IdentityDescriptor, MembershipQuery, ReadIdentityOptions) Overload that takes a single descriptor.
Public method ReadIdentity(TeamFoundationRequestContext, IdentitySearchFactor, String, MembershipQuery, ReadIdentityOptions, IEnumerable<String>) Overload 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.
Public method ReadIdentity(TeamFoundationRequestContext, IdentityDescriptor, MembershipQuery, ReadIdentityOptions, IEnumerable<String>, IdentityPropertyScope)
Public method ReadIdentity(TeamFoundationRequestContext, IdentitySearchFactor, String, MembershipQuery, ReadIdentityOptions, IEnumerable<String>, IdentityPropertyScope) Overload 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.
Public method ReadIdentityFromSource ReadIdentityFromSource is used to retrieve the identity from its source location (AD or GSS).
Public method ReadRequestIdentity(TeamFoundationRequestContext) Resolves the authorized user associated with the request context to a TeamFoundationIdentity.
Public method ReadRequestIdentity(TeamFoundationRequestContext, Boolean) Resolves the authorized user associated with the request context to a TeamFoundationIdentity.
Public method RefreshIdentity Sync an identity now. This identity must already be in the IMS store. If identity is a group, its DIRECT members' properties will also be synced (asynchronously).
Public method RemoveGroupAdministrator Removes the passed-in Team Foundation identity from being an administrator for the passed in group.
Public method RemoveMemberFromApplicationGroup(TeamFoundationRequestContext, IdentityDescriptor, IdentityDescriptor) Remove member from TFS Group.
Public method RemoveMemberFromApplicationGroup(TeamFoundationRequestContext, IdentityDescriptor, IdentityDescriptor, Boolean)
Public method RenameScope Rename a TFS "scope".
Public method SetCustomDisplayName Set or remove a custom display name for the calling user.
Public method SetPreferredEmailAddress
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method TryReadRequestIdentity(TeamFoundationRequestContext, TeamFoundationIdentity%)
Public method TryReadRequestIdentity(TeamFoundationRequestContext, Boolean, TeamFoundationIdentity%)
Public method UpdateApplicationGroup Updates a property of a TFS application group.
Public method UpdateExtendedProperties(TeamFoundationRequestContext, IdentityDescriptor, IEnumerable<PropertyValue>)
Public method UpdateExtendedProperties(TeamFoundationRequestContext, IdentityPropertyScope, IdentityDescriptor, IEnumerable<PropertyValue>)
Public method UpdateIdentities
Public method UpdateIdentity Update identity properties.

Top

Fields

  Name Description
Public field OnPreferredEmailAddressChanged

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IDisposable.Dispose
Explicit interface implemetationPrivate method ITeamFoundationService.ServiceEnd
Explicit interface implemetationPrivate method ITeamFoundationService.ServiceStart

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.TeamFoundation.Framework.Server Namespace