FPCRoutingRule object
Applies to: desktop apps only
The FPCRoutingRule object represents a single routing rule, or Web chaining rule, that has been defined in a Forefront TMG array. Web chaining rules determine whether a Web proxy client request is sent directly to the requested destination, to another upstream proxy server, or to a specified host. You can use this object to access all attributes of each Web chaining rule defined in an array.
Note Web chaining rules apply to requests from Web proxy clients, including requests from Web browsers running on Forefront TMG Client and Firewall Client computers. If you want to foward requests from Forefront TMG Client and Firewall Client computers and from SecureNAT clients that are not handled by the Forefront TMG Web proxy to an upstream Forefront TMG computer, you must configure firewall chaining by setting the properties of the FPCFirewallChaining object.
Forefront TMG is installed with the Default Web chaining rule. This rule, together with the Default cache rule, initially specifies that all Web proxy client requests are sent as HTTP requests directly to the applicable Web server if a valid version of the requested object that can be returned to the client is not found in the Forefront TMG cache. The Default Web chaining rule is applied last, and its position in the list of rules cannot be changed. You can modify the Default Web chaining rule's action and how it redirects outgoing Web proxy client requests, but you cannot delete it.
This object is an element of an FPCRoutingRules collection, and a new object representing a Web chaining rule can be created by calling the Add method of this collection.
.png "Ff826160.bkbutton(en-us,VS.85).png")
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 an object's data to and importing it from an XML document.
Members
The FPCRoutingRule object has these types of members:
- Properties
Properties
The FPCRoutingRule object has these properties.
| Property | Access type | Description |
|---|---|---|
| Read/write | Gets or sets a Boolean value that indicates whether Basic credentials are forwarded to an upstream proxy server for authenticating the client. |
|
| Read/write | Gets or sets the description of the rule. |
|
| Read-only | Gets an FPCRefs collection that contains references to the FPCDomainNameSet collections defining the domain name sets included in or excluded from the destinations to which the rule applies. |
|
| Read-only | Gets an FPCSelectionIPs object that specifies the complete set of destination IP addresses to which the rule applies. |
|
| Read/write | Gets or sets a Boolean value that indicates whether this rule is enabled. |
|
| Read-only | Gets a Boolean value that indicates whether the rule is preinstalled and cannot be deleted. |
|
| Read/write | Gets or sets the name of the rule. |
|
| Read/write | Gets or sets a value from the FpcPublishProtocolRedirectionType enumerated type that specifies the protocol to use when redirecting (bridging) HTTP requests arriving on a nonsecure channel. |
|
| Read-only | Gets the ordinal position of the rule in the list of routing rules, which corresponds to their order of application. |
|
| Read-only | Gets an FPCPrimaryRoute object that represents the primary route used to route requests from Web proxy clients. |
|
| Read/write | Gets or sets a value from the FpcPublishProtocolRedirectionType enumerated type that specifies the protocol to use when redirecting (bridging) SSL requests that came on a secure channel. |
|
| Read/write | Gets or sets an FPCCertificate object that represents the SSL client certificate to use when the Forefront TMG Web proxy authenticates to a Web server or an upstream proxy server. |
|
| Read/write | Gets or sets a value from the FpcSSLRequireSecureChannelMode enumerated type that indicates whether a secure channel is required and whether 128-bit encryption is required. |
|
| Read-only | Gets an FPCRefs collection that contains references to the FPCURLSet collections defining the URL sets included in or excluded from the destinations to which the rule applies. |
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 IFPCRoutingRule 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
Build date: 7/12/2010