RegisteredServer Class

Definition

Namespace:

Microsoft.SqlServer.Management.RegisteredServers

Assembly:

Microsoft.SqlServer.Management.RegisteredServers.dll

Package:

Microsoft.SqlServer.SqlManagementObjects v160.2004021.0

public sealed class RegisteredServer : Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance, Microsoft.SqlServer.Management.Common.IAlterable, Microsoft.SqlServer.Management.Common.ICreatable, Microsoft.SqlServer.Management.Common.IDroppable, Microsoft.SqlServer.Management.Common.IRenamable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcAlterable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcCreatable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcDroppable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcMovable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcRenamable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcValidate

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

Public NotInheritable Class RegisteredServer
Inherits SfcInstance
Implements IAlterable, ICreatable, IDroppable, IRenamable, ISfcAlterable, ISfcCreatable, ISfcDroppable, ISfcMovable, ISfcRenamable, ISfcValidate

Inheritance

Object

SfcInstance

RegisteredServer

Implements

IAlterable ICreatable IDroppable IRenamable ISfcAlterable ISfcCreatable ISfcDroppable ISfcMovable ISfcRenamable ISfcValidate

Constructors

RegisteredServer()

RegisteredServer(ServerGroup, String)

RegisteredServer(String)

Properties

AbstractIdentityKey	(Inherited from SfcInstance)
ActiveDirectoryTenant	Active Directory Tenant
ActiveDirectoryUserId	Active Directory User id
AuthenticationType	Authentication type for connections where the connection string isn't sufficient to discover it
ConnectionString
ConnectionStringWithEncryptedPassword	Connection string that contains the password in encrypted form. Will always return empty string for shared servers.
CredentialPersistenceType	Indicates whether the login name and the password will be saved.
CustomConnectionColorArgb
Description
ID
IdentityKey
IsDropped	Returns if SFC believes this is a dropped object.
IsLocal	Returns the IsLocal property of the RegisteredServersStore that this instance is associated with.
KeyChain	Returns the identity path of the object (Inherited from SfcInstance)
Metadata	(Inherited from SfcInstance)
Name
OtherParams	Additional parameters to append to the connection string
Parent
Properties	(Inherited from SfcInstance)
PropertyStorageProvider	This property returns the default implementation of SFC for ISfcPropertyStorageProvider interface, it can be overriden in the child classes to return another storage provider (i.e. flat properties list) (Inherited from SfcInstance)
SecureConnectionString	Gets or set the connection related data, specific to this server.
ServerName
ServerType
State	(Inherited from SfcInstance)
Urn	Create a new Urn string on each request and return it. (Inherited from SfcInstance)
UseCustomConnectionColor

Methods

Alter()
AlterImpl()	(Inherited from SfcInstance)
CheckObjectCreated()	To be called from domain for when an API requires the object to be Created Stronger than CheckObjectState (Inherited from SfcInstance)
CheckObjectState()	To be called from domain for any access to the object (Inherited from SfcInstance)
Create()
CreateIdentityKey()	(Inherited from SfcInstance)
CreateImpl()	(Inherited from SfcInstance)
Discover(ISfcDependencyDiscoveryObjectSink)	(Inherited from SfcInstance)
Drop()
DropImpl()	(Inherited from SfcInstance)
Export(String, CredentialPersistenceType)	Exports the content of the group to a file.
GetChildCollection(String)	Get the child collection in this instance for the given element name string. (Inherited from SfcInstance)
GetConnectionObject()	Returns the connection object that corresponds to the connection string
GetDomain()	(Inherited from SfcInstance)
GetObjectFactory()
GetPropertySet()	(Inherited from SfcInstance)
GetTypeMetadataImpl()	(Inherited from SfcInstance)
InitializeUIPropertyState()	Overridable from the child objects who care about initializing their states (dynamic metadata which is currently the ".Enabled" property) (Inherited from SfcInstance)
MarkForDropImpl(Boolean)	(Inherited from SfcInstance)
MarkRootAsConnected()	(Inherited from SfcInstance)
Move(ServerGroup)	Moves the RegisteredServer to be a child of another ServerGroup.
MoveImpl(SfcInstance)	(Inherited from SfcInstance)
OnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs)	(Inherited from SfcInstance)
OnPropertyValueChanges(PropertyChangedEventArgs)	(Inherited from SfcInstance)
PostAlter(Object)	(Inherited from SfcInstance)
PostCreate(Object)	(Inherited from SfcInstance)
PostDrop(Object)	(Inherited from SfcInstance)
PostMove(Object)	(Inherited from SfcInstance)
PostRename(Object)	(Inherited from SfcInstance)
Refresh()	refreshes the object's properties by reading them from the server (Inherited from SfcInstance)
Rename(SfcKey)	Renames the object on the server.
Rename(String)	Renames the object on the server.
RenameImpl(SfcKey)	(Inherited from SfcInstance)
ResetKey()	(Inherited from SfcInstance)
Serialize(XmlWriter)	(Inherited from SfcInstance)
ToString()	(Inherited from SfcInstance)
UpdateUIPropertyState()	(Inherited from SfcInstance)
Validate()	Basic child object's validation (Inherited from SfcInstance)
Validate(String, Object[])

Events

propertyChanged	(Inherited from SfcInstance)
PropertyChanged	(Inherited from SfcInstance)
propertyMetadataChanged	(Inherited from SfcInstance)
PropertyMetadataChanged	(Inherited from SfcInstance)

Explicit Interface Implementations

ISfcAlterable.ScriptAlter()

ISfcCreatable.ScriptCreate()

ISfcDroppable.ScriptDrop()

ISfcMovable.Move(SfcInstance)

ISfcMovable.ScriptMove(SfcInstance)

ISfcRenamable.ScriptRename(SfcKey)