Share via

  • Article

ServerGroupBase Class

The ServerGroupBase class is a base class that is used in the construction of the ServerGroup class, which 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
Public Class ServerGroupBase _
    Inherits RegSvrSmoObject _
    Implements ICreatable, IAlterable, IDroppable
'Usage
Dim instance As ServerGroupBase

public class ServerGroupBase : RegSvrSmoObject, 
    ICreatable, IAlterable, IDroppable

public ref class ServerGroupBase : public RegSvrSmoObject, 
    ICreatable, IAlterable, IDroppable

type ServerGroupBase =  
    class
        inherit RegSvrSmoObject
        interface ICreatable
        interface IAlterable
        interface IDroppable
    end

public class ServerGroupBase extends RegSvrSmoObject implements ICreatable, IAlterable, IDroppable

The ServerGroupBase type exposes the following members.

Properties

  Name Description
Public property Name Gets or sets the name of the object. (Inherited from RegSvrSmoObject.)
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.
Public property ServerGroups Represents a collection of ServerGroup objects. Each ServerGroup object represents a server group that is included in the parent server group.
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property Urn Gets the Urn object that represents the object. (Inherited from RegSvrSmoObject.)
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.
Protected method CheckObjectState Checks the state of the object. (Inherited from RegSvrSmoObject.)
Protected method ClearCollections Clears the server group collections.
Public method Create Creates a server group on the instance of Microsoft SQL Server as defined by the ServerGroupBase object.
Public method Drop Removes the ServerGroupBase from the parent server group.
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.
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

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.