Class EscClient

A high-level client for the Pulumi ESC (Environments, Secrets, Config) API. Wraps the generated IEscApi and provides a more convenient interface.

Inheritance

object

EscClient

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Pulumi.Esc.Sdk

Assembly: Pulumi.Esc.Sdk.dll

Syntax

public class EscClient : IDisposable

Properties

RawApi

The underlying raw API client. Use this for advanced scenarios not covered by the convenience methods.

Declaration

public IEscApi RawApi { get; }

Property Value

Type	Description
IEscApi

Methods

CheckEnvironmentAsync(string, EnvironmentDefinition, CancellationToken)

Checks an EnvironmentDefinition for errors. The definition is serialized to YAML before sending.

Declaration

public Task<CheckEnvironment?> CheckEnvironmentAsync(string orgName, EnvironmentDefinition definition, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName
EnvironmentDefinition	definition
CancellationToken	cancellationToken

Returns

Type	Description
Task<CheckEnvironment>	The check result, which may contain diagnostics even on error.

CheckEnvironmentYamlAsync(string, string, CancellationToken)

Checks an environment YAML definition for errors.

Declaration

public Task<CheckEnvironment?> CheckEnvironmentYamlAsync(string orgName, string yaml, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName
string	yaml
CancellationToken	cancellationToken

Returns

Type	Description
Task<CheckEnvironment>	The check result, which may contain diagnostics even on error.

CloneEnvironmentAsync(string, string, string, string, string, CloneEnvironmentOptions?, CancellationToken)

Clones an existing environment into a new environment.

Declaration

public Task CloneEnvironmentAsync(string orgName, string srcProjectName, string srcEnvName, string destProjectName, string destEnvName, CloneEnvironmentOptions? options = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName
string	srcProjectName
string	srcEnvName
string	destProjectName
string	destEnvName
CloneEnvironmentOptions	options
CancellationToken	cancellationToken

Returns

Type	Description
Task

Create(string, string?)

Creates a new EscClient with the specified access token and backend URL.

Declaration

public static EscClient Create(string accessToken, string? backendUrl = null)

Parameters

Type	Name	Description
string	accessToken	The Pulumi access token for authentication.
string	backendUrl	The ESC API base URL (e.g. "https://api.pulumi.com/api/esc"). If null, defaults to the standard Pulumi Cloud ESC API endpoint.

Returns

Type	Description
EscClient	A new EscClient instance.

CreateDefault()

Creates a new EscClient with default configuration. The access token is resolved from PULUMI_ACCESS_TOKEN environment variable or the currently logged-in Pulumi CLI / ESC CLI account. The backend URL is resolved from PULUMI_BACKEND_URL environment variable or the currently logged-in account URL.

Declaration

public static EscClient CreateDefault()

Returns

Type	Description
EscClient	A new EscClient instance.

Exceptions

Type	Condition
InvalidOperationException	If no access token can be found.

CreateEnvironmentAsync(string, string, string, CancellationToken)

Creates a new environment with the given name in the given organization.

Declaration

public Task CreateEnvironmentAsync(string orgName, string projectName, string envName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName
string	projectName
string	envName
CancellationToken	cancellationToken

Returns

Type	Description
Task

CreateEnvironmentRevisionTagAsync(string, string, string, string, int, CancellationToken)

Creates a new environment revision tag.

Declaration

public Task CreateEnvironmentRevisionTagAsync(string orgName, string projectName, string envName, string tagName, int revision, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName
string	projectName
string	envName
string	tagName
int	revision
CancellationToken	cancellationToken

Returns

Type	Description
Task

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

Creates a new environment tag.

Declaration

public Task<EnvironmentTag> CreateEnvironmentTagAsync(string orgName, string projectName, string envName, string tagName, string tagValue, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName
string	projectName
string	envName
string	tagName
string	tagValue
CancellationToken	cancellationToken

Returns

Type	Description
Task<EnvironmentTag>

DecryptEnvironmentAsync(string, string, string, CancellationToken)

Reads the environment definition with static secrets in plaintext and returns a parsed EnvironmentDefinition.

Declaration

public Task<EnvironmentDefinition?> DecryptEnvironmentAsync(string orgName, string projectName, string envName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName
string	projectName
string	envName
CancellationToken	cancellationToken

Returns

Type	Description
Task<EnvironmentDefinition>

DecryptEnvironmentYamlAsync(string, string, string, CancellationToken)

Reads the environment definition with static secrets in plaintext and returns the raw YAML string.

Declaration

public Task<string> DecryptEnvironmentYamlAsync(string orgName, string projectName, string envName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName
string	projectName
string	envName
CancellationToken	cancellationToken

Returns

Type	Description
Task<string>

DeleteEnvironmentAsync(string, string, string, CancellationToken)

Deletes the environment with the given name.

Declaration

public Task DeleteEnvironmentAsync(string orgName, string projectName, string envName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName
string	projectName
string	envName
CancellationToken	cancellationToken

Returns

Type	Description
Task

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

Deletes an environment revision tag.

Declaration

public Task DeleteEnvironmentRevisionTagAsync(string orgName, string projectName, string envName, string tagName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName
string	projectName
string	envName
string	tagName
CancellationToken	cancellationToken

Returns

Type	Description
Task

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

Deletes an environment tag.

Declaration

public Task DeleteEnvironmentTagAsync(string orgName, string projectName, string envName, string tagName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName
string	projectName
string	envName
string	tagName
CancellationToken	cancellationToken

Returns

Type	Description
Task

Dispose()

Disposes the underlying service provider and HttpClient resources.

Declaration

public void Dispose()

Dispose(bool)

Disposes managed resources.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

GetEnvironmentAsync(string, string, string, CancellationToken)

Reads the environment definition and returns a parsed EnvironmentDefinition.

Declaration

public Task<EnvironmentDefinition?> GetEnvironmentAsync(string orgName, string projectName, string envName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName
string	projectName
string	envName
CancellationToken	cancellationToken

Returns

Type	Description
Task<EnvironmentDefinition>

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

Reads the environment definition at a specific version and returns a parsed EnvironmentDefinition.

Declaration

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

Parameters

Type	Name	Description
string	orgName
string	projectName
string	envName
string	version
CancellationToken	cancellationToken

Returns

Type	Description
Task<EnvironmentDefinition>

GetEnvironmentAtVersionYamlAsync(string, string, string, string, CancellationToken)

Reads the environment definition at a specific version and returns the raw YAML string.

Declaration

public Task<string> GetEnvironmentAtVersionYamlAsync(string orgName, string projectName, string envName, string version, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName
string	projectName
string	envName
string	version
CancellationToken	cancellationToken

Returns

Type	Description
Task<string>

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

Gets an environment revision tag by name.

Declaration

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

Parameters

Type	Name	Description
string	orgName
string	projectName
string	envName
string	tagName
CancellationToken	cancellationToken

Returns

Type	Description
Task<EnvironmentRevisionTag>

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

Gets an environment tag by name.

Declaration

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

Parameters

Type	Name	Description
string	orgName
string	projectName
string	envName
string	tagName
CancellationToken	cancellationToken

Returns

Type	Description
Task<EnvironmentTag>

GetEnvironmentYamlAsync(string, string, string, CancellationToken)

Reads the environment definition and returns the raw YAML string.

Declaration

public Task<string> GetEnvironmentYamlAsync(string orgName, string projectName, string envName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName
string	projectName
string	envName
CancellationToken	cancellationToken

Returns

Type	Description
Task<string>

ListEnvironmentRevisionTagsAsync(string, string, string, CancellationToken)

Lists all environment revision tags.

Declaration

public Task<EnvironmentRevisionTags> ListEnvironmentRevisionTagsAsync(string orgName, string projectName, string envName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName
string	projectName
string	envName
CancellationToken	cancellationToken

Returns

Type	Description
Task<EnvironmentRevisionTags>

ListEnvironmentRevisionTagsPaginatedAsync(string, string, string, string?, int?, CancellationToken)

Lists environment revision tags with pagination support.

Declaration

public Task<EnvironmentRevisionTags> ListEnvironmentRevisionTagsPaginatedAsync(string orgName, string projectName, string envName, string? after = null, int? count = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName
string	projectName
string	envName
string	after
int?	count
CancellationToken	cancellationToken

Returns

Type	Description
Task<EnvironmentRevisionTags>

ListEnvironmentRevisionsAsync(string, string, string, CancellationToken)

Lists all revisions of the environment.

Declaration

public Task<List<EnvironmentRevision>> ListEnvironmentRevisionsAsync(string orgName, string projectName, string envName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName
string	projectName
string	envName
CancellationToken	cancellationToken

Returns

Type	Description
Task<List<EnvironmentRevision>>

ListEnvironmentRevisionsPaginatedAsync(string, string, string, int?, int?, CancellationToken)

Lists revisions of the environment with pagination support.

Declaration

public Task<List<EnvironmentRevision>> ListEnvironmentRevisionsPaginatedAsync(string orgName, string projectName, string envName, int? before = null, int? count = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName
string	projectName
string	envName
int?	before
int?	count
CancellationToken	cancellationToken

Returns

Type	Description
Task<List<EnvironmentRevision>>

ListEnvironmentTagsAsync(string, string, string, CancellationToken)

Lists all environment tags.

Declaration

public Task<ListEnvironmentTags> ListEnvironmentTagsAsync(string orgName, string projectName, string envName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName
string	projectName
string	envName
CancellationToken	cancellationToken

Returns

Type	Description
Task<ListEnvironmentTags>

ListEnvironmentTagsPaginatedAsync(string, string, string, string?, int?, CancellationToken)

Lists environment tags with pagination support.

Declaration

public Task<ListEnvironmentTags> ListEnvironmentTagsPaginatedAsync(string orgName, string projectName, string envName, string? after = null, int? count = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName
string	projectName
string	envName
string	after
int?	count
CancellationToken	cancellationToken

Returns

Type	Description
Task<ListEnvironmentTags>

ListEnvironmentsAsync(string, string?, CancellationToken)

Lists all environments in the given organization.

Declaration

public Task<OrgEnvironments> ListEnvironmentsAsync(string orgName, string? continuationToken = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName	Organization name.
string	continuationToken	Optional continuation token for pagination.
CancellationToken	cancellationToken	Cancellation token.

Returns

Type	Description
Task<OrgEnvironments>	The list of environments.

OpenAndReadEnvironmentAsync(string, string, string, CancellationToken)

Opens and reads an environment in a single call. Returns the full environment model and the unwrapped value dictionary.

Declaration

public Task<(ModelEnvironment Environment, Dictionary<string, object?>? Values)> OpenAndReadEnvironmentAsync(string orgName, string projectName, string envName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName
string	projectName
string	envName
CancellationToken	cancellationToken

Returns

Type	Description
Task<(ModelEnvironment Environment, Dictionary<string, object> Values)>

OpenAndReadEnvironmentAtVersionAsync(string, string, string, string, CancellationToken)

Opens and reads an environment at a specific version in a single call. Returns the full environment model and the unwrapped value dictionary.

Declaration

public Task<(ModelEnvironment Environment, Dictionary<string, object?>? Values)> OpenAndReadEnvironmentAtVersionAsync(string orgName, string projectName, string envName, string version, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName
string	projectName
string	envName
string	version
CancellationToken	cancellationToken

Returns

Type	Description
Task<(ModelEnvironment Environment, Dictionary<string, object> Values)>

OpenEnvironmentAsync(string, string, string, CancellationToken)

Opens an environment session and returns the session ID and any diagnostics.

Declaration

public Task<(string Id, List<EnvironmentDiagnostic>? Diagnostics)> OpenEnvironmentAsync(string orgName, string projectName, string envName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName
string	projectName
string	envName
CancellationToken	cancellationToken

Returns

Type	Description
Task<(string Id, List<EnvironmentDiagnostic> Diagnostics)>	A tuple of (sessionId, diagnostics).

OpenEnvironmentAtVersionAsync(string, string, string, string, CancellationToken)

Opens an environment session at a specific version and returns the session ID and any diagnostics.

Declaration

public Task<(string Id, List<EnvironmentDiagnostic>? Diagnostics)> OpenEnvironmentAtVersionAsync(string orgName, string projectName, string envName, string version, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName
string	projectName
string	envName
string	version
CancellationToken	cancellationToken

Returns

Type	Description
Task<(string Id, List<EnvironmentDiagnostic> Diagnostics)>	A tuple of (sessionId, diagnostics).

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

Reads the resolved values of an open environment session. Returns both the full environment model and the unwrapped value dictionary.

Declaration

public Task<(ModelEnvironment Environment, Dictionary<string, object?>? Values)> ReadOpenEnvironmentAsync(string orgName, string projectName, string envName, string openSessionId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName
string	projectName
string	envName
string	openSessionId
CancellationToken	cancellationToken

Returns

Type	Description
Task<(ModelEnvironment Environment, Dictionary<string, object> Values)>

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

Reads a specific property from an open environment session. Returns both the raw Value and the unwrapped primitive.

Declaration

public Task<(Value Value, object? Primitive)> ReadOpenEnvironmentPropertyAsync(string orgName, string projectName, string envName, string openSessionId, string propertyPath, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName
string	projectName
string	envName
string	openSessionId
string	propertyPath
CancellationToken	cancellationToken

Returns

Type	Description
Task<(Value Value, object Primitive)>

Remarks

The generated ReadOpenEnvironmentProperty API endpoint uses a double-slash (//) in its URL path to differentiate it from the ReadOpenEnvironment endpoint. .NET's Uri class normalizes // to /, breaking the request. As a workaround, this method reads the full environment and extracts the requested property using dot-separated path navigation.

UpdateEnvironmentAsync(string, string, string, EnvironmentDefinition, CancellationToken)

Updates the environment definition using an EnvironmentDefinition object. The definition is serialized to YAML before sending.

Declaration

public Task<EnvironmentDiagnostics?> UpdateEnvironmentAsync(string orgName, string projectName, string envName, EnvironmentDefinition definition, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName
string	projectName
string	envName
EnvironmentDefinition	definition
CancellationToken	cancellationToken

Returns

Type	Description
Task<EnvironmentDiagnostics>	Diagnostics from the update, if any.

UpdateEnvironmentRevisionTagAsync(string, string, string, string, int, CancellationToken)

Updates an environment revision tag to point to a different revision.

Declaration

public Task UpdateEnvironmentRevisionTagAsync(string orgName, string projectName, string envName, string tagName, int revision, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName
string	projectName
string	envName
string	tagName
int	revision
CancellationToken	cancellationToken

Returns

Type	Description
Task

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

Updates an environment tag.

Declaration

public Task<EnvironmentTag?> UpdateEnvironmentTagAsync(string orgName, string projectName, string envName, string tagName, string currentTagValue, string newTagName, string newTagValue, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName
string	projectName
string	envName
string	tagName
string	currentTagValue
string	newTagName
string	newTagValue
CancellationToken	cancellationToken

Returns

Type	Description
Task<EnvironmentTag>

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

Updates the environment definition using a raw YAML string.

Declaration

public Task<EnvironmentDiagnostics?> UpdateEnvironmentYamlAsync(string orgName, string projectName, string envName, string yaml, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	orgName
string	projectName
string	envName
string	yaml
CancellationToken	cancellationToken

Returns

Type	Description
Task<EnvironmentDiagnostics>	Diagnostics from the update, if any.

Implements

IDisposable