ApplicationPoolFailure Class

Reference

Definition

Namespace:: Microsoft.Web.Administration

Assembly:: Microsoft.Web.Administration.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Defines the actions to take when an application pool fails.

public ref class ApplicationPoolFailure sealed : Microsoft::Web::Administration::ConfigurationElement

public sealed class ApplicationPoolFailure : Microsoft.Web.Administration.ConfigurationElement

type ApplicationPoolFailure = class
    inherit ConfigurationElement

Public NotInheritable Class ApplicationPoolFailure
Inherits ConfigurationElement

Inheritance: Object

ConfigurationElement
ApplicationPoolFailure

Examples

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();
        }
    }
}

Remarks

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 Microsoft.Web.Administration.ServerManager.CommitChanges method to persist the values to the ApplicationHost.config file and to IIS Manager.

Properties

Attributes	Gets a configuration attribute collection that contains the list of attributes for this element. (Inherited from ConfigurationElement)
AutoShutdownExe	Gets or sets the path of an executable to run when the service shuts down an application pool for rapid-fail protection.
AutoShutdownParams	Gets or sets command-line parameters for the executable that is specified by the AutoShutdownExe property.
ChildElements	Gets all the child elements of the current element. (Inherited from ConfigurationElement)
ElementTagName	(Inherited from ConfigurationElement)
IsLocallyStored	Gets a value indicating whether the configuration element is stored in a particular configuration file. (Inherited from ConfigurationElement)
Item[String]	Gets or sets an attribute with the specified name. (Inherited from ConfigurationElement)
LoadBalancerCapabilities	Gets or sets the response behavior of a service when it is unavailable.
Methods	Gets a collection of methods for the configuration element. (Inherited from ConfigurationElement)
OrphanActionExe	Gets or sets the path of an executable to run when the service orphans a worker process.
OrphanActionParams	Gets or sets command-line parameters for the executable named by the OrphanActionExe property.
OrphanWorkerProcess	Gets or sets a value indicating whether to put a worker process in an orphan state when an application pool fails.
RapidFailProtection	Gets or sets a value indicating whether rapid-fail protection is on or off.
RapidFailProtectionInterval	Gets or sets the interval of time before the failure count for a process is reset.
RapidFailProtectionMaxCrashes	Gets or sets the maximum number of failures allowed within the time specified by the RapidFailProtectionInterval property.
RawAttributes	(Inherited from ConfigurationElement)
Schema	Gets the schema for the current element. (Inherited from ConfigurationElement)

Methods

Delete()	(Inherited from ConfigurationElement)
GetAttribute(String)	Returns a ConfigurationAttribute object that represents the requested attribute. (Inherited from ConfigurationElement)
GetAttributeValue(String)	Returns the value of the specified attribute. (Inherited from ConfigurationElement)
GetChildElement(String, Type)	Returns a child element that is under the current configuration element and has the specified name and type. (Inherited from ConfigurationElement)
GetChildElement(String)	Returns a child element that is under the current configuration element and has the specified name. (Inherited from ConfigurationElement)
GetCollection()	Returns the default collection for the current configuration element. (Inherited from ConfigurationElement)
GetCollection(String, Type)	Returns the configuration element that has the specified name and type and is under the current configuration element. (Inherited from ConfigurationElement)
GetCollection(String)	Returns all configuration elements that belong to the current configuration element. (Inherited from ConfigurationElement)
GetCollection(Type)	Returns the configuration element that has the specified type and is under the current configuration element. (Inherited from ConfigurationElement)
GetMetadata(String)	Returns metadata values from the element schema. (Inherited from ConfigurationElement)
SetAttributeValue(String, Object)	Sets the value of the specified attribute. (Inherited from ConfigurationElement)
SetMetadata(String, Object)	Sets metadata values from the element schema. (Inherited from ConfigurationElement)

Applies to

Share via