Partager via

IdentityManagementWebService2 Class

  • Article

Inheritance Hierarchy

System.Object
  System.ComponentModel.MarshalByValueComponent
    System.Web.Services.WebService
      Microsoft.TeamFoundation.Server.Core.WebServices.TeamFoundationWebService
        Microsoft.TeamFoundation.Server.Core.WebServices.FrameworkWebService
          Microsoft.TeamFoundation.Server.Core.WebServices.IdentityManagementWebService
            Microsoft.TeamFoundation.Server.Core.WebServices.IdentityManagementWebService2

Namespace:  Microsoft.TeamFoundation.Server.Core.WebServices
Assembly:  Microsoft.TeamFoundation.Server.Core (in Microsoft.TeamFoundation.Server.Core.dll)

Syntax

'Declaration
<WebServiceAttribute(Namespace := "https://microsoft.com/webservices/")> _
<ClientServiceAttribute(ComponentName := "Framework", RegistrationName := "Framework",  _
    ServerConfiguration := ServerConfiguration.TfsConnection, ServiceName := "IdentityManagementService2",  _
    CollectionServiceIdentifier := "A4CE4577-B38E-49C8-BDB4-B9C53615E0DA",  _
    ConfigurationServiceIdentifier := "6A67CA20-F7B4-4586-B8B6-CB4DA7234919")> _
Public Class IdentityManagementWebService2 _
    Inherits IdentityManagementWebService

[WebServiceAttribute(Namespace = "https://microsoft.com/webservices/")]
[ClientServiceAttribute(ComponentName = "Framework", RegistrationName = "Framework", 
    ServerConfiguration = ServerConfiguration.TfsConnection, ServiceName = "IdentityManagementService2", 
    CollectionServiceIdentifier = "A4CE4577-B38E-49C8-BDB4-B9C53615E0DA", 
    ConfigurationServiceIdentifier = "6A67CA20-F7B4-4586-B8B6-CB4DA7234919")]
public class IdentityManagementWebService2 : IdentityManagementWebService

[WebServiceAttribute(Namespace = L"https://microsoft.com/webservices/")]
[ClientServiceAttribute(ComponentName = L"Framework", RegistrationName = L"Framework", 
    ServerConfiguration = ServerConfiguration::TfsConnection, ServiceName = L"IdentityManagementService2", 
    CollectionServiceIdentifier = L"A4CE4577-B38E-49C8-BDB4-B9C53615E0DA", 
    ConfigurationServiceIdentifier = L"6A67CA20-F7B4-4586-B8B6-CB4DA7234919")]
public ref class IdentityManagementWebService2 : public IdentityManagementWebService

[<WebServiceAttribute(Namespace = "https://microsoft.com/webservices/")>]
[<ClientServiceAttribute(ComponentName = "Framework", RegistrationName = "Framework", 
    ServerConfiguration = ServerConfiguration.TfsConnection, ServiceName = "IdentityManagementService2", 
    CollectionServiceIdentifier = "A4CE4577-B38E-49C8-BDB4-B9C53615E0DA", 
    ConfigurationServiceIdentifier = "6A67CA20-F7B4-4586-B8B6-CB4DA7234919")>]
type IdentityManagementWebService2 =  
    class 
        inherit IdentityManagementWebService 
    end

public class IdentityManagementWebService2 extends IdentityManagementWebService

The IdentityManagementWebService2 type exposes the following members.

Constructors

  Name Description
Public method IdentityManagementWebService2 Builds the web service and our base class.

Top

Properties

  Name Description
Public property Application Gets the application object for the current HTTP request. (Inherited from WebService.)
Public property Container Gets the container for the component. (Inherited from MarshalByValueComponent.)
Public property Context Gets the ASP.NET HttpContext for the current request, which encapsulates all HTTP-specific context used by the HTTP server to process Web requests. (Inherited from WebService.)
Public property DesignMode Gets a value indicating whether the component is currently in design mode. (Inherited from MarshalByValueComponent.)
Protected property Events Gets the list of event handlers that are attached to this component. (Inherited from MarshalByValueComponent.)
Protected property RequestContext The RequestContext associated with this web service request. (Inherited from TeamFoundationWebService.)
Public property Server Gets the HttpServerUtility for the current request. (Inherited from WebService.)
Public property Session Gets the HttpSessionState instance for the current request. (Inherited from WebService.)
Public property Site Gets or sets the site of the component. (Inherited from MarshalByValueComponent.)
Public property SoapVersion Gets the version of the SOAP protocol used to make the SOAP request to the XML Web service. (Inherited from WebService.)
Public property User Gets the ASP.NET server User object. Can be used to authenticate whether a user is authorized to execute the request. (Inherited from WebService.)

Top

Methods

  Name Description
Public method AddMemberToApplicationGroup Add member to TFS Group. (Inherited from IdentityManagementWebService.)
Public method AddRecentUser Adds the passed in guid to recent user list for the calling user
Protected method AddWebServiceResource Adds IDisposable resources used by Web Service methods which should be disposed at the end of the request. (Inherited from TeamFoundationWebService.)
Public method CreateApplicationGroup Creates a TFS application group (Inherited from IdentityManagementWebService.)
Public method DeleteApplicationGroup Deletes a TFS application group (Inherited from IdentityManagementWebService.)
Public method Dispose() Releases all resources used by the MarshalByValueComponent. (Inherited from MarshalByValueComponent.)
Protected method Dispose(Boolean) Releases the unmanaged resources used by the MarshalByValueComponent and optionally releases the managed resources. (Inherited from MarshalByValueComponent.)
Protected method EnterMethod EnterMethod is used to note the beginning of the WebMethod execution. (Inherited from TeamFoundationWebService.)
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 MarshalByValueComponent.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetMostRecentlyUsedUsers Get the set of identities which have been recently accessed by the current user
Public method GetScopeName Gets the name of the scope for the provided id (Inherited from IdentityManagementWebService.)
Public method GetService Gets the implementer of the IServiceProvider. (Inherited from MarshalByValueComponent.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method HandleException This basic WebService ExceptionHandler captures the exception and records it in the request Context for future logging. Services may choose to over-ride this method, perform some actions based on the exception, changing the exception, eating it or just letting it pass. (Inherited from TeamFoundationWebService.)
Public method IsMember Expanded membership query. (Inherited from IdentityManagementWebService.)
Protected method LeaveMethod LeaveMethod should be called as the last piece of code within the execution of the WebMethod's scope. (Inherited from TeamFoundationWebService.)
Public method ListApplicationGroups Lists all TFS application groups within the specified scope (Inherited from IdentityManagementWebService.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method PrepareForWebServiceSerialization (Inherited from IdentityManagementWebService.)
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 full details on the expressions capabilities see documentation on the QueryExpression class.
Public method ReadIdentities Read identities. First try IMS store, then optionally source like AD. The actual source will be indicated by a property of the identity object itself. (Inherited from IdentityManagementWebService.)
Public method ReadIdentitiesByDescriptor 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. (Inherited from IdentityManagementWebService.)
Public method ReadIdentitiesById Read identities by Team Foundation Id. Note - performs FASTEST when no membership information is requested. (Inherited from IdentityManagementWebService.)
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). (Inherited from IdentityManagementWebService.)
Public method RemoveMemberFromApplicationGroup Remove member from TFS Group. (Inherited from IdentityManagementWebService.)
Public method SetCustomDisplayName 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 full details on the expressions capabilities see documentation on the QueryExpression class.
Protected method SetMethodName Sets the method name (does NOT call EnterMethod) This is meant to be called with the same instance of methodInformation, but without the parameters so that the method is correctly logged in the activity log rather than just its URL. (Inherited from TeamFoundationWebService.)
Public method ToString Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from MarshalByValueComponent.)
Public method UpdateApplicationGroup Updates a property of a TFS application group (Inherited from IdentityManagementWebService.)
Public method UpdateIdentityExtendedProperties

Top

Events

  Name Description
Public event Disposed Adds an event handler to listen to the Disposed event on the component. (Inherited from MarshalByValueComponent.)

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.Server.Core.WebServices Namespace