PolicyStore Class
The PolicyStore type is the root of the DMF object model.
Inheritance Hierarchy
System.Object
Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance
Microsoft.SqlServer.Management.Dmf.PolicyStore
Namespace: Microsoft.SqlServer.Management.Dmf
Assembly: Microsoft.SqlServer.Dmf (in Microsoft.SqlServer.Dmf.dll)
Syntax
'Declaration
<TypeConverterAttribute(GetType(LocalizableTypeConverter))> _
<StrongNameIdentityPermissionAttribute(SecurityAction.LinkDemand, PublicKey := "0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8")> _
Public NotInheritable Class PolicyStore _
Inherits SfcInstance _
Implements ISfcAlterable, IAlterable, ISfcDomain, ISfcDomainLite, _
ISfcHasConnection, ISfcSerializableUpgrade, ISfcValidate
'Usage
Dim instance As PolicyStore
[TypeConverterAttribute(typeof(LocalizableTypeConverter))]
[StrongNameIdentityPermissionAttribute(SecurityAction.LinkDemand, PublicKey = "0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8")]
public sealed class PolicyStore : SfcInstance,
ISfcAlterable, IAlterable, ISfcDomain, ISfcDomainLite, ISfcHasConnection,
ISfcSerializableUpgrade, ISfcValidate
[TypeConverterAttribute(typeof(LocalizableTypeConverter))]
[StrongNameIdentityPermissionAttribute(SecurityAction::LinkDemand, PublicKey = L"0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8")]
public ref class PolicyStore sealed : public SfcInstance,
ISfcAlterable, IAlterable, ISfcDomain, ISfcDomainLite, ISfcHasConnection,
ISfcSerializableUpgrade, ISfcValidate
[<SealedAttribute>]
[<TypeConverterAttribute(typeof(LocalizableTypeConverter))>]
[<StrongNameIdentityPermissionAttribute(SecurityAction.LinkDemand, PublicKey = "0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8")>]
type PolicyStore =
class
inherit SfcInstance
interface ISfcAlterable
interface IAlterable
interface ISfcDomain
interface ISfcDomainLite
interface ISfcHasConnection
interface ISfcSerializableUpgrade
interface ISfcValidate
end
public final class PolicyStore extends SfcInstance implements ISfcAlterable, IAlterable, ISfcDomain, ISfcDomainLite, ISfcHasConnection, ISfcSerializableUpgrade, ISfcValidate
The PolicyStore type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
PolicyStore() | Initializes a new instance of the PolicyStore class. |
|
PolicyStore(SfcConnection) | Initializes a new instance of the PolicyStore class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Protected property") |
AbstractIdentityKey | Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.) |
.gif "Public property") |
Conditions | Represents a collection of Condition objects. Each Condition object represents a policy-based Management condition. |
|
Enabled | Gets or sets whether the policy store is enabled. |
.gif "Static member") |
Facets | Represents a collection of FacetInfo objects. Each FacetInfo object represents a policy-based Management registered facet. |
|
HistoryRetentionInDays | Gets or sets the number of days the policy store retains history. |
|
IdentityKey | Gets the identity key. |
|
LogOnSuccess | Gets or sets whether log-on succeeded. |
|
Metadata | Returns metadata about the instance and its domain. (Inherited from SfcInstance.) |
|
Name | Gets the name of the policy store. |
|
ObjectSets | Represents a collection of ObjectSet objects. Each ObjectSet object represents a policy-based Management object set. |
|
Parent | Gets or sets the instance parent via the keychain. (Inherited from SfcInstance.) |
|
Policies | Represents a collection of Policy objects. Each Policy object represents a policy-based Management policy. |
|
PolicyCategories | Represents a collection of PolicyCategory objects. Each PolicyCategory object represents a policy-based Management policy category. |
|
PolicyCategorySubscriptions | Represents a collection of PolicyCategorySubscription objects. Each PolicyCategorySubscription object represents a policy-based Management policy category subscription. |
|
Properties | Returns a collection instance properties. (Inherited from SfcInstance.) |
|
SqlStoreConnection | Gets or sets the SqlStoreConnection object. |
|
State | Returns the state of the SfcInstance object. (Inherited from SfcInstance.) |
|
Urn | Returns the uniform resource name of the SfcInstance object. (Inherited from SfcInstance.) |
Top
Methods
| Name | Description | |
|---|---|---|
|
Alter | Alters a previously created PolicyStore object. |
.gif "Protected method") |
CreateIdentityKey | Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.) |
|
CreatePolicyFromFacet(SfcQueryExpression, String, String, String) | Creates new policy from an SfcQueryExpression object and names. |
|
CreatePolicyFromFacet(Object, String, String, String, XmlWriter) | Creates new policy from an Object and an XmlWriter object. |
|
CreatePolicyFromFacet(SfcQueryExpression, String, String, String, XmlWriter) | Creates new policy from an SfcQueryExpression object and an XmlWriter object. |
|
DeserializePolicy | Deserializes a single policy and its associated condition from the specified XML reader into the policy store. |
|
Discover | Discovers dependency relationships for the specified sink. (Overrides SfcInstance.Discover(ISfcDependencyDiscoveryObjectSink).) |
|
EnumApplicablePolicies | Enumerates policy items specified by an SfcQueryExpression object. |
|
EnumApplicablePolicyCategories | Enumerates conditions specified by an SfcQueryExpression object. |
|
EnumConditionsOnFacet(String) | Returns a list of conditions that are associated with the specified facet. |
|
EnumConditionsOnFacet(String, PolicyStore.EnumerationMode) | Enumerates a StringCollection of conditions. |
|
EnumDomainFacets | Enumerates facets in a domain. |
|
EnumPoliciesOnFacet(String) | Returns a list of policies associated with the specified facet. |
|
EnumPoliciesOnFacet(String, PolicyStore.EnumerationMode) | Enumerates policy items on a facet. |
|
EnumPolicyCategories | Returns an enumerated list of policy category information. |
|
EnumRootConditions | Returns a list of root conditions for the specified type. |
|
EnumRootFacets | Returns a list of root facets for the specified type. |
|
EnumTargetSetConditions(Type) | Returns a list of target set conditions for the specified type. |
|
EnumTargetSetConditions(Type, PolicyStore.EnumerationMode) | Enumerates conditions on the target. |
|
Equals | (Inherited from Object.) |
|
EraseSystemHealthPhantomRecords | Deletes system health phantom records specified by a SfcQueryExpression. |
|
GetAggregatedHealthState | Deletes system health phantom records specified by a SfcQueryExpression. |
|
GetChildCollection | Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.) |
|
GetDomain | Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.) |
|
GetHashCode | (Inherited from Object.) |
|
GetPropertySet | Returns the set of properties for the SfcInstance object. (Inherited from SfcInstance.) |
|
GetType | (Inherited from Object.) |
|
GetTypeMetadataImpl | Indicates the domains that override by returning the right TypeMetadata class directly. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.) |
|
ImportPolicy | Imports a single policy and its associated condition from the given XML reader into the policy store. |
|
InitializeUIPropertyState | Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.) |
|
MarkSystemObject | Sets the name of a Policy, Condition, or ObjectSet. |
|
OnPropertyMetadataChanges | Invoked whenever the effective value of any SfcInstance metadata is updated. (Inherited from SfcInstance.) |
|
OnPropertyValueChanges | Invoked whenever the effective value of any SfcInstance property is updated. (Inherited from SfcInstance.) |
|
PurgeHealthState() | Removes the health data for a specified tree/subtree. |
|
PurgeHealthState(SfcQueryExpression) | Removes the health data for a specified tree/subtree. |
|
Refresh | Refreshes the object's properties by reading them from the server. (Inherited from SfcInstance.) |
|
RepairPolicyAutomation | The RepairPolicyAutomation method recreates all necessary artifacts for all automated policies. |
|
ResetKey | Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.) |
|
ScriptAlter | Alters the script associated with this policy store. |
|
Serialize | Serializes the instance to XML. (Inherited from SfcInstance.) |
|
StartSerializationUpgrade | Starts a serialization upgrade. |
|
SubscribeToPolicyCategory | Subscribes the policy store to the category specified by the policyCategory and target parameters. |
|
ToString | Returns the PolicyStore object as a string value. (Overrides SfcInstance.ToString().) |
|
UnsubscribeFromPolicyCategory | Unsubscribes the policy store from the category specified by the policyCategory and target parameters. |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
PropertyChanged | CLS-compliant event for property changes. (Inherited from SfcInstance.) |
|
PropertyMetadataChanged | CLS-compliant event for property metadata changes. (Inherited from SfcInstance.) |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
ISfcDomain.GetExecutionEngine | Gets a new ISfcExecutionEngine object. |
|
ISfcDomain.GetKey | Gets a new SfcKey of type determined by the name property of urnFragment parameter. |
|
ISfcDomain.GetType | Gets a Type object specified by the typeName parameter. |
|
ISfcDomain.GetTypeMetadata | Gets a T:Microsoft.SqlServer.Management.Sdk.Sfc.SfcTypeMetadata object identified by the typeName parameter. |
|
ISfcDomain.UseSfcStateManagement | Use the SFC state management to return true. |
.gif "Private property") |
ISfcDomainLite.DomainInstanceName | Gets the name of the domain instance. |
|
ISfcDomainLite.DomainName | Gets the domain name. |
|
ISfcDomainLite.GetLogicalVersion | Indicates the logical version to get in the domain. |
|
ISfcHasConnection.ConnectionContext | Gets the connection context. |
|
ISfcHasConnection.GetConnection() | Indicates the connection to get. |
|
ISfcHasConnection.GetConnection(SfcObjectQueryMode) | Indicates the connection to get using the SfcObjectQuery mode. |
|
ISfcHasConnection.SetConnection | Indicates the connection to set. |
|
ISfcValidate.Validate | Validates the Policy objects in the PolicyStore. |
Top
Remarks
Using the PolicyStore object you can:
Hold a connection to the whole object model.
Access the collection of policies, conditions, policy groups, subscriptions and facets that are immediate children of the PolicyStore object.
Review the policy execution history.
Review applicable policies for a given target type.
Subscribe to policies.
Serialize and deserialize policies.
Create a policy from a facet.
Note
The PolicyStore class implements ISfcDomain, which specifies the connection point to any object domain defined using the Microsoft SFC.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.