RegisteredServer Class

Note: This API is now obsolete.

The RegisteredServer object represents a SQL Server registered server.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.RegisteredServers.RegSvrSmoObject
      Microsoft.SqlServer.Management.Smo.RegisteredServers.RegisteredServer

Namespace:  Microsoft.SqlServer.Management.Smo.RegisteredServers
Assembly:  Microsoft.SqlServer.SmoExtended (in Microsoft.SqlServer.SmoExtended.dll)

Syntax

'Declaration
<ObsoleteAttribute("Instead use namespace Microsoft.SqlServer.Management.RegisteredServers")> _
Public NotInheritable Class RegisteredServer _
    Inherits RegSvrSmoObject _
    Implements ICreatable, IAlterable, IDroppable
'Usage
Dim instance As RegisteredServer

[ObsoleteAttribute("Instead use namespace Microsoft.SqlServer.Management.RegisteredServers")]
public sealed class RegisteredServer : RegSvrSmoObject, 
    ICreatable, IAlterable, IDroppable

[ObsoleteAttribute(L"Instead use namespace Microsoft.SqlServer.Management.RegisteredServers")]
public ref class RegisteredServer sealed : public RegSvrSmoObject, 
    ICreatable, IAlterable, IDroppable

[<SealedAttribute>]
[<ObsoleteAttribute("Instead use namespace Microsoft.SqlServer.Management.RegisteredServers")>]
type RegisteredServer =  
    class
        inherit RegSvrSmoObject
        interface ICreatable
        interface IAlterable
        interface IDroppable
    end

public final class RegisteredServer extends RegSvrSmoObject implements ICreatable, IAlterable, IDroppable

The RegisteredServer type exposes the following members.

Constructors

	Name	Description
	RegisteredServer()	Initializes a new instance of the RegisteredServer object.
	RegisteredServer(String)	Initializes a new instance of the RegisteredServer object.
	RegisteredServer(RegisteredServerCollection, String)	Initializes a new instance of the RegisteredServer object.
	RegisteredServer(ServerGroup, String)	Initializes a new instance of the RegisteredServer object.

Top

Properties

	Name	Description
	Description	Gets or sets a textual description of the referenced registered server.
	Login	Gets or sets the login used to establish a connection with the registered server.
	LoginSecure	Gets or sets the Boolean property value that specifies whether the connection is authenticated by Windows Authentication.
	Name	Gets or sets the name of the object. (Inherited from RegSvrSmoObject.)
	Parent	Gets the ServerGroup object value that specifies the parent of the RegisteredServer object.
	Properties	Gets the properties associated with the object. (Inherited from RegSvrSmoObject.)
	SecurePassword	Gets or sets the password used with SQL Server standard authentication to establish a connection to the registered server.
	ServerInstance	Gets or sets the instance of SQL Server that is the registered server.
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	Urn	Gets the Urn object value that represents the referenced registered server. (Overrides RegSvrSmoObject.Urn.)
	UrnSkeleton	Gets the Urn object that represents the object. (Inherited from RegSvrSmoObject.)
	UserData	Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

	Name	Description
	Alter	Updates any RegisteredServer object property changes on the instance of SQL Server.
	CheckObjectState	Checks the state of the object. (Inherited from RegSvrSmoObject.)
	Create	Creates a registered server on the instance of SQL Server as defined by the RegisteredServer object.
	Drop	Removes the RegisteredServer from the server group and the registered server collection.
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetSmoObject	Gets a RegSvrSmoObject that is specified by a URN.
	GetType	(Inherited from Object.)
	ImplInitialize	Initializes the object. (Inherited from RegSvrSmoObject.)
	Initialize	Initializes the object. (Inherited from RegSvrSmoObject.)
	IsObjectInitialized	Gets a Boolean value that specifies whether the object was initialized. (Inherited from RegSvrSmoObject.)
	MemberwiseClone	(Inherited from Object.)
	Refresh	Refreshes the properties of the object. (Inherited from RegSvrSmoObject.)
	SetParentImpl	Sets a parent. (Inherited from RegSvrSmoObject.)
	ToString	(Inherited from Object.)
	UpdateObjectState	Gets the updated object state. (Inherited from RegSvrSmoObject.)
	Validate	Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Remarks

Thread Safety

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

To get or set RegisteredServer object properties, users must be a member of the sysadmin fixed server role.

To create or drop a registered server, users must be a member of the sysadmin fixed server role.

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.SqlServer.Management.Smo.RegisteredServers Namespace

Other Resources

Managing Registered Servers