Export (0) Print
Expand All

RegisteredServer Class

Note: This API is now obsolete.

The RegisteredServer object represents a SQL Server registered server.

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

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

The RegisteredServer type exposes the following members.

  NameDescription
Public methodRegisteredServer()Initializes a new instance of the RegisteredServer object.
Public methodRegisteredServer(String)Initializes a new instance of the RegisteredServer object.
Public methodRegisteredServer(RegisteredServerCollection, String)Initializes a new instance of the RegisteredServer object.
Public methodRegisteredServer(ServerGroup, String)Initializes a new instance of the RegisteredServer object.
Top

  NameDescription
Public propertyDescriptionGets or sets a textual description of the referenced registered server.
Public propertyLoginGets or sets the login used to establish a connection with the registered server.
Public propertyLoginSecureGets or sets the Boolean property value that specifies whether the connection is authenticated by Windows Authentication.
Public propertyNameGets or sets the name of the object. (Inherited from RegSvrSmoObject.)
Public propertyParentGets the ServerGroup object value that specifies the parent of the RegisteredServer object.
Public propertyPropertiesGets the properties associated with the object. (Inherited from RegSvrSmoObject.)
Public propertySecurePasswordGets or sets the password used with SQL Server standard authentication to establish a connection to the registered server.
Public propertyServerInstanceGets or sets the instance of SQL Server that is the registered server.
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
Public propertyUrnGets the Urn object value that represents the referenced registered server. (Overrides RegSvrSmoObject.Urn.)
Protected propertyUrnSkeletonGets the Urn object that represents the object. (Inherited from RegSvrSmoObject.)
Public propertyUserDataGets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public methodAlterUpdates any RegisteredServer object property changes on the instance of SQL Server. 
Protected methodCheckObjectStateChecks the state of the object. (Inherited from RegSvrSmoObject.)
Public methodCreateCreates a registered server on the instance of SQL Server as defined by the RegisteredServer object.
Public methodDropRemoves the RegisteredServer from the server group and the registered server collection.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetSmoObjectGets a RegSvrSmoObject that is specified by a URN.
Public methodGetType (Inherited from Object.)
Protected methodImplInitializeInitializes the object. (Inherited from RegSvrSmoObject.)
Public methodInitializeInitializes the object. (Inherited from RegSvrSmoObject.)
Protected methodIsObjectInitializedGets a Boolean value that specifies whether the object was initialized. (Inherited from RegSvrSmoObject.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodRefreshRefreshes the properties of the object. (Inherited from RegSvrSmoObject.)
Protected methodSetParentImplSets a parent. (Inherited from RegSvrSmoObject.)
Public methodToString (Inherited from Object.)
Protected methodUpdateObjectStateGets the updated object state. (Inherited from RegSvrSmoObject.)
Public methodValidateValidates the state of an object. (Inherited from SmoObjectBase.)
Top

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.

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

Community Additions

ADD
Show:
© 2014 Microsoft