Partager via


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
<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
'Utilisation
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

Le type Utility expose les membres suivants.

Constructeurs

  Nom Description
Méthode publique Utility() () () () Initializes a new, default instance of the Utility class.
Méthode publique 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
Propriété protégée AbstractIdentityKey Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
Propriété publique Computers Gets the collection of computers running managed instances.
Propriété publique CreatedBy Gets the authentication credentials for the user who created the Utility.
Propriété publique DateCreated Gets the date and time when the SQL Server Utility was created.
Propriété publique DeployedDacCount Gets the number of deployed DACs on the instances of SQL Server managed by the SQL Server Utility.
Propriété publique DeployedDacHealthyCount Gets the number of healthy deployed DACs on the instances of SQL Server managed by the SQL Server Utility.
Propriété publique DeployedDacManagementPendingCount Gets the number of deployed DAC instances that have a pending management status.
Propriété publique DeployedDacOnOverutilizedComputerCount Gets the number of DACs that are deployed on managed instances run on overutilized computers.
Propriété publique DeployedDacOnUnderutilizedComputerCount Gets the number of DACs that are deployed on managed instances run on underutilized computers.
Propriété publique DeployedDacOverutilizedCount Gets the number of overutilized deployed DACs.
Propriété publique DeployedDacs Gets the number of DACs that are deployed on managed instances.
Propriété publique DeployedDacUnderutilizedCount Gets the number of deployed, underutilized DACs on all the managed instances.
Propriété publique DeployedDacUnhealthyCount Gets the number of deployed unhealthy DACs on all the managed instances.
Propriété publique DeployedDacWithFilesOnOverutilizedVolumeCount Gets the number of deployed DACs that have files on overutilized volumes.
Propriété publique DeployedDacWithFilesOnUnderutilizedVolumeCount Gets the number of deployed DACs that have files on underutilized volumes.
Propriété publique DeployedDacWithOverutilizedFileCount Gets the number of deployed DACs that have overutilized files.
Propriété publique DeployedDacWithOverutilizedProcessorCount Gets the number of deployed DACs that operate over overutilized processors.
Propriété publique DeployedDacWithUnderutilizedFileCount Gets the number of deployed DACs that have underutilized files.
Propriété publique DeployedDacWithUnderutilizedProcessorCount Gets the number of deployed DACs that operate on underutilized processors.
Propriété publique Description Gets or sets a String describing the UCP.
Propriété publique ManagedInstanceCount Gets the number of instances of SQL Server managed by the UCP.
Propriété publique ManagedInstanceHealthyCount Gets the number of healthy instances of SQL Server managed by the UCP.
Propriété publique ManagedInstanceManagementPendingCount Gets the number of instances of SQL Server that have a pending management status.
Propriété publique ManagedInstanceOnOverutilizedComputerCount Gets the number of managed instances of SQL Server that are running on overutilized computers.
Propriété publique ManagedInstanceOnUnderutilizedComputerCount Gets the number of managed instances of SQL Server that are running on underutilized computers.
Propriété publique ManagedInstanceOverutilizedCount Gets the number of overutilized managed instances of SQL Server.
Propriété publique ManagedInstances Gets a collection containing each instance of SQL Server managed by this Utility.
Propriété publique ManagedInstanceUnderutilizedCount Gets the number of managed instances of SQL Server that are underutilized.
Propriété publique ManagedInstanceUnhealthyCount Gets the number of unhealthy managed instances of SQL Server.
Propriété publique ManagedInstanceWithFilesOnOverutilizedVolumeCount Gets the number of managed instances of SQL Server that have files on overutilized volumes.
Propriété publique ManagedInstanceWithFilesOnUnderutilizedVolumeCount Gets the number of managed instances of SQL Server that have files on underutilized volumes.
Propriété publique ManagedInstanceWithOverutilizedFileCount Gets the number of managed instances of SQL Server that have overutilized files.
Propriété publique ManagedInstanceWithOverutilizedProcessorCount Gets the number of managed instances of SQL Server that are executed on overutilized processors.
Propriété publique ManagedInstanceWithUnderutilizedFileCount Gets the number of managed instances of SQL Server with underutilized files.
Propriété publique ManagedInstanceWithUnderutilizedProcessorCount Gets the number of managed instances of SQL Server that are executed on underutilized processors.
Propriété publique MdwDatabaseName Gets or sets the name of the utility management data warehouse (UMDW) database.
Propriété publique 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.
Propriété publique 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.
Propriété publique 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.
Propriété publique Metadata Returns metadata about the instance and its domain. (hérité de SfcInstance.)
Propriété publique Name Gets the name of the connected SQL Store server.
Propriété publique OverUtilizationOccurenceFrequency Gets or sets the occurrence frequency that is used to computer over-utilization health states over the specified trailing window.
Propriété publique OverUtilizationTrailingWindow Gets or sets the trailing window, in hours, used to compute health states.
Propriété publique Parent Gets or sets the instance parent via the keychain. (hérité de SfcInstance.)
Propriété publique PolicyStore Gets the PolicyStore object that defines the policies of the SQL Store connection.
Propriété publique Properties Returns a collection instance properties. (hérité de SfcInstance.)
Propriété protégée PropertyStorageProvider Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
Propriété publique SqlStoreConnection Gets or sets the SQL Store connection
Propriété protégée State Returns the state of the SfcInstance object. (hérité de SfcInstance.)
Propriété publique TotalStorageCapacity Gets the storage capacity of the Utility.
Propriété publique TotalStorageUtilization Gets the amount of SQL Server Utility storage that is currently used.
Propriété publique UnderUtilizationOccurenceFrequency Gets or sets the occurrence frequency that is used to computer underutilization health states over the specified trailing window.
Propriété publique UnderUtilizationTrailingWindow Gets or sets the trailing window, in hours, used to compute health states.
Propriété publique Urn Returns the uniform resource name of the SfcInstance object. (hérité de SfcInstance.)
Propriété publique UtilityName Gets the name of the utility control point (UCP).

Haut de la page

Méthodes

  Nom Description
Méthode publique Alter Updates any Utility property changes on the instance of SQL Server.
Méthode protégée AlterImpl Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
Méthode protégée CheckObjectCreated Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
Méthode protégée CheckObjectState Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
Méthode publiqueMembre statique Connect Returns a SqlStoreConnection object specified by connection.
Méthode protégée CreateIdentityKey Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
Méthode protégée CreateImpl Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
Méthode publiqueMembre statique CreateUtility(String, SqlStoreConnection) Creates a Utility object.
Méthode publiqueMembre statique CreateUtility(String, SqlStoreConnection, String, SqlSecureString) Creates a Utility object.
Méthode publique Discover Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
Méthode protégée DropImpl Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
Méthode publique EnrollInstance(SqlStoreConnection) Enrolls a Utility object with the connection supplied by sqlStoreConnection parameter.
Méthode publique EnrollInstance(SqlStoreConnection, String, SqlSecureString) Enrolls a Utility object with the connection supplied by sqlStoreConnection parameter.
Méthode publique Equals (hérité de Object.)
Méthode protégée Finalize (hérité de Object.)
Méthode protégée GetChildCollection Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
Méthode publique GetDomain Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
Méthode publique GetHashCode (hérité de Object.)
Méthode publique GetPropertySet Returns the set of properties for the SfcInstance object. (hérité de SfcInstance.)
Méthode publique GetType (hérité de Object.)
Méthode protégée GetTypeMetadataImpl Indicates the domains that override by returning the right TypeMetadata class directly. Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
Méthode protégée InitializeUIPropertyState Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
Méthode publiqueMembre statique IsLoginUtilityReader Validates whether the login used in the connection has the utility reader role.
Méthode publiqueMembre statique IsUtilityControlPoint Determines whether the specified server is a utility control point (UCP).
Méthode protégée MarkForDropImpl Returns a value that indicates the existing objects to be dropped. Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
Méthode protégée MarkRootAsConnected Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
Méthode protégée MemberwiseClone (hérité de Object.)
Méthode protégée MoveImpl Indicates the new parent object to move in an instance. Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
Méthode protégée OnPropertyMetadataChanges Invoked whenever the effective value of any SfcInstance metadata is updated. (hérité de SfcInstance.)
Méthode protégée OnPropertyValueChanges Invoked whenever the effective value of any SfcInstance property is updated. (hérité de SfcInstance.)
Méthode protégée PostAlter Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
Méthode protégée PostCreate Indicates the default implementor that creates the execution result. Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
Méthode protégée PostDrop Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
Méthode protégée PostMove Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
Méthode protégée PostRename Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
Méthode publique Refresh Refreshes the SQL Server Utility properties. (remplace SfcInstance. . :: . .Refresh() () () ().)
Méthode protégée RenameImpl Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
Méthode protégée ResetKey Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
Méthode publique ScriptAlter Alters the properties of the base object if it has been changed.
Méthode publique Serialize Serializes the instance to XML. (hérité de SfcInstance.)
Méthode publique ToString Returns a string representation of the instance Urn. (hérité de SfcInstance.)
Méthode protégée UpdateUIPropertyState Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
Méthode protégée Validate Indicates the basic child object's validation. Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)

Haut de la page

Événements

  Nom Description
Événement protégé propertyChanged Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
Événement public PropertyChanged CLS-compliant event for property changes. (hérité de SfcInstance.)
Événement protégé propertyMetadataChanged Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
Événement public PropertyMetadataChanged CLS-compliant event for property metadata changes. (hérité de SfcInstance.)

Haut de la page

Implémentations d'interfaces explicites

  Nom Description
Implémentation d'interface expliciteMéthode privée ISfcDomain. . :: . .GetExecutionEngine Gets a new execution engine interface.
Implémentation d'interface expliciteMéthode privée ISfcDomain. . :: . .GetKey Gets a new SfcKey object.
Implémentation d'interface expliciteMéthode privée ISfcDomain. . :: . .GetType Gets the Type of the utility.
Implémentation d'interface expliciteMéthode privée ISfcDomain. . :: . .GetTypeMetadata Gets the SfcTypeMetadata.
Implémentation d'interface expliciteMéthode privée ISfcDomain. . :: . .UseSfcStateManagement Returns True.
Implémentation d'interface expliciteMéthode privée ISfcDomain2. . :: . .GetUrnSkeletonsFromType Gets a list of string values that contain the URN skeletons.
Implémentation d'interface explicitePropriété privée ISfcDomainLite. . :: . .DomainInstanceName Gets the domain instance name.
Implémentation d'interface explicitePropriété privée ISfcDomainLite. . :: . .DomainName Gets the domain name.
Implémentation d'interface expliciteMéthode privée ISfcDomainLite. . :: . .GetLogicalVersion Gets an integer value that specifies the logical version.
Implémentation d'interface explicitePropriété privée ISfcHasConnection. . :: . .ConnectionContext Gets the SfcConnectionContext.
Implémentation d'interface expliciteMéthode privée ISfcHasConnection. . :: . .GetConnection() () () () Gets the ISfcConnection.
Implémentation d'interface expliciteMéthode privée ISfcHasConnection. . :: . .GetConnection(SfcObjectQueryMode) Gets the ISfcConnection.
Implémentation d'interface expliciteMéthode privée 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.