Microsoft.SqlServer.Management.Dmf
TOC
Collapse the table of content
Expand the table of content

Microsoft.SqlServer.Management.Dmf Namespace

 

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

ClassDescription
System_CAPS_pubclassCondition

The T:Microsoft.SqlServer.Management.Smo.Condition object represents a policy-based management condition.

System_CAPS_pubclassConditionCollection

The ConditionCollection class represents a collection of Condition objects that represent all the conditions in the policy store.

System_CAPS_pubclassConditionExtender

The ConditionExtender class is an exception that is raised when the expression tree is incorrect.

System_CAPS_pubclassConnectionEvaluationHistory

The T:Microsoft.SqlServer.Management.Smo.ConnectionEvaluationHistory object represents information about parent policy evaluation that is stored in the system catalogs.

System_CAPS_pubclassConnectionEvaluationHistoryCollection

The ConnectionEvaluationHistoryCollection class represents a collection of ConnectionEvaluationHistory objects that represent all the connection evaluation histories that are in the evaluation history.

System_CAPS_pubclassPolicy.ConnectionProcessingFinishedEventArgs

Represents the arguments that are passed to the event handler when the connection processing is finished.

System_CAPS_pubclassPolicy.ConnectionProcessingStartedEventArgs

Represents the arguments that are passed to the event handler when the connection processing has started.

System_CAPS_pubclassEvaluationDetail

The T:Microsoft.SqlServer.Management.Smo.EvaluationDetail object represents the evaluation information that is stored in the system catalogs about the parent policy for a given target.

System_CAPS_pubclassEvaluationDetailCollection

The EvaluationDetailCollection class represents a collection of EvaluationDetail objects that represent all the detail rows that are in the evaluation.

System_CAPS_pubclassEvaluationFactory

Represents the evaluation factory in policy-based management services.

System_CAPS_pubclassEvaluationHistory

The T:Microsoft.SqlServer.Management.Smo.EvaluationHistory object represents information about parent policy evaluation that is stored in the system catalogs.

System_CAPS_pubclassEvaluationHistoryCollection

The EvaluationHistoryCollection class represents a collection of EvaluationHistory objects that represent all evaluation histories that are in the policy store.

System_CAPS_pubclassExpressionNode

The T:Microsoft.SqlServer.Management.Smo.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.

System_CAPS_pubclassExpressionNodeAttribute

The T:Microsoft.SqlServer.Management.Smo.ExpressionNodeAttribute object represents an attribute of a policy-based management expression node.

System_CAPS_pubclassExpressionNodeChildren

The T:Microsoft.SqlServer.Management.Smo.ExpressionNodeChildren object represents the child expression nodes that are dependent on an expression node.

System_CAPS_pubclassExpressionNodeConstant

The T:Microsoft.SqlServer.Management.Smo.ExpressionNodeConstant object represents an constant value that is used in an expression.

System_CAPS_pubclassExpressionNodeFunction

The T:Microsoft.SqlServer.Management.Smo.ExpressionNodeFunction object represents part of a policy-based management expression that is a function.

System_CAPS_pubclassExpressionNodeGroup

The T:Microsoft.SqlServer.Management.Smo.ExpressionNodeGroup object represents an expression node that is a group.

System_CAPS_pubclassExpressionNodeOperator

The T:Microsoft.SqlServer.Management.Smo.ExpressionNodeOperator object represents an expression node that is an operator.

System_CAPS_pubclassFacetInfo

The T:Microsoft.SqlServer.Management.Smo.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.

System_CAPS_pubclassFacetInfoCollection

The FacetInfoCollection class represents a collection of FacetInfo objects that represent all facets on the instance of SQL Server.

System_CAPS_pubclassCondition.Key

The Condition.Key class represents the key that identifies the Condition class.

System_CAPS_pubclassConnectionEvaluationHistory.Key

The ConnectionEvaluationHistory.Key class represents the key that is used to identify the ConnectionEvaluationHistory class.

System_CAPS_pubclassEvaluationDetail.Key

The EvaluationDetail.Key class represents the key that is used to identify the EvaluationDetail class.

System_CAPS_pubclassEvaluationHistory.Key

The EvaluationHistory.Key class represents the key that identifies the EvaluationHistory class.

System_CAPS_pubclassObjectSet.Key

The ObjectSet.Key class represents the key that identifies the ObjectSet class.

System_CAPS_pubclassPolicy.Key

The Policy.Key class represents the key that identifies each instance of the Policy class.

System_CAPS_pubclassPolicyCategory.Key

The PolicyCategory.Key class represents the key that identifies the PolicyCategory class.

System_CAPS_pubclassPolicyCategorySubscription.Key

The PolicyCategorySubscription.Key class represents the key that identifies the PolicyCategorySubscription class.

System_CAPS_pubclassPolicyStore.Key

The PolicyStore.Key class represents the key that identifies each instance of the PolicyStore class.

System_CAPS_pubclassTargetSet.Key

The TargetSet.Key class represents the key that identifies the TargetSet class.

System_CAPS_pubclassTargetSetLevel.Key

The TargetSetLevel.Key class represents the key that identifies the TargetSetLevel class.

System_CAPS_pubclassObjectSet

The T:Microsoft.SqlServer.Management.Smo.ObjectSet object represents a policy-based management set of objects.

System_CAPS_pubclassObjectSetCollection

The ObjectSetCollection class represents a collection of ObjectSet objects that represent all the object sets in the policy store.

System_CAPS_pubclassPolicy

The Policy object represents a Policy-Based Management policy. A policy represents the relationship between a target object and a condition.

System_CAPS_pubclassPolicyCategory

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.

System_CAPS_pubclassPolicyCategoryCollection

The PolicyCategoryCollection class represents a collection of PolicyCategory objects that represent all policy categories in the policy store.

System_CAPS_pubclassPolicyCategoryInformation

Contains information about the policy category in policy-based management services.

System_CAPS_pubclassPolicyCategorySubscription

The PolicyCategorySubscription object represents a subscription to a particular policy category.

System_CAPS_pubclassPolicyCategorySubscriptionCollection

The PolicyCategorySubscriptionCollection class represents a collection of PolicyCategorySubscription objects that represent all policy category subscriptions that are in the policy store.

System_CAPS_pubclassPolicyCollection

The PolicyCollection class represents a collection of Policy objects that represent all policies in the policy store.

System_CAPS_pubclassPolicy.PolicyEvaluationFinishedEventArgs

Represents the arguments that are passed to the event handler when the evaluation of a policy finishes.

System_CAPS_pubclassPolicyEvaluationResultsWriter

Represents the XML writer that records the policy evaluation history in Policy-Based Management.

System_CAPS_pubclassPolicyEvaluationWrapper

Represents a wrapper class for the policy evaluation.

System_CAPS_pubclassPolicyExtender

Contains additional functionality for the Policy object.

System_CAPS_pubclassPolicyStore

The PolicyStore type is the root of the DMF object model.

System_CAPS_pubclassPolicyStoreUpgradeSession

Represents a policy store upgrade session.

System_CAPS_pubclassTargetEvaluation

Represents the target evaluation in policy-based management services.

System_CAPS_pubclassPolicy.TargetProcessedEventArgs

Represents the arguments that are passed to the event handler when the target is processed.

System_CAPS_pubclassTargetSet

The TargetSet object represents a policy-based Management target set that holds information about levels, the condition for each level, and the target types.

System_CAPS_pubclassTargetSetCollection

The T:Microsoft.SqlServer.Management.Dmf.TargetSetCollectionCollection class represents a collection of TargetSet objects that represent all the policies in the policy store.

System_CAPS_pubclassTargetSetLevel

Represents the target set level in policy-based management services.

System_CAPS_pubclassTargetSetLevelCollection

The TargetSetLevelCollection class represents a collection of TargetSetLevel objects that represent all target set levels in the target set.

System_CAPS_pubclassUtils

Represents a utility class that is used in policy-based management services.

DelegateDescription
System_CAPS_pubdelegatePolicy.ConnectionProcessingFinishedEventHandler

The Policy.ConnectionProcessingFinishedEventHandler class represents the event handler that handles the event that occurs when the processing of the connection has finished.

System_CAPS_pubdelegatePolicy.ConnectionProcessingStartedEventHandler

The Policy.ConnectionProcessingStartedEventHandler class represents the event handler that handles the event that occurs when the processing of a connection has started.

System_CAPS_pubdelegatePolicy.PolicyEvaluationFinishedEventHandler

Represents the arguments that are passed to the event handler when a policy evaluation finishes.

System_CAPS_pubdelegatePolicy.PolicyEvaluationStartedEventHandler

The T:Microsoft.SqlServer.Management.Dmf.PolicyEvaluationStartedEventHandler class represents the event handler that handles the event that occurs when the evaluation of a policy has started.

System_CAPS_pubdelegatePolicy.TargetProcessedEventHandler

The T:Microsoft.SqlServer.Management.Smo.TargetProcessedEventHandler class represents the event handler that handles the event that occurs when the target has been processed.

EnumerationDescription
System_CAPS_pubenumAdHocPolicyEvaluationMode

The AdHocPolicyEvaluationMode enumeration contains values that specify the method that is used to evaluate the policy.

System_CAPS_pubenumPolicyStore.EnumerationMode

Specifies the enumeration mode for the PolicyStore object.

System_CAPS_pubenumExpressionNodeType

The ExpressionNodeType enumeration contains values that specify the type of expression node.

System_CAPS_pubenumExpressionNodeFunction.Function

The ExpressionNodeFunction.Function enumeration contains values that represent the different types of supported functions.

System_CAPS_pubenumNameConditionType

The NameConditionType enumeration contains values that are used to specify the condition that is used in a policy.

System_CAPS_pubenumOperatorType

Specifies the type of operator.

System_CAPS_pubenumPolicyHealthState

The PolicyHealthState enumeration contains values that specify the health state of the policy.

System_CAPS_pubenumTypeClass

The TypeClass enumeration contains values that describe the different class types.

The top-level instance is the PolicyStore class, which proves the connection to the instance of SQL Server.

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.

Return to top
Show:
© 2016 Microsoft