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
Runs a command on the destination when preSync/postSync is called.
- Assembly
- Cake
.MsDeploy .dll - Namespace
- Cake
.MsDeploy .Providers .MsDeployProviders - Interfaces
- Base Types
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 |
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 |
A true or false value for the 'dontUseCommandExe' setting.
Inherited from RunCommandProvider
|
DontUseJobObject | Nullable |
A true or false value for the 'dontUseJobObject' setting.
Inherited from RunCommandProvider
|
IncludeAcls | Nullable |
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 |
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 |
An integer value for the 'waitAttempts' setting.
Inherited from RunCommandProvider
|
WaitInterval | Nullable |
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 |
void |
Inherited from RunCommandProvider
|
Append |
void | |
To |
string |
Converts the MSDeploy Provider into its commmand line argument
Inherited from MsDeployProvider
|
Operators
Name | Value | Summary |
---|---|---|
implicit operator |
CommandProvider |
Extension Methods
Name | Value | Summary |
---|---|---|
Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
NotNull |
void |
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
ThrowIfNull |
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 |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
To |
string |
From StringExtensions
Requires the Cake.Issues addin
|