FPCPolicy object

Applies to: desktop apps only

The FPCPolicy object defines an enterprise policy, and its properties provide access to the configuration settings of the enterprise policy and to the set of policy rules defined in it (available only in Forefront TMG Enterprise Edition).

An enterprise policy is a policy defined on the enterprise level that can be applied to one or more arrays. An enterprise policy contains an ordered set of policy rules, which may include access rules and a placeholder that specifies the ordinal position (Order) of the set of array policy rules within the set of enterprise policy rules when the enterprise policy is applied to an array. Additional policy rules can be created for each array in the array policy on the array level.

The enterprise policy that is applied to an array is referenced by the FPCRef object held in the EnterprisePolicyUsed property of the FPCPolicyAssignment object that is accessed through the PolicyAssignment property of the FPCArray object.

When an enterprise policy is applied to an array, the enterprise policy rules with values of Order smaller than the value of Order for the placeholder are applied before the array policy rules, and the enterprise policy rules with values of Order larger than the value of Order for the placeholder are applied after the array policy rules.

Forefront TMG provides one predefined enterprise policy, called Default Policy, which contains a single access rule that denies all traffic and is assigned to each array when it is created. Default Policy cannot be modified or deleted. In particular, additional policy rules cannot be added to it.

This object is an element of an FPCPolicies collection.

Click here to see the Forefront TMG object hierarchy.

Inheritance

This object inherits from the FPCPersist object, which contains methods and properties related to the persistent storage of an object's data. They include methods for exporting the object's data to and importing it from an XML document.

Members

The FPCPolicy object has these types of members:

• Properties

Properties

The FPCPolicy object has these properties.

Property	Access type	Description
AdminSecurity	Read-only	Gets an FPCAdminSecurity object that holds the administration security settings for the enterprise policy.
CreatedTime	Read-only	Gets a Date value that specifies the date and time in Coordinated Universal Time (UTC) when the enterprise policy was created.
Description	Read/write	Gets or sets the description of the enterprise policy.
LastModifiedTime	Read-only	Gets a Date value that specifies the date and time in Coordinated Universal Time (UTC) when the enterprise policy was last modified.
Name	Read/write	Gets or sets the name of the enterprise policy.
PolicyRules	Read-only	Gets an FPCPolicyRules collection that contains all the policy rules in the enterprise policy.
Predefined	Read-only	Gets a Boolean value that indicates whether the policy is a predefined enterprise policy that was installed with Forefront TMG and cannot be modified or deleted.

 

Methods Inherited from FPCPersist

Name	Description
CancelWaitForChanges	Cancels the registration established by the WaitForChanges method (for use in C and C++ programming only).
CanImport	Returns a Boolean value that indicates whether the object's properties can be imported from the specified XML document.
Export	Recursively writes the stored values of all the properties of the object and its subobjects to the specified XML document.
ExportToFile	Recursively writes the stored values of all the properties of the object and its subobjects to the specified XML file.
GetServiceRestartMask	Retrieves a 32-bit bitmask of the FpcServices enumerated type that specifies which services need to be restarted for currently unsaved changes to take effect.
Import	Recursively copies the values of all the properties of the object and of its subobjects from the specified XML document to persistent storage.
ImportFromFile	Recursively copies the values of all the properties of the object and of its subobjects from the specified XML file to persistent storage.
LoadDocProperties	Provides the XML document's properties so that you can know what information can be imported from the document.
Refresh	Recursively reads the values of all the properties of the object and of its subobjects from persistent storage, overwriting any changes that have not been saved.
Save	Recursively writes the current values of all the properties of the object and its subobjects to persistent storage.
WaitForChanges	Registers to wait for an event indicating that the contents of the object have changed (for use in C and C++ programming only).

 

Properties Inherited from FPCPersist

Name	Description
PersistentName	Gets the persistent name of the object. The persistent name of an object is a name that is unique for the object at the respective level of the COM object hierarchy.
VendorParameterSets	Gets an FPCVendorParametersSets collection that can hold sets of custom data for extending the object.

 

Interfaces for C++ Programming

This object implements the IFPCEEPolicy interface.

Requirements

Minimum supported client	Windows Vista, None supported
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)
Version	Forefront Threat Management Gateway (TMG) 2010
IDL	Msfpccom.idl

See also

COM Objects

 

 

Build date: 7/12/2010