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

Summary

Manages your site's backup settings

Assembly

Cake.MsDeploy.dll

Namespace

Cake.MsDeploy.Providers.MsDeployProviders

Interfaces

Base Types

Object
MsDeployProvider

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["BackupSettingsProvider"] class Type type-node

Syntax

public class BackupSettingsProvider : MsDeployProvider, IMsDeployProvider, IMsDeployArgument

Attributes

Type	Description
NullableContextAttribute
NullableAttribute

Constructors

Name	Summary
BackupSettingsProvider()

Properties

Name	Value	Summary
AddExcludedProviders	IEnumerable<string>	List of providers to add to the existing excluded provider list for a backup.
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
ContinueSyncOnBackupFailure	Nullable<bool>	Boolean value to specify if a sync to your site should continue if a backup fails
Direction	Direction	Determines if the Provider is a source or destination Inherited from MsDeployProvider
Enabled	Nullable<bool>	A boolean value used to specify whether backups will occur during a sync.
IncludeAcls	Nullable<bool>	If true, include ACLs in the operation (applies to the file system, registry, and metabase). Inherited from MsDeployProvider
NumberOfBackups	Nullable<int>	Positive integer used to specify the maximum number of backups you would like to store on the server
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
RequirePath	bool	Determines if the Path argument is required for the MsDeployProvider Inherited from MsDeployProvider
TempAgent	Nullable<bool>	Inherited from MsDeployProvider
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<BackupSettingsProvider>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<BackupSettingsProvider>(BackupSettingsProvider[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<BackupSettingsProvider>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
NotNull<BackupSettingsProvider>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
ThrowIfNull<BackupSettingsProvider>(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<BackupSettingsProvider>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator 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