ServerGroup ServerGroup ServerGroup Class

Definition

The ServerGroup class represents a SQL Server server group.

public ref class ServerGroup sealed : Microsoft::SqlServer::Management::RegisteredServers::ServerGroupParent, Microsoft::SqlServer::Management::Common::IAlterable, Microsoft::SqlServer::Management::Common::ICreatable, Microsoft::SqlServer::Management::Common::IDroppable, Microsoft::SqlServer::Management::Common::IRenamable, Microsoft::SqlServer::Management::Sdk::Sfc::ISfcAlterable, Microsoft::SqlServer::Management::Sdk::Sfc::ISfcCreatable, Microsoft::SqlServer::Management::Sdk::Sfc::ISfcDroppable, Microsoft::SqlServer::Management::Sdk::Sfc::ISfcMovable, Microsoft::SqlServer::Management::Sdk::Sfc::ISfcRenamable, Microsoft::SqlServer::Management::Sdk::Sfc::ISfcValidate
public sealed class ServerGroup : Microsoft.SqlServer.Management.RegisteredServers.ServerGroupParent, Microsoft.SqlServer.Management.Common.IAlterable, Microsoft.SqlServer.Management.Common.ICreatable, Microsoft.SqlServer.Management.Common.IDroppable, Microsoft.SqlServer.Management.Common.IRenamable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcAlterable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcCreatable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcDroppable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcMovable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcRenamable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcValidate
Public NotInheritable Class ServerGroup
Inherits ServerGroupParent
Implements IAlterable, ICreatable, IDroppable, IRenamable, ISfcAlterable, ISfcCreatable, ISfcDroppable, ISfcMovable, ISfcRenamable, ISfcValidate
Inheritance
Implements
Microsoft.SqlServer.Management.Common.IAlterableMicrosoft.SqlServer.Management.Common.IAlterableMicrosoft.SqlServer.Management.Common.IAlterable Microsoft.SqlServer.Management.Common.ICreatableMicrosoft.SqlServer.Management.Common.ICreatableMicrosoft.SqlServer.Management.Common.ICreatable Microsoft.SqlServer.Management.Common.IDroppableMicrosoft.SqlServer.Management.Common.IDroppableMicrosoft.SqlServer.Management.Common.IDroppable Microsoft.SqlServer.Management.Common.IRenamableMicrosoft.SqlServer.Management.Common.IRenamableMicrosoft.SqlServer.Management.Common.IRenamable ISfcAlterableISfcAlterableISfcAlterable ISfcCreatableISfcCreatableISfcCreatable ISfcDroppableISfcDroppableISfcDroppable ISfcMovableISfcMovableISfcMovable ISfcRenamableISfcRenamableISfcRenamable ISfcValidateISfcValidateISfcValidate

Remarks

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

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() ServerGroup() ServerGroup()

Initializes a new instance of the ServerGroup class.

ServerGroup(ServerGroup, String) ServerGroup(ServerGroup, String) 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) ServerGroup(String) ServerGroup(String)

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

Properties

AbstractIdentityKey AbstractIdentityKey AbstractIdentityKey

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
Description Description Description

Gets the name of the server group.

DisplayName DisplayName DisplayName

Gets the display name of the server group.

ID ID ID

Gets the ID value that uniquely identifies the server group.

IdentityKey IdentityKey IdentityKey

Gets the key value that uniquely identifies the server group.

IsDropped IsDropped IsDropped

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

IsLocal IsLocal IsLocal

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

IsSystemServerGroup IsSystemServerGroup IsSystemServerGroup

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

Metadata Metadata Metadata

Returns metadata about the instance and its domain.

(Inherited from SfcInstance)
Name Name Name

Gets the name of the server group.

Parent Parent Parent

Gets the parent of the ServerGroup object.

Properties Properties Properties

Returns a collection instance properties.

(Inherited from SfcInstance)
PropertyStorageProvider PropertyStorageProvider PropertyStorageProvider

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
RegisteredServers RegisteredServers RegisteredServers

Represents a collection of RegisteredServer objects. Each RegisteredServer object represents a registered server.

ServerGroups ServerGroups ServerGroups

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

ServerType ServerType ServerType

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

State State State

Returns the state of the SfcInstance object.

(Inherited from SfcInstance)
Urn Urn Urn

Returns the uniform resource name of the SfcInstance object.

(Inherited from SfcInstance)

Methods

Alter() Alter() Alter()

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

AlterImpl() AlterImpl() AlterImpl()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
CheckObjectCreated() CheckObjectCreated() CheckObjectCreated()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
CheckObjectState() CheckObjectState() CheckObjectState()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
Create() Create() Create()

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

CreateIdentityKey() CreateIdentityKey() CreateIdentityKey()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
CreateImpl() CreateImpl() CreateImpl()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
Discover(ISfcDependencyDiscoveryObjectSink) Discover(ISfcDependencyDiscoveryObjectSink) Discover(ISfcDependencyDiscoveryObjectSink)

Discovers the dependency relationship for the server group.

Drop() Drop() Drop()

Drops the registered server.

DropImpl() DropImpl() DropImpl()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
Export(String, CredentialPersistenceType) Export(String, CredentialPersistenceType) Export(String, CredentialPersistenceType)

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

GetChildCollection(String) GetChildCollection(String) GetChildCollection(String)

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
GetDescendantRegisteredServers() GetDescendantRegisteredServers() GetDescendantRegisteredServers()

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

GetDomain() GetDomain() GetDomain()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
GetObjectFactory() GetObjectFactory() GetObjectFactory()

Returns the SFC object factory for the ServerGroup object.

GetPropertySet() GetPropertySet() GetPropertySet()

Returns the set of properties for the SfcInstance object.

(Inherited from SfcInstance)
GetTypeMetadataImpl() GetTypeMetadataImpl() 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) Import(String) Import(String)

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

InitializeUIPropertyState() InitializeUIPropertyState() InitializeUIPropertyState()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
MarkForDropImpl(Boolean) MarkForDropImpl(Boolean) MarkForDropImpl(Boolean)

Returns a value that indicates the existing objects to be dropped. Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
MarkRootAsConnected() MarkRootAsConnected() MarkRootAsConnected()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
Move(ServerGroup) Move(ServerGroup) Move(ServerGroup)

Specifies the ServerGroup object to move in a new location.

MoveImpl(SfcInstance) MoveImpl(SfcInstance) MoveImpl(SfcInstance)

Indicates the new parent object to move in an instance. Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
OnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs) OnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs) OnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs)

Invoked whenever the effective value of any SfcInstance metadata is updated.

(Inherited from SfcInstance)
OnPropertyValueChanges(PropertyChangedEventArgs) OnPropertyValueChanges(PropertyChangedEventArgs) OnPropertyValueChanges(PropertyChangedEventArgs)

Invoked whenever the effective value of any SfcInstance property is updated.

(Inherited from SfcInstance)
PostAlter(Object) PostAlter(Object) PostAlter(Object)

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
PostCreate(Object) PostCreate(Object) PostCreate(Object)

Indicates the default implementor that creates the execution result. Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
PostDrop(Object) PostDrop(Object) PostDrop(Object)

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
PostMove(Object) PostMove(Object) PostMove(Object)

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
PostRename(Object) PostRename(Object) PostRename(Object)

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
Refresh() Refresh() Refresh()

Refreshes the object's properties by reading them from the server.

(Inherited from SfcInstance)
Rename(SfcKey) Rename(SfcKey) Rename(SfcKey)

Renames the ServerGroup object by using the specified name.

Rename(String) Rename(String) Rename(String)

Renames the ServerGroup object by using the specified name.

RenameImpl(SfcKey) RenameImpl(SfcKey) RenameImpl(SfcKey)

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
ResetKey() ResetKey() ResetKey()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
Serialize(XmlWriter) Serialize(XmlWriter) Serialize(XmlWriter)

Serializes the instance to XML.

(Inherited from SfcInstance)
ToString() ToString() ToString()

Returns a string representation of the instance Urn.

(Inherited from SfcInstance)
UpdateUIPropertyState() UpdateUIPropertyState() UpdateUIPropertyState()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
Validate() Validate() Validate()

Indicates the basic child object's validation. Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
Validate(String, Object[]) Validate(String, Object[]) Validate(String, Object[])

Validates the ServerGroup object against the specified method and arguments.

Events

DuplicateFound DuplicateFound DuplicateFound

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

propertyChanged propertyChanged propertyChanged

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
PropertyChanged PropertyChanged PropertyChanged

Occurs when a property value changes.

(Inherited from SfcInstance)
propertyMetadataChanged propertyMetadataChanged propertyMetadataChanged

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

Occurs when a property metadata value changes.

(Inherited from SfcInstance)
PropertyMetadataChanged PropertyMetadataChanged PropertyMetadataChanged

Occurs when the metadata for a property has changed.

(Inherited from SfcInstance)

Explicit Interface Implementations

ISfcAlterable.ScriptAlter() ISfcAlterable.ScriptAlter() 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() ISfcCreatable.ScriptCreate() 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() ISfcDroppable.ScriptDrop() 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) ISfcMovable.Move(SfcInstance) 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) ISfcMovable.ScriptMove(SfcInstance) 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) ISfcRenamable.ScriptRename(SfcKey) 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..

Applies to