RegisteredServer RegisteredServer RegisteredServer Class

Definition

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
RegisteredServerRegisteredServerRegisteredServer
Implements

Constructors

RegisteredServer() RegisteredServer() RegisteredServer()
RegisteredServer(ServerGroup, String) RegisteredServer(ServerGroup, String) RegisteredServer(ServerGroup, String)
RegisteredServer(String) RegisteredServer(String) RegisteredServer(String)

Properties

AbstractIdentityKey AbstractIdentityKey AbstractIdentityKey Inherited from SfcInstance
ActiveDirectoryTenant ActiveDirectoryTenant ActiveDirectoryTenant

Active Directory Tenant

ActiveDirectoryUserId ActiveDirectoryUserId ActiveDirectoryUserId

Active Directory User id

AuthenticationType AuthenticationType AuthenticationType

Authentication type for connections where the connection string isn't sufficient to discover it

ConnectionString ConnectionString ConnectionString
ConnectionStringWithEncryptedPassword ConnectionStringWithEncryptedPassword ConnectionStringWithEncryptedPassword

Connection string that contains the password in encrypted form. Will always return empty string for shared servers.

CredentialPersistenceType CredentialPersistenceType CredentialPersistenceType

Indicates whether the login name and the password will be saved.

CustomConnectionColorArgb CustomConnectionColorArgb CustomConnectionColorArgb
Description Description Description
ID ID ID
IdentityKey IdentityKey IdentityKey
IsDropped IsDropped IsDropped

Returns if SFC believes this is a dropped object.

IsLocal IsLocal IsLocal

Returns the IsLocal property of the RegisteredServersStore that this instance is associated with.

Metadata Metadata Metadata Inherited from SfcInstance
Name Name Name
OtherParams OtherParams OtherParams

Additional parameters to append to the connection string

Parent Parent Parent
Properties Properties Properties Inherited from SfcInstance
PropertyStorageProvider PropertyStorageProvider 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 SecureConnectionString SecureConnectionString

Gets or set the connection related data, specific to this server.

ServerName ServerName ServerName
ServerType ServerType ServerType
State State State Inherited from SfcInstance
Urn Urn Urn

Create a new Urn string on each request and return it.

(Inherited from SfcInstance)
UseCustomConnectionColor UseCustomConnectionColor UseCustomConnectionColor

Methods

Alter() Alter() Alter()
AlterImpl() AlterImpl() AlterImpl() Inherited from SfcInstance
CheckObjectCreated() CheckObjectCreated() CheckObjectCreated()

To be called from domain for when an API requires the object to be Created Stronger than CheckObjectState

(Inherited from SfcInstance)
CheckObjectState() CheckObjectState() CheckObjectState()

To be called from domain for any access to the object

(Inherited from SfcInstance)
Create() Create() Create()
CreateIdentityKey() CreateIdentityKey() CreateIdentityKey() Inherited from SfcInstance
CreateImpl() CreateImpl() CreateImpl() Inherited from SfcInstance
Discover(ISfcDependencyDiscoveryObjectSink) Discover(ISfcDependencyDiscoveryObjectSink) Discover(ISfcDependencyDiscoveryObjectSink) Inherited from SfcInstance
Drop() Drop() Drop()
DropImpl() DropImpl() DropImpl() Inherited from SfcInstance
Export(String, CredentialPersistenceType) Export(String, CredentialPersistenceType) Export(String, CredentialPersistenceType)

Exports the content of the group to a file.

GetChildCollection(String) GetChildCollection(String) GetChildCollection(String)

Get the child collection in this instance for the given element name string.

(Inherited from SfcInstance)
GetConnectionObject() GetConnectionObject() GetConnectionObject()

Returns the connection object that corresponds to the connection string

GetDomain() GetDomain() GetDomain() Inherited from SfcInstance
GetObjectFactory() GetObjectFactory() GetObjectFactory()
GetPropertySet() GetPropertySet() GetPropertySet() Inherited from SfcInstance
GetTypeMetadataImpl() GetTypeMetadataImpl() GetTypeMetadataImpl() Inherited from SfcInstance
InitializeUIPropertyState() InitializeUIPropertyState() 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) MarkForDropImpl(Boolean) MarkForDropImpl(Boolean) Inherited from SfcInstance
MarkRootAsConnected() MarkRootAsConnected() MarkRootAsConnected() Inherited from SfcInstance
Move(ServerGroup) Move(ServerGroup) Move(ServerGroup)

Moves the RegisteredServer to be a child of another ServerGroup.

MoveImpl(SfcInstance) MoveImpl(SfcInstance) MoveImpl(SfcInstance) Inherited from SfcInstance
OnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs) OnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs) OnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs) Inherited from SfcInstance
OnPropertyValueChanges(PropertyChangedEventArgs) OnPropertyValueChanges(PropertyChangedEventArgs) OnPropertyValueChanges(PropertyChangedEventArgs) Inherited from SfcInstance
PostAlter(Object) PostAlter(Object) PostAlter(Object) Inherited from SfcInstance
PostCreate(Object) PostCreate(Object) PostCreate(Object) Inherited from SfcInstance
PostDrop(Object) PostDrop(Object) PostDrop(Object) Inherited from SfcInstance
PostMove(Object) PostMove(Object) PostMove(Object) Inherited from SfcInstance
PostRename(Object) PostRename(Object) PostRename(Object) Inherited from SfcInstance
Refresh() Refresh() Refresh()

refreshes the object's properties by reading them from the server

(Inherited from SfcInstance)
Rename(SfcKey) Rename(SfcKey) Rename(SfcKey)

Renames the object on the server.

Rename(String) Rename(String) Rename(String)

Renames the object on the server.

RenameImpl(SfcKey) RenameImpl(SfcKey) RenameImpl(SfcKey) Inherited from SfcInstance
ResetKey() ResetKey() ResetKey() Inherited from SfcInstance
Serialize(XmlWriter) Serialize(XmlWriter) Serialize(XmlWriter) Inherited from SfcInstance
ToString() ToString() ToString() Inherited from SfcInstance
UpdateUIPropertyState() UpdateUIPropertyState() UpdateUIPropertyState() Inherited from SfcInstance
Validate() Validate() Validate()

Basic child object's validation

(Inherited from SfcInstance)
Validate(String, Object[]) Validate(String, Object[]) Validate(String, Object[])

Explicit Interface Implementations

ISfcAlterable.ScriptAlter() ISfcAlterable.ScriptAlter() ISfcAlterable.ScriptAlter()
ISfcCreatable.ScriptCreate() ISfcCreatable.ScriptCreate() ISfcCreatable.ScriptCreate()
ISfcDroppable.ScriptDrop() ISfcDroppable.ScriptDrop() ISfcDroppable.ScriptDrop()
ISfcMovable.Move(SfcInstance) ISfcMovable.Move(SfcInstance) ISfcMovable.Move(SfcInstance)
ISfcMovable.ScriptMove(SfcInstance) ISfcMovable.ScriptMove(SfcInstance) ISfcMovable.ScriptMove(SfcInstance)
ISfcRenamable.ScriptRename(SfcKey) ISfcRenamable.ScriptRename(SfcKey) ISfcRenamable.ScriptRename(SfcKey)

Events

propertyChanged propertyChanged propertyChanged Inherited from SfcInstance
PropertyChanged PropertyChanged PropertyChanged Inherited from SfcInstance
propertyMetadataChanged propertyMetadataChanged propertyMetadataChanged Inherited from SfcInstance
PropertyMetadataChanged PropertyMetadataChanged PropertyMetadataChanged Inherited from SfcInstance

Applies to