Partilhar via


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

Delegados

  Delegado Descrição
Delegado público Policy.ConnectionProcessingFinishedEventHandler The Policy.ConnectionProcessingFinishedEventHandler class represents the event handler that handles the event that occurs when the processing of the connection has finished.
Delegado público Policy.ConnectionProcessingStartedEventHandler The Policy.ConnectionProcessingStartedEventHandler class represents the event handler that handles the event that occurs when the processing of a connection has started.
Delegado público Policy.PolicyEvaluationFinishedEventHandler Represents the arguments that are passed to the event handler when a policy evaluation finishes.
Delegado público Policy.PolicyEvaluationStartedEventHandler The PolicyEvaluationStartedEventHandler class represents the event handler that handles the event that occurs when the evaluation of a policy has started.
Delegado público Policy.TargetProcessedEventHandler The TargetProcessedEventHandler class represents the event handler that handles the event that occurs when the target has been processed.

Enumerações

  Enumeração Descrição
Enumeração pública AdHocPolicyEvaluationMode The AdHocPolicyEvaluationMode enumeration contains values that specify the method that is used to evaluate the policy.
Enumeração pública AutomatedPolicyEvaluationMode The AutomatedPolicyEvaluationMode enumeration contains values that specify the Policy-Based Management automated policy evaluation modes.
Enumeração pública DmfExceptionType The DmfExceptionType enumeration contains values that are used to specify the policy-based management exception types.
Enumeração pública ExpressionNodeFunction.Function The ExpressionNodeFunction.Function enumeration contains values that represent the different types of supported functions.
Enumeração pública ExpressionNodeType The ExpressionNodeType enumeration contains values that specify the type of expression node.
Enumeração pública ExpressionSerializationException.ReaderActionType Represents the reader action type that is associated with the serialization. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server.
Enumeração pública ImportPolicyEnabledState The ImportPolicyEnabledState enumeration contains values that are used to specify the state of the import policy.
Enumeração pública NameConditionType The NameConditionType enumeration contains values that are used to specify the condition that is used in a policy.
Enumeração pública OperatorType Specifies the type of operator.
Enumeração pública PolicyEffectiveState The PolicyEffectiveState enumeration contains values that are used to specify the effectiveness of the policy.
Enumeração pública PolicyHealthState The PolicyHealthState enumeration contains values that specify the health state of the policy.
Enumeração pública PolicyStore.EnumerationMode Specifies the enumeration mode for the PolicyStore object.
Enumeração pública PostConfigurationAction The PostConfigurationAction enumeration contains values that specify the action to take after configuration finishes.
Enumeração pública TypeClass The TypeClass enumeration contains values that describe the different class types.