Export (0) Print
Expand All

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.

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)

[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

The Utility type exposes the following members.

  NameDescription
Public methodUtility()Initializes a new, default instance of the Utility class.
Public methodUtility(SqlStoreConnection)Initializes a new instance of the Utility class with the specified connection to SqlStore.
Top

  NameDescription
Protected propertyAbstractIdentityKeyDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public propertyComputersGets the collection of computers running managed instances.
Public propertyCreatedByGets the authentication credentials for the user who created the Utility.
Public propertyDateCreatedGets the date and time when the SQL Server Utility was created.
Public propertyDeployedDacCountGets the number of deployed DACs on the instances of SQL Server managed by the SQL Server Utility.
Public propertyDeployedDacHealthyCountGets the number of healthy deployed DACs on the instances of SQL Server managed by the SQL Server Utility.
Public propertyDeployedDacManagementPendingCountGets the number of deployed DAC instances that have a pending management status.
Public propertyDeployedDacOnOverutilizedComputerCountGets the number of DACs that are deployed on managed instances run on overutilized computers.
Public propertyDeployedDacOnUnderutilizedComputerCountGets the number of DACs that are deployed on managed instances run on underutilized computers.
Public propertyDeployedDacOverutilizedCountGets the number of overutilized deployed DACs.
Public propertyDeployedDacsGets the number of DACs that are deployed on managed instances.
Public propertyDeployedDacUnderutilizedCountGets the number of deployed, underutilized DACs on all the managed instances.
Public propertyDeployedDacUnhealthyCountGets the number of deployed unhealthy DACs on all the managed instances.
Public propertyDeployedDacWithFilesOnOverutilizedVolumeCountGets the number of deployed DACs that have files on overutilized volumes.
Public propertyDeployedDacWithFilesOnUnderutilizedVolumeCountGets the number of deployed DACs that have files on underutilized volumes.
Public propertyDeployedDacWithOverutilizedFileCountGets the number of deployed DACs that have overutilized files.
Public propertyDeployedDacWithOverutilizedProcessorCountGets the number of deployed DACs that operate over overutilized processors.
Public propertyDeployedDacWithUnderutilizedFileCountGets the number of deployed DACs that have underutilized files.
Public propertyDeployedDacWithUnderutilizedProcessorCountGets the number of deployed DACs that operate on underutilized processors.
Public propertyDescriptionGets or sets a String describing the UCP.
Public propertyManagedInstanceCountGets the number of instances of SQL Server managed by the UCP.
Public propertyManagedInstanceHealthyCountGets the number of healthy instances of SQL Server managed by the UCP.
Public propertyManagedInstanceManagementPendingCountGets the number of instances of SQL Server that have a pending management status.
Public propertyManagedInstanceOnOverutilizedComputerCountGets the number of managed instances of SQL Server that are running on overutilized computers.
Public propertyManagedInstanceOnUnderutilizedComputerCountGets the number of managed instances of SQL Server that are running on underutilized computers.
Public propertyManagedInstanceOverutilizedCountGets the number of overutilized managed instances of SQL Server.
Public propertyManagedInstancesGets a collection containing each instance of SQL Server managed by this Utility.
Public propertyManagedInstanceUnderutilizedCountGets the number of managed instances of SQL Server that are underutilized.
Public propertyManagedInstanceUnhealthyCountGets the number of unhealthy managed instances of SQL Server.
Public propertyManagedInstanceWithFilesOnOverutilizedVolumeCountGets the number of managed instances of SQL Server that have files on overutilized volumes.
Public propertyManagedInstanceWithFilesOnUnderutilizedVolumeCountGets the number of managed instances of SQL Server that have files on underutilized volumes.
Public propertyManagedInstanceWithOverutilizedFileCountGets the number of managed instances of SQL Server that have overutilized files.
Public propertyManagedInstanceWithOverutilizedProcessorCountGets the number of managed instances of SQL Server that are executed on overutilized processors.
Public propertyManagedInstanceWithUnderutilizedFileCountGets the number of managed instances of SQL Server with underutilized files.
Public propertyManagedInstanceWithUnderutilizedProcessorCountGets the number of managed instances of SQL Server that are executed on underutilized processors.
Public propertyMdwDatabaseNameGets or sets the name of the utility management data warehouse (UMDW) database.
Public propertyMdwRetentionLengthInDaysForDaysHistoryGets or sets the length, in days, that data will be retained in the Management Data Warehouse (MDW) history table for per-day entries.
Public propertyMdwRetentionLengthInDaysForHoursHistoryGets 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 propertyMdwRetentionLengthInDaysForMinutesHistoryGets 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 propertyMetadataReturns metadata about the instance and its domain. (Inherited from SfcInstance.)
Public propertyNameGets the name of the connected SQL Store server.
Public propertyOverUtilizationOccurenceFrequencyGets or sets the occurrence frequency that is used to computer over-utilization health states over the specified trailing window.
Public propertyOverUtilizationTrailingWindowGets or sets the trailing window, in hours, used to compute health states.
Public propertyParentGets or sets the instance parent via the keychain. (Inherited from SfcInstance.)
Public propertyPolicyStoreGets the PolicyStore object that defines the policies of the SQL Store connection.
Public propertyPropertiesReturns a collection instance properties. (Inherited from SfcInstance.)
Public propertySqlStoreConnectionGets or sets the SQL Store connection
Protected propertyStateReturns the state of the SfcInstance object. (Inherited from SfcInstance.)
Public propertyTotalStorageCapacityGets the storage capacity of the Utility.
Public propertyTotalStorageUtilizationGets the amount of SQL Server Utility storage that is currently used.
Public propertyUnderUtilizationOccurenceFrequencyGets or sets the occurrence frequency that is used to computer underutilization health states over the specified trailing window.
Public propertyUnderUtilizationTrailingWindowGets or sets the trailing window, in hours, used to compute health states.
Public propertyUrnReturns the uniform resource name of the SfcInstance object. (Inherited from SfcInstance.)
Public propertyUtilityNameGets the name of the utility control point (UCP).
Top

  NameDescription
Public methodAlterUpdates any Utility property changes on the instance of SQL Server.
Public methodStatic memberConnectReturns a SqlStoreConnection object specified by connection.
Protected methodCreateIdentityKeyDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodStatic memberCreateUtility(String, SqlStoreConnection)Creates a Utility object.
Public methodStatic memberCreateUtility(String, SqlStoreConnection, String, SqlSecureString)Creates a Utility object.
Public methodDiscoverDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodEnrollInstance(SqlStoreConnection)Enrolls a Utility object with the connection supplied by sqlStoreConnection parameter.
Public methodEnrollInstance(SqlStoreConnection, String, SqlSecureString)Enrolls a Utility object with the connection supplied by sqlStoreConnection parameter.
Public methodEquals (Inherited from Object.)
Protected methodGetChildCollectionDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodGetDomainDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetPropertySetReturns the set of properties for the SfcInstance object. (Inherited from SfcInstance.)
Public methodGetType (Inherited from Object.)
Protected methodGetTypeMetadataImplIndicates 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 methodInitializeUIPropertyStateDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodStatic memberIsLoginUtilityReaderValidates whether the login used in the connection has the utility reader role.
Public methodStatic memberIsUtilityControlPointDetermines whether the specified server is a utility control point (UCP).
Protected methodOnPropertyMetadataChangesInvoked whenever the effective value of any SfcInstance metadata is updated. (Inherited from SfcInstance.)
Protected methodOnPropertyValueChangesInvoked whenever the effective value of any SfcInstance property is updated. (Inherited from SfcInstance.)
Public methodRefreshRefreshes the SQL Server Utility properties. (Overrides SfcInstance.Refresh().)
Protected methodResetKeyDo not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public methodScriptAlterAlters the properties of the base object if it has been changed.
Public methodSerializeSerializes the instance to XML. (Inherited from SfcInstance.)
Public methodToStringReturns a string representation of the instance Urn. (Inherited from SfcInstance.)
Top

  NameDescription
Public eventPropertyChangedCLS-compliant event for property changes. (Inherited from SfcInstance.)
Public eventPropertyMetadataChangedCLS-compliant event for property metadata changes. (Inherited from SfcInstance.)
Top

  NameDescription
Explicit interface implemetationPrivate methodISfcDomain.GetExecutionEngineGets a new execution engine interface.
Explicit interface implemetationPrivate methodISfcDomain.GetKeyGets a new SfcKey object.
Explicit interface implemetationPrivate methodISfcDomain.GetTypeGets the Type of the utility.
Explicit interface implemetationPrivate methodISfcDomain.GetTypeMetadataGets the SfcTypeMetadata.
Explicit interface implemetationPrivate methodISfcDomain.UseSfcStateManagementReturns True.
Explicit interface implemetationPrivate methodISfcDomain2.GetUrnSkeletonsFromTypeGets a list of string values that contain the URN skeletons.
Explicit interface implemetationPrivate propertyISfcDomainLite.DomainInstanceNameGets the domain instance name.
Explicit interface implemetationPrivate propertyISfcDomainLite.DomainNameGets the domain name.
Explicit interface implemetationPrivate methodISfcDomainLite.GetLogicalVersionGets an integer value that specifies the logical version.
Explicit interface implemetationPrivate propertyISfcHasConnection.ConnectionContextGets the SfcConnectionContext.
Explicit interface implemetationPrivate methodISfcHasConnection.GetConnection()Gets the ISfcConnection.
Explicit interface implemetationPrivate methodISfcHasConnection.GetConnection(SfcObjectQueryMode)Gets the ISfcConnection.
Explicit interface implemetationPrivate methodISfcHasConnection.SetConnectionSets the ISfcConnection.
Top

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft