RegisteredServer Class

Reference

Definition

Namespace:: Microsoft.SqlServer.Management.Smo.RegisteredServers

Assembly:: Microsoft.SqlServer.SmoExtended.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Caution

Instead use namespace Microsoft.SqlServer.Management.RegisteredServers

The RegisteredServer object represents a SQL Server registered server.

public ref class RegisteredServer sealed : Microsoft::SqlServer::Management::Smo::RegisteredServers::RegSvrSmoObject, Microsoft::SqlServer::Management::Common::IAlterable, Microsoft::SqlServer::Management::Common::ICreatable, Microsoft::SqlServer::Management::Common::IDroppable

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

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

Public NotInheritable Class RegisteredServer
Inherits RegSvrSmoObject
Implements IAlterable, ICreatable, IDroppable

Inheritance: Object

SmoObjectBase

RegSvrSmoObject
RegisteredServer

Attributes: ObsoleteAttribute

Implements: IAlterable ICreatable IDroppable

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.

Constructors

RegisteredServer()	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.
RegisteredServer(String)	Initializes a new instance of the RegisteredServer object.

Properties

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.
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)

Methods

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.
GetSmoObject(Urn)	Gets a RegSvrSmoObject that is specified by a URN.
ImplInitialize(String[], OrderBy[])	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)
Refresh()	Refreshes the properties of the object. (Inherited from RegSvrSmoObject)
SetParentImpl(RegSvrSmoObject)	Sets a parent. (Inherited from RegSvrSmoObject)
UpdateObjectState()	Gets the updated object state. (Inherited from RegSvrSmoObject)
Validate(String, Object[])	Validates the state of an object. (Inherited from SmoObjectBase)

Applies to