ManagedInstance Class

Definition

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

public ref class ManagedInstance : Microsoft::SqlServer::Management::Sdk::Sfc::SfcInstance, Microsoft::SqlServer::Management::Common::ICreatable, Microsoft::SqlServer::Management::Common::IDroppable, Microsoft::SqlServer::Management::Sdk::Sfc::ISfcCreatable, Microsoft::SqlServer::Management::Sdk::Sfc::ISfcDroppable
public class ManagedInstance : Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance, Microsoft.SqlServer.Management.Common.ICreatable, Microsoft.SqlServer.Management.Common.IDroppable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcCreatable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcDroppable
type ManagedInstance = class
    inherit SfcInstance
    interface ISfcCreatable
    interface ICreatable
    interface ISfcDroppable
    interface IDroppable
Public Class ManagedInstance
Inherits SfcInstance
Implements ICreatable, IDroppable, ISfcCreatable, ISfcDroppable
Inheritance
ManagedInstance
Implements

Remarks

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.

Constructors

ManagedInstance()

Initializes a new instance of the ManagedInstance class.

Properties

AbstractIdentityKey

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

(Inherited from SfcInstance)
AgentProxyAccount

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

BackupDirectory

Gets the backup directory for the server instance.

CacheDirectory

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

Collation

Gets the collation for the server instance.

ComputerNamePhysicalNetBIOS

Gives the physical NetBIOS for the server instance.

ComputerProcessorHealthState

Gets the computer processor health state.

ContainsOverUtilizedDatabases

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

ContainsOverUtilizedVolumes

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

ContainsUnderUtilizedDatabases

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

ContainsUnderUtilizedVolumes

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

CpuMaxClockSpeed

Gets the maximum clock speed of the CPU.

CpuName

Gets the name of the CPU.

DateCreated

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

Edition

Gets the edition of the instance of SQL Server.

EngineEdition

Gets the engine edition for the instance of SQL Server.

FileSpaceHealthState

Gets the file space health state.

ID

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

IdentityKey

Gets the key value that identifies the managed instance.

InstanceName

Gets the name of the instance of SQL Server.

IsCaseSensitive

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

IsClustered

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

IsPolicyOverridden

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

Language

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

LastReportedTime

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

ManagementState

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

Metadata

Returns metadata about the instance and its domain.

(Inherited from SfcInstance)
Name

Gets or sets the name of the managed instance.

NetName

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

OSVersion

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

Parent

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

PhysicalMemory

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

Processors

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

ProductLevel

Gets the product level of the server instance.

Properties

Returns a collection instance properties.

(Inherited from SfcInstance)
PropertyStorageProvider

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

(Inherited from SfcInstance)
ServerProcessorHealthState

Gets the server instance processor health state.

ServerType

Gets the type of the server instance.

ServerUrn

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

State

Returns the state of the SfcInstance object.

(Inherited from SfcInstance)
Urn

Returns the uniform resource name of the SfcInstance object.

(Inherited from SfcInstance)
Version

Specifies the version of the server instance.

VolumeSpaceHealthState

Gets the volume space health state.

Methods

AlterImpl()

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

(Inherited from SfcInstance)
CheckObjectCreated()

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

(Inherited from SfcInstance)
CheckObjectState()

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

(Inherited from SfcInstance)
CreateIdentityKey()

Creates an identity key.

CreateImpl()

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

(Inherited from SfcInstance)
Discover(ISfcDependencyDiscoveryObjectSink)

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

(Inherited from SfcInstance)
DropImpl()

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

(Inherited from SfcInstance)
GetChildCollection(String)

Gets the child collection.

GetDomain()

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

(Inherited from SfcInstance)
GetObjectFactory()

Gets the factory object used to create new instances.

GetPropertySet()

Returns the set of properties for the SfcInstance object.

(Inherited from SfcInstance)
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)
InitializeUIPropertyState()

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

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

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

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

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

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

(Inherited from SfcInstance)
PostCreate(Object)

Sets the ID property of the base type to the execution result.

PostDrop(Object)

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

(Inherited from SfcInstance)
PostMove(Object)

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

(Inherited from SfcInstance)
PostRename(Object)

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

(Inherited from SfcInstance)
Refresh()

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

(Inherited from SfcInstance)
Remove(SqlStoreConnection)

Removes the managed instance of the SqlStoreConnection object.

RenameImpl(SfcKey)

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

(Inherited from SfcInstance)
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)
UpdateUIPropertyState()

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

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

Events

propertyChanged

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

(Inherited from SfcInstance)
PropertyChanged

Occurs when a property value changes.

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

Occurs when the metadata for a property has changed.

(Inherited from SfcInstance)

Explicit Interface Implementations

ICreatable.Create()

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

IDroppable.Drop()

Drops the instance if the state is managed.

ISfcCreatable.ScriptCreate()

Creates an ISfcScript object.

ISfcDroppable.ScriptDrop()

Drops an ISfcScript object.

Applies to