Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

ServerGroup Class

The ServerGroup class represents a SQL Server server group.

Namespace:  Microsoft.SqlServer.Management.RegisteredServers
Assembly:  Microsoft.SqlServer.Management.RegisteredServers (in Microsoft.SqlServer.Management.RegisteredServers.dll)
public sealed class ServerGroup : ServerGroupParent, 
	ISfcValidate, ISfcCreatable, ICreatable, ISfcAlterable, IAlterable, 
	ISfcDroppable, IDroppable, ISfcRenamable, IRenamable, ISfcMovable

The ServerGroup type exposes the following members.

  NameDescription
Public methodServerGroup()Initializes a new instance of the ServerGroup class.
Public methodServerGroup(String)Initializes a new instance of the ServerGroup class that has the specified name.
Public methodServerGroup(ServerGroup, String)Initializes a new instance of the ServerGroup class that has the specified name and is a subgroup of the specified parent.
Top
  NameDescription
Protected propertyAbstractIdentityKeyDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public propertyDescriptionGets the name of the server group.
Public propertyDisplayNameGets the display name of the server group.
Public propertyIDGets the ID value that uniquely identifies the server group.
Public propertyIdentityKeyGets the key value that uniquely identifies the server group.
Public propertyIsDroppedGets the Boolean value that specifies whether the server group has been dropped or not.
Public propertyIsLocalGets the Boolean value that specifies whether the server group local.
Public propertyIsSystemServerGroupGets the Boolean value that specifies whether the server group is a system object.
Public propertyMetadataReturns metadata about the instance and its domain. (Inherited from SfcInstance.)
Public propertyNameGets the name of the server group.
Public propertyParentGets the parent of the ServerGroup object.
Public propertyPropertiesReturns a collection instance properties. (Inherited from SfcInstance.)
Public propertyRegisteredServersRepresents a collection of RegisteredServers objects. Each RegisteredServers object represents a registered server.
Public propertyServerGroupsRepresents a collection of ServerGroup objects. Each ServerGroup object represents a server group.
Public propertyServerTypeGets or the type of server that is associated with the server group.
Protected propertyStateReturns the state of the SfcInstance object. (Inherited from SfcInstance.)
Public propertyUrnReturns the uniform resource name of the SfcInstance object. (Inherited from SfcInstance.)
Top
  NameDescription
Public methodAlterUpdates any ServerGroup object property changes on the instance of SQL Server. 
Public methodCreateCreates a registered server on the instance of SQL Server as defined by the ServerGroup object.
Protected methodCreateIdentityKeyDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodDiscoverDiscovers the dependency relationship for the server group. (Overrides SfcInstance.Discover(ISfcDependencyDiscoveryObjectSink).)
Public methodDropDrops the registered server.
Public methodEquals (Inherited from Object.)
Public methodExportExports the server group to the specified file and using the specified credential persistence type.
Protected methodGetChildCollectionDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodGetDescendantRegisteredServersReturns a list of the registered servers in a server group.
Public methodGetDomainDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodGetHashCode (Inherited from Object.)
Public methodStatic memberGetObjectFactoryReturns the SFC object factory for the ServerGroup object.
Public methodGetPropertySetReturns the set of properties for the SfcInstance object. (Inherited from SfcInstance.)
Public methodGetType (Inherited from Object.)
Protected methodGetTypeMetadataImplIndicates 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 methodImportImports groups and servers saved to an XML file and adds them as children of the server group.
Protected methodInitializeUIPropertyStateDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodMoveSpecifies the RegisteredServersServerGroup object to move in a new location.
Protected methodOnPropertyMetadataChangesInvoked whenever the effective value of any SfcInstance metadata is updated. (Inherited from SfcInstance.)
Protected methodOnPropertyValueChangesInvoked whenever the effective value of any SfcInstance property is updated. (Inherited from SfcInstance.)
Public methodRefreshRefreshes the object's properties by reading them from the server. (Inherited from SfcInstance.)
Public methodRename(String)Renames the ServerGroup object by using the specified name.
Public methodRename(SfcKey)Renames the ServerGroup object by using the specified name.
Protected methodResetKeyDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodSerializeSerializes the instance to XML. (Inherited from SfcInstance.)
Public methodToStringReturns a string representation of the instance Urn. (Inherited from SfcInstance.)
Public methodValidateValidates the ServerGroup object against the specified method and arguments.
Top
  NameDescription
Public eventDuplicateFoundAn event raised if a duplicate registered server group is encountered.
Public eventPropertyChangedCLS-compliant event for property changes. (Inherited from SfcInstance.)
Public eventPropertyMetadataChangedCLS-compliant event for property metadata changes. (Inherited from SfcInstance.)
Top
  NameDescription
Explicit interface implemetationPrivate methodISfcAlterable.ScriptAlterAlters 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 methodISfcCreatable.ScriptCreateProduces 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 methodISfcDroppable.ScriptDropProduces 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 methodISfcMovable.MoveMoves 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 methodISfcMovable.ScriptMoveProduces 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 methodISfcRenamable.ScriptRenameRenames 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

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.