Share via


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
Public method Utility() Initializes a new, default instance of the Utility class.
Public method Utility(SqlStoreConnection) Initializes a new instance of the Utility class with the specified connection to SqlStore.

Top

Properties

  Name Description
Protected property AbstractIdentityKey Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public property Computers Gets the collection of computers running managed instances.
Public property CreatedBy Gets the authentication credentials for the user who created the Utility.
Public property DateCreated Gets the date and time when the SQL Server Utility was created.
Public property DeployedDacCount Gets the number of deployed DACs on the instances of SQL Server managed by the SQL Server Utility.
Public property DeployedDacHealthyCount Gets the number of healthy deployed DACs on the instances of SQL Server managed by the SQL Server Utility.
Public property DeployedDacManagementPendingCount Gets the number of deployed DAC instances that have a pending management status.
Public property DeployedDacOnOverutilizedComputerCount Gets the number of DACs that are deployed on managed instances run on overutilized computers.
Public property DeployedDacOnUnderutilizedComputerCount Gets the number of DACs that are deployed on managed instances run on underutilized computers.
Public property DeployedDacOverutilizedCount Gets the number of overutilized deployed DACs.
Public property DeployedDacs Gets the number of DACs that are deployed on managed instances.
Public property DeployedDacUnderutilizedCount Gets the number of deployed, underutilized DACs on all the managed instances.
Public property DeployedDacUnhealthyCount Gets the number of deployed unhealthy DACs on all the managed instances.
Public property DeployedDacWithFilesOnOverutilizedVolumeCount Gets the number of deployed DACs that have files on overutilized volumes.
Public property DeployedDacWithFilesOnUnderutilizedVolumeCount Gets the number of deployed DACs that have files on underutilized volumes.
Public property DeployedDacWithOverutilizedFileCount Gets the number of deployed DACs that have overutilized files.
Public property DeployedDacWithOverutilizedProcessorCount Gets the number of deployed DACs that operate over overutilized processors.
Public property DeployedDacWithUnderutilizedFileCount Gets the number of deployed DACs that have underutilized files.
Public property DeployedDacWithUnderutilizedProcessorCount Gets the number of deployed DACs that operate on underutilized processors.
Public property Description Gets or sets a String describing the UCP.
Public property ManagedInstanceCount Gets the number of instances of SQL Server managed by the UCP.
Public property ManagedInstanceHealthyCount Gets the number of healthy instances of SQL Server managed by the UCP.
Public property ManagedInstanceManagementPendingCount Gets the number of instances of SQL Server that have a pending management status.
Public property ManagedInstanceOnOverutilizedComputerCount Gets the number of managed instances of SQL Server that are running on overutilized computers.
Public property ManagedInstanceOnUnderutilizedComputerCount Gets the number of managed instances of SQL Server that are running on underutilized computers.
Public property ManagedInstanceOverutilizedCount Gets the number of overutilized managed instances of SQL Server.
Public property ManagedInstances Gets a collection containing each instance of SQL Server managed by this Utility.
Public property ManagedInstanceUnderutilizedCount Gets the number of managed instances of SQL Server that are underutilized.
Public property ManagedInstanceUnhealthyCount Gets the number of unhealthy managed instances of SQL Server.
Public property ManagedInstanceWithFilesOnOverutilizedVolumeCount Gets the number of managed instances of SQL Server that have files on overutilized volumes.
Public property ManagedInstanceWithFilesOnUnderutilizedVolumeCount Gets the number of managed instances of SQL Server that have files on underutilized volumes.
Public property ManagedInstanceWithOverutilizedFileCount Gets the number of managed instances of SQL Server that have overutilized files.
Public property ManagedInstanceWithOverutilizedProcessorCount Gets the number of managed instances of SQL Server that are executed on overutilized processors.
Public property ManagedInstanceWithUnderutilizedFileCount Gets the number of managed instances of SQL Server with underutilized files.
Public property ManagedInstanceWithUnderutilizedProcessorCount Gets the number of managed instances of SQL Server that are executed on underutilized processors.
Public property MdwDatabaseName Gets or sets the name of the utility management data warehouse (UMDW) database.
Public property 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.
Public property 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.
Public property 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.
Public property Metadata Returns metadata about the instance and its domain. (Inherited from SfcInstance.)
Public property Name Gets the name of the connected SQL Store server.
Public property OverUtilizationOccurenceFrequency Gets or sets the occurrence frequency that is used to computer over-utilization health states over the specified trailing window.
Public property OverUtilizationTrailingWindow Gets or sets the trailing window, in hours, used to compute health states.
Public property Parent Gets or sets the instance parent via the keychain. (Inherited from SfcInstance.)
Public property PolicyStore Gets the PolicyStore object that defines the policies of the SQL Store connection.
Public property Properties Returns a collection instance properties. (Inherited from SfcInstance.)
Protected property PropertyStorageProvider Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public property SqlStoreConnection Gets or sets the SQL Store connection
Protected property State Returns the state of the SfcInstance object. (Inherited from SfcInstance.)
Public property TotalStorageCapacity Gets the storage capacity of the Utility.
Public property TotalStorageUtilization Gets the amount of SQL Server Utility storage that is currently used.
Public property UnderUtilizationOccurenceFrequency Gets or sets the occurrence frequency that is used to computer underutilization health states over the specified trailing window.
Public property UnderUtilizationTrailingWindow Gets or sets the trailing window, in hours, used to compute health states.
Public property Urn Returns the uniform resource name of the SfcInstance object. (Inherited from SfcInstance.)
Public property UtilityName Gets the name of the utility control point (UCP).

Top

Methods

  Name Description
Public method Alter Updates any Utility property changes on the instance of SQL Server.
Protected method AlterImpl Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method CheckObjectCreated Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method CheckObjectState Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodStatic member Connect Returns a SqlStoreConnection object specified by connection.
Protected method CreateIdentityKey Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method CreateImpl Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodStatic member CreateUtility(String, SqlStoreConnection) Creates a Utility object.
Public methodStatic member CreateUtility(String, SqlStoreConnection, String, SqlSecureString) Creates a Utility object.
Public method Discover Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method DropImpl Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method EnrollInstance(SqlStoreConnection) Enrolls a Utility object with the connection supplied by sqlStoreConnection parameter.
Public method EnrollInstance(SqlStoreConnection, String, SqlSecureString) Enrolls a Utility object with the connection supplied by sqlStoreConnection parameter.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Protected method GetChildCollection Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method GetDomain Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method GetHashCode (Inherited from Object.)
Public method GetPropertySet Returns the set of properties for the SfcInstance object. (Inherited from SfcInstance.)
Public method GetType (Inherited from Object.)
Protected method 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.)
Protected method InitializeUIPropertyState Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodStatic member IsLoginUtilityReader Validates whether the login used in the connection has the utility reader role.
Public methodStatic member IsUtilityControlPoint Determines whether the specified server is a utility control point (UCP).
Protected method 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.)
Protected method MarkRootAsConnected Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method 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.)
Protected method OnPropertyMetadataChanges Invoked whenever the effective value of any SfcInstance metadata is updated. (Inherited from SfcInstance.)
Protected method OnPropertyValueChanges Invoked whenever the effective value of any SfcInstance property is updated. (Inherited from SfcInstance.)
Protected method PostAlter Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method 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.)
Protected method PostDrop Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method PostMove Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method PostRename Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method Refresh Refreshes the SQL Server Utility properties. (Overrides SfcInstance.Refresh().)
Protected method RenameImpl Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method ResetKey Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method ScriptAlter Alters the properties of the base object if it has been changed.
Public method Serialize Serializes the instance to XML. (Inherited from SfcInstance.)
Public method ToString Returns a string representation of the instance Urn. (Inherited from SfcInstance.)
Protected method UpdateUIPropertyState Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method 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
Protected event propertyChanged Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public event PropertyChanged CLS-compliant event for property changes. (Inherited from SfcInstance.)
Protected event propertyMetadataChanged Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public event PropertyMetadataChanged CLS-compliant event for property metadata changes. (Inherited from SfcInstance.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ISfcDomain.GetExecutionEngine Gets a new execution engine interface.
Explicit interface implemetationPrivate method ISfcDomain.GetKey Gets a new SfcKey object.
Explicit interface implemetationPrivate method ISfcDomain.GetType Gets the Type of the utility.
Explicit interface implemetationPrivate method ISfcDomain.GetTypeMetadata Gets the SfcTypeMetadata.
Explicit interface implemetationPrivate method ISfcDomain.UseSfcStateManagement Returns True.
Explicit interface implemetationPrivate method ISfcDomain2.GetUrnSkeletonsFromType Gets a list of string values that contain the URN skeletons.
Explicit interface implemetationPrivate property ISfcDomainLite.DomainInstanceName Gets the domain instance name.
Explicit interface implemetationPrivate property ISfcDomainLite.DomainName Gets the domain name.
Explicit interface implemetationPrivate method ISfcDomainLite.GetLogicalVersion Gets an integer value that specifies the logical version.
Explicit interface implemetationPrivate property ISfcHasConnection.ConnectionContext Gets the SfcConnectionContext.
Explicit interface implemetationPrivate method ISfcHasConnection.GetConnection() Gets the ISfcConnection.
Explicit interface implemetationPrivate method ISfcHasConnection.GetConnection(SfcObjectQueryMode) Gets the ISfcConnection.
Explicit interface implemetationPrivate method 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.