• Article

ServerGroup Class

Note: This API is now obsolete.

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

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.RegisteredServers.RegSvrSmoObject
      Microsoft.SqlServer.Management.Smo.RegisteredServers.ServerGroupBase
        Microsoft.SqlServer.Management.Smo.RegisteredServers.ServerGroup

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

Syntax

'Declaration
<ObsoleteAttribute("Instead use namespace Microsoft.SqlServer.Management.RegisteredServers")> _
Public NotInheritable Class ServerGroup _
    Inherits ServerGroupBase
'Usage
Dim instance As ServerGroup

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

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

[<SealedAttribute>]
[<ObsoleteAttribute("Instead use namespace Microsoft.SqlServer.Management.RegisteredServers")>]
type ServerGroup =  
    class
        inherit ServerGroupBase
    end

public final class ServerGroup extends ServerGroupBase

The ServerGroup type exposes the following members.

Constructors

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

Top

Properties

  Name Description
Public property Description Gets or sets the textual description of the referenced group of registered servers.
Public property Name Gets or sets the name of the object. (Inherited from RegSvrSmoObject.)
Public property Parent Gets or sets the ServerGroup object that is the parent of the referenced ServerGroup object.
Public property Path Gets the path of the referenced server group.
Public property Properties Gets the properties associated with the object. (Inherited from RegSvrSmoObject.)
Public property RegisteredServers Represents a collection of RegisteredServer objects. Each RegisteredServer object represents a registered server that is included in the parent server group. (Inherited from ServerGroupBase.)
Public property ServerGroups Represents a collection of ServerGroup objects. Each ServerGroup object represents a server group that is included in the parent server group. (Inherited from ServerGroupBase.)
Public property ServerType Gets the Guid object value that specifies the type of server associated with the server group.
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property Urn Gets the Urn object value that represents the server group. (Overrides RegSvrSmoObject.Urn.)
Protected property UrnSkeleton Gets the Urn object that represents the object. (Inherited from RegSvrSmoObject.)
Public property UserData Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

  Name Description
Public method Alter Updates any ServerGroupBase object property changes on the instance of Microsoft SQL Server. (Inherited from ServerGroupBase.)
Protected method CheckObjectState Checks the state of the object. (Inherited from RegSvrSmoObject.)
Protected method ClearCollections Clears the server group collections. (Inherited from ServerGroupBase.)
Public method Create Creates a server group on the instance of Microsoft SQL Server as defined by the ServerGroupBase object. (Inherited from ServerGroupBase.)
Public method Drop Removes the ServerGroupBase from the parent server group. (Inherited from ServerGroupBase.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetSmoObject Gets a RegSvrSmoObject that is specified by a URN. (Inherited from ServerGroupBase.)
Public method GetType (Inherited from Object.)
Protected method ImplInitialize Initializes the object. (Inherited from RegSvrSmoObject.)
Public method Initialize Initializes the object. (Inherited from RegSvrSmoObject.)
Protected method IsObjectInitialized Gets a Boolean value that specifies whether the object was initialized. (Inherited from RegSvrSmoObject.)
Protected method MemberwiseClone (Inherited from Object.)
Public method Refresh Refreshes the properties of the object. (Inherited from RegSvrSmoObject.)
Protected method SetParentImpl Sets a parent. (Inherited from RegSvrSmoObject.)
Public method ToString (Inherited from Object.)
Protected method UpdateObjectState Gets the updated object state. (Inherited from RegSvrSmoObject.)
Public method Validate Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Remarks

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.

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.