Class EscApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

EscApi

Implements

IEscApi

IApi

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Pulumi.Esc.Sdk.Api

Assembly: Pulumi.Esc.Sdk.dll

Syntax

public sealed class EscApi : IEscApi, IApi

Constructors

EscApi(ILogger<EscApi>, ILoggerFactory, HttpClient, JsonSerializerOptionsProvider, EscApiEvents, TokenProvider<ApiKeyToken>)

Initializes a new instance of the EscApi class.

Declaration

public EscApi(ILogger<EscApi> logger, ILoggerFactory loggerFactory, HttpClient httpClient, JsonSerializerOptionsProvider jsonSerializerOptionsProvider, EscApiEvents escApiEvents, TokenProvider<ApiKeyToken> apiKeyProvider)

Parameters

Type	Name	Description
ILogger<EscApi>	logger
ILoggerFactory	loggerFactory
HttpClient	httpClient
JsonSerializerOptionsProvider	jsonSerializerOptionsProvider
EscApiEvents	escApiEvents
TokenProvider<ApiKeyToken>	apiKeyProvider

Properties

ApiKeyProvider

A token provider of type ApiKeyProvider

Declaration

public TokenProvider<ApiKeyToken> ApiKeyProvider { get; }

Property Value

Type	Description
TokenProvider<ApiKeyToken>

Events

The class containing the events

Declaration

public EscApiEvents Events { get; }

Property Value

Type	Description
EscApiEvents

HttpClient

The HttpClient

Declaration

public HttpClient HttpClient { get; }

Property Value

Type	Description
HttpClient

Logger

The logger

Declaration

public ILogger<EscApi> Logger { get; }

Property Value

Type	Description
ILogger<EscApi>

LoggerFactory

The logger factory

Declaration

public ILoggerFactory LoggerFactory { get; }

Property Value

Type	Description
ILoggerFactory

Methods

CheckEnvironmentYamlAsync(string, string, CancellationToken)

Checks an environment definition for errors Checks an environment definition for errors

Declaration

public 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>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CheckEnvironmentYamlOrDefaultAsync(string, string, CancellationToken)

Checks an environment definition for errors Checks an environment definition for errors

Declaration

public 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>

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

Clones an environment Clones an environment

Declaration

public 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>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Clones an environment Clones an environment

Declaration

public 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>

CreateEnvironmentAsync(CreateEnvironment, string, CancellationToken)

Create a new environment Creates an environment in the given org with the given name.

Declaration

public 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>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateEnvironmentOrDefaultAsync(CreateEnvironment, string, CancellationToken)

Create a new environment Creates an environment in the given org with the given name.

Declaration

public 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>

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

Create environment revision tag Create environment revision tag

Declaration

public 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>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Create environment revision tag Create environment revision tag

Declaration

public 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>

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

Create environment tag Create environment tag

Declaration

public 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>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Create environment tag Create environment tag

Declaration

public 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>

DecryptEnvironmentAsync(string, string, string, CancellationToken)

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

Declaration

public 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>

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 Reads the definition for the given environment with static secrets in plaintext

Declaration

public 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>

DeleteEnvironmentAsync(string, string, string, CancellationToken)

Delete an environment Delete an environment

Declaration

public 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>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteEnvironmentOrDefaultAsync(string, string, string, CancellationToken)

Delete an environment Delete an environment

Declaration

public 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>

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

Delete environment revision tag Delete environment revision tag

Declaration

public 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>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Delete environment revision tag Delete environment revision tag

Declaration

public 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>

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

Delete environment tag Delete environment tag

Declaration

public 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>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Delete environment tag Delete environment tag

Declaration

public 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>

GetEnvironmentAsync(string, string, string, CancellationToken)

Read an environment Read an environment

Declaration

public 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>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Read an environment at a specific version Read an environmentat a specific revision or tag

Declaration

public 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>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Read an environment at a specific version Read an environmentat a specific revision or tag

Declaration

public 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>

GetEnvironmentETagAsync(string, string, string, CancellationToken)

Return an Environment ETag Returns the ETag for the given environment if it exists.

Declaration

public 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>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEnvironmentETagOrDefaultAsync(string, string, string, CancellationToken)

Return an Environment ETag Returns the ETag for the given environment if it exists.

Declaration

public 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>

GetEnvironmentOrDefaultAsync(string, string, string, CancellationToken)

Read an environment Read an environment

Declaration

public 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>

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

Read environment revision tag Read environment revision tag

Declaration

public 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>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Read environment revision tag Read environment revision tag

Declaration

public 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>

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

Read an environment tag Read an environment tag

Declaration

public 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>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Read an environment tag Read an environment tag

Declaration

public 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>

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

List environment revisions List environment revisions

Declaration

public 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>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

List environment revisions List environment revisions

Declaration

public 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>

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

List environment revisions List environment revisions

Declaration

public 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>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

List environment revisions List environment revisions

Declaration

public 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>

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

List environment tags List environment tags

Declaration

public 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>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

List environment tags List environment tags

Declaration

public 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>

ListEnvironmentsAsync(string, Option<string>, CancellationToken)

List environments in the organization List environments in the organization available to the current user

Declaration

public 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>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ListEnvironmentsOrDefaultAsync(string, Option<string>, CancellationToken)

List environments in the organization List environments in the organization available to the current user

Declaration

public 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>

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

Open an environment session 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.

Declaration

public 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>

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 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.

Declaration

public 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>

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 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.

Declaration

public 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>

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

Open an environment session 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.

Declaration

public 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>

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

Read an open environment Reads and decrypts secrets including retrieving dynamic secrets from providers.

Declaration

public 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>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Read an open environment Reads and decrypts secrets including retrieving dynamic secrets from providers.

Declaration

public 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>

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

Read an open environment Reads and decrypts secrets including retrieving dynamic secrets from providers.

Declaration

public 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>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Read an open environment Reads and decrypts secrets including retrieving dynamic secrets from providers.

Declaration

public 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>

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

Update environment revision tag Update environment revision tag

Declaration

public 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>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Update environment revision tag Update environment revision tag

Declaration

public 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>

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

Update an environment tag Update an environment tag

Declaration

public 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>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Update an environment tag Update an environment tag

Declaration

public 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>

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

Update an existing environment with Yaml file Validates and updates the given environment's definition.

Declaration

public 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>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Update an existing environment with Yaml file Validates and updates the given environment's definition.

Declaration

public 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>

Implements

IEscApi

IApi