ServerGroup Class

Reference

Definition

Namespace:: Microsoft.SqlServer.Management.Smo.RegisteredServers

Assembly:: Microsoft.SqlServer.SmoExtended.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Caution

Instead use namespace Microsoft.SqlServer.Management.RegisteredServers

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

public ref class ServerGroup sealed : Microsoft::SqlServer::Management::Smo::RegisteredServers::ServerGroupBase

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

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

Public NotInheritable Class ServerGroup
Inherits ServerGroupBase

Inheritance: Object

SmoObjectBase

RegSvrSmoObject

ServerGroupBase
ServerGroup

Attributes: ObsoleteAttribute

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.

Constructors

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

Properties

Description	Gets or sets the textual description of the referenced group of registered servers.
Name	Gets or sets the name of the object. (Inherited from RegSvrSmoObject)
Parent	Gets or sets the ServerGroup object that is the parent of the referenced ServerGroup object.
Path	Gets the path of the referenced server group.
Properties	Gets the properties associated with the object. (Inherited from RegSvrSmoObject)
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)
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)
ServerType	Gets the Guid object value that specifies the type of server associated with the server group.
State	Gets the state of the referenced object. (Inherited from SmoObjectBase)
Urn	Gets the Urn object value that represents the server group.
UrnSkeleton	Gets the Urn object that represents the object. (Inherited from RegSvrSmoObject)
UserData	Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase)

Methods

Alter()	Updates any ServerGroupBase object property changes on the instance of Microsoft SQL Server. (Inherited from ServerGroupBase)
CheckObjectState()	Checks the state of the object. (Inherited from RegSvrSmoObject)
ClearCollections()	Clears the server group collections. (Inherited from ServerGroupBase)
Create()	Creates a server group on the instance of Microsoft SQL Server as defined by the ServerGroupBase object. (Inherited from ServerGroupBase)
Drop()	Removes the ServerGroupBase from the parent server group. (Inherited from ServerGroupBase)
GetSmoObject(Urn)	Gets a RegSvrSmoObject that is specified by a URN. (Inherited from ServerGroupBase)
ImplInitialize(String[], OrderBy[])	Initializes the object. (Inherited from RegSvrSmoObject)
Initialize()	Initializes the object. (Inherited from RegSvrSmoObject)
IsObjectInitialized()	Gets a Boolean value that specifies whether the object was initialized. (Inherited from RegSvrSmoObject)
Refresh()	Refreshes the properties of the object. (Inherited from RegSvrSmoObject)
SetParentImpl(RegSvrSmoObject)	Sets a parent. (Inherited from RegSvrSmoObject)
UpdateObjectState()	Gets the updated object state. (Inherited from RegSvrSmoObject)
Validate(String, Object[])	Validates the state of an object. (Inherited from SmoObjectBase)

Applies to