This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.WebDeploy.

Summary

The settings used for the deployment

Assembly

Cake.WebDeploy.dll

Namespace

Cake.WebDeploy

Base Types

Object

graph BT Type-->Base0["Object"] Type["DeploySettings"] class Type type-node

Syntax

public class DeploySettings

Constructors

Name	Summary
DeploySettings()	Initializes a new instance of the `DeploySettings` class.

Properties

Name	Value	Summary
AgentType	RemoteAgent	Gets or sets the type of remote agent to connect to
AllowUntrusted	bool	Gets or sets if untrusted certificates should be allowed
ComputerName	string	Gets or sets the computer name to publish to
Delete	bool	Gets or sets if files that no longer exist should be deleted
DestinationPath	FilePath	Gets or sets the destination of the package to publish to
NTLM	bool	Gets or sets if NTLM authentication should be used
Parameters	Dictionary<string, string>	Gets or sets the `Parameters`.
ParametersFilePath	FilePath	Gets or sets the location of the SetParameters.xml file
Password	string	Gets or sets the credentials to use when connecting
Port	int	Sets the remote port to connect on
PublishUrl	string	Gets or sets the url to publish that package to
SiteName	string	Sets the name of the website to publish
SkipRules	List<SkipRule>	Gets or sets the `SkipRules`.
SourcePath	FilePath	Gets or sets the source of the package to publish
TraceLevel	TraceLevel	Gets or sets the logging trace level
UseAppOffline	bool	Gets or sets the AppOffline rule
UseChecksum	bool	Gets or sets if deployment compares each file using a checksum value instead of datetime
Username	string	Gets or sets the credentials to use when connecting
WhatIf	bool	Gets or sets if operations will not be executed but events will still be fired

Extension Methods

Name	Value	Summary
AddParameter(string, string)	DeploySettings	Adds the parameter. From DeploySettingsExtensions Requires the Cake.WebDeploy addin
AddSkipRule(SkipRule)	DeploySettings	Adds a `SkipRule`. From DeploySettingsExtensions Requires the Cake.WebDeploy addin
AddSkipRule(string, string, string, string, string)	DeploySettings	Adds a `SkipRule`. From DeploySettingsExtensions Requires the Cake.WebDeploy addin
Dump<DeploySettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
FromSourcePath(string)	DeploySettings	Sets the source of the package to publish From DeploySettingsExtensions Requires the Cake.WebDeploy addin
IsIn<DeploySettings>(DeploySettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<DeploySettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<DeploySettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
SetAllowUntrusted(bool)	DeploySettings	Sets if untrusted certificates should be allowed From DeploySettingsExtensions Requires the Cake.WebDeploy addin
SetDelete(bool)	DeploySettings	Sets if files that no longer exist should be deleted From DeploySettingsExtensions Requires the Cake.WebDeploy addin
SetPublishUrl(string)	DeploySettings	Sets the url to publish that package to From DeploySettingsExtensions Requires the Cake.WebDeploy addin
SetTraceLevel(TraceLevel)	DeploySettings	Sets the logging trace level From DeploySettingsExtensions Requires the Cake.WebDeploy addin
SetWhatIf(bool)	DeploySettings	Sets if operations will not be executed but events will still be fired From DeploySettingsExtensions Requires the Cake.WebDeploy addin
ThrowIfNull<DeploySettings>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<DeploySettings>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDestinationPath(string)	DeploySettings	Sets the destination of the package to publish to From DeploySettingsExtensions Requires the Cake.WebDeploy addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin
UseAgentType(RemoteAgent)	DeploySettings	Sets the type of remote agent to connect to From DeploySettingsExtensions Requires the Cake.WebDeploy addin
UseAppOffline(bool)	DeploySettings	Sets if the target web app should be put offline during the deployment process. From DeploySettingsExtensions Requires the Cake.WebDeploy addin
UseChecksum(bool)	DeploySettings	Sets if deployment compares each file using a checksum value instead of datetime From DeploySettingsExtensions Requires the Cake.WebDeploy addin
UseComputerName(string)	DeploySettings	Sets the computer name on publish to From DeploySettingsExtensions Requires the Cake.WebDeploy addin
UseNTLM(bool)	DeploySettings	Sets if NTLM authentication should be used From DeploySettingsExtensions Requires the Cake.WebDeploy addin
UsePassword(string)	DeploySettings	Sets the credentials to use when connecting From DeploySettingsExtensions Requires the Cake.WebDeploy addin
UsePort(int)	DeploySettings	Sets the remote port to connect on. From DeploySettingsExtensions Requires the Cake.WebDeploy addin
UseSiteName(string)	DeploySettings	Sets the name of the website to publish From DeploySettingsExtensions Requires the Cake.WebDeploy addin
UseUsername(string)	DeploySettings	Sets the credentials to use when connecting From DeploySettingsExtensions Requires the Cake.WebDeploy addin

DeploySettings Class

Summary

Syntax

Constructors

Properties

Extension Methods