Partager via


Classe Policy

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

Hiérarchie d'héritage

System.Object
  Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance
    Microsoft.SqlServer.Management.Dmf.Policy

Espace de noms :  Microsoft.SqlServer.Management.Dmf
Assembly :  Microsoft.SqlServer.Dmf (en Microsoft.SqlServer.Dmf.dll)

Syntaxe

'Déclaration
<StrongNameIdentityPermissionAttribute(SecurityAction.LinkDemand, PublicKey := "0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8")> _
<StrongNameIdentityPermissionAttribute(SecurityAction.LinkDemand, PublicKey := "0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8")> _
Public NotInheritable Class Policy _
    Inherits SfcInstance _
    Implements ISfcCreatable, ICreatable, ISfcDroppable, IDroppable,  _
    ISfcAlterable, IAlterable, ISfcRenamable, IRenamable, ISfcValidate
'Utilisation
Dim instance As Policy
[StrongNameIdentityPermissionAttribute(SecurityAction.LinkDemand, PublicKey = "0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8")]
[StrongNameIdentityPermissionAttribute(SecurityAction.LinkDemand, PublicKey = "0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8")]
public sealed class Policy : SfcInstance, 
    ISfcCreatable, ICreatable, ISfcDroppable, IDroppable, ISfcAlterable, 
    IAlterable, ISfcRenamable, IRenamable, ISfcValidate
[StrongNameIdentityPermissionAttribute(SecurityAction::LinkDemand, PublicKey = L"0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8")]
[StrongNameIdentityPermissionAttribute(SecurityAction::LinkDemand, PublicKey = L"0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8")]
public ref class Policy sealed : public SfcInstance, 
    ISfcCreatable, ICreatable, ISfcDroppable, IDroppable, ISfcAlterable, 
    IAlterable, ISfcRenamable, IRenamable, ISfcValidate
[<SealedAttribute>]
[<StrongNameIdentityPermissionAttribute(SecurityAction.LinkDemand, PublicKey = "0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8")>]
[<StrongNameIdentityPermissionAttribute(SecurityAction.LinkDemand, PublicKey = "0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8")>]
type Policy =  
    class 
        inherit SfcInstance 
        interface ISfcCreatable 
        interface ICreatable 
        interface ISfcDroppable 
        interface IDroppable 
        interface ISfcAlterable 
        interface IAlterable 
        interface ISfcRenamable 
        interface IRenamable 
        interface ISfcValidate 
    end
public final class Policy extends SfcInstance implements ISfcCreatable, ICreatable, ISfcDroppable, IDroppable, ISfcAlterable, IAlterable, ISfcRenamable, IRenamable, ISfcValidate

Le type Policy expose les membres suivants.

Constructeurs

  Nom Description
Méthode publique Policy() Initializes a new instance of the Policy class.
Méthode publique Policy(PolicyStore, String) Initializes a new instance of the Policy class.

Haut de la page

Propriétés

  Nom Description
Propriété protégée AbstractIdentityKey Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
Propriété publique AutomatedPolicyEvaluationMode Gets or sets the evaluation mode.
Propriété publique CategoryId Gets the ID value that uniquely identifies the category that is associated with the policy.
Propriété publique Condition Gets or sets the condition.
Propriété publique CreateDate Gets the date and time when the policy was created.
Propriété publique CreatedBy Gets the policy store authentication credentials of the user who created the policy.
Propriété publique DateModified Gets the date and time when the policy was last modified.
Propriété publique Description Gets or sets the textual description of the policy.
Propriété publique Enabled Gets or set the Boolean value that specifies whether the policy is enabled.
Propriété publique EvaluationHistories Gets the evaluation histories collection.
Propriété publique HasScript Gets the Boolean value that specifies whether the policy has a script.
Propriété publique HelpLink Gets or sets a URN to additional help information for the policy.
Propriété publique HelpText Gets or sets the display name for the help text.
Propriété publique ID Gets the ID value that uniquely identifies the policy.
Propriété publique IdentityKey Gets the key that identifies the policy.
Propriété publique IsSystemObject Determines whether the Policy object is a Object.
Propriété publique Metadata Returns metadata about the instance and its domain. (hérité de SfcInstance.)
Propriété publique ModifiedBy Gets the policy store authentication credentials of the user who last modified the policy.
Propriété publique Name Gets the name of the Policy object.
Propriété publique ObjectSet Gets or sets the set of objects that are associated with the policy.
Propriété publique Parent Gets or sets the PolicyStore that is the parent of the policy object.
Propriété publique PolicyCategory Gets or sets the category that is associated with the policy.
Propriété publique Properties Returns a collection instance properties. (hérité de SfcInstance.)
Propriété publique RootCondition Gets or sets the name of the root condition for this policy.
Propriété publique ScheduleUid Gets or sets the Guid that identifies the SQL Server Agent schedule that checks on the policy.
Propriété protégée State Returns the state of the SfcInstance object. (hérité de SfcInstance.)
Propriété publique Urn Returns the uniform resource name of the SfcInstance object. (hérité de SfcInstance.)

Haut de la page

Méthodes

  Nom Description
Méthode publique Alter Updates any Policy object property changes on the instance of SQL Server.
Méthode publique Create Creates management policy item.
Méthode protégée CreateIdentityKey Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
Méthode publique Discover Discovers conditions in the ObjectSet and adds them to the ISfcDependencyDiscoveryObjectSink identified by the sink parameter. (remplace SfcInstance.Discover(ISfcDependencyDiscoveryObjectSink).)
Méthode publique Drop Removes the policy from the instance of SQL Server.
Méthode publique Equals (hérité de Object.)
Méthode publique Evaluate(AdHocPolicyEvaluationMode, array<ISfcConnection[]) Evaluates the Policy object and applies policy to the data in identified by the targetConnections parameter.
Méthode publique Evaluate(AdHocPolicyEvaluationMode, array<Object[]) Immediately executes the policy against the specified target objects by using the specified evaluation mode.
Méthode publique Evaluate(AdHocPolicyEvaluationMode, SfcQueryExpression, array<ISfcConnection[]) Evaluates the Policy object and applies policy to the data in identified by the targetConnections parameter.
Méthode protégée GetChildCollection Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
Méthode publique GetDomain Ne faites pas directement référence à 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 publiqueMembre statique GetObjectFactory Gets the object factory for the 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 faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
Méthode protégée InitializeUIPropertyState Ne faites pas directement référence à 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 publique ProduceConfigureScript Gets the condition of a Policy object.
Méthode publique Refresh Refreshes the object's properties by reading them from the server. (hérité de SfcInstance.)
Méthode publique Rename Renames the policy.
Méthode protégée ResetKey Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
Méthode publique ScriptAlter Alters the script that is used to create the policy.
Méthode publique ScriptAlterWithObjectSet Alters a previously created ISfcScript object of the Policy object.
Méthode publique ScriptCreate Creates a script that is used to create the policy.
Méthode publique ScriptCreateWithDependencies Creates the ISfcScript object of the Policy object.
Méthode publique ScriptCreateWithObjectSet Creates the ISfcScript object of the ObjectSet.
Méthode publique ScriptDrop Drops the script that is used to create the policy.
Méthode publique ScriptDropWithObjectSet Drops the ISfcScript object of the ObjectSet.
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 publique UsesFacet Determines whether the facet identified by the parameter is contained by the Condition.
Méthode publique Validate Validates a Policy object as specified by the mode parameter.

Haut de la page

Événements

  Nom Description
Événement public ConnectionProcessingFinished Represents the event activated when connection processing completes.
Événement public ConnectionProcessingStarted Represents the event activated when connection processing begins.
Événement public PolicyEvaluationFinished Represents the event activated when policy evaluation completes.
Événement public PolicyEvaluationStarted Represents the event activated when policy evaluation begins.
Événement public PropertyChanged CLS-compliant event for property changes. (hérité de SfcInstance.)
Événement public PropertyMetadataChanged CLS-compliant event for property metadata changes. (hérité de SfcInstance.)
Événement public TargetProcessed Represents the event activated when policy target is processed.

Haut de la page

Champs

  Nom Description
Champ publicMembre statique HelpLinkStringMaxLength Specifies the maximum length of the link to help text.
Champ publicMembre statique HelpTextStringMaxLength Specifies the maximum length of the help text.

Haut de la page

Implémentations d'interfaces explicites

  Nom Description
Implémentation d'interface expliciteMéthode privée ISfcRenamable.Rename Renames the instance of Policy identified by the key parameter.
Implémentation d'interface expliciteMéthode privée ISfcRenamable.ScriptRename Renames a script in the policy.
Implémentation d'interface expliciteMéthode privée ISfcValidate.Validate Validates a Policy object.

Haut de la page

Notes

A policy represents the relationship between an individual object or a target set of objects and a condition.

A target is an entity on an instance of SQL Server. It could be the instance of SQL Server, or a component of it, such as a database or a table.

A condition is a relationship between a facet and a Boolean expression that determine the state of the facet. A facet is a dimension of a target. For example, the target could be an instance of SQL Server, the facet is Database Mail, the expression specifies that it is installed on the instance and the condition is that Database Mail is installed. Thus, the policy is that Database Mail is installed on the specified instance of SQL Server.

The evaluation mode of the policy determines how and when the policy is checked and enforced.

Using the Policy object, you can manage the following characteristics of a policy:

  • Condition

  • Evaluation mode

  • Schedule

  • Target set filter using XPath expression

  • A job on evaluation success

  • A job on evaluation failure

  • A policy group

Exemples

C#

Policy p = new Policy(ps, policyName);
p.AutomatedPolicyEvaluationMode = execMode;
p.Condition = condition.Name;
p.ScheduleUid = schedule.ScheduleUid;
if (execMode != AutomatedPolicyEvaluationMode.None) p.Enabled = true;
p.Create();

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.

Voir aussi

Référence

Espace de noms Microsoft.SqlServer.Management.Dmf

Autres ressources

Gestion des utilisateurs, rôles et connexions