ManagedInstance Class

Artikel
08/11/2014

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

Inheritance Hierarchy

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

Syntax

'Declaration
Public Class ManagedInstance _
    Inherits SfcInstance _
    Implements ISfcCreatable, ICreatable, ISfcDroppable, IDroppable
'Usage
Dim instance As ManagedInstance

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

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

type ManagedInstance =  
    class 
        inherit SfcInstance 
        interface ISfcCreatable 
        interface ICreatable 
        interface ISfcDroppable 
        interface IDroppable 
    end

public class ManagedInstance extends SfcInstance implements ISfcCreatable, ICreatable, ISfcDroppable, IDroppable

The ManagedInstance type exposes the following members.

Constructors

	Name	Description
	ManagedInstance	Initializes a new instance of the ManagedInstance class.

Top

Properties

	Name	Description
	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.

Top

Methods

	Name	Description
	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 SfcKey object. (Overrides SfcInstance.CreateIdentityKey().)
	CreateImpl	Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
	Discover	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.)
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetChildCollection	Throws a UtilityException. There is no such collection. (Overrides SfcInstance.GetChildCollection(String).)
	GetDomain	Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
	GetHashCode	(Inherited from Object.)
	GetObjectFactory	Gets the factory object used to create new instances.
	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.)
	InitializeUIPropertyState	Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
	MarkForDropImpl	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.)
	MemberwiseClone	(Inherited from Object.)
	MoveImpl	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	Invoked whenever the effective value of any SfcInstance metadata is updated. (Inherited from SfcInstance.)
	OnPropertyValueChanges	Invoked whenever the effective value of any SfcInstance property is updated. (Inherited from SfcInstance.)
	PostAlter	Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
	PostCreate	Sets the ID property of the base type to the execution result. (Overrides SfcInstance.PostCreate(Object).)
	PostDrop	Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
	PostMove	Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
	PostRename	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	Gets the parent SqlStoreConnection object.
	RenameImpl	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	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.)

Top

Events

	Name	Description
	propertyChanged	Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
	PropertyChanged	CLS-compliant event for property changes. (Inherited from SfcInstance.)
	propertyMetadataChanged	Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
	PropertyMetadataChanged	CLS-compliant event for property metadata changes. (Inherited from SfcInstance.)

Top

Explicit Interface Implementations

	Name	Description
	ICreatable.Create	Tests whether the state is managed and creates a server and connection if in the managed state.
	IDroppable.Drop	Tests whether state is managed and drops the instance if it is managed.
	ISfcCreatable.ScriptCreate	Creates an ISfcScript object.
	ISfcDroppable.ScriptDrop	Drops an ISfcScript object.

Top

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.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Delen via