Class WebDeploySettings

Used within WebDeployTasks.

Inheritance
System.Object
Nuke.Common.Tooling.ToolSettings
WebDeploySettings
Implements
Nuke.Common.Tooling.ISettingsEntity
Inherited Members
Nuke.Common.Tooling.ToolSettings.GetArguments()
Nuke.Common.Tooling.ToolSettings.HasValidToolPath()
Nuke.Common.Tooling.ToolSettings.ConfigureArguments(Nuke.Common.Tooling.Arguments)
Nuke.Common.Tooling.ToolSettings.GetArgumentsInternal()
Nuke.Common.Tooling.ToolSettings.ToString()
Nuke.Common.Tooling.ToolSettings.ToolPath
Nuke.Common.Tooling.ToolSettings.WorkingDirectory
Nuke.Common.Tooling.ToolSettings.EnvironmentVariables
Nuke.Common.Tooling.ToolSettings.ExecutionTimeout
Nuke.Common.Tooling.ToolSettings.LogOutput
Nuke.Common.Tooling.ToolSettings.ArgumentConfigurator
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Nuke.WebDeploy
Assembly: Nuke.WebDeploy.dll
Syntax
[PublicAPI]
[Serializable]
public class WebDeploySettings : ToolSettings, ISettingsEntity

Properties

| Improve this Doc View Source

AppOfflineHtmlTemplate

A html string that is used for the content of the App_Offline.htm file. If not specified, a default message is shown.

Declaration
public virtual string AppOfflineHtmlTemplate { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

EnableAppOfflineRule

Toggles enabling of the AppOfflineRule. If enabled, WebDeploy will create a file called App_Offline.htm before copying the content and remove it afterwards. This makes IIS suspend the site during the deployment process and frees locked files.

Declaration
public virtual bool? EnableAppOfflineRule { get; }
Property Value
Type Description
System.Nullable<System.Boolean>
| Improve this Doc View Source

EnableDoNotDeleteRule

Toggles enabling of the DoNotDelete rule

Declaration
public virtual bool? EnableDoNotDeleteRule { get; }
Property Value
Type Description
System.Nullable<System.Boolean>
| Improve this Doc View Source

Parameters

Additional web deploy sync parameters.

Declaration
public virtual IReadOnlyDictionary<string, string> Parameters { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyDictionary<System.String, System.String>
| Improve this Doc View Source

Password

The password used for the deployment via http basic authentication

Declaration
public virtual string Password { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

PublishUrl

The PublishUrl should include the site parameter, e.g.: https://appname.scm.azurewebsites.net:443/msdeploy.axd?site=appname

Declaration
public virtual string PublishUrl { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

RetryAttempts

Count of retry attempts to perform before giving up. This is useful when sites take a few moments to spin down and release locked files.

Declaration
public virtual int? RetryAttempts { get; }
Property Value
Type Description
System.Nullable<System.Int32>
| Improve this Doc View Source

RetryInterval

Delay in milliseconds between retry attempts.

Declaration
public virtual int? RetryInterval { get; }
Property Value
Type Description
System.Nullable<System.Int32>
| Improve this Doc View Source

ShowWhatIf

If enabled, no actual operations are performed. The output is still printed to the console to display what would have happened.

Declaration
public virtual bool? ShowWhatIf { get; }
Property Value
Type Description
System.Nullable<System.Boolean>
| Improve this Doc View Source

SiteName

The name of the site for web deploy.

Declaration
public virtual string SiteName { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

SourcePath

The source folder that should be synced to, e.g. the local publish folder.

Declaration
public virtual string SourcePath { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Username

The username used for the deployment via http basic authentication

Declaration
public virtual string Username { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

WrapAppOffline

Azure Web Apps in IIS are case sensitive and only accept all-lowercase app_offline.htm files. If this is toggled, an appropriately named file is created on the destination before deployment and deleted afterwards.

Declaration
public virtual bool? WrapAppOffline { get; }
Property Value
Type Description
System.Nullable<System.Boolean>

Methods

| Improve this Doc View Source

AssertValid()

Declaration
protected override void AssertValid()
Overrides
Nuke.Common.Tooling.ToolSettings.AssertValid()

Implements

Nuke.Common.Tooling.ISettingsEntity

Extension Methods