DeploySettingsExtensions Class

Summary

Contains extension methods for DeploySettings.
Assembly
Cake.WebDeploy.dll
Namespace
Cake.WebDeploy
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["DeploySettingsExtensions"] class Type type-node

Syntax

public static class DeploySettingsExtensions

Methods

Name Value Summary
AddParameter(DeploySettings, string, string) DeploySettings
Adds the parameter.
static
AddSkipRule(DeploySettings, SkipRule) DeploySettings
Adds a SkipRule.
static
AddSkipRule(DeploySettings, string, string, string, string, string) DeploySettings
Adds a SkipRule.
static
FromSourcePath(DeploySettings, string) DeploySettings
Sets the source of the package to publish
static
SetAllowUntrusted(DeploySettings, bool) DeploySettings
Sets if untrusted certificates should be allowed
static
SetDelete(DeploySettings, bool) DeploySettings
Sets if files that no longer exist should be deleted
static
SetPublishUrl(DeploySettings, string) DeploySettings
Sets the url to publish that package to
static
SetTraceLevel(DeploySettings, TraceLevel) DeploySettings
Sets the logging trace level
static
SetWhatIf(DeploySettings, bool) DeploySettings
Sets if operations will not be executed but events will still be fired
static
ToDestinationPath(DeploySettings, string) DeploySettings
Sets the destination of the package to publish to
static
UseAgentType(DeploySettings, RemoteAgent) DeploySettings
Sets the type of remote agent to connect to
static
UseAppOffline(DeploySettings, bool) DeploySettings
Sets if the target web app should be put offline during the deployment process.
static
UseChecksum(DeploySettings, bool) DeploySettings
Sets if deployment compares each file using a checksum value instead of datetime
static
UseComputerName(DeploySettings, string) DeploySettings
Sets the computer name on publish to
static
UseNTLM(DeploySettings, bool) DeploySettings
Sets if NTLM authentication should be used
static
UsePassword(DeploySettings, string) DeploySettings
Sets the credentials to use when connecting
static
UsePort(DeploySettings, int) DeploySettings
Sets the remote port to connect on.
static
UseSiteName(DeploySettings, string) DeploySettings
Sets the name of the website to publish
static
UseUsername(DeploySettings, string) DeploySettings
Sets the credentials to use when connecting
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin