PolicyStore Class

 

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

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

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

[TypeConverterAttribute(typeof(LocalizableTypeConverter))]
[StrongNameIdentityPermissionAttribute(SecurityAction.LinkDemand, 
	PublicKey = "0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8")]
public sealed class PolicyStore : SfcInstance, ISfcAlterable, 
	IAlterable, ISfcDomain, ISfcDomainLite, ISfcHasConnection, ISfcSerializableUpgrade, 
	ISfcValidate

NameDescription
System_CAPS_pubmethodPolicyStore()

Initializes a new instance of the PolicyStore class.

System_CAPS_pubmethodPolicyStore(SfcConnection)

Initializes a new instance of the PolicyStore class.

NameDescription
System_CAPS_protpropertyAbstractIdentityKey

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubpropertyConditions

Represents a collection of Condition objects. Each Condition object represents a policy-based Management condition.

System_CAPS_pubpropertyEnabled

Gets or sets whether the policy store is enabled.

System_CAPS_pubpropertySystem_CAPS_staticFacets

Represents a collection of FacetInfo objects. Each FacetInfo object represents a policy-based Management registered facet.

System_CAPS_pubpropertyHistoryRetentionInDays

Gets or sets the number of days the policy store retains history.

System_CAPS_pubpropertyIdentityKey

Gets the identity key.

System_CAPS_pubpropertyLogOnSuccess

Gets or sets whether log-on succeeded.

System_CAPS_pubpropertyMetadata

Returns metadata about the instance and its domain.(Inherited from SfcInstance.)

System_CAPS_pubpropertyName

Gets the name of the policy store.

System_CAPS_pubpropertyObjectSets

Represents a collection of ObjectSet objects. Each ObjectSet object represents a policy-based Management object set.

System_CAPS_pubpropertyParent

Gets or sets the instance parent via the keychain.(Inherited from SfcInstance.)

System_CAPS_pubpropertyPolicies

Represents a collection of Policy objects. Each Policy object represents a policy-based Management policy.

System_CAPS_pubpropertyPolicyCategories

Represents a collection of PolicyCategory objects. Each PolicyCategory object represents a policy-based Management policy category.

System_CAPS_pubpropertyPolicyCategorySubscriptions

Represents a collection of PolicyCategorySubscription objects. Each PolicyCategorySubscription object represents a policy-based Management policy category subscription.

System_CAPS_pubpropertyProperties

Returns a collection instance properties.(Inherited from SfcInstance.)

System_CAPS_pubpropertySqlStoreConnection

Gets or sets the SqlStoreConnection object.

System_CAPS_protpropertyState

Returns the state of the SfcInstance object.(Inherited from SfcInstance.)

System_CAPS_pubpropertyUrn

Returns the uniform resource name of the SfcInstance object.(Inherited from SfcInstance.)

NameDescription
System_CAPS_pubmethodAlter()

Alters a previously created PolicyStore object.

System_CAPS_protmethodCreateIdentityKey()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodCreatePolicyFromFacet(Object, String, String, String, XmlWriter)

Creates new policy from an Object and an XmlWriter object.

System_CAPS_pubmethodCreatePolicyFromFacet(SfcQueryExpression, String, String, String)

Creates new policy from an SfcQueryExpression object and names.

System_CAPS_pubmethodCreatePolicyFromFacet(SfcQueryExpression, String, String, String, XmlWriter)

Creates new policy from an SfcQueryExpression object and an XmlWriter object.

System_CAPS_pubmethodDeserializePolicy(XmlReader, Boolean, Boolean)

Deserializes a single policy and its associated condition from the specified XML reader into the policy store.

System_CAPS_pubmethodDiscover(ISfcDependencyDiscoveryObjectSink)
System_CAPS_pubmethodEnumApplicablePolicies(SfcQueryExpression)

Enumerates policy items specified by an SfcQueryExpression object.

System_CAPS_pubmethodEnumApplicablePolicyCategories(SfcQueryExpression)

Enumerates conditions specified by an SfcQueryExpression object.

System_CAPS_pubmethodEnumConditionsOnFacet(String)

Returns a list of conditions that are associated with the specified facet.

System_CAPS_pubmethodEnumConditionsOnFacet(String, PolicyStore.EnumerationMode)

Enumerates a StringCollection of conditions.

System_CAPS_pubmethodSystem_CAPS_staticEnumDomainFacets(String[])

Enumerates facets in a domain.

System_CAPS_pubmethodEnumPoliciesOnFacet(String)

Returns a list of policies associated with the specified facet.

System_CAPS_pubmethodEnumPoliciesOnFacet(String, PolicyStore.EnumerationMode)

Enumerates policy items on a facet.

System_CAPS_pubmethodEnumPolicyCategories()

Returns an enumerated list of policy category information.

System_CAPS_pubmethodEnumRootConditions(Type)

Returns a list of root conditions for the specified type.

System_CAPS_pubmethodSystem_CAPS_staticEnumRootFacets(Type)

Returns a list of root facets for the specified type.

System_CAPS_pubmethodEnumTargetSetConditions(Type)

Returns a list of target set conditions for the specified type.

System_CAPS_pubmethodEnumTargetSetConditions(Type, PolicyStore.EnumerationMode)

Enumerates conditions on the target.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodEraseSystemHealthPhantomRecords()

Deletes system health phantom records specified by a SfcQueryExpression.

System_CAPS_pubmethodGetAggregatedHealthState(SfcQueryExpression)

Deletes system health phantom records specified by a SfcQueryExpression.

System_CAPS_protmethodGetChildCollection(String)

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodGetDomain()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetPropertySet()

Returns the set of properties for the SfcInstance object.(Inherited from SfcInstance.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodGetTypeMetadataImpl()

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.)

System_CAPS_pubmethodImportPolicy(XmlReader, ImportPolicyEnabledState, Boolean, Boolean)

Imports a single policy and its associated condition from the given XML reader into the policy store.

System_CAPS_protmethodInitializeUIPropertyState()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodMarkSystemObject(Object, Boolean)

Sets the name of a Policy, Condition, or ObjectSet.

System_CAPS_protmethodOnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs)

Invoked whenever the effective value of any SfcInstance metadata is updated. (Inherited from SfcInstance.)

System_CAPS_protmethodOnPropertyValueChanges(PropertyChangedEventArgs)

Invoked whenever the effective value of any SfcInstance property is updated. (Inherited from SfcInstance.)

System_CAPS_pubmethodPurgeHealthState()

Removes the health data for a specified tree/subtree.

System_CAPS_pubmethodPurgeHealthState(SfcQueryExpression)

Removes the health data for a specified tree/subtree.

System_CAPS_pubmethodRefresh()

Refreshes the object's properties by reading them from the server.(Inherited from SfcInstance.)

System_CAPS_pubmethodRepairPolicyAutomation()

The RepairPolicyAutomation method recreates all necessary artifacts for all automated policies.

System_CAPS_protmethodResetKey()

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SfcInstance.)

System_CAPS_pubmethodScriptAlter()

Alters the script associated with this policy store.

System_CAPS_pubmethodSerialize(XmlWriter)

Serializes the instance to XML.(Inherited from SfcInstance.)

System_CAPS_pubmethodStartSerializationUpgrade()

Starts a serialization upgrade.

System_CAPS_pubmethodSubscribeToPolicyCategory(SfcQueryExpression, String)

Subscribes the policy store to the category specified by the policyCategory and target parameters.

System_CAPS_pubmethodToString()

Returns the T:Microsoft.SqlServer.Managment.Dmf.PolicyStore object as a string value.(Overrides SfcInstance.ToString().)

System_CAPS_pubmethodUnsubscribeFromPolicyCategory(SfcQueryExpression, String)

Unsubscribes the policy store from the category specified by the policyCategory and target parameters.

NameDescription
System_CAPS_pubeventPropertyChanged

Occurs when a property value changes.(Inherited from SfcInstance.)

System_CAPS_pubeventPropertyMetadataChanged

Occurs when the metadata for a property has changed.(Inherited from SfcInstance.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcDomain.GetExecutionEngine()

Gets a new ISfcExecutionEngine object.

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcDomain.GetKey(IUrnFragment)

Gets a new SfcKey of type determined by the name property of urnFragment parameter.

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcDomain.GetType(String)

Gets a Type object specified by the typeName parameter.

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcDomain.GetTypeMetadata(String)

Gets a T:Microsoft.SqlServer.Management.Sdk.Sfc.SfcTypeMetadata object identified by the typeName parameter.

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcDomain.UseSfcStateManagement()

Use the SFC state management to return true.

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcDomainLite.GetLogicalVersion()

Indicates the logical version to get in the domain.

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcHasConnection.GetConnection()

Indicates the connection to get.

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcHasConnection.GetConnection(SfcObjectQueryMode)

Indicates the connection to get using the SfcObjectQuery mode.

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcHasConnection.SetConnection(ISfcConnection)

Indicates the connection to set.

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcValidate.Validate(String, Object[])

Validates the Policy objects in the PolicyStore.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyISfcDomainLite.DomainInstanceName

Gets the domain instance name.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyISfcDomainLite.DomainName

Gets the domain name for the object.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyISfcHasConnection.ConnectionContext

Gets the connection context.

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.

System_CAPS_noteNote

The PolicyStore class implements ISfcDomain, which specifies the connection point to any object domain defined using the Microsoft SFC.

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: