Share via


ServerGroup Class

The ServerGroup class represents a SQL Server server group.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance
    Microsoft.SqlServer.Management.RegisteredServers.ServerGroupParent
      Microsoft.SqlServer.Management.RegisteredServers.ServerGroup

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

Syntax

'Declaration
Public NotInheritable Class ServerGroup _
    Inherits ServerGroupParent _
    Implements ISfcValidate, ISfcCreatable, ICreatable, ISfcAlterable,  _
    IAlterable, ISfcDroppable, IDroppable, ISfcRenamable, IRenamable,  _
    ISfcMovable
'Usage
Dim instance As ServerGroup
public sealed class ServerGroup : ServerGroupParent, 
    ISfcValidate, ISfcCreatable, ICreatable, ISfcAlterable, IAlterable, 
    ISfcDroppable, IDroppable, ISfcRenamable, IRenamable, ISfcMovable
public ref class ServerGroup sealed : public ServerGroupParent, 
    ISfcValidate, ISfcCreatable, ICreatable, ISfcAlterable, IAlterable, 
    ISfcDroppable, IDroppable, ISfcRenamable, IRenamable, ISfcMovable
[<SealedAttribute>]
type ServerGroup =  
    class
        inherit ServerGroupParent
        interface ISfcValidate
        interface ISfcCreatable
        interface ICreatable
        interface ISfcAlterable
        interface IAlterable
        interface ISfcDroppable
        interface IDroppable
        interface ISfcRenamable
        interface IRenamable
        interface ISfcMovable
    end
public final class ServerGroup extends ServerGroupParent implements ISfcValidate, ISfcCreatable, ICreatable, ISfcAlterable, IAlterable, ISfcDroppable, IDroppable, ISfcRenamable, IRenamable, ISfcMovable

The ServerGroup type exposes the following members.

Constructors

  Name Description
Public method ServerGroup() Initializes a new instance of the ServerGroup class.
Public method ServerGroup(String) Initializes a new instance of the ServerGroup class that has the specified name.
Public method ServerGroup(ServerGroup, String) Initializes a new instance of the ServerGroup class that has the specified name and is a subgroup of the specified parent.

Top

Properties

  Name Description
Protected property AbstractIdentityKey Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public property Description Gets the name of the server group.
Public property DisplayName Gets the display name of the server group.
Public property ID Gets the ID value that uniquely identifies the server group.
Public property IdentityKey Gets the key value that uniquely identifies the server group.
Public property IsDropped Gets the Boolean value that specifies whether the server group has been dropped or not.
Public property IsLocal Gets the Boolean value that specifies whether the server group local.
Public property IsSystemServerGroup Gets the Boolean value that specifies whether the server group is a system object.
Public property Metadata Returns metadata about the instance and its domain. (Inherited from SfcInstance.)
Public property Name Gets the name of the server group.
Public property Parent Gets the parent of the ServerGroup object.
Public property Properties Returns a collection instance properties. (Inherited from SfcInstance.)
Protected property PropertyStorageProvider Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public property RegisteredServers Represents a collection of RegisteredServers objects. Each RegisteredServers object represents a registered server.
Public property ServerGroups Represents a collection of ServerGroup objects. Each ServerGroup object represents a server group.
Public property ServerType Gets or the type of server that is associated with the server group.
Protected property State Returns the state of the SfcInstance object. (Inherited from SfcInstance.)
Public property Urn Returns the uniform resource name of the SfcInstance object. (Inherited from SfcInstance.)

Top

Methods

  Name Description
Public method Alter Updates any ServerGroup object property changes on the instance of SQL Server. 
Protected method AlterImpl Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method CheckObjectCreated Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method CheckObjectState Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method Create Creates a registered server on the instance of SQL Server as defined by the ServerGroup object.
Protected method CreateIdentityKey Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method CreateImpl Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method Discover Discovers the dependency relationship for the server group. (Overrides SfcInstance.Discover(ISfcDependencyDiscoveryObjectSink).)
Public method Drop Drops the registered server.
Protected method DropImpl Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method Equals (Inherited from Object.)
Public method Export Exports the server group to the specified file and using the specified credential persistence type.
Protected method Finalize (Inherited from Object.)
Protected method GetChildCollection Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method GetDescendantRegisteredServers Returns a list of the registered servers in a server group.
Public method GetDomain Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method GetHashCode (Inherited from Object.)
Public methodStatic member GetObjectFactory Returns the SFC object factory for the ServerGroup object.
Public method GetPropertySet Returns the set of properties for the SfcInstance object. (Inherited from SfcInstance.)
Public method GetType (Inherited from Object.)
Protected method 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.)
Public method Import Imports groups and servers saved to an XML file and adds them as children of the server group.
Protected method InitializeUIPropertyState Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method MarkForDropImpl Returns a value that indicates the existing objects to be dropped. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method MarkRootAsConnected Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method MemberwiseClone (Inherited from Object.)
Public method Move Specifies the RegisteredServersServerGroup object to move in a new location.
Protected method MoveImpl Indicates the new parent object to move in an instance. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method OnPropertyMetadataChanges Invoked whenever the effective value of any SfcInstance metadata is updated. (Inherited from SfcInstance.)
Protected method OnPropertyValueChanges Invoked whenever the effective value of any SfcInstance property is updated. (Inherited from SfcInstance.)
Protected method PostAlter Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method PostCreate Indicates the default implementor that creates the execution result. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method PostDrop Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method PostMove Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method PostRename Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method Refresh Refreshes the object's properties by reading them from the server. (Inherited from SfcInstance.)
Public method Rename(String) Renames the ServerGroup object by using the specified name.
Public method Rename(SfcKey) Renames the ServerGroup object by using the specified name.
Protected method RenameImpl Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method ResetKey Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method Serialize Serializes the instance to XML. (Inherited from SfcInstance.)
Public method ToString Returns a string representation of the instance Urn. (Inherited from SfcInstance.)
Protected method UpdateUIPropertyState Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method Validate() Indicates the basic child object's validation. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method Validate(String, array<Object[]) Validates the ServerGroup object against the specified method and arguments.

Top

Events

  Name Description
Public event DuplicateFound An event raised if a duplicate registered server group is encountered.
Protected event propertyChanged Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public event PropertyChanged CLS-compliant event for property changes. (Inherited from SfcInstance.)
Protected event propertyMetadataChanged Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public event PropertyMetadataChanged CLS-compliant event for property metadata changes. (Inherited from SfcInstance.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ISfcAlterable.ScriptAlter Alters the properties of the base object if it has been changed. Do not reference this member directly in your code. It supports the SQL Server infrastructure..
Explicit interface implemetationPrivate method ISfcCreatable.ScriptCreate Produces the script to create this object to storage in its current state. Do not reference this member directly in your code. It supports the SQL Server infrastructure..
Explicit interface implemetationPrivate method ISfcDroppable.ScriptDrop Produces the script to drop this object from storage. Do not reference this member directly in your code. It supports the SQL Server infrastructure..
Explicit interface implemetationPrivate method ISfcMovable.Move Moves the ServerGroup object under the specified parent object and updates the storage to reflect the move.Do not reference this member directly in your code. It supports the SQL Server infrastructure..
Explicit interface implemetationPrivate method ISfcMovable.ScriptMove Produces the script to move this object under the specified parent object.Do not reference this member directly in your code. It supports the SQL Server infrastructure..
Explicit interface implemetationPrivate method ISfcRenamable.ScriptRename Renames the instance of ISfcScript object identified by the key parameter. Do not reference this member directly in your code. It supports the SQL Server infrastructure..

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.