PowershellRunner Class

Summary

Responsible for executing powershell scripts.
Assembly
Cake.Powershell.dll
Namespace
Cake.Powershell
Interfaces
Base Types
  • Object
graph BT Type-->Base0["Object"] Type-.->Interface0["IPowershellRunner"] click Interface0 "/api/Cake.Powershell/IPowershellRunner" Type["PowershellRunner"] class Type type-node

Syntax

public sealed class PowershellRunner : IPowershellRunner

Constructors

Name Summary
PowershellRunner(ICakeContext) Initializes a new instance of the PowershellRunner class.
PowershellRunner(ICakeEnvironment, ICakeLog) Initializes a new instance of the PowershellRunner class.

Methods

Name Value Summary
Start(FilePath, PowershellSettings) Collection<PSObject>
Starts a powershell script using the specified information.
Start(string, PowershellSettings) Collection<PSObject>
Starts a powershell script using the specified information.
Start(Uri, FilePath, PowershellSettings) Collection<PSObject>
Starts a powershell script using the specified information.

Extension Methods

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