Utility 类

The Utility class represents a utility control point (UCP) that defines methods and properties to manage one or more remote instances of SQL Server.

继承层次结构

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

命名空间：  Microsoft.SqlServer.Management.Utility
程序集：  Microsoft.SqlServer.Management.Utility（在 Microsoft.SqlServer.Management.Utility.dll 中）

语法

声明
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<LocalizedPropertyResourcesAttribute("Microsoft.SqlServer.Management.Utility.FacetSR",  _
    True)> _
<PhysicalFacetAttribute> _
<TypeConverterAttribute(GetType(LocalizableTypeConverter))> _
Public NotInheritable Class Utility _
    Inherits SfcInstance _
    Implements ISfcDomain2, ISfcDomain, ISfcDomainLite, ISfcHasConnection,  _
    ISfcAlterable, IAlterable
用法
Dim instance As Utility

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[LocalizedPropertyResourcesAttribute("Microsoft.SqlServer.Management.Utility.FacetSR", 
    true)]
[PhysicalFacetAttribute]
[TypeConverterAttribute(typeof(LocalizableTypeConverter))]
public sealed class Utility : SfcInstance, 
    ISfcDomain2, ISfcDomain, ISfcDomainLite, ISfcHasConnection, ISfcAlterable, 
    IAlterable

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[LocalizedPropertyResourcesAttribute(L"Microsoft.SqlServer.Management.Utility.FacetSR", 
    true)]
[PhysicalFacetAttribute]
[TypeConverterAttribute(typeof(LocalizableTypeConverter))]
public ref class Utility sealed : public SfcInstance, 
    ISfcDomain2, ISfcDomain, ISfcDomainLite, ISfcHasConnection, ISfcAlterable, 
    IAlterable

[<SealedAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<LocalizedPropertyResourcesAttribute("Microsoft.SqlServer.Management.Utility.FacetSR", 
    true)>]
[<PhysicalFacetAttribute>]
[<TypeConverterAttribute(typeof(LocalizableTypeConverter))>]
type Utility =  
    class 
        inherit SfcInstance 
        interface ISfcDomain2 
        interface ISfcDomain 
        interface ISfcDomainLite 
        interface ISfcHasConnection 
        interface ISfcAlterable 
        interface IAlterable 
    end

public final class Utility extends SfcInstance implements ISfcDomain2, ISfcDomain, ISfcDomainLite, ISfcHasConnection, ISfcAlterable, IAlterable

Utility 类型公开以下成员。

构造函数

	名称	说明
	Utility()	Initializes a new, default instance of the Utility class.
	Utility(SqlStoreConnection)	Initializes a new instance of the Utility class with the specified connection to SqlStore.

页首

属性

	名称	说明
	AbstractIdentityKey	不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 （从 SfcInstance 继承。）
	Computers	Gets the collection of computers running managed instances.
	CreatedBy	Gets the authentication credentials for the user who created the Utility.
	DateCreated	Gets the date and time when the SQL Server Utility was created.
	DeployedDacCount	Gets the number of deployed DACs on the instances of SQL Server managed by the SQL Server Utility.
	DeployedDacHealthyCount	Gets the number of healthy deployed DACs on the instances of SQL Server managed by the SQL Server Utility.
	DeployedDacManagementPendingCount	Gets the number of deployed DAC instances that have a pending management status.
	DeployedDacOnOverutilizedComputerCount	Gets the number of DACs that are deployed on managed instances run on overutilized computers.
	DeployedDacOnUnderutilizedComputerCount	Gets the number of DACs that are deployed on managed instances run on underutilized computers.
	DeployedDacOverutilizedCount	Gets the number of overutilized deployed DACs.
	DeployedDacs	Gets the number of DACs that are deployed on managed instances.
	DeployedDacUnderutilizedCount	Gets the number of deployed, underutilized DACs on all the managed instances.
	DeployedDacUnhealthyCount	Gets the number of deployed unhealthy DACs on all the managed instances.
	DeployedDacWithFilesOnOverutilizedVolumeCount	Gets the number of deployed DACs that have files on overutilized volumes.
	DeployedDacWithFilesOnUnderutilizedVolumeCount	Gets the number of deployed DACs that have files on underutilized volumes.
	DeployedDacWithOverutilizedFileCount	Gets the number of deployed DACs that have overutilized files.
	DeployedDacWithOverutilizedProcessorCount	Gets the number of deployed DACs that operate over overutilized processors.
	DeployedDacWithUnderutilizedFileCount	Gets the number of deployed DACs that have underutilized files.
	DeployedDacWithUnderutilizedProcessorCount	Gets the number of deployed DACs that operate on underutilized processors.
	Description	Gets or sets a String describing the UCP.
	ManagedInstanceCount	Gets the number of instances of SQL Server managed by the UCP.
	ManagedInstanceHealthyCount	Gets the number of healthy instances of SQL Server managed by the UCP.
	ManagedInstanceManagementPendingCount	Gets the number of instances of SQL Server that have a pending management status.
	ManagedInstanceOnOverutilizedComputerCount	Gets the number of managed instances of SQL Server that are running on overutilized computers.
	ManagedInstanceOnUnderutilizedComputerCount	Gets the number of managed instances of SQL Server that are running on underutilized computers.
	ManagedInstanceOverutilizedCount	Gets the number of overutilized managed instances of SQL Server.
	ManagedInstances	Gets a collection containing each instance of SQL Server managed by this Utility.
	ManagedInstanceUnderutilizedCount	Gets the number of managed instances of SQL Server that are underutilized.
	ManagedInstanceUnhealthyCount	Gets the number of unhealthy managed instances of SQL Server.
	ManagedInstanceWithFilesOnOverutilizedVolumeCount	Gets the number of managed instances of SQL Server that have files on overutilized volumes.
	ManagedInstanceWithFilesOnUnderutilizedVolumeCount	Gets the number of managed instances of SQL Server that have files on underutilized volumes.
	ManagedInstanceWithOverutilizedFileCount	Gets the number of managed instances of SQL Server that have overutilized files.
	ManagedInstanceWithOverutilizedProcessorCount	Gets the number of managed instances of SQL Server that are executed on overutilized processors.
	ManagedInstanceWithUnderutilizedFileCount	Gets the number of managed instances of SQL Server with underutilized files.
	ManagedInstanceWithUnderutilizedProcessorCount	Gets the number of managed instances of SQL Server that are executed on underutilized processors.
	MdwDatabaseName	Gets or sets the name of the utility management data warehouse (UMDW) database.
	MdwRetentionLengthInDaysForDaysHistory	Gets or sets the length, in days, that data will be retained in the Management Data Warehouse (MDW) history table for per-day entries.
	MdwRetentionLengthInDaysForHoursHistory	Gets or sets the length in days that data will be retained in the utility management data warehouse (UMDW) history table for per-hour entries.
	MdwRetentionLengthInDaysForMinutesHistory	Gets or sets the length in days that data will be retained in the utility management data warehouse (UMDW) history table for per-minute entries.
	Metadata	Returns metadata about the instance and its domain. （从 SfcInstance 继承。）
	Name	Gets the name of the connected SQL Store server.
	OverUtilizationOccurenceFrequency	Gets or sets the occurrence frequency that is used to computer over-utilization health states over the specified trailing window.
	OverUtilizationTrailingWindow	Gets or sets the trailing window, in hours, used to compute health states.
	Parent	Gets or sets the instance parent via the keychain. （从 SfcInstance 继承。）
	PolicyStore	Gets the PolicyStore object that defines the policies of the SQL Store connection.
	Properties	Returns a collection instance properties. （从 SfcInstance 继承。）
	SqlStoreConnection	Gets or sets the SQL Store connection
	State	Returns the state of the SfcInstance object. （从 SfcInstance 继承。）
	TotalStorageCapacity	Gets the storage capacity of the Utility.
	TotalStorageUtilization	Gets the amount of SQL Server Utility storage that is currently used.
	UnderUtilizationOccurenceFrequency	Gets or sets the occurrence frequency that is used to computer underutilization health states over the specified trailing window.
	UnderUtilizationTrailingWindow	Gets or sets the trailing window, in hours, used to compute health states.
	Urn	Returns the uniform resource name of the SfcInstance object. （从 SfcInstance 继承。）
	UtilityName	Gets the name of the utility control point (UCP).

页首

方法

	名称	说明
	Alter	Updates any Utility property changes on the instance of SQL Server.
	Connect	Returns a SqlStoreConnection object specified by connection.
	CreateIdentityKey	不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 （从 SfcInstance 继承。）
	CreateUtility(String, SqlStoreConnection)	Creates a Utility object.
	CreateUtility(String, SqlStoreConnection, String, SqlSecureString)	Creates a Utility object.
	Discover	不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 （从 SfcInstance 继承。）
	EnrollInstance(SqlStoreConnection)	Enrolls a Utility object with the connection supplied by sqlStoreConnection parameter.
	EnrollInstance(SqlStoreConnection, String, SqlSecureString)	Enrolls a Utility object with the connection supplied by sqlStoreConnection parameter.
	Equals	（从 Object 继承。）
	GetChildCollection	不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 （从 SfcInstance 继承。）
	GetDomain	不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 （从 SfcInstance 继承。）
	GetHashCode	（从 Object 继承。）
	GetPropertySet	Returns the set of properties for the SfcInstance object. （从 SfcInstance 继承。）
	GetType	（从 Object 继承。）
	GetTypeMetadataImpl	Indicates the domains that override by returning the right TypeMetadata class directly. 不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 （从 SfcInstance 继承。）
	InitializeUIPropertyState	不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 （从 SfcInstance 继承。）
	IsLoginUtilityReader	Validates whether the login used in the connection has the utility reader role.
	IsUtilityControlPoint	Determines whether the specified server is a utility control point (UCP).
	OnPropertyMetadataChanges	Invoked whenever the effective value of any SfcInstance metadata is updated. （从 SfcInstance 继承。）
	OnPropertyValueChanges	Invoked whenever the effective value of any SfcInstance property is updated. （从 SfcInstance 继承。）
	Refresh	Refreshes the SQL Server Utility properties. （覆盖 SfcInstance.Refresh()。）
	ResetKey	不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 （从 SfcInstance 继承。）
	ScriptAlter	Alters the properties of the base object if it has been changed.
	Serialize	Serializes the instance to XML. （从 SfcInstance 继承。）
	ToString	Returns a string representation of the instance Urn. （从 SfcInstance 继承。）

页首

事件

	名称	说明
	PropertyChanged	CLS-compliant event for property changes. （从 SfcInstance 继承。）
	PropertyMetadataChanged	CLS-compliant event for property metadata changes. （从 SfcInstance 继承。）

页首

显式接口实现

	名称	说明
	ISfcDomain.GetExecutionEngine	Gets a new execution engine interface.
	ISfcDomain.GetKey	Gets a new SfcKey object.
	ISfcDomain.GetType	Gets the Type of the utility.
	ISfcDomain.GetTypeMetadata	Gets the SfcTypeMetadata.
	ISfcDomain.UseSfcStateManagement	Returns True.
	ISfcDomain2.GetUrnSkeletonsFromType	Gets a list of string values that contain the URN skeletons.
	ISfcDomainLite.DomainInstanceName	Gets the domain instance name.
	ISfcDomainLite.DomainName	Gets the domain name.
	ISfcDomainLite.GetLogicalVersion	Gets an integer value that specifies the logical version.
	ISfcHasConnection.ConnectionContext	Gets the SfcConnectionContext.
	ISfcHasConnection.GetConnection()	Gets the ISfcConnection.
	ISfcHasConnection.GetConnection(SfcObjectQueryMode)	Gets the ISfcConnection.
	ISfcHasConnection.SetConnection	Sets the ISfcConnection.

页首

注释

Remote instances of SQL Server, represented by ManagedInstance class instances, can be added to the SQL Server Utility's collection using the methods defined by the ManagedInstanceFactory class. After enrollment in the Utility, these instances are not fully managed until their utilization data and health states have been determined.

线程安全

此类型的任何公共 static（在 Visual Basic 中为 Shared） 成员都是线程安全的。不保证所有实例成员都是线程安全的。

请参阅

参考

Microsoft.SqlServer.Management.Utility 命名空间