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.

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

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

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

NameDescription
System_CAPS_pubmethodManagedInstance()

Initializes a new instance of the ManagedInstance class.

NameDescription
System_CAPS_protpropertyAbstractIdentityKey

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

System_CAPS_pubpropertyAgentProxyAccount

Gets the SQL Server Agent proxy account used to run scheduled jobs on the instance of SQL Server.

System_CAPS_pubpropertyBackupDirectory

Gets the backup directory for the server instance.

System_CAPS_pubpropertyCacheDirectory

Gets the cache directory where temporary files can be stored during deployment onto the instance of SQL Server.

System_CAPS_pubpropertyCollation

Gets the collation for the server instance.

System_CAPS_pubpropertyComputerNamePhysicalNetBIOS

Gives the physical NetBIOS for the server instance.

System_CAPS_pubpropertyComputerProcessorHealthState

Gets the computer processor health state.

System_CAPS_pubpropertyContainsOverUtilizedDatabases

Gets a value that indicates whether the server instance contains an over utilized databases.

System_CAPS_pubpropertyContainsOverUtilizedVolumes

Gets a value that indicates whether the server instance contains an over utilized volumes.

System_CAPS_pubpropertyContainsUnderUtilizedDatabases

Gets a value that indicates whether the server instance contains an under utilized databases.

System_CAPS_pubpropertyContainsUnderUtilizedVolumes

Gets a value that indicates whether the server instance contains an under utilized volumes.

System_CAPS_pubpropertyCpuMaxClockSpeed

Gets the maximum clock speed of the CPU.

System_CAPS_pubpropertyCpuName

Gets the name of the CPU.

System_CAPS_pubpropertyDateCreated

Gets the time and date when the ManagedInstance object was created.

System_CAPS_pubpropertyEdition

Gets the edition of the instance of SQL Server.

System_CAPS_pubpropertyEngineEdition

Gets the engine edition for the instance of SQL Server.

System_CAPS_pubpropertyFileSpaceHealthState

Gets the file space health state.

System_CAPS_pubpropertyID

Gets ID value that uniquely identifies the managed instance of SQL Server.

System_CAPS_pubpropertyIdentityKey

Gets the key value that identifies the managed instance.

System_CAPS_pubpropertyInstanceName

Gets the name of the instance of SQL Server.

System_CAPS_pubpropertyIsCaseSensitive

Gets a value that indicates whether the server instance is case-sensitive.

System_CAPS_pubpropertyIsClustered

Gets a value that indicates whether the server instance is part of a clustered server.

System_CAPS_pubpropertyIsPolicyOverridden

Gets a value that indicates whether any of the server instance policies have been overridden.

System_CAPS_pubpropertyLanguage

Gets the language used by the managed instance of SQL Server.

System_CAPS_pubpropertyLastReportedTime

Gets the latest reported time for the properties of the server instance object.

System_CAPS_pubpropertyManagementState

Gets the current state of instance of SQL Server with regard to being managed by the SQL Server Utility service.

System_CAPS_pubpropertyMetadata

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

System_CAPS_pubpropertyName

Gets or sets the name of the managed instance.

System_CAPS_pubpropertyNetName

Gets the NetBIOS name of the network on which the server instance is running.

System_CAPS_pubpropertyOSVersion

Gets the operating system version of the managed instance of SQL Server.

System_CAPS_pubpropertyParent

Gets or sets the Utility object that is the parent of the ManagedInstance object.

System_CAPS_pubpropertyPhysicalMemory

Gets the physical memory of the managed instance of SQL Server.

System_CAPS_pubpropertyProcessors

Gets the number of processors for the managed instance of SQL Server.

System_CAPS_pubpropertyProductLevel

Gets the product level of the server instance.

System_CAPS_pubpropertyProperties

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

System_CAPS_protpropertyPropertyStorageProvider

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

System_CAPS_pubpropertyServerProcessorHealthState

Gets the server instance processor health state.

System_CAPS_pubpropertyServerType

Gets the type of the server instance.

System_CAPS_pubpropertyServerUrn

Gets the uniform resource name (URN) of the server instance.

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

System_CAPS_pubpropertyVersion

Specifies the version of the server instance.

System_CAPS_pubpropertyVolumeSpaceHealthState

Gets the volume space health state.

NameDescription
System_CAPS_protmethodAlterImpl()

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

System_CAPS_protmethodCheckObjectCreated()

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

System_CAPS_protmethodCheckObjectState()

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

System_CAPS_protmethodCreateIdentityKey()

Creates an SfcKey object.(Overrides SfcInstance.CreateIdentityKey().)

System_CAPS_protmethodCreateImpl()

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

System_CAPS_pubmethodDiscover(ISfcDependencyDiscoveryObjectSink)

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

System_CAPS_protmethodDropImpl()

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

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_protmethodGetChildCollection(String)

Throws a UtilityException. There is no such collection.(Overrides SfcInstance.GetChildCollection(String).)

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

Gets the factory object used to create new instances.

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

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

System_CAPS_protmethodMarkForDropImpl(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.)

System_CAPS_protmethodMarkRootAsConnected()

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

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethodMoveImpl(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.)

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_protmethodPostAlter(Object)

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

System_CAPS_protmethodPostCreate(Object)

Sets the ID property of the base type to the execution result.(Overrides SfcInstance.PostCreate(Object).)

System_CAPS_protmethodPostDrop(Object)

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

System_CAPS_protmethodPostMove(Object)

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

System_CAPS_protmethodPostRename(Object)

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

System_CAPS_pubmethodRefresh()

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

System_CAPS_pubmethodRemove(SqlStoreConnection)

Gets the parent SqlStoreConnection object.

System_CAPS_protmethodRenameImpl(SfcKey)

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

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

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

System_CAPS_protmethodValidate()

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

NameDescription
System_CAPS_proteventpropertyChanged

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

System_CAPS_pubeventPropertyChanged

Occurs when a property value changes.(Inherited from SfcInstance.)

System_CAPS_proteventpropertyMetadataChanged

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

System_CAPS_pubeventPropertyMetadataChanged

Occurs when the metadata for a property has changed.(Inherited from SfcInstance.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodICreatable.Create()

Tests whether the state is managed and creates a server and connection if in the managed state.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIDroppable.Drop()

Tests whether state is managed and drops the instance if it is managed.

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcCreatable.ScriptCreate()

Creates an ISfcScript object.

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcDroppable.ScriptDrop()

Drops an ISfcScript object.

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 T:Microsoft.SqlServer.Management.Utility.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.

Return to top
Show: