CommandProvider Class

Summary

Runs a command on the destination when preSync/postSync is called.
graph BT Type-->Base0["RunCommandProvider"] click Base0 "/api/Cake.MsDeploy.Providers.MsDeployProviders/RunCommandProvider" Base0-->Base1["MsDeployProvider"] click Base1 "/api/Cake.MsDeploy.Providers/MsDeployProvider" Base1-->Base2["Object"] Type-.->Interface0["IMsDeployProvider"] click Interface0 "/api/Cake.MsDeploy.Providers/IMsDeployProvider" Type-.->Interface1["IMsDeployArgument"] click Interface1 "/api/Cake.MsDeploy/IMsDeployArgument" Type["CommandProvider"] class Type type-node

Syntax

public class CommandProvider : RunCommandProvider, IMsDeployProvider, IMsDeployArgument

Constructors

Name Summary
CommandProvider()

Properties

Name Value Summary
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
Direction Direction
Determines if the Provider is a source or destination
Inherited from MsDeployProvider
DontUseCommandExe Nullable<bool>
A true or false value for the 'dontUseCommandExe' setting.
Inherited from RunCommandProvider
DontUseJobObject Nullable<bool>
A true or false value for the 'dontUseJobObject' setting.
Inherited from RunCommandProvider
IncludeAcls Nullable<bool>
If true, include ACLs in the operation (applies to the file system, registry, and metabase).
Inherited from MsDeployProvider
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
SuccessReturnCodes string
A semicolon (;) separated list of return values that will be treated as a success for the command. If specified, all other return values will be treated as errors.
Inherited from RunCommandProvider
TempAgent Nullable<bool>
Inherited from MsDeployProvider
Type string
Inherited from RunCommandProvider
Username string
User name to authenticate for remote connections (required if using Basic authentication).
Inherited from MsDeployProvider
WaitAttempts Nullable<int>
An integer value for the 'waitAttempts' setting.
Inherited from RunCommandProvider
WaitInterval Nullable<int>
An integer value for the 'waitInterval' setting.
Inherited from RunCommandProvider
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
Inherited from RunCommandProvider
AppendCommandLineArgument(StringBuilder) void
ToCommandLineArgument() string
Converts the MSDeploy Provider into its commmand line argument
Inherited from MsDeployProvider

Operators

Name Value Summary
implicit operator CommandProvider(string) CommandProvider

Extension Methods

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