PowershellSettingsExtensions Class

Summary

Contains extension methods for PowershellSettings.
Assembly
Cake.Powershell.dll
Namespace
Cake.Powershell
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["PowershellSettingsExtensions"] class Type type-node

Syntax

public static class PowershellSettingsExtensions

Methods

Name Value Summary
BypassExecutionPolicy(PowershellSettings) PowershellSettings
Sets a value indicating whether security should be set to unrestricted.
static
OutputToAppConsole(PowershellSettings, bool) PowershellSettings
Sets a value indicating whether the output of an application is written to its on-screen console.
static
SetFormatOutput(PowershellSettings, bool) PowershellSettings
Sets a value indicating whether the output of an application should be formatted as text
static
SetLogOutput(PowershellSettings, bool) PowershellSettings
Sets a value indicating whether the output of an application is written to the cake console
static
SetTimeout(PowershellSettings, int) PowershellSettings
Sets the optional timeout for powershell command
static
UseAuthenticationMechanism(PowershellSettings, AuthenticationMechanism) PowershellSettings
Sets the authentication mechanism to use when connecting
static
UseComputerName(PowershellSettings, string) PowershellSettings
Sets the computer name to connect to
static
UsePassword(PowershellSettings, string) PowershellSettings
Gets or sets the credentials to use when connecting
static
UsePort(PowershellSettings, int) PowershellSettings
Sets the remote port to connect on.
static
UseUsername(PowershellSettings, string) PowershellSettings
Gets or sets the credentials to use when connecting
static
UseWorkingDirectory(PowershellSettings, DirectoryPath) PowershellSettings
Sets the working directory for the process to be started.
static
WithArguments(PowershellSettings, Action<ProcessArgumentBuilder>) PowershellSettings
Sets the arguments for the powershell command
static
WithDotSourcing(PowershellSettings) PowershellSettings
Executes scripts using dot sourcing
static
WithModule(PowershellSettings, string) PowershellSettings
Adds the specified module to load into the initial state
static

Extension Methods

Name Value Summary
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