ServerGroup Class
The ServerGroup class represents a SQL Server server group.
Assembly: Microsoft.SqlServer.Management.RegisteredServers (in Microsoft.SqlServer.Management.RegisteredServers.dll)
Microsoft.SqlServer.Management.Sdk.Sfc::SfcInstance
Microsoft.SqlServer.Management.RegisteredServers::ServerGroupParent
Microsoft.SqlServer.Management.RegisteredServers::ServerGroup
| Name | Description | |
|---|---|---|
![]() | ServerGroup() | Initializes a new instance of the ServerGroup class. |
![]() | ServerGroup(ServerGroup^, String^) | Initializes a new instance of the ServerGroup class that has the specified name and is a subgroup of the specified parent. |
![]() | ServerGroup(String^) | Initializes a new instance of the ServerGroup class that has the specified name. |
| Name | Description | |
|---|---|---|
![]() | AbstractIdentityKey | Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.) |
![]() | Description | Gets the name of the server group. |
![]() | DisplayName | Gets the display name of the server group. |
![]() | ID | Gets the ID value that uniquely identifies the server group. |
![]() | IdentityKey | Gets the key value that uniquely identifies the server group. |
![]() | IsDropped | Gets the Boolean value that specifies whether the server group has been dropped or not. |
![]() | IsLocal | Gets the Boolean value that specifies whether the server group local. |
![]() | IsSystemServerGroup | Gets the Boolean value that specifies whether the server group is a system object. |
![]() | Metadata | Returns metadata about the instance and its domain.(Inherited from SfcInstance.) |
![]() | Name | Gets the name of the server group. |
![]() | Parent | Gets the parent of the ServerGroup object. |
![]() | Properties | Returns a collection instance properties.(Inherited from SfcInstance.) |
![]() | RegisteredServers | Represents a collection of T:Microsoft.SqlServer.Management.RegisteredServers.RegisteredServers objects. Each T:Microsoft.SqlServer.Management.RegisteredServers.RegisteredServers object represents a registered server. |
![]() | ServerGroups | Represents a collection of ServerGroup objects. Each ServerGroup object represents a server group. |
![]() | ServerType | Gets or the type of server that is associated with the server group. |
![]() | State | Returns the state of the SfcInstance object.(Inherited from SfcInstance.) |
![]() | Urn | Returns the uniform resource name of the SfcInstance object.(Inherited from SfcInstance.) |
| Name | Description | |
|---|---|---|
![]() | Alter() | Updates any ServerGroup object property changes on the instance of SQL Server. |
![]() | Create() | Creates a registered server on the instance of SQL Server as defined by the ServerGroup object. |
![]() | CreateIdentityKey() | Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.) |
![]() | Discover(ISfcDependencyDiscoveryObjectSink^) | Discovers the dependency relationship for the server group.(Overrides SfcInstance::Discover(ISfcDependencyDiscoveryObjectSink^).) |
![]() | Drop() | Drops the registered server. |
![]() | Equals(Object^) | (Inherited from Object.) |
![]() | Export(String^, CredentialPersistenceType) | Exports the server group to the specified file and using the specified credential persistence type. |
![]() | GetChildCollection(String^) | Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.) |
![]() | GetDescendantRegisteredServers() | Returns a list of the registered servers in a server group. |
![]() | GetDomain() | Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.) |
![]() | GetHashCode() | (Inherited from Object.) |
![]() ![]() | GetObjectFactory() | Returns the SFC object factory for the ServerGroup object. |
![]() | GetPropertySet() | Returns the set of properties for the SfcInstance object.(Inherited from SfcInstance.) |
![]() | GetType() | (Inherited from Object.) |
![]() | GetTypeMetadataImpl() | 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.) |
![]() | Import(String^) | Imports groups and servers saved to an XML file and adds them as children of the server group. |
![]() | InitializeUIPropertyState() | Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.) |
![]() | Move(ServerGroup^) | Specifies the T:Microsoft.SqlServer.Management.RegisteredServers ServerGroup object to move in a new location. |
![]() | OnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs^) | Invoked whenever the effective value of any SfcInstance metadata is updated. (Inherited from SfcInstance.) |
![]() | OnPropertyValueChanges(PropertyChangedEventArgs^) | Invoked whenever the effective value of any SfcInstance property is updated. (Inherited from SfcInstance.) |
![]() | Refresh() | Refreshes the object's properties by reading them from the server.(Inherited from SfcInstance.) |
![]() | Rename(SfcKey^) | Renames the ServerGroup object by using the specified name. |
![]() | Rename(String^) | Renames the ServerGroup object by using the specified name. |
![]() | ResetKey() | Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.) |
![]() | Serialize(XmlWriter^) | Serializes the instance to XML.(Inherited from SfcInstance.) |
![]() | ToString() | Returns a string representation of the instance Urn.(Inherited from SfcInstance.) |
![]() | Validate(String^, array<Object^>^) | Validates the ServerGroup object against the specified method and arguments. |
| Name | Description | |
|---|---|---|
![]() | DuplicateFound | An event raised if a duplicate registered server group is encountered. |
![]() | PropertyChanged | Occurs when a property value changes.(Inherited from SfcInstance.) |
![]() | PropertyMetadataChanged | Occurs when the metadata for a property has changed.(Inherited from SfcInstance.) |
| Name | Description | |
|---|---|---|
![]() ![]() | ISfcAlterable::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.. |
![]() ![]() | ISfcCreatable::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.. |
![]() ![]() | ISfcDroppable::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.. |
![]() ![]() | ISfcMovable::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.. |
![]() ![]() | ISfcMovable::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.. |
![]() ![]() | ISfcRenamable::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.







