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.

Namespace:   Microsoft.SqlServer.Management.Utility
Assembly:  Microsoft.SqlServer.Management.Utility (in Microsoft.SqlServer.Management.Utility.dll)

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

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

NameDescription
System_CAPS_pubmethodUtility()

Initializes a new, default instance of the Utility class.

System_CAPS_pubmethodUtility(SqlStoreConnection^)

Initializes a new instance of the Utility class with the specified connection to SqlStore.

NameDescription
System_CAPS_protpropertyAbstractIdentityKey

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubpropertyComputers

Gets the collection of computers running managed instances.

System_CAPS_pubpropertyCreatedBy

Gets the authentication credentials for the user who created the Utility.

System_CAPS_pubpropertyDateCreated

Gets the date and time when the SQL Server Utility was created.

System_CAPS_pubpropertyDeployedDacCount

Gets the number of deployed DACs on the instances of SQL Server managed by the SQL Server Utility.

System_CAPS_pubpropertyDeployedDacHealthyCount

Gets the number of healthy deployed DACs on the instances of SQL Server managed by the SQL Server Utility.

System_CAPS_pubpropertyDeployedDacManagementPendingCount

Gets the number of deployed DAC instances that have a pending management status.

System_CAPS_pubpropertyDeployedDacOnOverutilizedComputerCount

Gets the number of DACs that are deployed on managed instances run on overutilized computers.

System_CAPS_pubpropertyDeployedDacOnUnderutilizedComputerCount

Gets the number of DACs that are deployed on managed instances run on underutilized computers.

System_CAPS_pubpropertyDeployedDacOverutilizedCount

Gets the number of overutilized deployed DACs.

System_CAPS_pubpropertyDeployedDacs

Gets the number of DACs that are deployed on managed instances.

System_CAPS_pubpropertyDeployedDacUnderutilizedCount

Gets the number of deployed, underutilized DACs on all the managed instances.

System_CAPS_pubpropertyDeployedDacUnhealthyCount

Gets the number of deployed unhealthy DACs on all the managed instances.

System_CAPS_pubpropertyDeployedDacWithFilesOnOverutilizedVolumeCount

Gets the number of deployed DACs that have files on overutilized volumes.

System_CAPS_pubpropertyDeployedDacWithFilesOnUnderutilizedVolumeCount

Gets the number of deployed DACs that have files on underutilized volumes.

System_CAPS_pubpropertyDeployedDacWithOverutilizedFileCount

Gets the number of deployed DACs that have overutilized files.

System_CAPS_pubpropertyDeployedDacWithOverutilizedProcessorCount

Gets the number of deployed DACs that operate over overutilized processors.

System_CAPS_pubpropertyDeployedDacWithUnderutilizedFileCount

Gets the number of deployed DACs that have underutilized files.

System_CAPS_pubpropertyDeployedDacWithUnderutilizedProcessorCount

Gets the number of deployed DACs that operate on underutilized processors.

System_CAPS_pubpropertyDescription

Gets or sets a String describing the UCP.

System_CAPS_pubpropertyManagedInstanceCount

Gets the number of instances of SQL Server managed by the UCP.

System_CAPS_pubpropertyManagedInstanceHealthyCount

Gets the number of healthy instances of SQL Server managed by the UCP.

System_CAPS_pubpropertyManagedInstanceManagementPendingCount

Gets the number of instances of SQL Server that have a pending management status.

System_CAPS_pubpropertyManagedInstanceOnOverutilizedComputerCount

Gets the number of managed instances of SQL Server that are running on overutilized computers.

System_CAPS_pubpropertyManagedInstanceOnUnderutilizedComputerCount

Gets the number of managed instances of SQL Server that are running on underutilized computers.

System_CAPS_pubpropertyManagedInstanceOverutilizedCount

Gets the number of overutilized managed instances of SQL Server.

System_CAPS_pubpropertyManagedInstances

Gets a collection containing each instance of SQL Server managed by this Utility.

System_CAPS_pubpropertyManagedInstanceUnderutilizedCount

Gets the number of managed instances of SQL Server that are underutilized.

System_CAPS_pubpropertyManagedInstanceUnhealthyCount

Gets the number of unhealthy managed instances of SQL Server.

System_CAPS_pubpropertyManagedInstanceWithFilesOnOverutilizedVolumeCount

Gets the number of managed instances of SQL Server that have files on overutilized volumes.

System_CAPS_pubpropertyManagedInstanceWithFilesOnUnderutilizedVolumeCount

Gets the number of managed instances of SQL Server that have files on underutilized volumes.

System_CAPS_pubpropertyManagedInstanceWithOverutilizedFileCount

Gets the number of managed instances of SQL Server that have overutilized files.

System_CAPS_pubpropertyManagedInstanceWithOverutilizedProcessorCount

Gets the number of managed instances of SQL Server that are executed on overutilized processors.

System_CAPS_pubpropertyManagedInstanceWithUnderutilizedFileCount

Gets the number of managed instances of SQL Server with underutilized files.

System_CAPS_pubpropertyManagedInstanceWithUnderutilizedProcessorCount

Gets the number of managed instances of SQL Server that are executed on underutilized processors.

System_CAPS_pubpropertyMdwDatabaseName

Gets or sets the name of the utility management data warehouse (UMDW) database.

System_CAPS_pubpropertyMdwRetentionLengthInDaysForDaysHistory

Gets or sets the length, in days, that data will be retained in the Management Data Warehouse (MDW) history table for per-day entries.

System_CAPS_pubpropertyMdwRetentionLengthInDaysForHoursHistory

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.

System_CAPS_pubpropertyMdwRetentionLengthInDaysForMinutesHistory

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.

System_CAPS_pubpropertyMetadata

Returns metadata about the instance and its domain.(Inherited from SfcInstance.)

System_CAPS_pubpropertyName

Gets the name of the connected SQL Store server.

System_CAPS_pubpropertyOverUtilizationOccurenceFrequency

Gets or sets the occurrence frequency that is used to computer over-utilization health states over the specified trailing window.

System_CAPS_pubpropertyOverUtilizationTrailingWindow

Gets or sets the trailing window, in hours, used to compute health states.

System_CAPS_pubpropertyParent

Gets or sets the instance parent via the keychain.(Inherited from SfcInstance.)

System_CAPS_pubpropertyPolicyStore

Gets the PolicyStore object that defines the policies of the SQL Store connection.

System_CAPS_pubpropertyProperties

Returns a collection instance properties.(Inherited from SfcInstance.)

System_CAPS_pubpropertySqlStoreConnection

Gets or sets the SQL Store connection

System_CAPS_protpropertyState

Returns the state of the SfcInstance object.(Inherited from SfcInstance.)

System_CAPS_pubpropertyTotalStorageCapacity

Gets the storage capacity of the Utility.

System_CAPS_pubpropertyTotalStorageUtilization

Gets the amount of SQL Server Utility storage that is currently used.

System_CAPS_pubpropertyUnderUtilizationOccurenceFrequency

Gets or sets the occurrence frequency that is used to computer underutilization health states over the specified trailing window.

System_CAPS_pubpropertyUnderUtilizationTrailingWindow

Gets or sets the trailing window, in hours, used to compute health states.

System_CAPS_pubpropertyUrn

Returns the uniform resource name of the SfcInstance object.(Inherited from SfcInstance.)

System_CAPS_pubpropertyUtilityName

Gets the name of the utility control point (UCP).

NameDescription
System_CAPS_pubmethodAlter()

Updates any Utility property changes on the instance of SQL Server.

System_CAPS_pubmethodSystem_CAPS_staticConnect(SqlStoreConnection^)

Returns a SqlStoreConnection object specified by connection.

System_CAPS_protmethodCreateIdentityKey()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodSystem_CAPS_staticCreateUtility(String^, SqlStoreConnection^)

Creates a Utility object.

System_CAPS_pubmethodSystem_CAPS_staticCreateUtility(String^, SqlStoreConnection^, String^, SqlSecureString^)

Creates a Utility object.

System_CAPS_pubmethodDiscover(ISfcDependencyDiscoveryObjectSink^)

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodEnrollInstance(SqlStoreConnection^)

Enrolls a Utility object with the connection supplied by sqlStoreConnection parameter.

System_CAPS_pubmethodEnrollInstance(SqlStoreConnection^, String^, SqlSecureString^)

Enrolls a Utility object with the connection supplied by sqlStoreConnection parameter.

System_CAPS_pubmethodEquals(Object^)

(Inherited from Object.)

System_CAPS_protmethodGetChildCollection(String^)

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodGetDomain()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetPropertySet()

Returns the set of properties for the SfcInstance object.(Inherited from SfcInstance.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodGetTypeMetadataImpl()

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

System_CAPS_protmethodInitializeUIPropertyState()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodSystem_CAPS_staticIsLoginUtilityReader(SqlStoreConnection^)

Validates whether the login used in the connection has the utility reader role.

System_CAPS_pubmethodSystem_CAPS_staticIsUtilityControlPoint(SqlStoreConnection^)

Determines whether the specified server is a utility control point (UCP).

System_CAPS_protmethodOnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs^)

Invoked whenever the effective value of any SfcInstance metadata is updated. (Inherited from SfcInstance.)

System_CAPS_protmethodOnPropertyValueChanges(PropertyChangedEventArgs^)

Invoked whenever the effective value of any SfcInstance property is updated. (Inherited from SfcInstance.)

System_CAPS_pubmethodRefresh()

Refreshes the SQL Server Utility properties.(Overrides SfcInstance::Refresh().)

System_CAPS_protmethodResetKey()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodScriptAlter()

Alters the properties of the base object if it has been changed.

System_CAPS_pubmethodSerialize(XmlWriter^)

Serializes the instance to XML.(Inherited from SfcInstance.)

System_CAPS_pubmethodToString()

Returns a string representation of the instance Urn.(Inherited from SfcInstance.)

NameDescription
System_CAPS_pubeventPropertyChanged

(Inherited from SfcInstance.)

System_CAPS_pubeventPropertyMetadataChanged

(Inherited from SfcInstance.)

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 T:Microsoft.SqlServer.Management.Utility.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.

Return to top
Show: