Export (0) Print
Expand All

ServerGroup Class

Note: This API is now obsolete.

The ServerGroup object represents a group of Microsoft SQL Server registered servers.

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

[ObsoleteAttribute("Instead use namespace Microsoft.SqlServer.Management.RegisteredServers")]
public sealed class ServerGroup : ServerGroupBase

The ServerGroup type exposes the following members.

  NameDescription
Public methodServerGroup()Initializes a new instance of the ServerGroup object.
Public methodServerGroup(String)Initializes a new instance of the ServerGroup object that has the specified name.
Public methodServerGroup(ServerGroup, String)Initializes a new instance of the ServerGroup object based on the specified server group and with the specified name.
Top

  NameDescription
Public propertyDescriptionGets or sets the textual description of the referenced group of registered servers.
Public propertyNameGets or sets the name of the object. (Inherited from RegSvrSmoObject.)
Public propertyParentGets or sets the ServerGroup object that is the parent of the referenced ServerGroup object.
Public propertyPathGets the path of the referenced server group.
Public propertyPropertiesGets the properties associated with the object. (Inherited from RegSvrSmoObject.)
Public propertyRegisteredServersRepresents a collection of RegisteredServer objects. Each RegisteredServer object represents a registered server that is included in the parent server group. (Inherited from ServerGroupBase.)
Public propertyServerGroupsRepresents a collection of ServerGroup objects. Each ServerGroup object represents a server group that is included in the parent server group. (Inherited from ServerGroupBase.)
Public propertyServerTypeGets the Guid object value that specifies the type of server associated with the server group.
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
Public propertyUrnGets the Urn object value that represents the server group. (Overrides RegSvrSmoObject.Urn.)
Protected propertyUrnSkeletonGets the Urn object that represents the object. (Inherited from RegSvrSmoObject.)
Public propertyUserDataGets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public methodAlterUpdates any ServerGroupBase object property changes on the instance of Microsoft SQL Server. (Inherited from ServerGroupBase.)
Protected methodCheckObjectStateChecks the state of the object. (Inherited from RegSvrSmoObject.)
Protected methodClearCollectionsClears the server group collections. (Inherited from ServerGroupBase.)
Public methodCreateCreates a server group on the instance of Microsoft SQL Server as defined by the ServerGroupBase object. (Inherited from ServerGroupBase.)
Public methodDropRemoves the ServerGroupBase from the parent server group. (Inherited from ServerGroupBase.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetSmoObjectGets a RegSvrSmoObject that is specified by a URN. (Inherited from ServerGroupBase.)
Public methodGetType (Inherited from Object.)
Protected methodImplInitializeInitializes the object. (Inherited from RegSvrSmoObject.)
Public methodInitializeInitializes the object. (Inherited from RegSvrSmoObject.)
Protected methodIsObjectInitializedGets a Boolean value that specifies whether the object was initialized. (Inherited from RegSvrSmoObject.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodRefreshRefreshes the properties of the object. (Inherited from RegSvrSmoObject.)
Protected methodSetParentImplSets a parent. (Inherited from RegSvrSmoObject.)
Public methodToString (Inherited from Object.)
Protected methodUpdateObjectStateGets the updated object state. (Inherited from RegSvrSmoObject.)
Public methodValidateValidates the state of an object. (Inherited from SmoObjectBase.)
Top

To get or set ServerGroup object properties, users must be a member of the sysadmin fixed server role.

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.

Community Additions

ADD
Show:
© 2014 Microsoft