Classe 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.
Hiérarchie d'héritage
System.Object
Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance
Microsoft.SqlServer.Management.Utility.Utility
Espace de noms : Microsoft.SqlServer.Management.Utility
Assembly : Microsoft.SqlServer.Management.Utility (en Microsoft.SqlServer.Management.Utility.dll)
Syntaxe
'Déclaration
<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
'Utilisation
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
Le type Utility expose les membres suivants.
Constructeurs
Nom | Description | |
---|---|---|
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. |
Haut de la page
Propriétés
Nom | Description | |
---|---|---|
AbstractIdentityKey | Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de 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. (hérité de 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. (hérité de SfcInstance.) | |
PolicyStore | Gets the PolicyStore object that defines the policies of the SQL Store connection. | |
Properties | Returns a collection instance properties. (hérité de SfcInstance.) | |
SqlStoreConnection | Gets or sets the SQL Store connection | |
State | Returns the state of the SfcInstance object. (hérité de 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. (hérité de SfcInstance.) | |
UtilityName | Gets the name of the utility control point (UCP). |
Haut de la page
Méthodes
Nom | Description | |
---|---|---|
Alter | Updates any Utility property changes on the instance of SQL Server. | |
Connect | Returns a SqlStoreConnection object specified by connection. | |
CreateIdentityKey | Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.) | |
CreateUtility(String, SqlStoreConnection) | Creates a Utility object. | |
CreateUtility(String, SqlStoreConnection, String, SqlSecureString) | Creates a Utility object. | |
Discover | Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de 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 | (hérité de Object.) | |
GetChildCollection | Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.) | |
GetDomain | Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.) | |
GetHashCode | (hérité de Object.) | |
GetPropertySet | Returns the set of properties for the SfcInstance object. (hérité de SfcInstance.) | |
GetType | (hérité de Object.) | |
GetTypeMetadataImpl | Indicates the domains that override by returning the right TypeMetadata class directly. Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.) | |
InitializeUIPropertyState | Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de 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. (hérité de SfcInstance.) | |
OnPropertyValueChanges | Invoked whenever the effective value of any SfcInstance property is updated. (hérité de SfcInstance.) | |
Refresh | Refreshes the SQL Server Utility properties. (remplace SfcInstance.Refresh().) | |
ResetKey | Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.) | |
ScriptAlter | Alters the properties of the base object if it has been changed. | |
Serialize | Serializes the instance to XML. (hérité de SfcInstance.) | |
ToString | Returns a string representation of the instance Urn. (hérité de SfcInstance.) |
Haut de la page
Événements
Nom | Description | |
---|---|---|
PropertyChanged | CLS-compliant event for property changes. (hérité de SfcInstance.) | |
PropertyMetadataChanged | CLS-compliant event for property metadata changes. (hérité de SfcInstance.) |
Haut de la page
Implémentations d'interfaces explicites
Nom | Description | |
---|---|---|
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. |
Haut de la page
Notes
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.
Sécurité des threads
Tous les membres publics static (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.