Class LocalPulumiCommand

A PulumiCommand implementation that uses a locally installed Pulumi CLI.

Inheritance

object

PulumiCommand

LocalPulumiCommand

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Pulumi.Automation.Commands

Assembly: Pulumi.Automation.dll

Syntax

public class LocalPulumiCommand : PulumiCommand

Fields

SkipVersionCheckVar

Declaration

public const string SkipVersionCheckVar = "PULUMI_AUTOMATION_API_SKIP_VERSION_CHECK"

Field Value

Type	Description
string

Properties

Version

The version of the Pulumi CLI that is being used.

Declaration

public override SemVersion? Version { get; }

Property Value

Type	Description
SemVersion

Overrides

PulumiCommand.Version

Methods

CreateAsync(LocalPulumiCommandOptions?, CancellationToken)

Creates a new LocalPulumiCommand instance.

Declaration

public static Task<LocalPulumiCommand> CreateAsync(LocalPulumiCommandOptions? options = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
LocalPulumiCommandOptions	options	Options to configure the LocalPulumiCommand.
CancellationToken	cancellationToken	A cancellation token.

Returns

Type	Description
Task<LocalPulumiCommand>

Install(LocalPulumiCommandOptions?, CancellationToken)

Installs the Pulumi CLI if it is not already installed and returns a new LocalPulumiCommand instance.

Declaration

public static Task<LocalPulumiCommand> Install(LocalPulumiCommandOptions? options = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
LocalPulumiCommandOptions	options	Options to configure the LocalPulumiCommand.
CancellationToken	cancellationToken	A cancellation token.

Returns

Type	Description
Task<LocalPulumiCommand>

RunAsync(IList<string>, string, IDictionary<string, string?>, Action<string>?, Action<string>?, Action<EngineEvent>?, CancellationToken)

Declaration

public override Task<CommandResult> RunAsync(IList<string> args, string workingDir, IDictionary<string, string?> additionalEnv, Action<string>? onStandardOutput = null, Action<string>? onStandardError = null, Action<EngineEvent>? onEngineEvent = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IList<string>	args
string	workingDir
IDictionary<string, string>	additionalEnv
Action<string>	onStandardOutput
Action<string>	onStandardError
Action<EngineEvent>	onEngineEvent
CancellationToken	cancellationToken

Returns

Type	Description
Task<CommandResult>

Overrides

PulumiCommand.RunAsync(IList<string>, string, IDictionary<string, string?>, Action<string>?, Action<string>?, Action<EngineEvent>?, CancellationToken)

RunInputAsync(IList<string>, string, IDictionary<string, string?>, Action<string>?, Action<string>?, string?, Action<EngineEvent>?, CancellationToken)

Declaration

public override Task<CommandResult> RunInputAsync(IList<string> args, string workingDir, IDictionary<string, string?> additionalEnv, Action<string>? onStandardOutput = null, Action<string>? onStandardError = null, string? stdIn = null, Action<EngineEvent>? onEngineEvent = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IList<string>	args
string	workingDir
IDictionary<string, string>	additionalEnv
Action<string>	onStandardOutput
Action<string>	onStandardError
string	stdIn
Action<EngineEvent>	onEngineEvent
CancellationToken	cancellationToken

Returns

Type	Description
Task<CommandResult>

Overrides

PulumiCommand.RunInputAsync(IList<string>, string, IDictionary<string, string?>, Action<string>?, Action<string>?, string?, Action<EngineEvent>?, CancellationToken)