Freigeben über


Policy-Klasse

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

Vererbungshierarchie

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

Namespace:  Microsoft.SqlServer.Management.Dmf
Assembly:  Microsoft.SqlServer.Dmf (in Microsoft.SqlServer.Dmf.dll)

Syntax

'Declaration
<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
'Usage
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

Der Policy-Typ macht folgende Elemente verfügbar.

Konstruktoren

  Name Beschreibung
Öffentliche Methode Policy() Initializes a new instance of the Policy class.
Öffentliche Methode Policy(PolicyStore, String) Initializes a new instance of the Policy class.

Zum Anfang

Eigenschaften

  Name Beschreibung
Geschützte Eigenschaft AbstractIdentityKey Verweisen Sie nicht direkt im Code auf dieses Element. Unterstützt die SQL Server-Infrastruktur. (Geerbt von SfcInstance.)
Öffentliche Eigenschaft AutomatedPolicyEvaluationMode Gets or sets the evaluation mode.
Öffentliche Eigenschaft CategoryId Gets the ID value that uniquely identifies the category that is associated with the policy.
Öffentliche Eigenschaft Condition Gets or sets the condition.
Öffentliche Eigenschaft CreateDate Gets the date and time when the policy was created.
Öffentliche Eigenschaft CreatedBy Gets the policy store authentication credentials of the user who created the policy.
Öffentliche Eigenschaft DateModified Gets the date and time when the policy was last modified.
Öffentliche Eigenschaft Description Gets or sets the textual description of the policy.
Öffentliche Eigenschaft Enabled Gets or set the Boolean value that specifies whether the policy is enabled.
Öffentliche Eigenschaft EvaluationHistories Gets the evaluation histories collection.
Öffentliche Eigenschaft HasScript Gets the Boolean value that specifies whether the policy has a script.
Öffentliche Eigenschaft HelpLink Gets or sets a URN to additional help information for the policy.
Öffentliche Eigenschaft HelpText Gets or sets the display name for the help text.
Öffentliche Eigenschaft ID Gets the ID value that uniquely identifies the policy.
Öffentliche Eigenschaft IdentityKey Gets the key that identifies the policy.
Öffentliche Eigenschaft IsSystemObject Determines whether the Policy object is a Object.
Öffentliche Eigenschaft Metadata Returns metadata about the instance and its domain. (Geerbt von SfcInstance.)
Öffentliche Eigenschaft ModifiedBy Gets the policy store authentication credentials of the user who last modified the policy.
Öffentliche Eigenschaft Name Gets the name of the Policy object.
Öffentliche Eigenschaft ObjectSet Gets or sets the set of objects that are associated with the policy.
Öffentliche Eigenschaft Parent Gets or sets the PolicyStore that is the parent of the policy object.
Öffentliche Eigenschaft PolicyCategory Gets or sets the category that is associated with the policy.
Öffentliche Eigenschaft Properties Returns a collection instance properties. (Geerbt von SfcInstance.)
Öffentliche Eigenschaft RootCondition Gets or sets the name of the root condition for this policy.
Öffentliche Eigenschaft ScheduleUid Gets or sets the Guid that identifies the SQL Server Agent schedule that checks on the policy.
Geschützte Eigenschaft State Returns the state of the SfcInstance object. (Geerbt von SfcInstance.)
Öffentliche Eigenschaft Urn Returns the uniform resource name of the SfcInstance object. (Geerbt von SfcInstance.)

Zum Anfang

Methoden

  Name Beschreibung
Öffentliche Methode Alter Updates any Policy object property changes on the instance of SQL Server.
Öffentliche Methode Create Creates management policy item.
Geschützte Methode CreateIdentityKey Verweisen Sie nicht direkt im Code auf dieses Element. Unterstützt die SQL Server-Infrastruktur. (Geerbt von SfcInstance.)
Öffentliche Methode Discover Discovers conditions in the ObjectSet and adds them to the ISfcDependencyDiscoveryObjectSink identified by the sink parameter. (Überschreibt SfcInstance.Discover(ISfcDependencyDiscoveryObjectSink).)
Öffentliche Methode Drop Removes the policy from the instance of SQL Server.
Öffentliche Methode Equals (Geerbt von Object.)
Öffentliche Methode Evaluate(AdHocPolicyEvaluationMode, array<ISfcConnection[]) Evaluates the Policy object and applies policy to the data in identified by the targetConnections parameter.
Öffentliche Methode Evaluate(AdHocPolicyEvaluationMode, array<Object[]) Immediately executes the policy against the specified target objects by using the specified evaluation mode.
Öffentliche Methode Evaluate(AdHocPolicyEvaluationMode, SfcQueryExpression, array<ISfcConnection[]) Evaluates the Policy object and applies policy to the data in identified by the targetConnections parameter.
Geschützte Methode GetChildCollection Verweisen Sie nicht direkt im Code auf dieses Element. Unterstützt die SQL Server-Infrastruktur. (Geerbt von SfcInstance.)
Öffentliche Methode GetDomain Verweisen Sie nicht direkt im Code auf dieses Element. Unterstützt die SQL Server-Infrastruktur. (Geerbt von SfcInstance.)
Öffentliche Methode GetHashCode (Geerbt von Object.)
Öffentliche MethodeStatisches Element GetObjectFactory Gets the object factory for the object.
Öffentliche Methode GetPropertySet Returns the set of properties for the SfcInstance object. (Geerbt von SfcInstance.)
Öffentliche Methode GetType (Geerbt von Object.)
Geschützte Methode GetTypeMetadataImpl Indicates the domains that override by returning the right TypeMetadata class directly. Verweisen Sie nicht direkt im Code auf dieses Element. Unterstützt die SQL Server-Infrastruktur. (Geerbt von SfcInstance.)
Geschützte Methode InitializeUIPropertyState Verweisen Sie nicht direkt im Code auf dieses Element. Unterstützt die SQL Server-Infrastruktur. (Geerbt von SfcInstance.)
Geschützte Methode OnPropertyMetadataChanges Invoked whenever the effective value of any SfcInstance metadata is updated. (Geerbt von SfcInstance.)
Geschützte Methode OnPropertyValueChanges Invoked whenever the effective value of any SfcInstance property is updated. (Geerbt von SfcInstance.)
Öffentliche Methode ProduceConfigureScript Gets the condition of a Policy object.
Öffentliche Methode Refresh Refreshes the object's properties by reading them from the server. (Geerbt von SfcInstance.)
Öffentliche Methode Rename Renames the policy.
Geschützte Methode ResetKey Verweisen Sie nicht direkt im Code auf dieses Element. Unterstützt die SQL Server-Infrastruktur. (Geerbt von SfcInstance.)
Öffentliche Methode ScriptAlter Alters the script that is used to create the policy.
Öffentliche Methode ScriptAlterWithObjectSet Alters a previously created ISfcScript object of the Policy object.
Öffentliche Methode ScriptCreate Creates a script that is used to create the policy.
Öffentliche Methode ScriptCreateWithDependencies Creates the ISfcScript object of the Policy object.
Öffentliche Methode ScriptCreateWithObjectSet Creates the ISfcScript object of the ObjectSet.
Öffentliche Methode ScriptDrop Drops the script that is used to create the policy.
Öffentliche Methode ScriptDropWithObjectSet Drops the ISfcScript object of the ObjectSet.
Öffentliche Methode Serialize Serializes the instance to XML. (Geerbt von SfcInstance.)
Öffentliche Methode ToString Returns a string representation of the instance Urn. (Geerbt von SfcInstance.)
Öffentliche Methode UsesFacet Determines whether the facet identified by the parameter is contained by the Condition.
Öffentliche Methode Validate Validates a Policy object as specified by the mode parameter.

Zum Anfang

Ereignisse

  Name Beschreibung
Öffentliches Ereignis ConnectionProcessingFinished Represents the event activated when connection processing completes.
Öffentliches Ereignis ConnectionProcessingStarted Represents the event activated when connection processing begins.
Öffentliches Ereignis PolicyEvaluationFinished Represents the event activated when policy evaluation completes.
Öffentliches Ereignis PolicyEvaluationStarted Represents the event activated when policy evaluation begins.
Öffentliches Ereignis PropertyChanged CLS-compliant event for property changes. (Geerbt von SfcInstance.)
Öffentliches Ereignis PropertyMetadataChanged CLS-compliant event for property metadata changes. (Geerbt von SfcInstance.)
Öffentliches Ereignis TargetProcessed Represents the event activated when policy target is processed.

Zum Anfang

Felder

  Name Beschreibung
Öffentliches FeldStatisches Element HelpLinkStringMaxLength Specifies the maximum length of the link to help text.
Öffentliches FeldStatisches Element HelpTextStringMaxLength Specifies the maximum length of the help text.

Zum Anfang

Explizite Schnittstellenimplementierungen

  Name Beschreibung
Explizite SchnittstellenimplementierungPrivate Methode ISfcRenamable.Rename Renames the instance of Policy identified by the key parameter.
Explizite SchnittstellenimplementierungPrivate Methode ISfcRenamable.ScriptRename Renames a script in the policy.
Explizite SchnittstellenimplementierungPrivate Methode ISfcValidate.Validate Validates a Policy object.

Zum Anfang

Hinweise

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

Beispiele

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();

Threadsicherheit

Alle öffentlichen static (Shared in Visual Basic)-Elemente dieses Typs sind Threadsicher. Für Instanzelemente wird die Threadsicherheit nicht gewährleistet.

Siehe auch

Verweis

Microsoft.SqlServer.Management.Dmf-Namespace

Andere Ressourcen

Verwalten von Benutzern, Rollen und Anmeldungen