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

Assembly

Cake.DeployParams.dll

Namespace

Cake.DeployParams

Base Types

Object

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

Syntax

public class DeploySettings

Constructors

Name	Summary
DeploySettings()

Properties

Name	Value	Summary
AgentType	RemoteAgent
AllowUntrusted	bool
ComputerName	string
DeclareParamFile	FilePath
Delete	bool
DestinationPath	FilePath
DestProvider	DeploymentWellKnownProvider
NTLM	bool
Parameters	Dictionary<string, string>
Password	string
Port	int
PublishUrl	string
SiteName	string
SkipRules	List<SkipRule>
SourcePath	FilePath
SourceProvider	DeploymentWellKnownProvider
TraceLevel	TraceLevel
Username	string
WhatIf	bool

Extension Methods

Name	Value	Summary
AddParameter(string, string)	DeploySettings	From DeploySettingsExtensions Requires the Cake.DeployParams addin
AddSkipRule(SkipRule)	DeploySettings	From DeploySettingsExtensions Requires the Cake.DeployParams addin
AddSkipRule(string, string, string, string, string)	DeploySettings	From DeploySettingsExtensions Requires the Cake.DeployParams addin
Dump<DeploySettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
FromSourcePath(string)	DeploySettings	From DeploySettingsExtensions Requires the Cake.DeployParams 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 IssuesArgumentChecks Requires the Cake.Issues addin
NotNull<DeploySettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
SetAllowUntrusted(bool)	DeploySettings	From DeploySettingsExtensions Requires the Cake.DeployParams addin
SetDelete(bool)	DeploySettings	From DeploySettingsExtensions Requires the Cake.DeployParams addin
SetPublishUrl(string)	DeploySettings	From DeploySettingsExtensions Requires the Cake.DeployParams addin
SetTraceLevel(TraceLevel)	DeploySettings	From DeploySettingsExtensions Requires the Cake.DeployParams addin
SetWhatIf(bool)	DeploySettings	From DeploySettingsExtensions Requires the Cake.DeployParams 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	From DeploySettingsExtensions Requires the Cake.DeployParams 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	From DeploySettingsExtensions Requires the Cake.DeployParams addin
UseComputerName(string)	DeploySettings	From DeploySettingsExtensions Requires the Cake.DeployParams addin
UseNTLM(bool)	DeploySettings	From DeploySettingsExtensions Requires the Cake.DeployParams addin
UsePassword(string)	DeploySettings	From DeploySettingsExtensions Requires the Cake.DeployParams addin
UsePort(int)	DeploySettings	From DeploySettingsExtensions Requires the Cake.DeployParams addin
UseSiteName(string)	DeploySettings	From DeploySettingsExtensions Requires the Cake.DeployParams addin
UseUsername(string)	DeploySettings	From DeploySettingsExtensions Requires the Cake.DeployParams addin

DeploySettings Class

Syntax

Constructors

Properties

Extension Methods