Interface IEscApi

Represents a collection of functions to interact with the API endpoints This class is registered as transient.

Inherited Members

IApi.HttpClient

Namespace: Pulumi.Esc.Sdk.Api

Assembly: Pulumi.Esc.Sdk.dll

Syntax

public interface IEscApi : IApi

Properties

Events

The class containing the events

Declaration

EscApiEvents Events { get; }

Property Value

Type	Description
EscApiEvents

Methods

CheckEnvironmentYamlAsync(string, string, CancellationToken)

Checks an environment definition for errors

Declaration

Task<ICheckEnvironmentYamlApiResponse> CheckEnvironmentYamlAsync(string orgName, string body, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	body	Environment Yaml content
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ICheckEnvironmentYamlApiResponse>	Task<ICheckEnvironmentYamlApiResponse>

Remarks

Checks an environment definition for errors

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CheckEnvironmentYamlOrDefaultAsync(string, string, CancellationToken)

Checks an environment definition for errors

Declaration

Task<ICheckEnvironmentYamlApiResponse?> CheckEnvironmentYamlOrDefaultAsync(string orgName, string body, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	body	Environment Yaml content
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ICheckEnvironmentYamlApiResponse>	Task<ICheckEnvironmentYamlApiResponse?>

Remarks

Checks an environment definition for errors

CloneEnvironmentAsync(CloneEnvironment, string, string, string, CancellationToken)

Clones an environment

Declaration

Task<ICloneEnvironmentApiResponse> CloneEnvironmentAsync(CloneEnvironment cloneEnvironment, string orgName, string projectName, string envName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CloneEnvironment	cloneEnvironment	Clone environment
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ICloneEnvironmentApiResponse>	Task<ICloneEnvironmentApiResponse>

Remarks

Clones an environment

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CloneEnvironmentOrDefaultAsync(CloneEnvironment, string, string, string, CancellationToken)

Clones an environment

Declaration

Task<ICloneEnvironmentApiResponse?> CloneEnvironmentOrDefaultAsync(CloneEnvironment cloneEnvironment, string orgName, string projectName, string envName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CloneEnvironment	cloneEnvironment	Clone environment
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ICloneEnvironmentApiResponse>	Task<ICloneEnvironmentApiResponse?>

Remarks

Clones an environment

CreateEnvironmentAsync(CreateEnvironment, string, CancellationToken)

Create a new environment

Declaration

Task<ICreateEnvironmentApiResponse> CreateEnvironmentAsync(CreateEnvironment createEnvironment, string orgName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateEnvironment	createEnvironment	Create Environment
string	orgName	Organization name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ICreateEnvironmentApiResponse>	Task<ICreateEnvironmentApiResponse>

Remarks

Creates an environment in the given org with the given name.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateEnvironmentOrDefaultAsync(CreateEnvironment, string, CancellationToken)

Create a new environment

Declaration

Task<ICreateEnvironmentApiResponse?> CreateEnvironmentOrDefaultAsync(CreateEnvironment createEnvironment, string orgName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateEnvironment	createEnvironment	Create Environment
string	orgName	Organization name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ICreateEnvironmentApiResponse>	Task<ICreateEnvironmentApiResponse?>

Remarks

Creates an environment in the given org with the given name.

CreateEnvironmentRevisionTagAsync(CreateEnvironmentRevisionTag, string, string, string, CancellationToken)

Create environment revision tag

Declaration

Task<ICreateEnvironmentRevisionTagApiResponse> CreateEnvironmentRevisionTagAsync(CreateEnvironmentRevisionTag createEnvironmentRevisionTag, string orgName, string projectName, string envName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateEnvironmentRevisionTag	createEnvironmentRevisionTag	Create environment revision tag
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ICreateEnvironmentRevisionTagApiResponse>	Task<ICreateEnvironmentRevisionTagApiResponse>

Remarks

Create environment revision tag

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateEnvironmentRevisionTagOrDefaultAsync(CreateEnvironmentRevisionTag, string, string, string, CancellationToken)

Create environment revision tag

Declaration

Task<ICreateEnvironmentRevisionTagApiResponse?> CreateEnvironmentRevisionTagOrDefaultAsync(CreateEnvironmentRevisionTag createEnvironmentRevisionTag, string orgName, string projectName, string envName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateEnvironmentRevisionTag	createEnvironmentRevisionTag	Create environment revision tag
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ICreateEnvironmentRevisionTagApiResponse>	Task<ICreateEnvironmentRevisionTagApiResponse?>

Remarks

Create environment revision tag

CreateEnvironmentTagAsync(CreateEnvironmentTag, string, string, string, CancellationToken)

Create environment tag

Declaration

Task<ICreateEnvironmentTagApiResponse> CreateEnvironmentTagAsync(CreateEnvironmentTag createEnvironmentTag, string orgName, string projectName, string envName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateEnvironmentTag	createEnvironmentTag	Create environment tag
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ICreateEnvironmentTagApiResponse>	Task<ICreateEnvironmentTagApiResponse>

Remarks

Create environment tag

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateEnvironmentTagOrDefaultAsync(CreateEnvironmentTag, string, string, string, CancellationToken)

Create environment tag

Declaration

Task<ICreateEnvironmentTagApiResponse?> CreateEnvironmentTagOrDefaultAsync(CreateEnvironmentTag createEnvironmentTag, string orgName, string projectName, string envName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateEnvironmentTag	createEnvironmentTag	Create environment tag
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ICreateEnvironmentTagApiResponse>	Task<ICreateEnvironmentTagApiResponse?>

Remarks

Create environment tag

DecryptEnvironmentAsync(string, string, string, CancellationToken)

Reads the definition for the given environment with static secrets in plaintext

Declaration

Task<IDecryptEnvironmentApiResponse> DecryptEnvironmentAsync(string orgName, string projectName, string envName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IDecryptEnvironmentApiResponse>	Task<IDecryptEnvironmentApiResponse>

Remarks

Reads the definition for the given environment with static secrets in plaintext

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DecryptEnvironmentOrDefaultAsync(string, string, string, CancellationToken)

Reads the definition for the given environment with static secrets in plaintext

Declaration

Task<IDecryptEnvironmentApiResponse?> DecryptEnvironmentOrDefaultAsync(string orgName, string projectName, string envName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IDecryptEnvironmentApiResponse>	Task<IDecryptEnvironmentApiResponse?>

Remarks

Reads the definition for the given environment with static secrets in plaintext

DeleteEnvironmentAsync(string, string, string, CancellationToken)

Delete an environment

Declaration

Task<IDeleteEnvironmentApiResponse> DeleteEnvironmentAsync(string orgName, string projectName, string envName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IDeleteEnvironmentApiResponse>	Task<IDeleteEnvironmentApiResponse>

Remarks

Delete an environment

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteEnvironmentOrDefaultAsync(string, string, string, CancellationToken)

Delete an environment

Declaration

Task<IDeleteEnvironmentApiResponse?> DeleteEnvironmentOrDefaultAsync(string orgName, string projectName, string envName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IDeleteEnvironmentApiResponse>	Task<IDeleteEnvironmentApiResponse?>

Remarks

Delete an environment

DeleteEnvironmentRevisionTagAsync(string, string, string, string, CancellationToken)

Delete environment revision tag

Declaration

Task<IDeleteEnvironmentRevisionTagApiResponse> DeleteEnvironmentRevisionTagAsync(string orgName, string projectName, string envName, string tagName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
string	tagName	Tag name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IDeleteEnvironmentRevisionTagApiResponse>	Task<IDeleteEnvironmentRevisionTagApiResponse>

Remarks

Delete environment revision tag

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteEnvironmentRevisionTagOrDefaultAsync(string, string, string, string, CancellationToken)

Delete environment revision tag

Declaration

Task<IDeleteEnvironmentRevisionTagApiResponse?> DeleteEnvironmentRevisionTagOrDefaultAsync(string orgName, string projectName, string envName, string tagName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
string	tagName	Tag name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IDeleteEnvironmentRevisionTagApiResponse>	Task<IDeleteEnvironmentRevisionTagApiResponse?>

Remarks

Delete environment revision tag

DeleteEnvironmentTagAsync(string, string, string, string, CancellationToken)

Delete environment tag

Declaration

Task<IDeleteEnvironmentTagApiResponse> DeleteEnvironmentTagAsync(string orgName, string projectName, string envName, string tagName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
string	tagName	Tag name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IDeleteEnvironmentTagApiResponse>	Task<IDeleteEnvironmentTagApiResponse>

Remarks

Delete environment tag

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteEnvironmentTagOrDefaultAsync(string, string, string, string, CancellationToken)

Delete environment tag

Declaration

Task<IDeleteEnvironmentTagApiResponse?> DeleteEnvironmentTagOrDefaultAsync(string orgName, string projectName, string envName, string tagName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
string	tagName	Tag name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IDeleteEnvironmentTagApiResponse>	Task<IDeleteEnvironmentTagApiResponse?>

Remarks

Delete environment tag

GetEnvironmentAsync(string, string, string, CancellationToken)

Read an environment

Declaration

Task<IGetEnvironmentApiResponse> GetEnvironmentAsync(string orgName, string projectName, string envName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IGetEnvironmentApiResponse>	Task<IGetEnvironmentApiResponse>

Remarks

Read an environment

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEnvironmentAtVersionAsync(string, string, string, string, CancellationToken)

Read an environment at a specific version

Declaration

Task<IGetEnvironmentAtVersionApiResponse> GetEnvironmentAtVersionAsync(string orgName, string projectName, string envName, string version, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
string	version	Revision or tag
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IGetEnvironmentAtVersionApiResponse>	Task<IGetEnvironmentAtVersionApiResponse>

Remarks

Read an environmentat a specific revision or tag

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEnvironmentAtVersionOrDefaultAsync(string, string, string, string, CancellationToken)

Read an environment at a specific version

Declaration

Task<IGetEnvironmentAtVersionApiResponse?> GetEnvironmentAtVersionOrDefaultAsync(string orgName, string projectName, string envName, string version, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
string	version	Revision or tag
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IGetEnvironmentAtVersionApiResponse>	Task<IGetEnvironmentAtVersionApiResponse?>

Remarks

Read an environmentat a specific revision or tag

GetEnvironmentETagAsync(string, string, string, CancellationToken)

Return an Environment ETag

Declaration

Task<IGetEnvironmentETagApiResponse> GetEnvironmentETagAsync(string orgName, string projectName, string envName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IGetEnvironmentETagApiResponse>	Task<IGetEnvironmentETagApiResponse>

Remarks

Returns the ETag for the given environment if it exists.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEnvironmentETagOrDefaultAsync(string, string, string, CancellationToken)

Return an Environment ETag

Declaration

Task<IGetEnvironmentETagApiResponse?> GetEnvironmentETagOrDefaultAsync(string orgName, string projectName, string envName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IGetEnvironmentETagApiResponse>	Task<IGetEnvironmentETagApiResponse?>

Remarks

Returns the ETag for the given environment if it exists.

GetEnvironmentOrDefaultAsync(string, string, string, CancellationToken)

Read an environment

Declaration

Task<IGetEnvironmentApiResponse?> GetEnvironmentOrDefaultAsync(string orgName, string projectName, string envName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IGetEnvironmentApiResponse>	Task<IGetEnvironmentApiResponse?>

Remarks

Read an environment

GetEnvironmentRevisionTagAsync(string, string, string, string, CancellationToken)

Read environment revision tag

Declaration

Task<IGetEnvironmentRevisionTagApiResponse> GetEnvironmentRevisionTagAsync(string orgName, string projectName, string envName, string tagName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
string	tagName	Tag name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IGetEnvironmentRevisionTagApiResponse>	Task<IGetEnvironmentRevisionTagApiResponse>

Remarks

Read environment revision tag

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEnvironmentRevisionTagOrDefaultAsync(string, string, string, string, CancellationToken)

Read environment revision tag

Declaration

Task<IGetEnvironmentRevisionTagApiResponse?> GetEnvironmentRevisionTagOrDefaultAsync(string orgName, string projectName, string envName, string tagName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
string	tagName	Tag name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IGetEnvironmentRevisionTagApiResponse>	Task<IGetEnvironmentRevisionTagApiResponse?>

Remarks

Read environment revision tag

GetEnvironmentTagAsync(string, string, string, string, CancellationToken)

Read an environment tag

Declaration

Task<IGetEnvironmentTagApiResponse> GetEnvironmentTagAsync(string orgName, string projectName, string envName, string tagName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
string	tagName	Tag name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IGetEnvironmentTagApiResponse>	Task<IGetEnvironmentTagApiResponse>

Remarks

Read an environment tag

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEnvironmentTagOrDefaultAsync(string, string, string, string, CancellationToken)

Read an environment tag

Declaration

Task<IGetEnvironmentTagApiResponse?> GetEnvironmentTagOrDefaultAsync(string orgName, string projectName, string envName, string tagName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
string	tagName	Tag name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IGetEnvironmentTagApiResponse>	Task<IGetEnvironmentTagApiResponse?>

Remarks

Read an environment tag

ListEnvironmentRevisionTagsAsync(string, string, string, Option<int>, Option<string>, CancellationToken)

List environment revisions

Declaration

Task<IListEnvironmentRevisionTagsApiResponse> ListEnvironmentRevisionTagsAsync(string orgName, string projectName, string envName, Option<int> count = default, Option<string> after = default, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
Option<int>	count	limit of tags to return (optional)
Option<string>	after	after tag for pagination (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IListEnvironmentRevisionTagsApiResponse>	Task<IListEnvironmentRevisionTagsApiResponse>

Remarks

List environment revisions

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ListEnvironmentRevisionTagsOrDefaultAsync(string, string, string, Option<int>, Option<string>, CancellationToken)

List environment revisions

Declaration

Task<IListEnvironmentRevisionTagsApiResponse?> ListEnvironmentRevisionTagsOrDefaultAsync(string orgName, string projectName, string envName, Option<int> count = default, Option<string> after = default, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
Option<int>	count	limit of tags to return (optional)
Option<string>	after	after tag for pagination (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IListEnvironmentRevisionTagsApiResponse>	Task<IListEnvironmentRevisionTagsApiResponse?>

Remarks

List environment revisions

ListEnvironmentRevisionsAsync(string, string, string, Option<int>, Option<int>, CancellationToken)

List environment revisions

Declaration

Task<IListEnvironmentRevisionsApiResponse> ListEnvironmentRevisionsAsync(string orgName, string projectName, string envName, Option<int> before = default, Option<int> count = default, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
Option<int>	before	before revision number for pagination (optional)
Option<int>	count	limit of revisions to return (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IListEnvironmentRevisionsApiResponse>	Task<IListEnvironmentRevisionsApiResponse>

Remarks

List environment revisions

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ListEnvironmentRevisionsOrDefaultAsync(string, string, string, Option<int>, Option<int>, CancellationToken)

List environment revisions

Declaration

Task<IListEnvironmentRevisionsApiResponse?> ListEnvironmentRevisionsOrDefaultAsync(string orgName, string projectName, string envName, Option<int> before = default, Option<int> count = default, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
Option<int>	before	before revision number for pagination (optional)
Option<int>	count	limit of revisions to return (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IListEnvironmentRevisionsApiResponse>	Task<IListEnvironmentRevisionsApiResponse?>

Remarks

List environment revisions

ListEnvironmentTagsAsync(string, string, string, Option<int>, Option<string>, CancellationToken)

List environment tags

Declaration

Task<IListEnvironmentTagsApiResponse> ListEnvironmentTagsAsync(string orgName, string projectName, string envName, Option<int> count = default, Option<string> after = default, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
Option<int>	count	limit of tags to return (optional)
Option<string>	after	after tag for pagination (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IListEnvironmentTagsApiResponse>	Task<IListEnvironmentTagsApiResponse>

Remarks

List environment tags

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ListEnvironmentTagsOrDefaultAsync(string, string, string, Option<int>, Option<string>, CancellationToken)

List environment tags

Declaration

Task<IListEnvironmentTagsApiResponse?> ListEnvironmentTagsOrDefaultAsync(string orgName, string projectName, string envName, Option<int> count = default, Option<string> after = default, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
Option<int>	count	limit of tags to return (optional)
Option<string>	after	after tag for pagination (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IListEnvironmentTagsApiResponse>	Task<IListEnvironmentTagsApiResponse?>

Remarks

List environment tags

ListEnvironmentsAsync(string, Option<string>, CancellationToken)

List environments in the organization

Declaration

Task<IListEnvironmentsApiResponse> ListEnvironmentsAsync(string orgName, Option<string> continuationToken = default, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
Option<string>	continuationToken	continuation Token from previous query to fetch next page of results (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IListEnvironmentsApiResponse>	Task<IListEnvironmentsApiResponse>

Remarks

List environments in the organization available to the current user

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ListEnvironmentsOrDefaultAsync(string, Option<string>, CancellationToken)

List environments in the organization

Declaration

Task<IListEnvironmentsApiResponse?> ListEnvironmentsOrDefaultAsync(string orgName, Option<string> continuationToken = default, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
Option<string>	continuationToken	continuation Token from previous query to fetch next page of results (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IListEnvironmentsApiResponse>	Task<IListEnvironmentsApiResponse?>

Remarks

List environments in the organization available to the current user

OpenEnvironmentAsync(string, string, string, Option<string>, CancellationToken)

Open an environment session

Declaration

Task<IOpenEnvironmentApiResponse> OpenEnvironmentAsync(string orgName, string projectName, string envName, Option<string> duration = default, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
Option<string>	duration	open duration - A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as “300ms”, “1.5h” or “2h45m”. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”. (optional, default to "1h")
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IOpenEnvironmentApiResponse>	Task<IOpenEnvironmentApiResponse>

Remarks

Opens a session the given environment for the indicated duration. This returns a session id that can be used to then read values. The default duration is 1 hour.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

OpenEnvironmentAtVersionAsync(string, string, string, string, Option<string>, CancellationToken)

Open an environment session at a specific version

Declaration

Task<IOpenEnvironmentAtVersionApiResponse> OpenEnvironmentAtVersionAsync(string orgName, string projectName, string envName, string version, Option<string> duration = default, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
string	version	Revision or tag
Option<string>	duration	open duration - A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as “300ms”, “1.5h” or “2h45m”. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”. (optional, default to "1h")
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IOpenEnvironmentAtVersionApiResponse>	Task<IOpenEnvironmentAtVersionApiResponse>

Remarks

Opens a session the given environment at a specific version for the indicated duration. This returns a session id that can be used to then read values. The default duration is 1 hour.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

OpenEnvironmentAtVersionOrDefaultAsync(string, string, string, string, Option<string>, CancellationToken)

Open an environment session at a specific version

Declaration

Task<IOpenEnvironmentAtVersionApiResponse?> OpenEnvironmentAtVersionOrDefaultAsync(string orgName, string projectName, string envName, string version, Option<string> duration = default, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
string	version	Revision or tag
Option<string>	duration	open duration - A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as “300ms”, “1.5h” or “2h45m”. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”. (optional, default to "1h")
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IOpenEnvironmentAtVersionApiResponse>	Task<IOpenEnvironmentAtVersionApiResponse?>

Remarks

Opens a session the given environment at a specific version for the indicated duration. This returns a session id that can be used to then read values. The default duration is 1 hour.

OpenEnvironmentOrDefaultAsync(string, string, string, Option<string>, CancellationToken)

Open an environment session

Declaration

Task<IOpenEnvironmentApiResponse?> OpenEnvironmentOrDefaultAsync(string orgName, string projectName, string envName, Option<string> duration = default, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
Option<string>	duration	open duration - A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as “300ms”, “1.5h” or “2h45m”. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”. (optional, default to "1h")
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IOpenEnvironmentApiResponse>	Task<IOpenEnvironmentApiResponse?>

Remarks

Opens a session the given environment for the indicated duration. This returns a session id that can be used to then read values. The default duration is 1 hour.

ReadOpenEnvironmentAsync(string, string, string, string, CancellationToken)

Read an open environment

Declaration

Task<IReadOpenEnvironmentApiResponse> ReadOpenEnvironmentAsync(string orgName, string projectName, string envName, string openSessionID, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
string	openSessionID	Open session ID returned from environment open
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IReadOpenEnvironmentApiResponse>	Task<IReadOpenEnvironmentApiResponse>

Remarks

Reads and decrypts secrets including retrieving dynamic secrets from providers.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ReadOpenEnvironmentOrDefaultAsync(string, string, string, string, CancellationToken)

Read an open environment

Declaration

Task<IReadOpenEnvironmentApiResponse?> ReadOpenEnvironmentOrDefaultAsync(string orgName, string projectName, string envName, string openSessionID, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
string	openSessionID	Open session ID returned from environment open
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IReadOpenEnvironmentApiResponse>	Task<IReadOpenEnvironmentApiResponse?>

Remarks

Reads and decrypts secrets including retrieving dynamic secrets from providers.

ReadOpenEnvironmentPropertyAsync(string, string, string, string, string, CancellationToken)

Read an open environment

Declaration

Task<IReadOpenEnvironmentPropertyApiResponse> ReadOpenEnvironmentPropertyAsync(string orgName, string projectName, string envName, string openSessionID, string property, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
string	openSessionID	Open session ID returned from environment open
string	property	Path to a specific property using Pulumi path syntax https://www.pulumi.com/docs/concepts/config/#structured-configuration
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IReadOpenEnvironmentPropertyApiResponse>	Task<IReadOpenEnvironmentPropertyApiResponse>

Remarks

Reads and decrypts secrets including retrieving dynamic secrets from providers.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ReadOpenEnvironmentPropertyOrDefaultAsync(string, string, string, string, string, CancellationToken)

Read an open environment

Declaration

Task<IReadOpenEnvironmentPropertyApiResponse?> ReadOpenEnvironmentPropertyOrDefaultAsync(string orgName, string projectName, string envName, string openSessionID, string property, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
string	openSessionID	Open session ID returned from environment open
string	property	Path to a specific property using Pulumi path syntax https://www.pulumi.com/docs/concepts/config/#structured-configuration
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IReadOpenEnvironmentPropertyApiResponse>	Task<IReadOpenEnvironmentPropertyApiResponse?>

Remarks

Reads and decrypts secrets including retrieving dynamic secrets from providers.

UpdateEnvironmentRevisionTagAsync(UpdateEnvironmentRevisionTag, string, string, string, string, CancellationToken)

Update environment revision tag

Declaration

Task<IUpdateEnvironmentRevisionTagApiResponse> UpdateEnvironmentRevisionTagAsync(UpdateEnvironmentRevisionTag updateEnvironmentRevisionTag, string orgName, string projectName, string envName, string tagName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UpdateEnvironmentRevisionTag	updateEnvironmentRevisionTag	Update environment revision tag
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
string	tagName	Tag name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IUpdateEnvironmentRevisionTagApiResponse>	Task<IUpdateEnvironmentRevisionTagApiResponse>

Remarks

Update environment revision tag

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

UpdateEnvironmentRevisionTagOrDefaultAsync(UpdateEnvironmentRevisionTag, string, string, string, string, CancellationToken)

Update environment revision tag

Declaration

Task<IUpdateEnvironmentRevisionTagApiResponse?> UpdateEnvironmentRevisionTagOrDefaultAsync(UpdateEnvironmentRevisionTag updateEnvironmentRevisionTag, string orgName, string projectName, string envName, string tagName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UpdateEnvironmentRevisionTag	updateEnvironmentRevisionTag	Update environment revision tag
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
string	tagName	Tag name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IUpdateEnvironmentRevisionTagApiResponse>	Task<IUpdateEnvironmentRevisionTagApiResponse?>

Remarks

Update environment revision tag

UpdateEnvironmentTagAsync(UpdateEnvironmentTag, string, string, string, string, CancellationToken)

Update an environment tag

Declaration

Task<IUpdateEnvironmentTagApiResponse> UpdateEnvironmentTagAsync(UpdateEnvironmentTag updateEnvironmentTag, string orgName, string projectName, string envName, string tagName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UpdateEnvironmentTag	updateEnvironmentTag	Update environment tag
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
string	tagName	Tag name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IUpdateEnvironmentTagApiResponse>	Task<IUpdateEnvironmentTagApiResponse>

Remarks

Update an environment tag

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

UpdateEnvironmentTagOrDefaultAsync(UpdateEnvironmentTag, string, string, string, string, CancellationToken)

Update an environment tag

Declaration

Task<IUpdateEnvironmentTagApiResponse?> UpdateEnvironmentTagOrDefaultAsync(UpdateEnvironmentTag updateEnvironmentTag, string orgName, string projectName, string envName, string tagName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UpdateEnvironmentTag	updateEnvironmentTag	Update environment tag
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
string	tagName	Tag name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IUpdateEnvironmentTagApiResponse>	Task<IUpdateEnvironmentTagApiResponse?>

Remarks

Update an environment tag

UpdateEnvironmentYamlAsync(string, string, string, string, CancellationToken)

Update an existing environment with Yaml file

Declaration

Task<IUpdateEnvironmentYamlApiResponse> UpdateEnvironmentYamlAsync(string orgName, string projectName, string envName, string body, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
string	body	Environment Yaml content
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IUpdateEnvironmentYamlApiResponse>	Task<IUpdateEnvironmentYamlApiResponse>

Remarks

Validates and updates the given environment's definition.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

UpdateEnvironmentYamlOrDefaultAsync(string, string, string, string, CancellationToken)

Update an existing environment with Yaml file

Declaration

Task<IUpdateEnvironmentYamlApiResponse?> UpdateEnvironmentYamlOrDefaultAsync(string orgName, string projectName, string envName, string body, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name
string	projectName	Project name
string	envName	Environment name
string	body	Environment Yaml content
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<IUpdateEnvironmentYamlApiResponse>	Task<IUpdateEnvironmentYamlApiResponse?>

Remarks

Validates and updates the given environment's definition.