Utility Class
The Utility class represents a utility control point (UCP) that defines methods and properties to manage one or more remote instances of SQL Server.
Inheritance Hierarchy
System.Object
Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance
Microsoft.SqlServer.Management.Utility.Utility
Namespace: Microsoft.SqlServer.Management.Utility
Assembly: Microsoft.SqlServer.Management.Utility (in Microsoft.SqlServer.Management.Utility.dll)
Syntax
'Declaration
<PhysicalFacetAttribute> _
<LocalizedPropertyResourcesAttribute("Microsoft.SqlServer.Management.Utility.FacetSR", _
True)> _
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<TypeConverterAttribute(GetType(LocalizableTypeConverter))> _
Public NotInheritable Class Utility _
Inherits SfcInstance _
Implements ISfcDomain2, ISfcDomain, ISfcDomainLite, ISfcHasConnection, _
ISfcAlterable, IAlterable
'Usage
Dim instance As Utility
[PhysicalFacetAttribute]
[LocalizedPropertyResourcesAttribute("Microsoft.SqlServer.Management.Utility.FacetSR",
true)]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[TypeConverterAttribute(typeof(LocalizableTypeConverter))]
public sealed class Utility : SfcInstance,
ISfcDomain2, ISfcDomain, ISfcDomainLite, ISfcHasConnection, ISfcAlterable,
IAlterable
[PhysicalFacetAttribute]
[LocalizedPropertyResourcesAttribute(L"Microsoft.SqlServer.Management.Utility.FacetSR",
true)]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[TypeConverterAttribute(typeof(LocalizableTypeConverter))]
public ref class Utility sealed : public SfcInstance,
ISfcDomain2, ISfcDomain, ISfcDomainLite, ISfcHasConnection, ISfcAlterable,
IAlterable
[<SealedAttribute>]
[<PhysicalFacetAttribute>]
[<LocalizedPropertyResourcesAttribute("Microsoft.SqlServer.Management.Utility.FacetSR",
true)>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<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
The Utility type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
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. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Protected property") |
AbstractIdentityKey | Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.) |
.gif "Public property") |
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. (Inherited from 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. (Inherited from SfcInstance.) |
|
PolicyStore | Gets the PolicyStore object that defines the policies of the SQL Store connection. |
|
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.) |
|
SqlStoreConnection | Gets or sets the SQL Store connection |
|
State | Returns the state of the SfcInstance object. (Inherited from 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. (Inherited from SfcInstance.) |
|
UtilityName | Gets the name of the utility control point (UCP). |
Top
Methods
| Name | Description | |
|---|---|---|
|
Alter | Updates any Utility property changes on the instance of SQL Server. |
.gif "Protected method") |
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.) |
.gif "Static member") |
Connect | Returns a SqlStoreConnection object specified by connection. |
|
CreateIdentityKey | Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.) |
|
CreateImpl | Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.) |
|
CreateUtility(String, SqlStoreConnection) | Creates a Utility object. |
|
CreateUtility(String, SqlStoreConnection, String, SqlSecureString) | Creates a Utility object. |
|
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.) |
|
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 | (Inherited from Object.) |
|
Finalize | (Inherited from Object.) |
|
GetChildCollection | Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.) |
|
GetDomain | Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.) |
|
GetHashCode | (Inherited from Object.) |
|
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.) |
|
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). |
|
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 | Indicates the default implementor that creates the execution result. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.) |
|
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 SQL Server Utility properties. (Overrides SfcInstance.Refresh().) |
|
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.) |
|
ScriptAlter | Alters the properties of the base object if it has been changed. |
|
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 | |
|---|---|---|
.gif "Protected event") |
propertyChanged | Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.) |
.gif "Public event") |
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 | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
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. |
.gif "Private property") |
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. |
Top
Remarks
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.
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.