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

Configures recycling settings for an application pool.

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

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

type ApplicationPoolRecycling = class
    inherit ConfigurationElement

Public NotInheritable Class ApplicationPoolRecycling
Inherits ConfigurationElement

Inheritance: Object

ConfigurationElement
ApplicationPoolRecycling

Examples

The following example displays a few property values for the ApplicationPoolRecycling object. The LogEventOnRecycle property is changed to Requests and Schedule, the Microsoft.Web.Administration.ApplicationPoolPeriodicRestart.Time property is changed to 5 minutes.

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

namespace AdministrationSnippets
{
    class ApplicationPoolRecycling
    {
        public void GetApplicationPoolRecycling()
        {
            ServerManager manager = new ServerManager();
            // Get the application recycling property values.
            Console.WriteLine("DisallowOverlappingRotation:\t{0}",
                manager.ApplicationPools["DefaultAppPool"].Recycling.DisallowOverlappingRotation.ToString());
            Console.WriteLine("DisallowRotationOnConfigChange:\t{0}",
                manager.ApplicationPools["DefaultAppPool"].Recycling.DisallowRotationOnConfigChange.ToString());
            Console.WriteLine("LogEventOnRecycle:\t{0}",
                manager.ApplicationPools["DefaultAppPool"].Recycling.LogEventOnRecycle.ToString());
            Console.WriteLine("PeriodicRestart.Time:\t{0}",
                manager.ApplicationPools["DefaultAppPool"].Recycling.PeriodicRestart.Time);
            // Change the LogEventOnRecycle and PeriodicRestart.Time properties.
            manager.ApplicationPools["DefaultAppPool"].Recycling.LogEventOnRecycle = (RecyclingLogEventOnRecycle)6;
            manager.ApplicationPools["DefaultAppPool"].Recycling.PeriodicRestart.Time = TimeSpan.FromMinutes(5);
            // Commit the changes to ApplicationHost.config file.
            manager.CommitChanges();
        }
    }
}

Remarks

Unless the default application pool recycling settings are locked, individual application pool settings can override them.

When the properties of an ApplicationPoolRecycling 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)
ChildElements	Gets all the child elements of the current element. (Inherited from ConfigurationElement)
DisallowOverlappingRotation	Gets or sets the startup behavior of overlapping worker processes.
DisallowRotationOnConfigChange	Gets or sets the startup behavior of overlapping worker processes in an application pool when a configuration change is detected.
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)
LogEventOnRecycle	Gets or sets the logging behavior of a recycling application pool.
Methods	Gets a collection of methods for the configuration element. (Inherited from ConfigurationElement)
PeriodicRestart	Gets the settings for application pool recycling.
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