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

Top

Methods

	Name	Description
	Alter	Updates any ServerGroup object property changes on the instance of SQL Server.
	Create	Creates a registered server on the instance of SQL Server as defined by the ServerGroup object.
	CreateIdentityKey	Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
	Discover	Discovers the dependency relationship for the server group. (Overrides SfcInstance.Discover(ISfcDependencyDiscoveryObjectSink).)
	Drop	Drops the registered server.
	Equals	(Inherited from Object.)
	Export	Exports the server group to the specified file and using the specified credential persistence type.
	GetChildCollection	Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
	GetDescendantRegisteredServers	Returns a list of the registered servers in a server group.
	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 ServerGroup 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.)
	Import	Imports groups and servers saved to an XML file and adds them as children of the server group.
	InitializeUIPropertyState	Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
	Move	Specifies the RegisteredServersServerGroup object 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 ServerGroup object by using the specified name.
	Rename(SfcKey)	Renames the ServerGroup object by using the specified name.
	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 ServerGroup object against the specified method and arguments.

Top

Events

	Name	Description
	DuplicateFound	An event raised if a duplicate registered server group is encountered.
	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. Do not reference this member directly in your code. It supports the SQL Server infrastructure..
	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..
	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..
	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..
	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..
	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.

See Also

Reference

Microsoft.SqlServer.Management.RegisteredServers Namespace