RecycleAppProvider Class

Summary

Recycles, starts, or stops an application's app pool, or unloads an application's app domains on IIS 7.
graph BT Type-->Base0["MsDeployProvider"] click Base0 "/api/Cake.MsDeploy.Providers/MsDeployProvider" Base0-->Base1["Object"] Type-.->Interface0["IMsDeployProvider"] click Interface0 "/api/Cake.MsDeploy.Providers/IMsDeployProvider" Type-.->Interface1["IMsDeployArgument"] click Interface1 "/api/Cake.MsDeploy/IMsDeployArgument" Type["RecycleAppProvider"] class Type type-node

Syntax

public class RecycleAppProvider : MsDeployProvider, IMsDeployProvider, IMsDeployArgument

Constructors

Name Summary
RecycleAppProvider()

Properties

Name Value Summary
AppendQuotesToPath bool
Determines if the Path is surrounded in "quotes"
Inherited from MsDeployProvider
AuthenticationType Nullable<AuthenticationScheme>
Authentication scheme to use. NTLM is the default setting. If the wmsvc option is specified, then Basic is the default setting.
Inherited from MsDeployProvider
ComputerName string
Name of remote computer or proxy-URL
Inherited from MsDeployProvider
Direction Direction
Determines if the Provider is a source or destination
Inherited from MsDeployProvider
IncludeAcls Nullable<bool>
If true, include ACLs in the operation (applies to the file system, registry, and metabase).
Inherited from MsDeployProvider
Password string
Password of the user for remote connections (required if using Basic authentication).
Inherited from MsDeployProvider
Path string
Path of the provider type
Inherited from MsDeployProvider
PublishSettings string
Inherited from MsDeployProvider
RecycleMode Nullable<RecycleMode>
One of 4 values to control what action is taken on the application pool: RecycleAppPool, StartAppPool, StopAppPool, or UnloadAppDomain. The default is RecycleAppPool.
RequirePath bool
Determines if the Path argument is required for the MsDeployProvider
Inherited from MsDeployProvider
TempAgent Nullable<bool>
Inherited from MsDeployProvider
Timeout Nullable<int>
Amount of time, in milliseconds, to wait for an application pool to recycle, start or stop. To return immediately after requesting the operation (without waiting for completion), specify zero. To use the application pool's startupTimeLimit and shutdownTimeLimit (or the sum of their values in the case of a recycle), specify -1. The default value is -1.
Type string
Username string
User name to authenticate for remote connections (required if using Basic authentication).
Inherited from MsDeployProvider
WebManagementService string
Name of remote computer or proxy-URL for the Web Management Service (WMSvc). Assumes that the service is listening on port 8172.
Inherited from MsDeployProvider

Methods

Name Value Summary
AdditionalSettings(StringBuilder) void
AppendCommandLineArgument(StringBuilder) void
Converts the object into its MSDeploy command line equivalent and Appends it to the stringbuilder
Inherited from MsDeployProvider
ToCommandLineArgument() string
Converts the MSDeploy Provider into its commmand line argument
Inherited from MsDeployProvider

Extension Methods

Name Value Summary
Dump<RecycleAppProvider>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<RecycleAppProvider>(RecycleAppProvider[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<RecycleAppProvider>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<RecycleAppProvider>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<RecycleAppProvider>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<RecycleAppProvider>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin