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
Contract for a parameter
- Assembly
- Cake
.MsDeploy .dll - Namespace
- Cake
.MsDeploy .Parameters - Interfaces
- Implementing Types
graph BT
Type-.->Interface0["IMsDeployArgument"]
click Interface0 "/api/Cake.MsDeploy/IMsDeployArgument"
Type["IParameter"]
class Type type-node
Implementing0["DeclareParameter"]-.->Type
click Implementing0 "/api/Cake.MsDeploy.Parameters/DeclareParameter"
Implementing1["SetParameter"]-.->Type
click Implementing1 "/api/Cake.MsDeploy.Parameters/SetParameter"
Syntax
public interface IParameter : IMsDeployArgumentProperties
| Name | Value | Summary |
|---|---|---|
| Description | string |
An optional user-supplied string that describes the purpose of the parameter
|
| Kind | Nullable |
specifies the parameter kind
|
| Match | string |
Specifies an item to be matched
|
| Name | string |
Name of the declared parameter
|
| Scope | string |
The scope of the specified parameter kind
|
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 |
Throws an exception if the specified parameter's value is null.
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 |
Returns the string value or a
Not set> markup suitable for Spectre.Console.
From StringExtensions
Requires the Cake.Issues addin
|