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

NameDescription
System_CAPS_pubmethodServerGroup()

Initializes a new instance of the ServerGroup class.

System_CAPS_pubmethodServerGroup(ServerGroup, String)

Initializes a new instance of the ServerGroup class that has the specified name and is a subgroup of the specified parent.

System_CAPS_pubmethodServerGroup(String)

Initializes a new instance of the ServerGroup class that has the specified name.

NameDescription
System_CAPS_protpropertyAbstractIdentityKey

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubpropertyDescription

Gets the name of the server group.

System_CAPS_pubpropertyDisplayName

Gets the display name of the server group.

System_CAPS_pubpropertyID

Gets the ID value that uniquely identifies the server group.

System_CAPS_pubpropertyIdentityKey

Gets the key value that uniquely identifies the server group.

System_CAPS_pubpropertyIsDropped

Gets the Boolean value that specifies whether the server group has been dropped or not.

System_CAPS_pubpropertyIsLocal

Gets the Boolean value that specifies whether the server group local.

System_CAPS_pubpropertyIsSystemServerGroup

Gets the Boolean value that specifies whether the server group is a system object.

System_CAPS_pubpropertyMetadata

Returns metadata about the instance and its domain.(Inherited from SfcInstance.)

System_CAPS_pubpropertyName

Gets the name of the server group.

System_CAPS_pubpropertyParent

Gets the parent of the ServerGroup object.

System_CAPS_pubpropertyProperties

Returns a collection instance properties.(Inherited from SfcInstance.)

System_CAPS_pubpropertyRegisteredServers

Represents a collection of T:Microsoft.SqlServer.Management.RegisteredServers.RegisteredServers objects. Each T:Microsoft.SqlServer.Management.RegisteredServers.RegisteredServers object represents a registered server.

System_CAPS_pubpropertyServerGroups

Represents a collection of ServerGroup objects. Each ServerGroup object represents a server group.

System_CAPS_pubpropertyServerType

Gets or the type of server that is associated with the server group.

System_CAPS_protpropertyState

Returns the state of the SfcInstance object.(Inherited from SfcInstance.)

System_CAPS_pubpropertyUrn

Returns the uniform resource name of the SfcInstance object.(Inherited from SfcInstance.)

NameDescription
System_CAPS_pubmethodAlter()

Updates any ServerGroup object property changes on the instance of SQL Server. 

System_CAPS_pubmethodCreate()

Creates a registered server on the instance of SQL Server as defined by the ServerGroup object.

System_CAPS_protmethodCreateIdentityKey()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodDiscover(ISfcDependencyDiscoveryObjectSink)

Discovers the dependency relationship for the server group.(Overrides SfcInstance.Discover(ISfcDependencyDiscoveryObjectSink).)

System_CAPS_pubmethodDrop()

Drops the registered server.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodExport(String, CredentialPersistenceType)

Exports the server group to the specified file and using the specified credential persistence type.

System_CAPS_protmethodGetChildCollection(String)

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodGetDescendantRegisteredServers()

Returns a list of the registered servers in a server group.

System_CAPS_pubmethodGetDomain()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_staticGetObjectFactory()

Returns the SFC object factory for the ServerGroup object.

System_CAPS_pubmethodGetPropertySet()

Returns the set of properties for the SfcInstance object.(Inherited from SfcInstance.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodGetTypeMetadataImpl()

Indicates 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.)

System_CAPS_pubmethodImport(String)

Imports groups and servers saved to an XML file and adds them as children of the server group.

System_CAPS_protmethodInitializeUIPropertyState()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodMove(ServerGroup)

Specifies the T:Microsoft.SqlServer.Management.RegisteredServers ServerGroup object to move in a new location.

System_CAPS_protmethodOnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs)

Invoked whenever the effective value of any SfcInstance metadata is updated. (Inherited from SfcInstance.)

System_CAPS_protmethodOnPropertyValueChanges(PropertyChangedEventArgs)

Invoked whenever the effective value of any SfcInstance property is updated. (Inherited from SfcInstance.)

System_CAPS_pubmethodRefresh()

Refreshes the object's properties by reading them from the server.(Inherited from SfcInstance.)

System_CAPS_pubmethodRename(SfcKey)

Renames the ServerGroup object by using the specified name.

System_CAPS_pubmethodRename(String)

Renames the ServerGroup object by using the specified name.

System_CAPS_protmethodResetKey()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodSerialize(XmlWriter)

Serializes the instance to XML.(Inherited from SfcInstance.)

System_CAPS_pubmethodToString()

Returns a string representation of the instance Urn.(Inherited from SfcInstance.)

System_CAPS_pubmethodValidate(String, Object[])

Validates the ServerGroup object against the specified method and arguments.

NameDescription
System_CAPS_pubeventDuplicateFound

An event raised if a duplicate registered server group is encountered.

System_CAPS_pubeventPropertyChanged

(Inherited from SfcInstance.)

System_CAPS_pubeventPropertyMetadataChanged

(Inherited from SfcInstance.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcAlterable.ScriptAlter()

Alters 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..

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcCreatable.ScriptCreate()

Produces 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..

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcDroppable.ScriptDrop()

Produces the script to drop this object from storage. Do not reference this member directly in your code. It supports the SQL Server infrastructure..

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcMovable.Move(SfcInstance)

Moves 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..

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcMovable.ScriptMove(SfcInstance)

Produces 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..

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcRenamable.ScriptRename(SfcKey)

Renames 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..

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.

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.

Return to top
Show: