TechNet
Export (0) Print
Expand All

RegisteredServer Class

 

Represents a SQL Server registered server.

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

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

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

NameDescription
System_CAPS_pubmethodRegisteredServer()

Initializes a new instance of the RegisteredServer class with the default property values.

System_CAPS_pubmethodRegisteredServer(ServerGroup, String)

Initializes a new instance of the RegisteredServer class with the specified name and server.

System_CAPS_pubmethodRegisteredServer(String)

Initializes a new instance of the RegisteredServer class that has the specified name.

NameDescription
System_CAPS_protpropertyAbstractIdentityKey

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubpropertyConnectionString

Gets or sets the connection string that is used to connect to the instance of SQL Server.

System_CAPS_pubpropertyConnectionStringWithEncryptedPassword

Gets the connection string that is used to connect to the instance of SQL Server that has the encrypted password. 

System_CAPS_pubpropertyCredentialPersistenceType

Gets or sets how the logins and passwords are persisted on the registered server.

System_CAPS_pubpropertyCustomConnectionColorArgb

Gets or sets the specified ARGB color of the RegisteredServer object.

System_CAPS_pubpropertyDescription

Gets the name of the registered server.

System_CAPS_pubpropertyID

Gets the ID value that uniquely identifies the registered server.

System_CAPS_pubpropertyIdentityKey

Gets the key value that uniquely identifies the registered server.

System_CAPS_pubpropertyIsDropped

Gets the Boolean value that specifies whether the registered server has been dropped or not.

System_CAPS_pubpropertyIsLocal

Gets the Boolean value that specifies whether the registered server is local or not.

System_CAPS_pubpropertyMetadata

Returns metadata about the instance and its domain.(Inherited from SfcInstance.)

System_CAPS_pubpropertyName

Gets the name of the RegisteredServer object.

System_CAPS_pubpropertyParent

Gets the parent of the RegisteredServer object.

System_CAPS_pubpropertyProperties

Returns a collection instance properties.(Inherited from SfcInstance.)

System_CAPS_pubpropertySecureConnectionString

Gets or sets the secure string that is used to connect to the instance of SQL Server.

System_CAPS_pubpropertyServerName

Gets or sets the name of the server that is associated with the registered server.

System_CAPS_pubpropertyServerType

Gets or the kind of server that is associated with the registered server.

System_CAPS_protpropertyState

Returns the state of the SfcInstance object.(Inherited from SfcInstance.)

System_CAPS_pubpropertyUrn

Returns the uniform resource name of the SfcInstance object.(Inherited from SfcInstance.)

System_CAPS_pubpropertyUseCustomConnectionColor

Gets or sets a value indicating whether the object uses a custom connection color.

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_protmethodCreateIdentityKey()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodDiscover(ISfcDependencyDiscoveryObjectSink)

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodDrop()

Drops the registered server.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodExport(String, CredentialPersistenceType)

Exports the registered server to the specified file and using the given credential persistence type.

System_CAPS_protmethodGetChildCollection(String)

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodGetConnectionObject()

Returns the SFC interface object that represents the connection to the instance of SQL Server.

System_CAPS_pubmethodGetDomain()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_staticGetObjectFactory()

Returns the SFC object factory for the RegisteredServer object.

System_CAPS_pubmethodGetPropertySet()

Returns the set of properties for the SfcInstance object.(Inherited from SfcInstance.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodGetTypeMetadataImpl()

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

System_CAPS_protmethodInitializeUIPropertyState()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodMove(ServerGroup)

Specifies the RegisteredServer to move in a new location.

System_CAPS_protmethodOnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs)

Invoked whenever the effective value of any SfcInstance metadata is updated. (Inherited from SfcInstance.)

System_CAPS_protmethodOnPropertyValueChanges(PropertyChangedEventArgs)

Invoked whenever the effective value of any SfcInstance property is updated. (Inherited from SfcInstance.)

System_CAPS_pubmethodRefresh()

Refreshes the object's properties by reading them from the server.(Inherited from SfcInstance.)

System_CAPS_pubmethodRename(SfcKey)

Specifies the RegisteredServer object to rename.

System_CAPS_pubmethodRename(String)

Renames the RegisteredServer object by using the specified name.

System_CAPS_protmethodResetKey()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodSerialize(XmlWriter)

Serializes the instance to XML.(Inherited from SfcInstance.)

System_CAPS_pubmethodToString()

Returns a string representation of the instance Urn.(Inherited from SfcInstance.)

System_CAPS_pubmethodValidate(String, Object[])

Validates the RegisteredServer object against the specified method and arguments.

NameDescription
System_CAPS_pubeventPropertyChanged

(Inherited from SfcInstance.)

System_CAPS_pubeventPropertyMetadataChanged

(Inherited from SfcInstance.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcAlterable.ScriptAlter()

Alters the properties of the base object if it has been changed. This class cannot be inherited.

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcCreatable.ScriptCreate()

Produces the script to create this object to storage in its current state. This class cannot be inherited.

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcDroppable.ScriptDrop()

Produces the script to drop this object from storage. This class cannot be inherited.

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcMovable.Move(SfcInstance)

Moves this object under the specified parent object and updates the storage to reflect the move. This class cannot be inherited.

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcMovable.ScriptMove(SfcInstance)

Produces the script to move this object under the specified parent object. This class cannot be inherited.

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcRenamable.ScriptRename(SfcKey)

Renames the instance of ISfcScript identified by the key parameter. This class cannot be inherited.

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

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.

Return to top
Show:
© 2016 Microsoft