Class API

Runs Pulumi CLI commands, one method per command. The invocation itself is provided by the boilerplate half of this partial class.

Inheritance

object

API

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Pulumi.Automation.Commands

Assembly: Pulumi.Automation.dll

Syntax

public sealed class API

Constructors

API(PulumiCommand)

Creates an API backed by the given PulumiCommand.

Declaration

public API(PulumiCommand command)

Parameters

Type	Name	Description
PulumiCommand	command

Methods

CancelAsync(string?, PulumiCancelOptions?, CancellationToken)

Runs the pulumi cancel command.

Declaration

public Task<CommandResult> CancelAsync(string? stackName = null, PulumiCancelOptions? options = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	stackName
PulumiCancelOptions	options
CancellationToken	cancellationToken

Returns

Type	Description
Task<CommandResult>

ImportAsync(IEnumerable<string>?, PulumiImportOptions?, CancellationToken)

Runs the pulumi import command.

Declaration

public Task<CommandResult> ImportAsync(IEnumerable<string>? arg = null, PulumiImportOptions? options = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IEnumerable<string>	arg
PulumiImportOptions	options
CancellationToken	cancellationToken

Returns

Type	Description
Task<CommandResult>

NewAsync(string?, PulumiNewOptions?, CancellationToken)

Runs the pulumi new command.

Declaration

public Task<CommandResult> NewAsync(string? templateOrUrl = null, PulumiNewOptions? options = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	templateOrUrl
PulumiNewOptions	options
CancellationToken	cancellationToken

Returns

Type	Description
Task<CommandResult>

OrgAsync(PulumiOrgOptions?, CancellationToken)

Runs the pulumi org command.

Declaration

public Task<CommandResult> OrgAsync(PulumiOrgOptions? options = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
PulumiOrgOptions	options
CancellationToken	cancellationToken

Returns

Type	Description
Task<CommandResult>

OrgGetDefaultAsync(PulumiOrgGetDefaultOptions?, CancellationToken)

Runs the pulumi org get-default command.

Declaration

public Task<CommandResult> OrgGetDefaultAsync(PulumiOrgGetDefaultOptions? options = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
PulumiOrgGetDefaultOptions	options
CancellationToken	cancellationToken

Returns

Type	Description
Task<CommandResult>

OrgSearchAIAsync(PulumiOrgSearchAIOptions?, CancellationToken)

Runs the pulumi org search ai command.

Declaration

public Task<CommandResult> OrgSearchAIAsync(PulumiOrgSearchAIOptions? options = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
PulumiOrgSearchAIOptions	options
CancellationToken	cancellationToken

Returns

Type	Description
Task<CommandResult>

OrgSearchAsync(PulumiOrgSearchOptions?, CancellationToken)

Runs the pulumi org search command.

Declaration

public Task<CommandResult> OrgSearchAsync(PulumiOrgSearchOptions? options = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
PulumiOrgSearchOptions	options
CancellationToken	cancellationToken

Returns

Type	Description
Task<CommandResult>

OrgSetDefaultAsync(string, PulumiOrgSetDefaultOptions?, CancellationToken)

Runs the pulumi org set-default command.

Declaration

public Task<CommandResult> OrgSetDefaultAsync(string name, PulumiOrgSetDefaultOptions? options = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	name
PulumiOrgSetDefaultOptions	options
CancellationToken	cancellationToken

Returns

Type	Description
Task<CommandResult>