Share via


Espace de noms Microsoft.SqlServer.Management.Dmf

The Microsoft.SqlServer.Management.Dmf namespace contains classes that represent the SQL Server policy-based management objects. 

The top-level instance is the PolicyStore class, which proves the connection to the instance of SQL Server. The other : Policy, Condition, PolicyGroupSubscription, PolicyCategory, Facets.

The DMF objects can be used to create and manage policies that control the behavior and configuration of an instance of SQL Server. All behavior and configurations are represented by facets. The Microsoft.SqlServer.Management.Facets namespace contains the objects that represent the repository of facets used when defining policies. Policies are used when defining a DAC package using the DAC objects. This enables you control policies when installing a database application structure stored in the DAC package onto an instance of SQL Server. The specified policies determine the instances of SQL Server in the SQL Fabric to which the DAC package can be deployed.

A policy is the result of applying a condition to one of more target object. The condition is a facet combined with a state of behavior, for example, Database Mail is the facet and whether it is installed or not is the state. So, specifying that Database Mail must be installed is a condition. You can create a target set of objects by applying a filter. Then, apply the condition to the target object set to make a policy.

The Microsoft.SqlServer.Management.Dmf namespace resides in the Microsoft.SqlServer.Dmf.dll file. Additionally, some supporting objects are in the Microsoft.SqlServer.DmfSqlClrWrapper.dll and Microsoft.SqlServer.Dmf.Adapters.dll files. You will have to import these files to access the classes in the Microsoft.SqlServer.Management.Dmf namespace.

By using the Microsoft.SqlServer.Management.Dmf namespace, you can do the following:

  • Create, read, update and delete policies, target objects, conditions, filters and subscriptions.

  • Script out the DMF objects associated with the connection.

  • Define a target object set by using a filter.

  • Extract the existing configuration state from an instance of SQL Server and create a policy.

  • Export and import DMF objects.

  • Assign a policy to a set of target objects.

  • Evaluate a policy.

  • Have target subscribe to policy.

Classes

  Classe Description
Classe publique AdapterAlreadyExistsException The AdapterAlreadyExistsException class is an exception that is raised when an attempt is made to retrieve a collection that is not available.
Classe publique AdapterWrongNumberOfArgumentsException The AdapterWrongNumberOfArgumentsException class is an exception that is raised when the adapter receives the wrong number of arguments.
Classe publique AssemblyAlreadyRegisteredException The AssemblyAlreadyRegistered class is an exception that is raised when an the adapter receives the wrong number of arguments.
Classe publique BadEventDataException The BadEventDataException class is an exception that is raised when the event data is incorrect.
Classe publique BadExpressionTreeException The BadExpressionTreeException class is an exception that is raised when the expression tree is incorrect.
Classe publique Condition The Condition object represents a policy-based management condition.
Classe publique Condition. . :: . .Key The Condition..::..Key class represents the key that identifies the Condition class.
Classe publique ConditionCollection The ConditionCollection class represents a collection of Condition objects that represent all the conditions in the policy store.
Classe publique ConditionExtender The ConditionExtender class is an exception that is raised when the expression tree is incorrect.
Classe publique ConflictingPropertyValuesException The ConflictingPropertyValuesException class is an exception that is raised when property values conflict.
Classe publique ConnectionEvaluationHistory The ConnectionEvaluationHistory object represents information about parent policy evaluation that is stored in the system catalogs.
Classe publique ConnectionEvaluationHistory. . :: . .Key The ConnectionEvaluationHistory..::..Key class represents the key that is used to identify the ConnectionEvaluationHistory class.
Classe publique ConnectionEvaluationHistoryCollection The ConnectionEvaluationHistoryCollection class represents a collection of ConnectionEvaluationHistory objects that represent all the connection evaluation histories that are in the evaluation history.
Classe publique ConversionNotSupportedException The ConversionNotSupportedException class is an exception that is raised when an unsupported conversion is attempted on a type.
Classe publique DmfException The DmfException class represents a generic policy-based management exception.
Classe publique EvaluationDetail The EvaluationDetail object represents the evaluation information that is stored in the system catalogs about the parent policy for a given target.
Classe publique EvaluationDetail. . :: . .Key The EvaluationDetail..::..Key class represents the key that is used to identify the EvaluationDetail class.
Classe publique EvaluationDetailCollection The EvaluationDetailCollection class represents a collection of EvaluationDetail objects that represent all the detail rows that are in the evaluation.
Classe publique EvaluationFactory Represents the evaluation factory in policy-based management services.
Classe publique EvaluationHistory The EvaluationHistory object represents information about parent policy evaluation that is stored in the system catalogs.
Classe publique EvaluationHistory. . :: . .Key The EvaluationHistory..::..Key class represents the key that identifies the EvaluationHistory class.
Classe publique EvaluationHistoryCollection The EvaluationHistoryCollection class represents a collection of EvaluationHistory objects that represent all evaluation histories that are in the policy store.
Classe publique ExpressionNode The ExpressionNode object represents a policy-based management expression node. The expression node describes part of an expression, such as a constant value, an operator, or a function.
Classe publique ExpressionNodeAttribute The ExpressionNodeAttribute object represents an attribute of a policy-based management expression node.
Classe publique ExpressionNodeChildren The ExpressionNodeChildren object represents the child expression nodes that are dependent on an expression node.
Classe publique ExpressionNodeConfigurationException The ExpressionNodeConfigurationException class is an exception that is raised when the adapter receives the wrong number of arguments.
Classe publique ExpressionNodeConstant The ExpressionNodeConstant object represents an constant value that is used in an expression.
Classe publique ExpressionNodeFunction The ExpressionNodeFunction object represents part of a policy-based management expression that is a function.
Classe publique ExpressionNodeGroup The ExpressionNodeGroup object represents an expression node that is a group.
Classe publique ExpressionNodeNotConfigurableException The ExpressionNodeNotConfigurableException class is an exception that is raised when the expression node cannot be configured.
Classe publique ExpressionNodeNotConfigurableOperatorException The ExpressionNodeNotConfigurableOperatorException class is an exception that is raised if the operator cannot configure the expression node.
Classe publique ExpressionNodeOperator The ExpressionNodeOperator object represents an expression node that is an operator.
Classe publique ExpressionSerializationException The ExpressionSerializationException class is an exception that is raised when an the adapter receives the wrong number of arguments.
Classe publique ExpressionTypeMistmatchException The ExpressionTypeMismatchException class is an exception that is raised when the types in the expression do not match.
Classe publique FacetInfo The FacetInfo object represents facet information. A facet represents a logical dimension of a target object and is used, together with a local expression, to build a condition.
Classe publique FacetInfoCollection The FacetInfoCollection class represents a collection of FacetInfo objects that represent all facets on the instance of SQL Server.
Classe publique FailedOperationException The FailedOperationException class is an exception that is raised when a policy-based management operation fails.
Classe publique FunctionBadDatePartException The FunctionBadDatePartException class is an exception that is raised when the date that is supplied to the function is not the correct format.
Classe publique FunctionNoServerException The FunctionNoServerException class is an exception that is raised when the server is not recognized.
Classe publique FunctionNotASmoObjectException The FunctionNotASmoObjectException class is an exception that is raised when the function encounters an unsupported object.
Classe publique FunctionTooManyColumnsException The FunctionTooManyColumnsException class is an exception that is raised when the function has too many columns.
Classe publique FunctionWrongArgumentsNumberException The FunctionWrongArgumentsNumberException class is an exception that is raised when the function receives the incorrect number of arguments.
Classe publique FunctionWrongArgumentTypeException The FunctionWrongArgumentTypeException class is an exception that is raised when the function receives an argument that is the incorrect type.
Classe publique FunctionWrongReturnTypeException The FunctionWrongReturnTypeException class is an exception that is raised when the specified return type is not the same as the type that is returned by the function.
Classe publique InvalidInOperatorException The InvalidInOperatorException class is an exception that is raised when the operator is not valid.
Classe publique InvalidOperandException The InvalidOperandException class is an exception that is raised when an operand is encountered that is not valid.
Classe publique MissingJobScheduleException The MissingJobScheduleException class is an exception that is raised when there in no job schedule.
Classe publique MissingObjectException The MissingObjectException class is an exception that is raised when a specified object is missing.
Classe publique MissingPropertyException The MissingPropertyException class is an exception that is raised when a specified property is missing.
Classe publique MissingTypeFacetAssociationException The MissingTypeFacetAssociationException class is an exception that is raised when a specified association between a facet and a type is missing.
Classe publique NonConfigurableReadOnlyPropertyException The NonConfigurableReadOnlyPropertyException class is an exception that is raised when there is an attempt to configure a read-only property.
Classe publique NonRetrievablePropertyException The NonRetrievablePropertyException class is an exception that is raised when a property cannot be retrieved.
Classe publique NoTargetSetEnabledException The NoTargetSetEnabledException class is an exception that is raised when the target set has not been enabled.
Classe publique NullFacetException The NullFacetException class is an exception that is raised when the facet is not set.
Classe publique ObjectAlreadyExistsException The ObjectAlreadyExistsException class is an exception that is raised when an attempt to create an object that already exists is made.
Classe publique ObjectSet The ObjectSet object represents a policy-based management set of objects.
Classe publique ObjectSet. . :: . .Key The ObjectSet..::..Key class represents the key that identifies the ObjectSet class.
Classe publique ObjectSetCollection The ObjectSetCollection class represents a collection of ObjectSet objects that represent all the object sets in the policy store.
Classe publique ObjectValidationException The ObjectValidationException class is an exception that is raised when an object encounters an error during validation.
Classe publique OperatorNotApplicableException The OperatorNotApplicableException class is an exception that is raised when an operator does not have the appropriate permissions.
Classe publique Policy The Policy object represents a Policy-Based Management policy. A policy represents the relationship between a target object and a condition.
Classe publique Policy. . :: . .ConnectionProcessingFinishedEventArgs Represents the arguments that are passed to the event handler when the connection processing is finished.
Classe publique Policy. . :: . .ConnectionProcessingStartedEventArgs Represents the arguments that are passed to the event handler when the connection processing has started.
Classe publique Policy. . :: . .Key The Policy..::..Key class represents the key that identifies each instance of the Policy class.
Classe publique Policy. . :: . .PolicyEvaluationFinishedEventArgs Represents the arguments that are passed to the event handler when the evaluation of a policy finishes.
Classe publique Policy. . :: . .TargetProcessedEventArgs Represents the arguments that are passed to the event handler when the target is processed.
Classe publique PolicyCategory Represents a category that classifies policies in SQL Server Policy-Based Management. Policy Categories are used to group policies together to which target objects can subscribe.
Classe publique PolicyCategory. . :: . .Key The PolicyCategory..::..Key class represents the key that identifies the PolicyCategory class.
Classe publique PolicyCategoryCollection The PolicyCategoryCollection class represents a collection of PolicyCategory objects that represent all policy categories in the policy store.
Classe publique PolicyCategoryInformation Contains information about the policy category in policy-based management services.
Classe publique PolicyCategorySubscription The PolicyCategorySubscription object represents a subscription to a particular policy category.
Classe publique PolicyCategorySubscription. . :: . .Key The PolicyCategorySubscription..::..Key class represents the key that identifies the PolicyCategorySubscription class.
Classe publique PolicyCategorySubscriptionCollection The PolicyCategorySubscriptionCollection class represents a collection of PolicyCategorySubscription objects that represent all policy category subscriptions that are in the policy store.
Classe publique PolicyCollection The PolicyCollection class represents a collection of Policy objects that represent all policies in the policy store.
Classe publique PolicyEvaluationException The PolicyEvaluationException class is an exception that is raised when an error occurs during the evaluation of a policy.
Classe publique PolicyEvaluationResultsWriter Represents the XML writer that records the policy evaluation history in Policy-Based Management.
Classe publique PolicyEvaluationWrapper Represents a wrapper class for the policy evaluation.
Classe publique PolicyExtender Contains additional functionality for the Policy object.
Classe publique PolicyStore The PolicyStore type is the root of the DMF object model.
Classe publique PolicyStore. . :: . .Key The PolicyStore..::..Key class represents the key that identifies each instance of the PolicyStore class.
Classe publique PolicyStoreUpgradeSession Represents a policy store upgrade session.
Classe publique PostConfigurationActionAttribute Represents a set post configuration action attributes.
Classe publique RestartPendingException The RestartPendingException class represents the exception that is raised when a system restart is pending.
Classe publique RestartPendingException< (Of < ( <'T> ) > ) > The RestartPendingException class is an exception that is raised when an error occurs when a system restart is pending.
Classe publique StringPropertyTooLongException The StringPropertyTooLongException class is an exception that is raised when the string that is assigned to a property is too long.
Classe publique TargetEvaluation Represents the target evaluation in policy-based management services.
Classe publique TargetSet The TargetSet object represents a policy-based Management target set that holds information about levels, the condition for each level, and the target types.
Classe publique TargetSet. . :: . .Key The TargetSet..::..Key class represents the key that identifies the TargetSet class.
Classe publique TargetSetCollection The TargetSetCollectionCollection class represents a collection of TargetSet objects that represent all the policies in the policy store.
Classe publique TargetSetCountMismatchException The TargetSetCountMismatchException class is an exception that is raised when the target set and facet counts do not match.
Classe publique TargetSetLevel Represents the target set level in policy-based management services.
Classe publique TargetSetLevel. . :: . .Key The TargetSetLevel..::..Key class represents the key that identifies the TargetSetLevel class.
Classe publique TargetSetLevelCollection The TargetSetLevelCollection class represents a collection of TargetSetLevel objects that represent all target set levels in the target set.
Classe publique TypeConversionException The TypeConversionException class is an exception that is raised when a type conversion error occurs.
Classe publique UnsupportedObjectTypeException The UnsupportedObjectTypeException class is an exception that is raised when an error occurs when the policy encounters an unsupported object.
Classe publique UnsupportedTargetSetForFacetException The UnsupportedTargetSetForFacetException class is an exception that is raised when an error occurs when the target set is not supported by the facet.
Classe publique UnsupportedTypeException The UnsupportedTypeException class is an exception that is raised when an unsupported type is encountered.
Classe publique Utils Represents a utility class that is used in policy-based management services.

Délégués

  Délégué Description
Délégué public Policy. . :: . .ConnectionProcessingFinishedEventHandler The Policy..::..ConnectionProcessingFinishedEventHandler class represents the event handler that handles the event that occurs when the processing of the connection has finished.
Délégué public Policy. . :: . .ConnectionProcessingStartedEventHandler The Policy..::..ConnectionProcessingStartedEventHandler class represents the event handler that handles the event that occurs when the processing of a connection has started.
Délégué public Policy. . :: . .PolicyEvaluationFinishedEventHandler Représente les arguments passés au gestionnaire d'événements à la fin de l'évaluation d'une stratégie.
Délégué public Policy. . :: . .PolicyEvaluationStartedEventHandler The PolicyEvaluationStartedEventHandler class represents the event handler that handles the event that occurs when the evaluation of a policy has started.
Délégué public Policy. . :: . .TargetProcessedEventHandler The TargetProcessedEventHandler class represents the event handler that handles the event that occurs when the target has been processed.

Énumérations

  Énumération Description
Énumération publique AdHocPolicyEvaluationMode The AdHocPolicyEvaluationMode enumeration contains values that specify the method that is used to evaluate the policy.
Énumération publique AutomatedPolicyEvaluationMode The AutomatedPolicyEvaluationMode enumeration contains values that specify the Policy-Based Management automated policy evaluation modes.
Énumération publique DmfExceptionType The DmfExceptionType enumeration contains values that are used to specify the policy-based management exception types.
Énumération publique ExpressionNodeFunction. . :: . .Function The ExpressionNodeFunction..::..Function enumeration contains values that represent the different types of supported functions.
Énumération publique ExpressionNodeType The ExpressionNodeType enumeration contains values that specify the type of expression node.
Énumération publique ExpressionSerializationException. . :: . .ReaderActionType Represents the reader action type that is associated with the serialization. Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server.
Énumération publique ImportPolicyEnabledState L'énumération ImportPolicyEnabledState contient les valeurs utilisées pour spécifier l'état de la stratégie d'importation.
Énumération publique NameConditionType The NameConditionType enumeration contains values that are used to specify the condition that is used in a policy.
Énumération publique OperatorType The OperatorType enumeration contains values that are used to specify the type of operator.
Énumération publique PolicyEffectiveState The PolicyEffectiveState enumeration contains values that are used to specify the effectiveness of the policy.
Énumération publique PolicyHealthState The PolicyHealthState enumeration contains values that specify the health state of the policy.
Énumération publique PolicyStore. . :: . .EnumerationMode Specifies the enumeration mode for the PolicyStore object.
Énumération publique PostConfigurationAction The PostConfigurationAction enumeration contains values that specify the action to take after configuration finishes.
Énumération publique TypeClass The TypeClass enumeration contains values that describe the different class types.