TfsConfigurationServer Class

  • Article

Represents a connection to the server that is running Team Foundation Server.

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.Client.TfsConnection
    Microsoft.TeamFoundation.Client.TfsConfigurationServer

Namespace:  Microsoft.TeamFoundation.Client
Assembly:  Microsoft.TeamFoundation.Client (in Microsoft.TeamFoundation.Client.dll)

Syntax

'Declaration
Public Class TfsConfigurationServer _
    Inherits TfsConnection

public class TfsConfigurationServer : TfsConnection

public ref class TfsConfigurationServer : public TfsConnection

type TfsConfigurationServer =  
    class
        inherit TfsConnection
    end

public class TfsConfigurationServer extends TfsConnection

The TfsConfigurationServer type exposes the following members.

Constructors

  Name Description
Public method TfsConfigurationServer(Uri) Initializes a new instance of the TfsConfigurationServer object.
Public method TfsConfigurationServer(RegisteredConfigurationServer) Initializes a new instance of the TfsConfigurationServer object by using the registration information on the local computer.
Public method TfsConfigurationServer(Uri, ICredentialsProvider) Initializes a new instance of the TfsConfigurationServer object.
Public method TfsConfigurationServer(Uri, IdentityDescriptor) Initializes a new instance of the TfsConfigurationServer object.
Public method TfsConfigurationServer(Uri, ICredentials) Initializes a new instance of the TfsConfigurationServer object.
Public method TfsConfigurationServer(RegisteredConfigurationServer, IdentityDescriptor) Initializes a new instance of the TfsConfigurationServer object by using the registration information on the local computer, and impersonating an identity from IIdentityManagementService.
Public method TfsConfigurationServer(Uri, ICredentials, ICredentialsProvider) Initializes a new instance of the TfsConfigurationServer object.
Public method TfsConfigurationServer(RegisteredConfigurationServer, ICredentials, ICredentialsProvider) Initializes a new instance of the TfsConfigurationServer object.
Public method TfsConfigurationServer(Uri, ICredentials, ICredentialsProvider, IdentityDescriptor) Initializes a new instance of the TfsConfigurationServer object.
Public method TfsConfigurationServer(RegisteredConfigurationServer, ICredentials, ICredentialsProvider, IdentityDescriptor) Initializes a new instance of the TfsConfigurationServer object.

Top

Properties

  Name Description
Public property AuthorizedIdentity Gets the identity that is authorized to make calls to the server that is running Team Foundation Server. (Inherited from TfsConnection.)
Public property CatalogNode Gets the catalog resource that is associated with this instance of TfsConfigurationServer. (Overrides TfsConnection.CatalogNode.)
Protected property CatalogResourceId (Inherited from TfsConnection.)
Public property ClientCacheDirectoryForInstance Gets the path of the directory that is used to cache data from the server that is running Team Foundation Server. (Inherited from TfsConnection.)
Public property Credentials Gets the credentials for this Team Foundation Server instance. (Inherited from TfsConnection.)
Public property Culture Gets or sets the localization environment that is used by the server that is running Team Foundation Server. (Inherited from TfsConnection.)
Public property HasAuthenticated Gets the status of a flag that describes whether this TfsConnection instance has successfully authenticated. (Inherited from TfsConnection.)
Public property InstanceId Gets the GUID that identifies this Team Foundation Server connection. (Inherited from TfsConnection.)
Public property Name Gets the name of this instance of TfsConfigurationServer. (Overrides TfsConnection.Name.)
Public property SessionId Gets the GUID that identifies this instance of the client to the server. (Inherited from TfsConnection.)
Public property TimeZone Gets or sets the time zone of this Team Foundation Server connection. Used to convert dates and times to UTC. (Inherited from TfsConnection.)
Public property Uri Gets the uniform resource identifier (URI) for this Team Foundation Server connection. (Inherited from TfsConnection.)

Top

Methods

  Name Description
Public method Authenticate Authenticates the connection to Team Foundation Server by using the specified credentials provider. (Inherited from TfsConnection.)
Public method Connect Connects to a server that is running Team Foundation Server and returns information based on connectOptions. (Inherited from TfsConnection.)
Protected method CreateInternalProxy (Inherited from TfsConnection.)
Protected method CreateServiceInstance (Inherited from TfsConnection.)
Public method Dispose Notifies related objects of disposal and disposes of this instance of TfsConnection. (Inherited from TfsConnection.)
Public method EnsureAuthenticated Authenticates the connection to Team Foundation Server if it has not been previously authenticated. (Inherited from TfsConnection.)
Public method Equals (Inherited from TfsConnection.)
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 GetAuthenticatedIdentity Gets the identity that authenticated with the server. (Inherited from TfsConnection.)
Public method GetHashCode Gets the hash code of this TfsConnection instance. (Inherited from TfsConnection.)
Public method GetService(Type) Gets the requested service. (Inherited from TfsConnection.)
Public method GetService<T>() Gets the requested service. (Inherited from TfsConnection.)
Protected method GetServiceInstance Gets the base service instance of the specified service. (Overrides TfsConnection.GetServiceInstance(Type, Object).)
Public method GetTeamProjectCollection Gets the TfsTeamProjectCollection that has the specified ID.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method InitializeTeamFoundationObject Initializes the specified Team Foundation Server object. (Overrides TfsConnection.InitializeTeamFoundationObject(String, Object).)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Gets the name of the TfsConnection instance. (Inherited from TfsConnection.)

Top

Events

  Name Description
Public event CredentialsChanged This event is raised when the credentials of the TeamFoundationServer object change. (Inherited from TfsConnection.)

Top

Remarks

TfsConfigurationServer is derived from TfsConnection. It replaces the obsolete class TeamFoundationServer.

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.Client Namespace

TfsConfigurationServerFactory

TfsTeamProjectCollection

Other Resources

Connect to Team Foundation Server from a Console Application