This topic has not yet been rated - Rate this topic

ApplicationPoolFailure Class

IIS 7.0

Defines the actions to take when an application pool fails.

System..::..Object
  Microsoft.Web.Administration..::..ConfigurationElement
    Microsoft.Web.Administration..::..ApplicationPoolFailure

Namespace:  Microsoft.Web.Administration
Assembly:  Microsoft.Web.Administration (in Microsoft.Web.Administration.dll)
public sealed class ApplicationPoolFailure : ConfigurationElement

The ApplicationPoolFailure type exposes the following members.

  Name Description
Public property Attributes Gets a configuration attribute collection that contains the list of attributes for this element. (Inherited from ConfigurationElement.)
Public property AutoShutdownExe Gets or sets the path of an executable to run when the service shuts down an application pool for rapid-fail protection.
Public property AutoShutdownParams Gets or sets command-line parameters for the executable that is specified by the AutoShutdownExe property.
Public property ChildElements Gets all the child elements of the current element. (Inherited from ConfigurationElement.)
Public property ElementTagName Gets the XML tag name of the current element. (Inherited from ConfigurationElement.)
Public property IsLocallyStored Gets a value indicating whether the configuration element is stored in a particular configuration file. (Inherited from ConfigurationElement.)
Public property Item Gets or sets an attribute with the specified name. (Inherited from ConfigurationElement.)
Public property LoadBalancerCapabilities Gets or sets the response behavior of a service when it is unavailable.
Public property Methods Gets a collection of methods for the configuration element. (Inherited from ConfigurationElement.)
Public property OrphanActionExe Gets or sets the path of an executable to run when the service orphans a worker process.
Public property OrphanActionParams Gets or sets command-line parameters for the executable named by the OrphanActionExe property.
Public property OrphanWorkerProcess Gets or sets a value indicating whether to put a worker process in an orphan state when an application pool fails.
Public property RapidFailProtection Gets or sets a value indicating whether rapid-fail protection is on or off.
Public property RapidFailProtectionInterval Gets or sets the interval of time before the failure count for a process is reset.
Public property RapidFailProtectionMaxCrashes Gets or sets the maximum number of failures allowed within the time specified by the RapidFailProtectionInterval property.
Public property RawAttributes Gets the raw attribute names and values for the current configuration element. (Inherited from ConfigurationElement.)
Public property Schema Gets the schema for the current element. (Inherited from ConfigurationElement.)
Top
  Name Description
Public method Delete (Inherited from ConfigurationElement.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetAttribute Returns a ConfigurationAttribute object that represents the requested attribute. (Inherited from ConfigurationElement.)
Public method GetAttributeValue Returns the value of the specified attribute. (Inherited from ConfigurationElement.)
Public method GetChildElement(String) Returns a child element that is under the current configuration element and has the specified name. (Inherited from ConfigurationElement.)
Public method GetChildElement(String, Type) Returns a child element that is under the current configuration element and has the specified name and type. (Inherited from ConfigurationElement.)
Public method GetCollection()()()() Returns the default collection for the current configuration element. (Inherited from ConfigurationElement.)
Public method GetCollection(String) Returns all configuration elements that belong to the current configuration element. (Inherited from ConfigurationElement.)
Public method GetCollection(Type) Returns the configuration element that has the specified type and is under the current configuration element. (Inherited from ConfigurationElement.)
Public method GetCollection(String, Type) Returns the configuration element that has the specified name and type and is under the current configuration element. (Inherited from ConfigurationElement.)
Public method GetHashCode (Inherited from Object.)
Public method GetMetadata Returns metadata values from the element schema. (Inherited from ConfigurationElement.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method SetAttributeValue Sets the value of the specified attribute. (Inherited from ConfigurationElement.)
Public method SetMetadata Sets metadata values from the element schema. (Inherited from ConfigurationElement.)
Public method ToString (Inherited from Object.)
Top

This class represents the application pool failure configuration in the IIS configuration system. The properties correspond directly to the attributes of the failure element for the applicationPoolDefaults element for the applicationPools element.

When the properties of an ApplicationPoolFailure object are modified, you must call the ServerManager..::..CommitChanges method to persist the values to the ApplicationHost.config file and to IIS Manager.

The following example displays the property values for the ApplicationPoolFailure object. If the RapidFailProtection property is set to true, the RapidFailProtectionInterval and RapidFailProtectionMaxCrashes property values are set and the application pool failures are committed.


using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.Web.Administration;
using Microsoft.Web.Management;

namespace AdministrationSnippets
{
    class ApplicationPoolFailure
    {
        public void GetApplicationPoolFailures()
        {
            ServerManager manager = new ServerManager();
            // Get the application pool failures.
            Console.WriteLine("AutoShutdownExe:\t{0}",
                manager.ApplicationPoolDefaults.Failure.AutoShutdownExe);
            Console.WriteLine("AutoShutdownParams:\t{0}",
                manager.ApplicationPoolDefaults.Failure.AutoShutdownParams);
            Console.WriteLine("LoadBalancerCapabilities:\t{0}",
                manager.ApplicationPoolDefaults.Failure.LoadBalancerCapabilities);
            Console.WriteLine("OrphanActionExe:\t{0}",
                manager.ApplicationPoolDefaults.Failure.OrphanActionExe);
            Console.WriteLine("OrphanActionParams:\t{0}",
                manager.ApplicationPoolDefaults.Failure.OrphanActionParams);
            Console.WriteLine("OrphanWorkerProcess:\t{0}",
                manager.ApplicationPoolDefaults.Failure.OrphanWorkerProcess);
            Console.WriteLine("RapidFailProtection:\t{0}",
                manager.ApplicationPoolDefaults.Failure.RapidFailProtection);
            Console.WriteLine("RapidFailProtectionInterval:\t{0}",
                manager.ApplicationPoolDefaults.Failure.RapidFailProtectionInterval);
            Console.WriteLine("RapidFailProtectionMaxCrashes:\t{0}",
                manager.ApplicationPoolDefaults.Failure.RapidFailProtectionMaxCrashes);
            // If the RapidFailProtection is enabled, set 
            // the Interval and maximum crashes properties.
            if (manager.ApplicationPoolDefaults.Failure.RapidFailProtection)
            {
                manager.ApplicationPoolDefaults.Failure.
                    RapidFailProtectionInterval = (TimeSpan.FromMinutes(10));
                manager.ApplicationPoolDefaults.Failure.
                    RapidFailProtectionMaxCrashes = 6;
            }
            // Commit the changes to ApplicationHost.config file.
            manager.CommitChanges();
        }
    }
}


Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ