Export (0) Print
Expand All

ManagedInstance Class

The ManagedInstance type represents an instance of SQL Server that is managed by the SQL Server Utility services to control policy, and deployments.

Object
  Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance
    Microsoft.SqlServer.Management.Utility.ManagedInstance

Namespace:  Microsoft.SqlServer.Management.Utility
Assembly:  Microsoft.SqlServer.Management.Utility (in Microsoft.SqlServer.Management.Utility.dll)

public class ManagedInstance : SfcInstance, 
	ISfcCreatable, ICreatable, ISfcDroppable, IDroppable

The ManagedInstance type exposes the following members.

  NameDescription
Public methodManagedInstanceInitializes a new instance of the ManagedInstance class.
Top

  NameDescription
Protected propertyAbstractIdentityKeyDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public propertyAgentProxyAccountGets the SQL Server Agent proxy account used to run scheduled jobs on the instance of SQL Server.
Public propertyBackupDirectoryGets the backup directory for the server instance.
Public propertyCacheDirectoryGets the cache directory where temporary files can be stored during deployment onto the instance of SQL Server.
Public propertyCollationGets the collation for the server instance.
Public propertyComputerNamePhysicalNetBIOSGives the physical NetBIOS for the server instance.
Public propertyComputerProcessorHealthStateGets the computer processor health state.
Public propertyContainsOverUtilizedDatabasesGets a value that indicates whether the server instance contains an over utilized databases.
Public propertyContainsOverUtilizedVolumesGets a value that indicates whether the server instance contains an over utilized volumes.
Public propertyContainsUnderUtilizedDatabasesGets a value that indicates whether the server instance contains an under utilized databases.
Public propertyContainsUnderUtilizedVolumesGets a value that indicates whether the server instance contains an under utilized volumes.
Public propertyCpuMaxClockSpeedGets the maximum clock speed of the CPU.
Public propertyCpuNameGets the name of the CPU.
Public propertyDateCreatedGets the time and date when the ManagedInstance object was created.
Public propertyEditionGets the edition of the instance of SQL Server.
Public propertyEngineEditionGets the engine edition for the instance of SQL Server.
Public propertyFileSpaceHealthStateGets the file space health state.
Public propertyIDGets ID value that uniquely identifies the managed instance of SQL Server.
Public propertyIdentityKeyGets the key value that identifies the managed instance.
Public propertyInstanceNameGets the name of the instance of SQL Server.
Public propertyIsCaseSensitiveGets a value that indicates whether the server instance is case-sensitive.
Public propertyIsClusteredGets a value that indicates whether the server instance is part of a clustered server.
Public propertyIsPolicyOverriddenGets a value that indicates whether any of the server instance policies have been overridden.
Public propertyLanguageGets the language used by the managed instance of SQL Server.
Public propertyLastReportedTimeGets the latest reported time for the properties of the server instance object.
Public propertyManagementStateGets the current state of instance of SQL Server with regard to being managed by the SQL Server Utility service.
Public propertyMetadataReturns metadata about the instance and its domain. (Inherited from SfcInstance.)
Public propertyNameGets or sets the name of the managed instance.
Public propertyNetNameGets the NetBIOS name of the network on which the server instance is running.
Public propertyOSVersionGets the operating system version of the managed instance of SQL Server.
Public propertyParentGets or sets the Utility object that is the parent of the ManagedInstance object.
Public propertyPhysicalMemoryGets the physical memory of the managed instance of SQL Server.
Public propertyProcessorsGets the number of processors for the managed instance of SQL Server.
Public propertyProductLevelGets the product level of the server instance.
Public propertyPropertiesReturns a collection instance properties. (Inherited from SfcInstance.)
Protected propertyPropertyStorageProviderDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public propertyServerProcessorHealthStateGets the server instance processor health state.
Public propertyServerTypeGets the type of the server instance.
Public propertyServerUrnGets the uniform resource name (URN) of the server instance.
Protected propertyStateReturns the state of the SfcInstance object. (Inherited from SfcInstance.)
Public propertyUrnReturns the uniform resource name of the SfcInstance object. (Inherited from SfcInstance.)
Public propertyVersionSpecifies the version of the server instance.
Public propertyVolumeSpaceHealthStateGets the volume space health state.
Top

  NameDescription
Protected methodAlterImplDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected methodCheckObjectCreatedDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected methodCheckObjectStateDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected methodCreateIdentityKeyCreates an SfcKey object. (Overrides SfcInstance.CreateIdentityKey().)
Protected methodCreateImplDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodDiscoverDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected methodDropImplDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Protected methodGetChildCollectionThrows a UtilityException. There is no such collection. (Overrides SfcInstance.GetChildCollection(String).)
Public methodGetDomainDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodGetHashCode (Inherited from Object.)
Public methodStatic memberGetObjectFactoryGets the factory object used to create new instances.
Public methodGetPropertySetReturns the set of properties for the SfcInstance object. (Inherited from SfcInstance.)
Public methodGetType (Inherited from Object.)
Protected methodGetTypeMetadataImplIndicates 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.)
Protected methodInitializeUIPropertyStateDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected methodMarkForDropImplReturns 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.)
Protected methodMarkRootAsConnectedDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodMoveImplIndicates 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.)
Protected methodOnPropertyMetadataChangesInvoked whenever the effective value of any SfcInstance metadata is updated. (Inherited from SfcInstance.)
Protected methodOnPropertyValueChangesInvoked whenever the effective value of any SfcInstance property is updated. (Inherited from SfcInstance.)
Protected methodPostAlterDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected methodPostCreateSets the ID property of the base type to the execution result. (Overrides SfcInstance.PostCreate(Object).)
Protected methodPostDropDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected methodPostMoveDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected methodPostRenameDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodRefreshRefreshes the object's properties by reading them from the server. (Inherited from SfcInstance.)
Public methodRemoveGets the parent SqlStoreConnection object.
Protected methodRenameImplDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected methodResetKeyDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodSerializeSerializes the instance to XML. (Inherited from SfcInstance.)
Public methodToStringReturns a string representation of the instance Urn. (Inherited from SfcInstance.)
Protected methodUpdateUIPropertyStateDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected methodValidateIndicates the basic child object's validation. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Top

  NameDescription
Protected eventpropertyChangedDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public eventPropertyChangedCLS-compliant event for property changes. (Inherited from SfcInstance.)
Protected eventpropertyMetadataChangedDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public eventPropertyMetadataChangedCLS-compliant event for property metadata changes. (Inherited from SfcInstance.)
Top

  NameDescription
Explicit interface implemetationPrivate methodICreatableCreateTests whether the state is managed and creates a server and connection if in the managed state.
Explicit interface implemetationPrivate methodIDroppableDropTests whether state is managed and drops the instance if it is managed.
Explicit interface implemetationPrivate methodISfcCreatable.ScriptCreateCreates an ISfcScript object.
Explicit interface implemetationPrivate methodISfcDroppable.ScriptDropDrops an ISfcScript object.
Top

The Managed instance object represents an instance of SQL Server that is included in the group of computers managed by SQL Server Utility services. Using the ManagedObject object, you can:

  • Determine the agent proxy account that runs scheduled jobs on the instance of SQL Server.

  • Determine the cache directory where temporary files are stored during a deployment.

  • Determine the management state of the instance of SQL Server.

  • Stop managing the instance of SQL Server and remove it from the SQL Server Utility.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft