Export (0) Print
Expand All

RegisteredServer Class

Represents a registered server.

Object
  Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance
    Microsoft.SqlServer.Management.RegisteredServers.RegisteredServer

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

public sealed class RegisteredServer : SfcInstance, 
	ISfcValidate, ISfcCreatable, ICreatable, ISfcAlterable, IAlterable, 
	ISfcDroppable, IDroppable, ISfcRenamable, IRenamable, ISfcMovable

The RegisteredServer type exposes the following members.

  NameDescription
Public methodRegisteredServer()Initializes a new instance of the RegisteredServer class with the default property values.
Public methodRegisteredServer(String)Initializes a new instance of the RegisteredServer class that has the specified name.
Public methodRegisteredServer(ServerGroup, String)Initializes a new instance of the RegisteredServer class with the specified name and server.
Top

  NameDescription
Protected propertyAbstractIdentityKeyDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public propertyConnectionStringGets or sets the connection string that is used to connect to the instance of SQL Server.
Public propertyConnectionStringWithEncryptedPasswordGets the connection string that is used to connect to the instance of SQL Server that has the encrypted password. 
Public propertyCredentialPersistenceTypeGets or sets how the logins and passwords are persisted on the registered server.
Public propertyCustomConnectionColorArgbGets or sets the specified ARGB color of the RegisteredServer object.
Public propertyDescriptionGets the name of the registered server.
Public propertyIDGets the ID value that uniquely identifies the registered server.
Public propertyIdentityKeyGets the key value that uniquely identifies the registered server.
Public propertyIsDroppedGets the Boolean value that specifies whether the registered server has been dropped or not.
Public propertyIsLocalGets the Boolean value that specifies whether the registered server is local or not.
Public propertyMetadataReturns metadata about the instance and its domain. (Inherited from SfcInstance.)
Public propertyNameGets the name of the RegisteredServer object.
Public propertyParentGets the parent of the RegisteredServer object.
Public propertyPropertiesReturns a collection instance properties. (Inherited from SfcInstance.)
Public propertySecureConnectionStringGets or sets the secure string that is used to connect to the instance of SQL Server.
Public propertyServerNameGets or sets the name of the server that is associated with the registered server.
Public propertyServerTypeGets or the kind of server that is associated with the registered server.
Protected propertyStateReturns the state of the SfcInstance object. (Inherited from SfcInstance.)
Public propertyUrnReturns the uniform resource name of the SfcInstance object. (Inherited from SfcInstance.)
Public propertyUseCustomConnectionColorGets or sets a value indicating whether the object uses a custom connection color.
Top

  NameDescription
Public methodAlterUpdates any RegisteredServer object property changes on the instance of SQL Server. 
Public methodCreateCreates a registered server on the instance of SQL Server as defined by the RegisteredServer object.
Protected methodCreateIdentityKeyDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodDiscoverDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodDropDrops the registered server.
Public methodEquals (Inherited from Object.)
Public methodExportExports the registered server to the specified file and using the given credential persistence type.
Protected methodGetChildCollectionDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodGetConnectionObjectReturns the SFC interface object that represents the connection to the instance of SQL Server.
Public methodGetDomainDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodGetHashCode (Inherited from Object.)
Public methodStatic memberGetObjectFactoryReturns the SFC object factory for the RegisteredServer object.
Public methodGetPropertySetReturns the set of properties for the SfcInstance object. (Inherited from SfcInstance.)
Public methodGetType (Inherited from Object.)
Protected methodGetTypeMetadataImplIndicates the domains that override by returning the right TypeMetadata class directly. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected methodInitializeUIPropertyStateDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodMoveSpecifies the RegisteredServer to move in a new location.
Protected methodOnPropertyMetadataChangesInvoked whenever the effective value of any SfcInstance metadata is updated. (Inherited from SfcInstance.)
Protected methodOnPropertyValueChangesInvoked whenever the effective value of any SfcInstance property is updated. (Inherited from SfcInstance.)
Public methodRefreshRefreshes the object's properties by reading them from the server. (Inherited from SfcInstance.)
Public methodRename(String)Renames the RegisteredServer object by using the specified name.
Public methodRename(SfcKey)Specifies the RegisteredServer object to rename.
Protected methodResetKeyDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodSerializeSerializes the instance to XML. (Inherited from SfcInstance.)
Public methodToStringReturns a string representation of the instance Urn. (Inherited from SfcInstance.)
Public methodValidateValidates the RegisteredServer object against the specified method and arguments.
Top

  NameDescription
Public eventPropertyChangedCLS-compliant event for property changes. (Inherited from SfcInstance.)
Public eventPropertyMetadataChangedCLS-compliant event for property metadata changes. (Inherited from SfcInstance.)
Top

  NameDescription
Explicit interface implemetationPrivate methodISfcAlterable.ScriptAlterAlters the properties of the base object if it has been changed. This class cannot be inherited.
Explicit interface implemetationPrivate methodISfcCreatable.ScriptCreateProduces the script to create this object to storage in its current state. This class cannot be inherited.
Explicit interface implemetationPrivate methodISfcDroppable.ScriptDropProduces the script to drop this object from storage. This class cannot be inherited.
Explicit interface implemetationPrivate methodISfcMovable.MoveMoves this object under the specified parent object and updates the storage to reflect the move. This class cannot be inherited.
Explicit interface implemetationPrivate methodISfcMovable.ScriptMoveProduces the script to move this object under the specified parent object. This class cannot be inherited.
Explicit interface implemetationPrivate methodISfcRenamable.ScriptRenameRenames the instance of ISfcScript identified by the key parameter. This class cannot be inherited.
Top

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft