MsDeploySettings Class

Summary

Contains settings used by MsDeployRunner.
Assembly
Cake.MsDeploy.dll
Namespace
Cake.MsDeploy
Base Types
  • ToolSettings
graph BT Type-->Base0["ToolSettings"] Type["MsDeploySettings"] class Type type-node

Syntax

public class MsDeploySettings : ToolSettings

Constructors

Name Summary
MsDeploySettings()

Properties

Name Value Summary
AllowUntrusted Nullable<bool>
Allow untrusted server certificate when using SSL.
DeclareParamFile FilePath
Includes parameter declarations from an XML file.
DeclareParams IEnumerable<DeclareParameter>
Collection of Parameters to DECLARE during a sync operation
Destination MsDeployProvider
The destination object for the operation.
DisableAppStore Nullable<bool>
Disables saving to the application store during a sync
DisableLinks IEnumerable<string>
Collection of link extensions to disable during a sync operation
DisableRules IEnumerable<string>
Disables the specified synchronization rule(s).
DisableSkipDirective string
Specifies collection of specified skip directive(s) to disable.
EnableLinks IEnumerable<string>
Enables the specified link extension(s).
EnableRules IEnumerable<string>
Enables the specified synchronization rule(s).
EnableSkipDirective string
Specifies collection of specified skip directive(s) to enable.
PostSyncCommand CommandProvider
Command to run on the remote server after a sync operation completes
PreSyncCommand CommandProvider
Command to run on the remote server before a sync operation starts
RemoveParams IEnumerable<string>
Collection parameters to remove from the declare list
ReplacementRules IEnumerable<ReplacementRule>
Specifies collection of attribute replacement rules
RetryAttempts Nullable<int>
The number of times a provider will retry after a failed action (not all providers support retrying). Defaults to 5.
RetryInterval Nullable<int>
Interval in milliseconds between retry attempts (-retryAttempts). The default is 1000.
SetParamFile FilePath
Applies parameter settings from an XML file
SetParams IEnumerable<SetParameter>
Collection of Parameters to SET during a sync operation
ShowSecure Nullable<bool>
true to show secure attributes in XML output instead of hiding them
SkipDirectives IEnumerable<SkipDirective>
Collection of SkipDirectives that specifies object(s) to skip during synchronization.
Source MsDeployProvider
The source object for the operation (required).
UseCheckSum Nullable<bool>
This setting is useful when you want to copy only the files whose content has changed, and ignore files that have the same content but different time stamps.
Verb Operation
Action to perform (required).
Verbose Nullable<bool>
Enables more verbose output.
WhatIf Nullable<bool>
Displays what would have happened without actually performing any operations.
Xml Nullable<bool>
True to Return results in XML format.
XPath string
An XPath expression to apply to XML output.

Extension Methods

Name Value Summary
Dump<MsDeploySettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<MsDeploySettings>(MsDeploySettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<MsDeploySettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<MsDeploySettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<MsDeploySettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<MsDeploySettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
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