Show / Hide Table of Contents

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

View Source

API(PulumiCommand)

Creates an API backed by the given PulumiCommand.

Declaration
public API(PulumiCommand command)
Parameters
Type Name Description
PulumiCommand command

Methods

View Source

AboutAsync(PulumiAboutOptions?, CancellationToken)

Runs the pulumi about command.

Declaration
public Task<CommandResult> AboutAsync(PulumiAboutOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiAboutOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

AboutEnvAsync(PulumiAboutEnvOptions?, CancellationToken)

Runs the pulumi about env command.

Declaration
public Task<CommandResult> AboutEnvAsync(PulumiAboutEnvOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiAboutEnvOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

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>
View Source

ConfigAsync(PulumiConfigOptions?, CancellationToken)

Runs the pulumi config command.

Declaration
public Task<CommandResult> ConfigAsync(PulumiConfigOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiConfigOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

ConfigCopyAsync(string?, PulumiConfigCopyOptions?, CancellationToken)

Runs the pulumi config copy command.

Declaration
public Task<CommandResult> ConfigCopyAsync(string? key = null, PulumiConfigCopyOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string key
PulumiConfigCopyOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

ConfigEnvAddAsync(IEnumerable<string>, PulumiConfigEnvAddOptions?, CancellationToken)

Runs the pulumi config env add command.

Declaration
public Task<CommandResult> ConfigEnvAddAsync(IEnumerable<string> environmentName, PulumiConfigEnvAddOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IEnumerable<string> environmentName
PulumiConfigEnvAddOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

ConfigEnvInitAsync(PulumiConfigEnvInitOptions?, CancellationToken)

Runs the pulumi config env init command.

Declaration
public Task<CommandResult> ConfigEnvInitAsync(PulumiConfigEnvInitOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiConfigEnvInitOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

ConfigEnvListAsync(PulumiConfigEnvListOptions?, CancellationToken)

Runs the pulumi config env list command.

Declaration
public Task<CommandResult> ConfigEnvListAsync(PulumiConfigEnvListOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiConfigEnvListOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

ConfigEnvRemoveAsync(string, PulumiConfigEnvRemoveOptions?, CancellationToken)

Runs the pulumi config env remove command.

Declaration
public Task<CommandResult> ConfigEnvRemoveAsync(string environmentName, PulumiConfigEnvRemoveOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string environmentName
PulumiConfigEnvRemoveOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

ConfigGetAsync(string, PulumiConfigGetOptions?, CancellationToken)

Runs the pulumi config get command.

Declaration
public Task<CommandResult> ConfigGetAsync(string key, PulumiConfigGetOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string key
PulumiConfigGetOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

ConfigRefreshAsync(PulumiConfigRefreshOptions?, CancellationToken)

Runs the pulumi config refresh command.

Declaration
public Task<CommandResult> ConfigRefreshAsync(PulumiConfigRefreshOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiConfigRefreshOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

ConfigRemoveAllAsync(IEnumerable<string>, PulumiConfigRemoveAllOptions?, CancellationToken)

Runs the pulumi config remove-all command.

Declaration
public Task<CommandResult> ConfigRemoveAllAsync(IEnumerable<string> key, PulumiConfigRemoveAllOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IEnumerable<string> key
PulumiConfigRemoveAllOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

ConfigRemoveAsync(string, PulumiConfigRemoveOptions?, CancellationToken)

Runs the pulumi config remove command.

Declaration
public Task<CommandResult> ConfigRemoveAsync(string key, PulumiConfigRemoveOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string key
PulumiConfigRemoveOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

ConfigSetAllAsync(PulumiConfigSetAllOptions?, CancellationToken)

Runs the pulumi config set-all command.

Declaration
public Task<CommandResult> ConfigSetAllAsync(PulumiConfigSetAllOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiConfigSetAllOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

ConfigSetAsync(string, string?, PulumiConfigSetOptions?, CancellationToken)

Runs the pulumi config set command.

Declaration
public Task<CommandResult> ConfigSetAsync(string key, string? value = null, PulumiConfigSetOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string key
string value
PulumiConfigSetOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

ConvertAsync(IEnumerable<string>?, PulumiConvertOptions?, CancellationToken)

Runs the pulumi convert command.

Declaration
public Task<CommandResult> ConvertAsync(IEnumerable<string>? arg = null, PulumiConvertOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IEnumerable<string> arg
PulumiConvertOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvChangeRequestApplyAsync(PulumiEnvChangeRequestApplyOptions?, CancellationToken)

Runs the pulumi env change-request apply command.

Declaration
public Task<CommandResult> EnvChangeRequestApplyAsync(PulumiEnvChangeRequestApplyOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvChangeRequestApplyOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvChangeRequestApproveAsync(PulumiEnvChangeRequestApproveOptions?, CancellationToken)

Runs the pulumi env change-request approve command.

Declaration
public Task<CommandResult> EnvChangeRequestApproveAsync(PulumiEnvChangeRequestApproveOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvChangeRequestApproveOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvChangeRequestCloseAsync(PulumiEnvChangeRequestCloseOptions?, CancellationToken)

Runs the pulumi env change-request close command.

Declaration
public Task<CommandResult> EnvChangeRequestCloseAsync(PulumiEnvChangeRequestCloseOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvChangeRequestCloseOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvChangeRequestCommentAsync(PulumiEnvChangeRequestCommentOptions?, CancellationToken)

Runs the pulumi env change-request comment command.

Declaration
public Task<CommandResult> EnvChangeRequestCommentAsync(PulumiEnvChangeRequestCommentOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvChangeRequestCommentOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvChangeRequestDiffAsync(PulumiEnvChangeRequestDiffOptions?, CancellationToken)

Runs the pulumi env change-request diff command.

Declaration
public Task<CommandResult> EnvChangeRequestDiffAsync(PulumiEnvChangeRequestDiffOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvChangeRequestDiffOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvChangeRequestGetAsync(PulumiEnvChangeRequestGetOptions?, CancellationToken)

Runs the pulumi env change-request get command.

Declaration
public Task<CommandResult> EnvChangeRequestGetAsync(PulumiEnvChangeRequestGetOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvChangeRequestGetOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvChangeRequestListAsync(PulumiEnvChangeRequestListOptions?, CancellationToken)

Runs the pulumi env change-request list command.

Declaration
public Task<CommandResult> EnvChangeRequestListAsync(PulumiEnvChangeRequestListOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvChangeRequestListOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvChangeRequestLogAsync(PulumiEnvChangeRequestLogOptions?, CancellationToken)

Runs the pulumi env change-request log command.

Declaration
public Task<CommandResult> EnvChangeRequestLogAsync(PulumiEnvChangeRequestLogOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvChangeRequestLogOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvChangeRequestRebaseAsync(PulumiEnvChangeRequestRebaseOptions?, CancellationToken)

Runs the pulumi env change-request rebase command.

Declaration
public Task<CommandResult> EnvChangeRequestRebaseAsync(PulumiEnvChangeRequestRebaseOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvChangeRequestRebaseOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvChangeRequestUnapproveAsync(PulumiEnvChangeRequestUnapproveOptions?, CancellationToken)

Runs the pulumi env change-request unapprove command.

Declaration
public Task<CommandResult> EnvChangeRequestUnapproveAsync(PulumiEnvChangeRequestUnapproveOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvChangeRequestUnapproveOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvCloneAsync(PulumiEnvCloneOptions?, CancellationToken)

Runs the pulumi env clone command.

Declaration
public Task<CommandResult> EnvCloneAsync(PulumiEnvCloneOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvCloneOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvDiffAsync(PulumiEnvDiffOptions?, CancellationToken)

Runs the pulumi env diff command.

Declaration
public Task<CommandResult> EnvDiffAsync(PulumiEnvDiffOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvDiffOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvEditAsync(PulumiEnvEditOptions?, CancellationToken)

Runs the pulumi env edit command.

Declaration
public Task<CommandResult> EnvEditAsync(PulumiEnvEditOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvEditOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvGetAsync(PulumiEnvGetOptions?, CancellationToken)

Runs the pulumi env get command.

Declaration
public Task<CommandResult> EnvGetAsync(PulumiEnvGetOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvGetOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvInitAsync(PulumiEnvInitOptions?, CancellationToken)

Runs the pulumi env init command.

Declaration
public Task<CommandResult> EnvInitAsync(PulumiEnvInitOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvInitOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvListAsync(PulumiEnvListOptions?, CancellationToken)

Runs the pulumi env list command.

Declaration
public Task<CommandResult> EnvListAsync(PulumiEnvListOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvListOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvOpenAsync(PulumiEnvOpenOptions?, CancellationToken)

Runs the pulumi env open command.

Declaration
public Task<CommandResult> EnvOpenAsync(PulumiEnvOpenOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvOpenOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvOpenRequestAsync(PulumiEnvOpenRequestOptions?, CancellationToken)

Runs the pulumi env open-request command.

Declaration
public Task<CommandResult> EnvOpenRequestAsync(PulumiEnvOpenRequestOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvOpenRequestOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvProviderAwsLoginOidcAsync(PulumiEnvProviderAwsLoginOidcOptions?, CancellationToken)

Runs the pulumi env provider aws-login oidc command.

Declaration
public Task<CommandResult> EnvProviderAwsLoginOidcAsync(PulumiEnvProviderAwsLoginOidcOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvProviderAwsLoginOidcOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvProviderAwsLoginStaticAsync(PulumiEnvProviderAwsLoginStaticOptions?, CancellationToken)

Runs the pulumi env provider aws-login static command.

Declaration
public Task<CommandResult> EnvProviderAwsLoginStaticAsync(PulumiEnvProviderAwsLoginStaticOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvProviderAwsLoginStaticOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvProviderAzureLoginOidcAsync(PulumiEnvProviderAzureLoginOidcOptions?, CancellationToken)

Runs the pulumi env provider azure-login oidc command.

Declaration
public Task<CommandResult> EnvProviderAzureLoginOidcAsync(PulumiEnvProviderAzureLoginOidcOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvProviderAzureLoginOidcOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvProviderAzureLoginStaticAsync(PulumiEnvProviderAzureLoginStaticOptions?, CancellationToken)

Runs the pulumi env provider azure-login static command.

Declaration
public Task<CommandResult> EnvProviderAzureLoginStaticAsync(PulumiEnvProviderAzureLoginStaticOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvProviderAzureLoginStaticOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvProviderGcpLoginOidcAsync(PulumiEnvProviderGcpLoginOidcOptions?, CancellationToken)

Runs the pulumi env provider gcp-login oidc command.

Declaration
public Task<CommandResult> EnvProviderGcpLoginOidcAsync(PulumiEnvProviderGcpLoginOidcOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvProviderGcpLoginOidcOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvProviderGcpLoginStaticAsync(PulumiEnvProviderGcpLoginStaticOptions?, CancellationToken)

Runs the pulumi env provider gcp-login static command.

Declaration
public Task<CommandResult> EnvProviderGcpLoginStaticAsync(PulumiEnvProviderGcpLoginStaticOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvProviderGcpLoginStaticOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvReferrerListAsync(PulumiEnvReferrerListOptions?, CancellationToken)

Runs the pulumi env referrer list command.

Declaration
public Task<CommandResult> EnvReferrerListAsync(PulumiEnvReferrerListOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvReferrerListOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvRemoveAsync(PulumiEnvRemoveOptions?, CancellationToken)

Runs the pulumi env remove command.

Declaration
public Task<CommandResult> EnvRemoveAsync(PulumiEnvRemoveOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvRemoveOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvRotateAsync(PulumiEnvRotateOptions?, CancellationToken)

Runs the pulumi env rotate command.

Declaration
public Task<CommandResult> EnvRotateAsync(PulumiEnvRotateOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvRotateOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvRunAsync(PulumiEnvRunOptions?, CancellationToken)

Runs the pulumi env run command.

Declaration
public Task<CommandResult> EnvRunAsync(PulumiEnvRunOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvRunOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvScheduleEditAsync(PulumiEnvScheduleEditOptions?, CancellationToken)

Runs the pulumi env schedule edit command.

Declaration
public Task<CommandResult> EnvScheduleEditAsync(PulumiEnvScheduleEditOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvScheduleEditOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvScheduleGetAsync(PulumiEnvScheduleGetOptions?, CancellationToken)

Runs the pulumi env schedule get command.

Declaration
public Task<CommandResult> EnvScheduleGetAsync(PulumiEnvScheduleGetOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvScheduleGetOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvScheduleHistoryAsync(PulumiEnvScheduleHistoryOptions?, CancellationToken)

Runs the pulumi env schedule history command.

Declaration
public Task<CommandResult> EnvScheduleHistoryAsync(PulumiEnvScheduleHistoryOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvScheduleHistoryOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvScheduleListAsync(PulumiEnvScheduleListOptions?, CancellationToken)

Runs the pulumi env schedule list command.

Declaration
public Task<CommandResult> EnvScheduleListAsync(PulumiEnvScheduleListOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvScheduleListOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvScheduleNewAsync(PulumiEnvScheduleNewOptions?, CancellationToken)

Runs the pulumi env schedule new command.

Declaration
public Task<CommandResult> EnvScheduleNewAsync(PulumiEnvScheduleNewOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvScheduleNewOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvScheduleRemoveAsync(PulumiEnvScheduleRemoveOptions?, CancellationToken)

Runs the pulumi env schedule remove command.

Declaration
public Task<CommandResult> EnvScheduleRemoveAsync(PulumiEnvScheduleRemoveOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvScheduleRemoveOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvSetAsync(PulumiEnvSetOptions?, CancellationToken)

Runs the pulumi env set command.

Declaration
public Task<CommandResult> EnvSetAsync(PulumiEnvSetOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvSetOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvSettingsGetAsync(PulumiEnvSettingsGetOptions?, CancellationToken)

Runs the pulumi env settings get command.

Declaration
public Task<CommandResult> EnvSettingsGetAsync(PulumiEnvSettingsGetOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvSettingsGetOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvSettingsSetAsync(PulumiEnvSettingsSetOptions?, CancellationToken)

Runs the pulumi env settings set command.

Declaration
public Task<CommandResult> EnvSettingsSetAsync(PulumiEnvSettingsSetOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvSettingsSetOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvSetupAwsAsync(PulumiEnvSetupAwsOptions?, CancellationToken)

Runs the pulumi env setup aws command.

Declaration
public Task<CommandResult> EnvSetupAwsAsync(PulumiEnvSetupAwsOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvSetupAwsOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvSetupAzureAsync(PulumiEnvSetupAzureOptions?, CancellationToken)

Runs the pulumi env setup azure command.

Declaration
public Task<CommandResult> EnvSetupAzureAsync(PulumiEnvSetupAzureOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvSetupAzureOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvSetupGcpAsync(PulumiEnvSetupGcpOptions?, CancellationToken)

Runs the pulumi env setup gcp command.

Declaration
public Task<CommandResult> EnvSetupGcpAsync(PulumiEnvSetupGcpOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvSetupGcpOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvTagAsync(PulumiEnvTagOptions?, CancellationToken)

Runs the pulumi env tag command.

Declaration
public Task<CommandResult> EnvTagAsync(PulumiEnvTagOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvTagOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvTagGetAsync(PulumiEnvTagGetOptions?, CancellationToken)

Runs the pulumi env tag get command.

Declaration
public Task<CommandResult> EnvTagGetAsync(PulumiEnvTagGetOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvTagGetOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvTagListAsync(PulumiEnvTagListOptions?, CancellationToken)

Runs the pulumi env tag list command.

Declaration
public Task<CommandResult> EnvTagListAsync(PulumiEnvTagListOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvTagListOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvTagMoveAsync(PulumiEnvTagMoveOptions?, CancellationToken)

Runs the pulumi env tag move command.

Declaration
public Task<CommandResult> EnvTagMoveAsync(PulumiEnvTagMoveOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvTagMoveOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvTagRemoveAsync(PulumiEnvTagRemoveOptions?, CancellationToken)

Runs the pulumi env tag remove command.

Declaration
public Task<CommandResult> EnvTagRemoveAsync(PulumiEnvTagRemoveOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvTagRemoveOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvVersionAsync(PulumiEnvVersionOptions?, CancellationToken)

Runs the pulumi env version command.

Declaration
public Task<CommandResult> EnvVersionAsync(PulumiEnvVersionOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvVersionOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvVersionHistoryAsync(PulumiEnvVersionHistoryOptions?, CancellationToken)

Runs the pulumi env version history command.

Declaration
public Task<CommandResult> EnvVersionHistoryAsync(PulumiEnvVersionHistoryOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvVersionHistoryOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvVersionRetractAsync(PulumiEnvVersionRetractOptions?, CancellationToken)

Runs the pulumi env version retract command.

Declaration
public Task<CommandResult> EnvVersionRetractAsync(PulumiEnvVersionRetractOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvVersionRetractOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvVersionRollbackAsync(PulumiEnvVersionRollbackOptions?, CancellationToken)

Runs the pulumi env version rollback command.

Declaration
public Task<CommandResult> EnvVersionRollbackAsync(PulumiEnvVersionRollbackOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvVersionRollbackOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvVersionTagAsync(PulumiEnvVersionTagOptions?, CancellationToken)

Runs the pulumi env version tag command.

Declaration
public Task<CommandResult> EnvVersionTagAsync(PulumiEnvVersionTagOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvVersionTagOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvVersionTagListAsync(PulumiEnvVersionTagListOptions?, CancellationToken)

Runs the pulumi env version tag list command.

Declaration
public Task<CommandResult> EnvVersionTagListAsync(PulumiEnvVersionTagListOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvVersionTagListOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvVersionTagRemoveAsync(PulumiEnvVersionTagRemoveOptions?, CancellationToken)

Runs the pulumi env version tag remove command.

Declaration
public Task<CommandResult> EnvVersionTagRemoveAsync(PulumiEnvVersionTagRemoveOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvVersionTagRemoveOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvWebhookDeliveryListAsync(PulumiEnvWebhookDeliveryListOptions?, CancellationToken)

Runs the pulumi env webhook delivery list command.

Declaration
public Task<CommandResult> EnvWebhookDeliveryListAsync(PulumiEnvWebhookDeliveryListOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvWebhookDeliveryListOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvWebhookEditAsync(PulumiEnvWebhookEditOptions?, CancellationToken)

Runs the pulumi env webhook edit command.

Declaration
public Task<CommandResult> EnvWebhookEditAsync(PulumiEnvWebhookEditOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvWebhookEditOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvWebhookGetAsync(PulumiEnvWebhookGetOptions?, CancellationToken)

Runs the pulumi env webhook get command.

Declaration
public Task<CommandResult> EnvWebhookGetAsync(PulumiEnvWebhookGetOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvWebhookGetOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvWebhookListAsync(PulumiEnvWebhookListOptions?, CancellationToken)

Runs the pulumi env webhook list command.

Declaration
public Task<CommandResult> EnvWebhookListAsync(PulumiEnvWebhookListOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvWebhookListOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvWebhookNewAsync(PulumiEnvWebhookNewOptions?, CancellationToken)

Runs the pulumi env webhook new command.

Declaration
public Task<CommandResult> EnvWebhookNewAsync(PulumiEnvWebhookNewOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvWebhookNewOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvWebhookPingAsync(PulumiEnvWebhookPingOptions?, CancellationToken)

Runs the pulumi env webhook ping command.

Declaration
public Task<CommandResult> EnvWebhookPingAsync(PulumiEnvWebhookPingOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvWebhookPingOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

EnvWebhookRemoveAsync(PulumiEnvWebhookRemoveOptions?, CancellationToken)

Runs the pulumi env webhook remove command.

Declaration
public Task<CommandResult> EnvWebhookRemoveAsync(PulumiEnvWebhookRemoveOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiEnvWebhookRemoveOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

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>
View Source

InstallAsync(PulumiInstallOptions?, CancellationToken)

Runs the pulumi install command.

Declaration
public Task<CommandResult> InstallAsync(PulumiInstallOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiInstallOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

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>
View Source

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>
View Source

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>
View Source

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>
View Source

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>
View Source

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>
View Source

RefreshAsync(PulumiRefreshOptions?, CancellationToken)

Runs the pulumi refresh command.

Declaration
public Task<CommandResult> RefreshAsync(PulumiRefreshOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiRefreshOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

StateEditAsync(PulumiStateEditOptions?, CancellationToken)

Runs the pulumi state edit command.

Declaration
public Task<CommandResult> StateEditAsync(PulumiStateEditOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiStateEditOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

StateGetAsync(string?, PulumiStateGetOptions?, CancellationToken)

Runs the pulumi state get command.

Declaration
public Task<CommandResult> StateGetAsync(string? resource = null, PulumiStateGetOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string resource
PulumiStateGetOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

StateMoveAsync(IEnumerable<string>, PulumiStateMoveOptions?, CancellationToken)

Runs the pulumi state move command.

Declaration
public Task<CommandResult> StateMoveAsync(IEnumerable<string> urn, PulumiStateMoveOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IEnumerable<string> urn
PulumiStateMoveOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

StatePromoteAsync(string, PulumiStatePromoteOptions?, CancellationToken)

Runs the pulumi state promote command.

Declaration
public Task<CommandResult> StatePromoteAsync(string snippetName, PulumiStatePromoteOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string snippetName
PulumiStatePromoteOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

StateProtectAsync(IEnumerable<string>?, PulumiStateProtectOptions?, CancellationToken)

Runs the pulumi state protect command.

Declaration
public Task<CommandResult> StateProtectAsync(IEnumerable<string>? resourceUrn = null, PulumiStateProtectOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IEnumerable<string> resourceUrn
PulumiStateProtectOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

StateRemoveAsync(IEnumerable<string>?, PulumiStateRemoveOptions?, CancellationToken)

Runs the pulumi state remove command.

Declaration
public Task<CommandResult> StateRemoveAsync(IEnumerable<string>? resourceUrn = null, PulumiStateRemoveOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IEnumerable<string> resourceUrn
PulumiStateRemoveOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

StateRenameAsync(string?, string?, PulumiStateRenameOptions?, CancellationToken)

Runs the pulumi state rename command.

Declaration
public Task<CommandResult> StateRenameAsync(string? resourceUrn = null, string? newName = null, PulumiStateRenameOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string resourceUrn
string newName
PulumiStateRenameOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

StateRepairAsync(PulumiStateRepairOptions?, CancellationToken)

Runs the pulumi state repair command.

Declaration
public Task<CommandResult> StateRepairAsync(PulumiStateRepairOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiStateRepairOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

StateTaintAsync(IEnumerable<string>?, PulumiStateTaintOptions?, CancellationToken)

Runs the pulumi state taint command.

Declaration
public Task<CommandResult> StateTaintAsync(IEnumerable<string>? resourceUrn = null, PulumiStateTaintOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IEnumerable<string> resourceUrn
PulumiStateTaintOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

StateUnprotectAsync(IEnumerable<string>?, PulumiStateUnprotectOptions?, CancellationToken)

Runs the pulumi state unprotect command.

Declaration
public Task<CommandResult> StateUnprotectAsync(IEnumerable<string>? resourceUrn = null, PulumiStateUnprotectOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IEnumerable<string> resourceUrn
PulumiStateUnprotectOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

StateUntaintAsync(IEnumerable<string>?, PulumiStateUntaintOptions?, CancellationToken)

Runs the pulumi state untaint command.

Declaration
public Task<CommandResult> StateUntaintAsync(IEnumerable<string>? resourceUrn = null, PulumiStateUntaintOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
IEnumerable<string> resourceUrn
PulumiStateUntaintOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

StateUpgradeAsync(PulumiStateUpgradeOptions?, CancellationToken)

Runs the pulumi state upgrade command.

Declaration
public Task<CommandResult> StateUpgradeAsync(PulumiStateUpgradeOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiStateUpgradeOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

VersionAsync(PulumiVersionOptions?, CancellationToken)

Runs the pulumi version command.

Declaration
public Task<CommandResult> VersionAsync(PulumiVersionOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiVersionOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>
View Source

WhoamiAsync(PulumiWhoamiOptions?, CancellationToken)

Runs the pulumi whoami command.

Declaration
public Task<CommandResult> WhoamiAsync(PulumiWhoamiOptions? options = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PulumiWhoamiOptions options
CancellationToken cancellationToken
Returns
Type Description
Task<CommandResult>

Version 3.116.1

  • View Source
Back to top Copyright 2016-2023, Pulumi Corporation.