RegisteredServer Class
Represents a registered server.
Inheritance Hierarchy
System.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)
Syntax
'Declaration
Public NotInheritable Class RegisteredServer _
Inherits SfcInstance _
Implements ISfcValidate, ISfcCreatable, ICreatable, ISfcAlterable, _
IAlterable, ISfcDroppable, IDroppable, ISfcRenamable, IRenamable, _
ISfcMovable
'Usage
Dim instance As RegisteredServer
public sealed class RegisteredServer : SfcInstance,
ISfcValidate, ISfcCreatable, ICreatable, ISfcAlterable, IAlterable,
ISfcDroppable, IDroppable, ISfcRenamable, IRenamable, ISfcMovable
public ref class RegisteredServer sealed : public SfcInstance,
ISfcValidate, ISfcCreatable, ICreatable, ISfcAlterable, IAlterable,
ISfcDroppable, IDroppable, ISfcRenamable, IRenamable, ISfcMovable
[<SealedAttribute>]
type RegisteredServer =
class
inherit SfcInstance
interface ISfcValidate
interface ISfcCreatable
interface ICreatable
interface ISfcAlterable
interface IAlterable
interface ISfcDroppable
interface IDroppable
interface ISfcRenamable
interface IRenamable
interface ISfcMovable
end
public final class RegisteredServer extends SfcInstance implements ISfcValidate, ISfcCreatable, ICreatable, ISfcAlterable, IAlterable, ISfcDroppable, IDroppable, ISfcRenamable, IRenamable, ISfcMovable
The RegisteredServer type exposes the following members.
Constructors
Name | Description | |
---|---|---|
RegisteredServer() | Initializes a new instance of the RegisteredServer class with the default property values. | |
RegisteredServer(String) | Initializes a new instance of the RegisteredServer class that has the specified name. | |
RegisteredServer(ServerGroup, String) | Initializes a new instance of the RegisteredServer class with the specified name and server. |
Top
Properties
Name | Description | |
---|---|---|
AbstractIdentityKey | Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.) | |
ConnectionString | Gets or sets the connection string that is used to connect to the instance of SQL Server. | |
ConnectionStringWithEncryptedPassword | Gets the connection string that is used to connect to the instance of SQL Server that has the encrypted password. | |
CredentialPersistenceType | Gets or sets how the logins and passwords are persisted on the registered server. | |
CustomConnectionColorArgb | Gets or sets the specified ARGB color of the RegisteredServer object. | |
Description | Gets the name of the registered server. | |
ID | Gets the ID value that uniquely identifies the registered server. | |
IdentityKey | Gets the key value that uniquely identifies the registered server. | |
IsDropped | Gets the Boolean value that specifies whether the registered server has been dropped or not. | |
IsLocal | Gets the Boolean value that specifies whether the registered server is local or not. | |
Metadata | Returns metadata about the instance and its domain. (Inherited from SfcInstance.) | |
Name | Gets the name of the RegisteredServer object. | |
Parent | Gets the parent of the RegisteredServer object. | |
Properties | Returns a collection instance properties. (Inherited from SfcInstance.) | |
SecureConnectionString | Gets or sets the secure string that is used to connect to the instance of SQL Server. | |
ServerName | Gets or sets the name of the server that is associated with the registered server. | |
ServerType | Gets or the kind of server that is associated with the registered server. | |
State | Returns the state of the SfcInstance object. (Inherited from SfcInstance.) | |
Urn | Returns the uniform resource name of the SfcInstance object. (Inherited from SfcInstance.) | |
UseCustomConnectionColor | Gets or sets a value indicating whether the object uses a custom connection color. |
Top
Methods
Name | Description | |
---|---|---|
Alter | Updates any RegisteredServer object property changes on the instance of SQL Server. | |
Create | Creates a registered server on the instance of SQL Server as defined by the RegisteredServer object. | |
CreateIdentityKey | Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.) | |
Discover | Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.) | |
Drop | Drops the registered server. | |
Equals | (Inherited from Object.) | |
Export | Exports the registered server to the specified file and using the given credential persistence type. | |
GetChildCollection | Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.) | |
GetConnectionObject | Returns the SFC interface object that represents the connection to the instance of SQL Server. | |
GetDomain | Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.) | |
GetHashCode | (Inherited from Object.) | |
GetObjectFactory | Returns the SFC object factory for the RegisteredServer object. | |
GetPropertySet | Returns the set of properties for the SfcInstance object. (Inherited from SfcInstance.) | |
GetType | (Inherited from Object.) | |
GetTypeMetadataImpl | 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.) | |
InitializeUIPropertyState | Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.) | |
Move | Specifies the RegisteredServer to move in a new location. | |
OnPropertyMetadataChanges | Invoked whenever the effective value of any SfcInstance metadata is updated. (Inherited from SfcInstance.) | |
OnPropertyValueChanges | Invoked whenever the effective value of any SfcInstance property is updated. (Inherited from SfcInstance.) | |
Refresh | Refreshes the object's properties by reading them from the server. (Inherited from SfcInstance.) | |
Rename(String) | Renames the RegisteredServer object by using the specified name. | |
Rename(SfcKey) | Specifies the RegisteredServer object to rename. | |
ResetKey | Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.) | |
Serialize | Serializes the instance to XML. (Inherited from SfcInstance.) | |
ToString | Returns a string representation of the instance Urn. (Inherited from SfcInstance.) | |
Validate | Validates the RegisteredServer object against the specified method and arguments. |
Top
Events
Name | Description | |
---|---|---|
PropertyChanged | CLS-compliant event for property changes. (Inherited from SfcInstance.) | |
PropertyMetadataChanged | CLS-compliant event for property metadata changes. (Inherited from SfcInstance.) |
Top
Explicit Interface Implementations
Name | Description | |
---|---|---|
ISfcAlterable.ScriptAlter | Alters the properties of the base object if it has been changed. This class cannot be inherited. | |
ISfcCreatable.ScriptCreate | Produces the script to create this object to storage in its current state. This class cannot be inherited. | |
ISfcDroppable.ScriptDrop | Produces the script to drop this object from storage. This class cannot be inherited. | |
ISfcMovable.Move | Moves this object under the specified parent object and updates the storage to reflect the move. This class cannot be inherited. | |
ISfcMovable.ScriptMove | Produces the script to move this object under the specified parent object. This class cannot be inherited. | |
ISfcRenamable.ScriptRename | Renames the instance of ISfcScript identified by the key parameter. This class cannot be inherited. |
Top
Remarks
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.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.