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)

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

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

NameDescription
System_CAPS_pubmethodRegisteredServer()

Initializes a new instance of the RegisteredServer object.

System_CAPS_pubmethodRegisteredServer(RegisteredServerCollection, String)

Initializes a new instance of the RegisteredServer object.

System_CAPS_pubmethodRegisteredServer(ServerGroup, String)

Initializes a new instance of the RegisteredServer object.

System_CAPS_pubmethodRegisteredServer(String)

Initializes a new instance of the RegisteredServer object.

NameDescription
System_CAPS_pubpropertyDescription

Gets or sets a textual description of the referenced registered server.

System_CAPS_pubpropertyLogin

Gets or sets the login used to establish a connection with the registered server.

System_CAPS_pubpropertyLoginSecure

Gets or sets the Boolean property value that specifies whether the connection is authenticated by Windows Authentication.

System_CAPS_pubpropertyName

Gets or sets the name of the object. (Inherited from RegSvrSmoObject.)

System_CAPS_pubpropertyParent

Gets the ServerGroup object value that specifies the parent of the RegisteredServer object.

System_CAPS_pubpropertyProperties

Gets the properties associated with the object. (Inherited from RegSvrSmoObject.)

System_CAPS_pubpropertySecurePassword

Gets or sets the password used with SQL Server standard authentication to establish a connection to the registered server.

System_CAPS_pubpropertyServerInstance

Gets or sets the instance of SQL Server that is the registered server.

System_CAPS_pubpropertyState

Gets the state of the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertyUrn

Gets the T:Microsoft.SqlServer.Management.Smo.Urn object value that represents the referenced registered server. (Overrides RegSvrSmoObject.Urn.)

System_CAPS_protpropertyUrnSkeleton

Gets the T:Microsoft.SqlServer.Management.Smo.Urn object that represents the object. (Inherited from RegSvrSmoObject.)

System_CAPS_pubpropertyUserData

Gets or sets user-defined data associated with the referenced object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubmethodAlter()

Updates any RegisteredServer object property changes on the instance of SQL Server. 

System_CAPS_pubmethodCreate()

Creates a registered server on the instance of SQL Server as defined by the RegisteredServer object.

System_CAPS_pubmethodDrop()

Removes the RegisteredServer from the server group and the registered server collection.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetSmoObject(Urn)

Gets a RegSvrSmoObject that is specified by a URN.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitialize()

Initializes the object.(Inherited from RegSvrSmoObject.)

System_CAPS_protmethodIsObjectInitialized()

Gets a Boolean value that specifies whether the object was initialized.(Inherited from RegSvrSmoObject.)

System_CAPS_pubmethodRefresh()

Refreshes the properties of the object.(Inherited from RegSvrSmoObject.)

System_CAPS_protmethodSetParentImpl(RegSvrSmoObject)

Sets a parent.(Inherited from RegSvrSmoObject.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodValidate(String, Object[])

Validates the state of an object.(Inherited from SmoObjectBase.)

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.

Return to top
Show: