Microsoft.SqlServer.Management.Dmf Namespace
The Microsoft.SqlServer.Management.Dmf namespace contains classes that represent the SQL Server policy-based management objects.
The top-level class is the PolicyStore class, where the following objects are child objects: Policy, Condition, PolicyGroupSubscription, PolicyCategory, Facets
The Microsoft.SqlServer.Management.Facets namespace supports the Microsoft.SqlServer.Management.Dmf namespace.
Classes
| Class | Description |
|---|---|
| AdapterAlreadyExistsException | The AdapterAlreadyExistsException class is an exception that is raised when an attempt is made to retrieve a collection that is not available. |
| AdapterWrongNumberOfArgumentsException | The AdapterWrongNumberOfArgumentsException class is an exception that is raised when the adapter receives the wrong number of arguments. |
| AssemblyAlreadyRegisteredException | |
| BadEventDataException | The BadEventDataException class is an exception that is raised when the event data is incorrect. |
| BadExpressionTreeException | The BadExpressionTreeException class is an exception that is raised when the expression tree is incorrect. |
| Condition | The Condition object represents a policy-based management condition. |
| Condition.Key | The Condition.Key class represents the key that identifies the Condition class. |
| ConditionCollection | The ConditionCollection class represents a collection of Condition objects that represent all the conditions in the policy store. |
| ConditionExtender | The ConditionExtender class is an exception that is raised when the expression tree is incorrect. |
| ConflictingPropertyValuesException | The ConflictingPropertyValuesException class is an exception that is raised when property values conflict. |
| ConnectionEvaluationHistory | The ConnectionEvaluationHistory object represents the information that is stored in the system catalogs to evaluate the policy on a specific instance of SQL Server. |
| ConnectionEvaluationHistory.Key | The ConnectionEvaluationHistory.Key class represents the key that is used to identify the ConnectionEvaluationHistory class. |
| ConnectionEvaluationHistoryCollection | The ConnectionEvaluationHistoryCollection class represents a collection of ConnectionEvaluationHistory objects that represent all the connection evaluation histories that are in the evaluation history. |
| ConversionNotSupportedException | The ConversionNotSupportedException class is an exception that is raised when an unsupported conversion is attempted on a type. |
| DmfException | The DmfException class represents a generic policy-based management exception. |
| EvaluationDetail | The EvaluationDetail object represents the evaluation information that is stored in the system catalogs about the parent policy for a given target. |
| EvaluationDetail.Key | The EvaluationDetail.Key class represents the key that identifies the EvaluationDetail class. |
| EvaluationDetailCollection | The EvaluationDetailCollection class represents a collection of EvaluationDetail objects that represent all the evaluation details that are in the connection evaluation history. |
| EvaluationFactory | Represents the evaluation factory in policy-based management services. |
| EvaluationHistory | The EvaluationHistory object represents information about parent policy evaluation that is stored in the system catalogs. |
| EvaluationHistory.Key | The EvaluationHistory.Key class represents the key that identifies the EvaluationHistory class. |
| EvaluationHistoryCollection | The EvaluationHistoryCollection class represents a collection of EvaluationHistory objects that represent all evaluation histories that are in the policy store. |
| 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. |
| ExpressionNodeAttribute | The ExpressionNodeAttribute object represents an attribute of a policy-based management expression node. |
| ExpressionNodeChildren | The ExpressionNodeChildren object represents the child expression nodes that are dependent on an expression node. |
| ExpressionNodeConfigurationException | The ExpressionNodeConfigurationException class is an exception that is raised when an the adapter receives the wrong number of arguments. |
| ExpressionNodeConstant | The ExpressionNodeConstant object represents an objectthat is used in an expression. |
| ExpressionNodeFunction | The ExpressionNodeFunction object represents part of a policy-based management expression that is a function. |
| ExpressionNodeGroup | The ExpressionNodeGroup object represents an expression node that is a group. |
| ExpressionNodeNotConfigurableException | The ExpressionNodeNotConfigurableException class is an exception that is raised when the expression node cannot be configured. |
| ExpressionNodeNotConfigurableOperatorException | The ExpressionNodeNotConfigurableOperatorException class is an exception that is raised if the operator cannot configure the expression node. |
| ExpressionNodeOperator | The ExpressionNodeOperator object represents an expression node that is an operator. |
| ExpressionSerializationException | The ExpressionSerializationException class is an exception that is raised when an the adapter receives the wrong number of arguments. |
| ExpressionTypeMistmatchException | The ExpressionTypeMismatchException class is an exception that is raised when the types in the expression do not match. |
| FacetInfo | The FacetInfo object represents a facet information item that is used to record information about the facets. |
| FacetInfoCollection | The FacetInfoCollection class represents a collection of FacetInfo objects that represent all facets on the instance of SQL Server. |
| FailedOperationException | The FailedOperationException class is an exception that is raised when a policy-based management operation fails. |
| FunctionBadDatePartException | The FunctionBadDatePartException class is an exception that is raised when the date that is supplied to the function is not the correct format. |
| FunctionNoServerException | The FunctionNoServerException class is an exception that is raised when the server is not recognized. |
| FunctionNotASmoObjectException | The FunctionNotASmoObjectException class is an exception that is raised when the function encounters an unsupported object. |
| FunctionTooManyColumnsException | The FunctionTooManyColumnsException class is an exception that is raised when the function has too many columns. |
| FunctionWrongArgumentsNumberException | The FunctionWrongArgumentsNumberException class is an exception that is raised when the function receives the incorrect number of arguments. |
| FunctionWrongArgumentTypeException | The FunctionWrongArgumentTypeException class is an exception that is raised when the function receives an argument that is the incorrect type. |
| 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. |
| InvalidInOperatorException | The InvalidInOperatorException class is an exception that is raised when the operator is not valid. |
| InvalidOperandException | The InvalidOperandException class is an exception that is raised when an operand is encountered that is not valid. |
| MissingJobScheduleException | The MissingJobScheduleException class is an exception that is raised when there in no job schedule. |
| MissingObjectException | The MissingObjectException class is an exception that is raised when a specified object is missing. |
| MissingPropertyException | The MissingPropertyException class is an exception that is raised when a specified property is missing. |
| MissingTypeFacetAssociationException | The MissingTypeFacetAssociationException class is an exception that is raised when a specified association between a facet and a type is missing. |
| NonConfigurableReadOnlyPropertyException | The NonConfigurableReadOnlyPropertyException class is an exception that is raised when there is an attempt to configure a read-only property. |
| NonRetrievablePropertyException | The NonRetrievablePropertyException class is an exception that is raised when a property cannot be retrieved. |
| NoTargetSetEnabledException | The NoTargetSetEnabledException class is an exception that is raised when the target set has not been enabled. |
| NullFacetException | The NullFacetException class is an exception that is raised when the facet is not set. |
| ObjectAlreadyExistsException | The ObjectAlreadyExistsException class is an exception that is raised when an attempt to create an object that already exists is made. |
| ObjectSet | The ObjectSet object represents a policy-based management set of objects. |
| ObjectSet.Key | The ObjectSet.Key class represents the key that identifies the ObjectSet class. |
| ObjectSetCollection | The ObjectSetCollection class represents a collection of ObjectSet objects that represent all the object sets in the policy store. |
| ObjectValidationException | The ObjectValidationException class is an exception that is raised when an object encounters an error during validation. |
| OperatorNotApplicableException | The OperatorNotApplicableException class is an exception that is raised when an operator does not have the appropriate permissions. |
| Policy | The Policy object represents a Policy-Based Management policy. |
| Policy.ConnectionProcessingFinishedEventArgs | Represents the arguments that are passed to the event handler when the connection processing is finished. |
| Policy.ConnectionProcessingStartedEventArgs | Represents the arguments that are passed to the event handler when the connection processing has started. |
| Policy.Key | The Policy.Key class represents the key that identifies the Policy class. |
| Policy.PolicyEvaluationFinishedEventArgs | Represents the arguments that are passed to the event handler when the evaluation of a policy finishes. |
| Policy.TargetProcessedEventArgs | Represents the arguments that are passed to the event handler when the target is processed. |
| PolicyCategory | Represents a category that classifies policies in SQL Server Policy-Based Management. |
| PolicyCategory.Key | The PolicyCategory.Key class represents the key that identifies the PolicyCategory class. |
| PolicyCategoryCollection | The PolicyCategoryCollection class represents a collection of PolicyCategory objects that represent all policy categories in the policy store. |
| PolicyCategoryInformation | Contains information about the policy category in policy-based management services. |
| PolicyCategorySubscription | The PolicyCategorySubscription object represents a subscription to a particular policy category. |
| PolicyCategorySubscription.Key | The PolicyCategorySubscription.Key class represents the key that identifies the PolicyCategorySubscription class. |
| PolicyCategorySubscriptionCollection | |
| PolicyCollection | The PolicyCollection class represents a collection of Policy objects that represent all policies in the policy store. |
| PolicyEvaluationException | The PolicyEvaluationException class is an exception that is raised when an error occurs during the evaluation of a policy. |
| PolicyEvaluationResultsWriter | Represents the XML writer that records the policy evaluation history in Policy-Based Management. |
| PolicyEvaluationWrapper | Represents a wrapper class for the policy evaluation. |
| PolicyExtender | Contains additional functionality for the Policy object. |
| PolicyStore | The PolicyStore object represents a policy-based Management policy store that holds information about policies, conditions, object sets, and subscriptions. |
| PolicyStore.Key | The PolicyStore.Key class represents the key that identifies the PolicyStore class. |
| PolicyStoreUpgradeSession | Represents a policy store upgrade session. |
| PostConfigurationActionAttribute | Represents an attribute that is associated with the post configuration action in policy-based management services. |
| RestartPendingException | The RestartPendingException class represents the exception that is raised when a system restart is pending. |
| RestartPendingException | The RestartPendingException class is an exception that is raised when an error occurs when a system restart is pending. |
| StringPropertyTooLongException | The StringPropertyTooLongException class is an exception that is raised when the string that is assigned to a property is too long. |
| TargetEvaluation | Represents the target evaluation in policy-based management services. |
| 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. |
| TargetSet.Key | The TargetSet.Key class represents the key that identifies the TargetSet class. |
| TargetSetCollection | The TargetSetCollectionCollection class represents a collection of TargetSet objects that represent all the policies in the policy store. |
| TargetSetCountMismatchException | The TargetSetCountMismatchException class is an exception that is raised when the target set and facet counts do not match. |
| TargetSetLevel | Represents the target set level in policy-based management services. |
| TargetSetLevel.Key | The TargetSetLevel.Key class represents the key that identifies the TargetSetLevel class. |
| TargetSetLevelCollection | The TargetSetLevelCollection class represents a collection of TargetSetLevel objects that represent all target set levels in the target set. |
| TypeConversionException | The TypeConversionException class is an exception that is raised when a type conversion error occurs. |
| UnsupportedObjectTypeException | The UnsupportedObjectTypeException class is an exception that is raised when an error occurs when the policy encounters an unsupported object. |
| UnsupportedTargetSetForFacetException | |
| UnsupportedTypeException | The UnsupportedTypeException class is an exception that is raised when an unsupported type is encountered. |
| Utils | Represents a utility class that is used in policy-based management services. |
Delegates
| Delegate | Description |
|---|---|
| Policy.ConnectionProcessingFinishedEventHandler | The ConnectionProcessingFinishedEventHandler class represents the event handler that handles the event that occurs when the processing of the connection has finished. |
| Policy.ConnectionProcessingStartedEventHandler | The ConnectionProcessingStartedEventHandler class represents the event handler that handles the event that occurs when the processing of a connection has started. |
| Policy.PolicyEvaluationFinishedEventHandler | Represents the arguments that are passed to the event handler when a policy evaluation finishes. |
| Policy.PolicyEvaluationStartedEventHandler | The PolicyEvaluationStartedEventHandler class represents the event handler that handles the event that occurs when the evaluation of a policy has started. |
| Policy.TargetProcessedEventHandler | The TargetProcessedEventHandler class represents the event handler that handles the event that occurs when the target has been processed. |
Enumerations
| Enumeration | Description |
|---|---|
| AdHocPolicyEvaluationMode | The AdHocPolicyEvaluationMode enumeration contains values that specify the method that is used to evaluate the policy. |
| AutomatedPolicyEvaluationMode | The AutomatedPolicyEvaluationMode enumeration contains values that specify the Policy-Based Management automated policy evaluation modes. |
| DmfExceptionType | The DmfExceptionType enumeration contains values that are used to specify the policy-based management exception types. |
| ExpressionNodeFunction.Function | The ExpressionNodeFunction.Function enumeration contains values that represent the different types of supported function. |
| ExpressionNodeType | The ExpressionNodeType enumeration contains values that specify the type of expression node. |
| ExpressionSerializationException.ReaderActionType | Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. |
| ImportPolicyEnabledState | The ImportPolicyEnabledState enumeration contains values that are used to specify the state of the import policy. |
| NameConditionType | The NameConditionType enumeration contains values that are used to specify the condition that is used in a policy. |
| OperatorType | The OperatorType enumeration contains values that are used to specify the type of operator. |
| PolicyEffectiveState | The PolicyEffectiveState enumeration contains values that are used to specify the effectiveness of the policy. |
| PolicyHealthState | The PolicyHealthState enumeration contains values that specify the health state of the policy. |
| PostConfigurationAction | The PostConfigurationAction enumeration contains values that specify the action to take after configuration finishes. |
| TypeClass | The TypeClass enumeration contains values that describe the different class types. |