ServerGroup Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
public sealed class ServerGroup : Microsoft.SqlServer.Management.RegisteredServers.ServerGroupParent, 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.ISfcValidatetype ServerGroup = class
inherit ServerGroupParent
interface ISfcValidate
interface ISfcCreatable
interface ICreatable
interface ISfcAlterable
interface IAlterable
interface ISfcDroppable
interface IDroppable
interface ISfcRenamable
interface IRenamable
interface ISfcMovablePublic NotInheritable Class ServerGroup
Inherits ServerGroupParent
Implements IAlterable, ICreatable, IDroppable, IRenamable, ISfcAlterable, ISfcCreatable, ISfcDroppable, ISfcMovable, ISfcRenamable, ISfcValidate- Inheritance
- Implements
Constructors
| ServerGroup() | |
| ServerGroup(ServerGroup, String) | |
| ServerGroup(String) |
Properties
| AbstractIdentityKey | (Inherited from SfcInstance) |
| Description | |
| DisplayName |
Display name for the group |
| 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. |
| IsSystemServerGroup |
Returns true if this servergroup is one among the standard server groups. |
| KeyChain |
Returns the identity path of the object (Inherited from SfcInstance) |
| Metadata | (Inherited from SfcInstance) |
| Name | |
| 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) |
| RegisteredServers | |
| ServerGroups | |
| ServerType | |
| State | (Inherited from SfcInstance) |
| Urn |
Create a new Urn string on each request and return it. (Inherited from SfcInstance) |
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) | |
| 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) |
| GetDescendantRegisteredServers() |
Method to flatten the hierarchy for a ServerGroup and return the complete list of descendant RegisteredServers. |
| GetDomain() | (Inherited from SfcInstance) |
| GetObjectFactory() | |
| GetPropertySet() | (Inherited from SfcInstance) |
| GetTypeMetadataImpl() | (Inherited from SfcInstance) |
| Import(String) |
Imports groups and servers saved in the XML file and adds them as children. |
| 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 ServerGroup 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
| DuplicateFound |
The event that is raise when user attempts to import a registered server or server group that already exists in the local store |
| 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) |